Class: AmzSpApi::UploadsApiModel::UploadsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/uploads-api-model/api/uploads_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UploadsApi

Returns a new instance of UploadsApi.



16
17
18
 
# File 'lib/uploads-api-model/api/uploads_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/uploads-api-model/api/uploads_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_upload_destination_for_resource(marketplace_ids, content_md5, resource, opts = {}) ⇒ CreateUploadDestinationResponse

Creates an upload destination, returning the information required to upload a file to the destination and to programmatically access the file. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | .1 | 5 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • marketplace_ids —

    A list of marketplace identifiers. This specifies the marketplaces where the upload will be available. Only one marketplace can be specified.

  • content_md5 —

    An MD5 hash of the content to be submitted to the upload destination. This value is used to determine if the data has been corrupted or tampered with during transit.

  • resource —

    The resource for the upload destination that you are creating. For example, if you are creating an upload destination for the createLegalDisclosure operation of the Messaging API, the `resource` would be `/messaging/v1/orders/amazonOrderId/messages/legalDisclosure`, and the entire path would be `/uploads/2020-11-01/uploadDestinations/messaging/v1/orders/amazonOrderId/messages/legalDisclosure`. If you are creating an upload destination for an Aplus content document, the `resource` would be `aplus/2020-11-01/contentDocuments` and the path would be `/uploads/v1/uploadDestinations/aplus/2020-11-01/contentDocuments`.

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

    the optional parameters

Options Hash (opts):

  • :content_type (String) —

    The content type of the file to be uploaded.

Returns:



26
27
28
29
 
# File 'lib/uploads-api-model/api/uploads_api.rb', line 26

def create_upload_destination_for_resource(marketplace_ids, content_md5, resource, opts = {})
  data, _status_code, _headers = create_upload_destination_for_resource_with_http_info(marketplace_ids, content_md5, resource, opts)
  data
end

#create_upload_destination_for_resource_with_http_info(marketplace_ids, content_md5, resource, opts = {}) ⇒ Array<(CreateUploadDestinationResponse, Integer, Hash)>

Creates an upload destination, returning the information required to upload a file to the destination and to programmatically access the file. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | .1 | 5 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • marketplace_ids —

    A list of marketplace identifiers. This specifies the marketplaces where the upload will be available. Only one marketplace can be specified.

  • content_md5 —

    An MD5 hash of the content to be submitted to the upload destination. This value is used to determine if the data has been corrupted or tampered with during transit.

  • resource —

    The resource for the upload destination that you are creating. For example, if you are creating an upload destination for the createLegalDisclosure operation of the Messaging API, the &#x60;resource&#x60; would be &#x60;/messaging/v1/orders/amazonOrderId/messages/legalDisclosure&#x60;, and the entire path would be &#x60;/uploads/2020-11-01/uploadDestinations/messaging/v1/orders/amazonOrderId/messages/legalDisclosure&#x60;. If you are creating an upload destination for an Aplus content document, the &#x60;resource&#x60; would be &#x60;aplus/2020-11-01/contentDocuments&#x60; and the path would be &#x60;/uploads/v1/uploadDestinations/aplus/2020-11-01/contentDocuments&#x60;.

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

    the optional parameters

Options Hash (opts):

  • :content_type (String) —

    The content type of the file to be uploaded.

Returns:



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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/uploads-api-model/api/uploads_api.rb', line 38

def create_upload_destination_for_resource_with_http_info(marketplace_ids, content_md5, resource, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UploadsApi.create_upload_destination_for_resource ...'
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling UploadsApi.create_upload_destination_for_resource"
  end
  # verify the required parameter 'content_md5' is set
  if @api_client.config.client_side_validation && content_md5.nil?
    fail ArgumentError, "Missing the required parameter 'content_md5' when calling UploadsApi.create_upload_destination_for_resource"
  end
  # verify the required parameter 'resource' is set
  if @api_client.config.client_side_validation && resource.nil?
    fail ArgumentError, "Missing the required parameter 'resource' when calling UploadsApi.create_upload_destination_for_resource"
  end
  # resource path
  local_var_path = '/uploads/2020-11-01/uploadDestinations/{resource}'.sub('{' + 'resource' + '}', resource.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)
  query_params[:'contentMD5'] = content_md5
  query_params[:'contentType'] = opts[:'content_type'] if !opts[:'content_type'].nil?

  # 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] || 'CreateUploadDestinationResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, 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: UploadsApi#create_upload_destination_for_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end