class AmzSpApi::UploadsApiModel::UploadsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/uploads-api-model/api/uploads_api.rb, line 16
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create_upload_destination_for_resource(marketplace_ids, content_md5, resource, opts = {}) click to toggle source

Creates an upload destination for a resource that you specify and returns the information required to upload to that destination. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | .1 | 5 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param marketplace_ids A list of marketplace identifiers. This specifies the marketplaces where the upload will be available. Only one marketplace can be specified. @param 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. @param resource The URL of the resource for the upload destination that you are creating. For example, to create an upload destination for a Buyer-Seller Messaging message, the {resource} would be /messaging and the path would be /uploads/v1/uploadDestinations/messaging @param [Hash] opts the optional parameters @option opts [String] :content_type The content type of the file to be uploaded. @return [CreateUploadDestinationResponse]

# 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 = {}) click to toggle source

Creates an upload destination for a resource that you specify and returns the information required to upload to that destination. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | .1 | 5 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param marketplace_ids A list of marketplace identifiers. This specifies the marketplaces where the upload will be available. Only one marketplace can be specified. @param 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. @param resource The URL of the resource for the upload destination that you are creating. For example, to create an upload destination for a Buyer-Seller Messaging message, the {resource} would be /messaging and the path would be /uploads/v1/uploadDestinations/messaging @param [Hash] opts the optional parameters @option opts [String] :content_type The content type of the file to be uploaded. @return [Array<(CreateUploadDestinationResponse, Integer, Hash)>] CreateUploadDestinationResponse data, response status code and response headers

# 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