Class: AmzSpApi::VendorTransactionStatusApiModel::VendorTransactionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vendor-transaction-status-api-model/api/vendor_transaction_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VendorTransactionApi

Returns a new instance of VendorTransactionApi.



16
17
18
 
# File 'lib/vendor-transaction-status-api-model/api/vendor_transaction_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/vendor-transaction-status-api-model/api/vendor_transaction_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_transaction(transaction_id, opts = {}) ⇒ GetTransactionResponse

Returns the status of the transaction that you specify. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | —- | —- | —- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • transaction_id —

    The GUID provided by Amazon in the 'transactionId' field in response to the post request of a specific transaction.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/vendor-transaction-status-api-model/api/vendor_transaction_api.rb', line 23

def get_transaction(transaction_id, opts = {})
  data, _status_code, _headers = get_transaction_with_http_info(transaction_id, opts)
  data
end

#get_transaction_with_http_info(transaction_id, opts = {}) ⇒ Array<(GetTransactionResponse, Integer, Hash)>

Returns the status of the transaction that you specify. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | —- | —- | —- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • transaction_id —

    The GUID provided by Amazon in the &#x27;transactionId&#x27; field in response to the post request of a specific transaction.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetTransactionResponse, Integer, Hash)>) —

    GetTransactionResponse data, response status code and response headers



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/vendor-transaction-status-api-model/api/vendor_transaction_api.rb', line 32

def get_transaction_with_http_info(transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VendorTransactionApi.get_transaction ...'
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling VendorTransactionApi.get_transaction"
  end
  # resource path
  local_var_path = '/vendor/transactions/v1/transactions/{transactionId}'.sub('{' + 'transactionId' + '}', transaction_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'GetTransactionResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VendorTransactionApi#get_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end