class AmzSpApi::AplusContentApiModel::AplusContentApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

create_content_document(body, marketplace_id, opts = {}) click to toggle source

Creates a new A+ Content document. **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. @param body The content document request details. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param [Hash] opts the optional parameters @return [PostContentDocumentResponse]

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 24
def create_content_document(body, marketplace_id, opts = {})
  data, _status_code, _headers = create_content_document_with_http_info(body, marketplace_id, opts)
  data
end
create_content_document_with_http_info(body, marketplace_id, opts = {}) click to toggle source

Creates a new A+ Content document. **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&quot; in the Selling Partner API documentation. @param body The content document request details. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param [Hash] opts the optional parameters @return [Array<(PostContentDocumentResponse, Integer, Hash)>] PostContentDocumentResponse data, response status code and response headers

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 34
def create_content_document_with_http_info(body, marketplace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AplusContentApi.create_content_document ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AplusContentApi.create_content_document"
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling AplusContentApi.create_content_document"
  end
  # resource path
  local_var_path = '/aplus/2020-11-01/contentDocuments'

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

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

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

  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: AplusContentApi#create_content_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_content_document(content_reference_key, marketplace_id, included_data_set, opts = {}) click to toggle source

Returns an A+ Content document, if available. **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. @param content_reference_key The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param included_data_set The set of A+ Content data types to include in the response. @param [Hash] opts the optional parameters @return [GetContentDocumentResponse]

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 88
def get_content_document(content_reference_key, marketplace_id, included_data_set, opts = {})
  data, _status_code, _headers = get_content_document_with_http_info(content_reference_key, marketplace_id, included_data_set, opts)
  data
end
get_content_document_with_http_info(content_reference_key, marketplace_id, included_data_set, opts = {}) click to toggle source

Returns an A+ Content document, if available. **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&quot; in the Selling Partner API documentation. @param content_reference_key The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param included_data_set The set of A+ Content data types to include in the response. @param [Hash] opts the optional parameters @return [Array<(GetContentDocumentResponse, Integer, Hash)>] GetContentDocumentResponse data, response status code and response headers

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 99
def get_content_document_with_http_info(content_reference_key, marketplace_id, included_data_set, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AplusContentApi.get_content_document ...'
  end
  # verify the required parameter 'content_reference_key' is set
  if @api_client.config.client_side_validation && content_reference_key.nil?
    fail ArgumentError, "Missing the required parameter 'content_reference_key' when calling AplusContentApi.get_content_document"
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling AplusContentApi.get_content_document"
  end
  # verify the required parameter 'included_data_set' is set
  if @api_client.config.client_side_validation && included_data_set.nil?
    fail ArgumentError, "Missing the required parameter 'included_data_set' when calling AplusContentApi.get_content_document"
  end
  # resource path
  local_var_path = '/aplus/2020-11-01/contentDocuments/{contentReferenceKey}'.sub('{' + 'contentReferenceKey' + '}', content_reference_key.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceId'] = marketplace_id
  query_params[:'includedDataSet'] = @api_client.build_collection_param(included_data_set, :csv)

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

  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: AplusContentApi#get_content_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_content_document_asin_relations(content_reference_key, marketplace_id, opts = {}) click to toggle source

Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. **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. @param content_reference_key The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param [Hash] opts the optional parameters @option opts [Array<String>] :included_data_set The set of A+ Content data types to include in the response. If you do not include this parameter, the operation returns the related ASINs without metadata. @option opts [Array<String>] :asin_set The set of ASINs. @option opts [String] :page_token A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations. @return [ListContentDocumentAsinRelationsResponse]

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 158
def list_content_document_asin_relations(content_reference_key, marketplace_id, opts = {})
  data, _status_code, _headers = list_content_document_asin_relations_with_http_info(content_reference_key, marketplace_id, opts)
  data
end
list_content_document_asin_relations_with_http_info(content_reference_key, marketplace_id, opts = {}) click to toggle source

Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. **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&quot; in the Selling Partner API documentation. @param content_reference_key The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param [Hash] opts the optional parameters @option opts [Array<String>] :included_data_set The set of A+ Content data types to include in the response. If you do not include this parameter, the operation returns the related ASINs without metadata. @option opts [Array<String>] :asin_set The set of ASINs. @option opts [String] :page_token A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations. @return [Array<(ListContentDocumentAsinRelationsResponse, Integer, Hash)>] ListContentDocumentAsinRelationsResponse data, response status code and response headers

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 171
def list_content_document_asin_relations_with_http_info(content_reference_key, marketplace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AplusContentApi.list_content_document_asin_relations ...'
  end
  # verify the required parameter 'content_reference_key' is set
  if @api_client.config.client_side_validation && content_reference_key.nil?
    fail ArgumentError, "Missing the required parameter 'content_reference_key' when calling AplusContentApi.list_content_document_asin_relations"
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling AplusContentApi.list_content_document_asin_relations"
  end
  if @api_client.config.client_side_validation && opts[:'included_data_set'] && !opts[:'included_data_set'].all? { |item| ['METADATA'].include?(item) }
    fail ArgumentError, 'invalid value for "included_data_set", must include one of METADATA'
  end
  # resource path
  local_var_path = '/aplus/2020-11-01/contentDocuments/{contentReferenceKey}/asins'.sub('{' + 'contentReferenceKey' + '}', content_reference_key.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceId'] = marketplace_id
  query_params[:'includedDataSet'] = @api_client.build_collection_param(opts[:'included_data_set'], :csv) if !opts[:'included_data_set'].nil?
  query_params[:'asinSet'] = @api_client.build_collection_param(opts[:'asin_set'], :csv) if !opts[:'asin_set'].nil?
  query_params[:'pageToken'] = opts[:'page_token'] if !opts[:'page_token'].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] || 'ListContentDocumentAsinRelationsResponse' 

  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: AplusContentApi#list_content_document_asin_relations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_content_document_approval_submission(content_reference_key, marketplace_id, opts = {}) click to toggle source

Submits an A+ Content document for review, approval, and publishing. **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. @param content_reference_key The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param [Hash] opts the optional parameters @return [PostContentDocumentApprovalSubmissionResponse]

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 228
def post_content_document_approval_submission(content_reference_key, marketplace_id, opts = {})
  data, _status_code, _headers = post_content_document_approval_submission_with_http_info(content_reference_key, marketplace_id, opts)
  data
end
post_content_document_approval_submission_with_http_info(content_reference_key, marketplace_id, opts = {}) click to toggle source

Submits an A+ Content document for review, approval, and publishing. **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&quot; in the Selling Partner API documentation. @param content_reference_key The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param [Hash] opts the optional parameters @return [Array<(PostContentDocumentApprovalSubmissionResponse, Integer, Hash)>] PostContentDocumentApprovalSubmissionResponse data, response status code and response headers

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 238
def post_content_document_approval_submission_with_http_info(content_reference_key, marketplace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AplusContentApi.post_content_document_approval_submission ...'
  end
  # verify the required parameter 'content_reference_key' is set
  if @api_client.config.client_side_validation && content_reference_key.nil?
    fail ArgumentError, "Missing the required parameter 'content_reference_key' when calling AplusContentApi.post_content_document_approval_submission"
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling AplusContentApi.post_content_document_approval_submission"
  end
  # resource path
  local_var_path = '/aplus/2020-11-01/contentDocuments/{contentReferenceKey}/approvalSubmissions'.sub('{' + 'contentReferenceKey' + '}', content_reference_key.to_s)

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

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

  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: AplusContentApi#post_content_document_approval_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_content_document_asin_relations(body, marketplace_id, content_reference_key, opts = {}) click to toggle source

Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **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. @param body The content document ASIN relations request details. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param content_reference_key The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier. @param [Hash] opts the optional parameters @return [PostContentDocumentAsinRelationsResponse]

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 290
def post_content_document_asin_relations(body, marketplace_id, content_reference_key, opts = {})
  data, _status_code, _headers = post_content_document_asin_relations_with_http_info(body, marketplace_id, content_reference_key, opts)
  data
end
post_content_document_asin_relations_with_http_info(body, marketplace_id, content_reference_key, opts = {}) click to toggle source

Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **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&quot; in the Selling Partner API documentation. @param body The content document ASIN relations request details. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param content_reference_key The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier. @param [Hash] opts the optional parameters @return [Array<(PostContentDocumentAsinRelationsResponse, Integer, Hash)>] PostContentDocumentAsinRelationsResponse data, response status code and response headers

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 301
def post_content_document_asin_relations_with_http_info(body, marketplace_id, content_reference_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AplusContentApi.post_content_document_asin_relations ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AplusContentApi.post_content_document_asin_relations"
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling AplusContentApi.post_content_document_asin_relations"
  end
  # verify the required parameter 'content_reference_key' is set
  if @api_client.config.client_side_validation && content_reference_key.nil?
    fail ArgumentError, "Missing the required parameter 'content_reference_key' when calling AplusContentApi.post_content_document_asin_relations"
  end
  # resource path
  local_var_path = '/aplus/2020-11-01/contentDocuments/{contentReferenceKey}/asins'.sub('{' + 'contentReferenceKey' + '}', content_reference_key.to_s)

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

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

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

  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: AplusContentApi#post_content_document_asin_relations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_content_document_suspend_submission(content_reference_key, marketplace_id, opts = {}) click to toggle source

Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **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. @param content_reference_key The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param [Hash] opts the optional parameters @return [PostContentDocumentSuspendSubmissionResponse]

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 358
def post_content_document_suspend_submission(content_reference_key, marketplace_id, opts = {})
  data, _status_code, _headers = post_content_document_suspend_submission_with_http_info(content_reference_key, marketplace_id, opts)
  data
end
post_content_document_suspend_submission_with_http_info(content_reference_key, marketplace_id, opts = {}) click to toggle source

Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **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&quot; in the Selling Partner API documentation. @param content_reference_key The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param [Hash] opts the optional parameters @return [Array<(PostContentDocumentSuspendSubmissionResponse, Integer, Hash)>] PostContentDocumentSuspendSubmissionResponse data, response status code and response headers

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 368
def post_content_document_suspend_submission_with_http_info(content_reference_key, marketplace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AplusContentApi.post_content_document_suspend_submission ...'
  end
  # verify the required parameter 'content_reference_key' is set
  if @api_client.config.client_side_validation && content_reference_key.nil?
    fail ArgumentError, "Missing the required parameter 'content_reference_key' when calling AplusContentApi.post_content_document_suspend_submission"
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling AplusContentApi.post_content_document_suspend_submission"
  end
  # resource path
  local_var_path = '/aplus/2020-11-01/contentDocuments/{contentReferenceKey}/suspendSubmissions'.sub('{' + 'contentReferenceKey' + '}', content_reference_key.to_s)

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

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

  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: AplusContentApi#post_content_document_suspend_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
search_content_documents(marketplace_id, opts = {}) click to toggle source

Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **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. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param [Hash] opts the optional parameters @option opts [String] :page_token A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations. @return [SearchContentDocumentsResponse]

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 419
def search_content_documents(marketplace_id, opts = {})
  data, _status_code, _headers = search_content_documents_with_http_info(marketplace_id, opts)
  data
end
search_content_documents_with_http_info(marketplace_id, opts = {}) click to toggle source

Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **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&quot; in the Selling Partner API documentation. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param [Hash] opts the optional parameters @option opts [String] :page_token A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations. @return [Array<(SearchContentDocumentsResponse, Integer, Hash)>] SearchContentDocumentsResponse data, response status code and response headers

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 429
def search_content_documents_with_http_info(marketplace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AplusContentApi.search_content_documents ...'
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling AplusContentApi.search_content_documents"
  end
  # resource path
  local_var_path = '/aplus/2020-11-01/contentDocuments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceId'] = marketplace_id
  query_params[:'pageToken'] = opts[:'page_token'] if !opts[:'page_token'].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] || 'SearchContentDocumentsResponse' 

  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: AplusContentApi#search_content_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
search_content_publish_records(marketplace_id, asin, opts = {}) click to toggle source

Searches for A+ Content publishing records, if available. **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. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param asin The Amazon Standard Identification Number (ASIN). @param [Hash] opts the optional parameters @option opts [String] :page_token A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations. @return [SearchContentPublishRecordsResponse]

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 478
def search_content_publish_records(marketplace_id, asin, opts = {})
  data, _status_code, _headers = search_content_publish_records_with_http_info(marketplace_id, asin, opts)
  data
end
search_content_publish_records_with_http_info(marketplace_id, asin, opts = {}) click to toggle source

Searches for A+ Content publishing records, if available. **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&quot; in the Selling Partner API documentation. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param asin The Amazon Standard Identification Number (ASIN). @param [Hash] opts the optional parameters @option opts [String] :page_token A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations. @return [Array<(SearchContentPublishRecordsResponse, Integer, Hash)>] SearchContentPublishRecordsResponse data, response status code and response headers

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 489
def search_content_publish_records_with_http_info(marketplace_id, asin, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AplusContentApi.search_content_publish_records ...'
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling AplusContentApi.search_content_publish_records"
  end
  # verify the required parameter 'asin' is set
  if @api_client.config.client_side_validation && asin.nil?
    fail ArgumentError, "Missing the required parameter 'asin' when calling AplusContentApi.search_content_publish_records"
  end
  # resource path
  local_var_path = '/aplus/2020-11-01/contentPublishRecords'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceId'] = marketplace_id
  query_params[:'asin'] = asin
  query_params[:'pageToken'] = opts[:'page_token'] if !opts[:'page_token'].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] || 'SearchContentPublishRecordsResponse' 

  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: AplusContentApi#search_content_publish_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_content_document(body, marketplace_id, content_reference_key, opts = {}) click to toggle source

Updates an existing A+ Content document. **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. @param body The content document request details. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param content_reference_key The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier. @param [Hash] opts the optional parameters @return [PostContentDocumentResponse]

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 543
def update_content_document(body, marketplace_id, content_reference_key, opts = {})
  data, _status_code, _headers = update_content_document_with_http_info(body, marketplace_id, content_reference_key, opts)
  data
end
update_content_document_with_http_info(body, marketplace_id, content_reference_key, opts = {}) click to toggle source

Updates an existing A+ Content document. **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&quot; in the Selling Partner API documentation. @param body The content document request details. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param content_reference_key The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier. @param [Hash] opts the optional parameters @return [Array<(PostContentDocumentResponse, Integer, Hash)>] PostContentDocumentResponse data, response status code and response headers

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 554
def update_content_document_with_http_info(body, marketplace_id, content_reference_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AplusContentApi.update_content_document ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AplusContentApi.update_content_document"
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling AplusContentApi.update_content_document"
  end
  # verify the required parameter 'content_reference_key' is set
  if @api_client.config.client_side_validation && content_reference_key.nil?
    fail ArgumentError, "Missing the required parameter 'content_reference_key' when calling AplusContentApi.update_content_document"
  end
  # resource path
  local_var_path = '/aplus/2020-11-01/contentDocuments/{contentReferenceKey}'.sub('{' + 'contentReferenceKey' + '}', content_reference_key.to_s)

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

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

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

  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: AplusContentApi#update_content_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
validate_content_document_asin_relations(body, marketplace_id, opts = {}) click to toggle source

Checks if the A+ Content document is valid for use on a set of ASINs. **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. @param body The content document request details. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param [Hash] opts the optional parameters @option opts [Array<String>] :asin_set The set of ASINs. @return [ValidateContentDocumentAsinRelationsResponse]

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 612
def validate_content_document_asin_relations(body, marketplace_id, opts = {})
  data, _status_code, _headers = validate_content_document_asin_relations_with_http_info(body, marketplace_id, opts)
  data
end
validate_content_document_asin_relations_with_http_info(body, marketplace_id, opts = {}) click to toggle source

Checks if the A+ Content document is valid for use on a set of ASINs. **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&quot; in the Selling Partner API documentation. @param body The content document request details. @param marketplace_id The identifier for the marketplace where the A+ Content is published. @param [Hash] opts the optional parameters @option opts [Array<String>] :asin_set The set of ASINs. @return [Array<(ValidateContentDocumentAsinRelationsResponse, Integer, Hash)>] ValidateContentDocumentAsinRelationsResponse data, response status code and response headers

# File lib/aplus-content-api-model/api/aplus_content_api.rb, line 623
def validate_content_document_asin_relations_with_http_info(body, marketplace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AplusContentApi.validate_content_document_asin_relations ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AplusContentApi.validate_content_document_asin_relations"
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling AplusContentApi.validate_content_document_asin_relations"
  end
  # resource path
  local_var_path = '/aplus/2020-11-01/contentAsinValidations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceId'] = marketplace_id
  query_params[:'asinSet'] = @api_client.build_collection_param(opts[:'asin_set'], :csv) if !opts[:'asin_set'].nil?

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

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

  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: AplusContentApi#validate_content_document_asin_relations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end