Class: Peddler::APIs::Reports20210630

Inherits:
Peddler::API show all
Includes:
Helpers::Reports20210630
Defined in:
lib/peddler/apis/reports_2021_06_30.rb,
lib/peddler/apis/reports_2021_06_30/error.rb,
lib/peddler/apis/reports_2021_06_30/report.rb,
lib/peddler/apis/reports_2021_06_30/error_list.rb,
lib/peddler/apis/reports_2021_06_30/report_list.rb,
lib/peddler/apis/reports_2021_06_30/report_document.rb,
lib/peddler/apis/reports_2021_06_30/report_schedule.rb,
lib/peddler/apis/reports_2021_06_30/get_reports_response.rb,
lib/peddler/apis/reports_2021_06_30/report_schedule_list.rb,
lib/peddler/apis/reports_2021_06_30/create_report_response.rb,
lib/peddler/apis/reports_2021_06_30/create_report_specification.rb,
lib/peddler/apis/reports_2021_06_30/create_report_schedule_response.rb,
lib/peddler/apis/reports_2021_06_30/create_report_schedule_specification.rb,
sig/peddler/apis/reports_2021_06_30.rbs

Overview

Selling Partner API for Reports

The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling partners manage their businesses.

See Also:

Defined Under Namespace

Classes: CreateReportResponse, CreateReportScheduleResponse, CreateReportScheduleSpecification, CreateReportSpecification, Error, ErrorList, GetReportsResponse, Report, ReportDocument, ReportList, ReportSchedule, ReportScheduleList

Constant Summary

Constants inherited from Peddler::API

Peddler::API::TRANSIENT_STATUSES

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #base_url, #endpoint, #retries

Instance Method Summary collapse

Methods included from Helpers::Reports20210630

#download_report_document, #download_report_document_from_url

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #host_header, #http, #initialize, #must_sandbox!, #parse_base_url, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#cancel_report(report_id, rate_limit: 0.0222) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Cancels the report that you specify. Only reports with processingStatus=IN_QUEUE can be cancelled. Cancelled reports are returned in subsequent calls to the getReport and getReports operations.

Parameters:

  • report_id (String) —

    The identifier for the report. This identifier is unique only in combination with a seller ID.

  • rate_limit (Float) (defaults to: 0.0222) —

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 0.0222)

Returns:



75
76
77
78
 
# File 'lib/peddler/apis/reports_2021_06_30.rb', line 75

def cancel_report(report_id, rate_limit: 0.0222)
  path = "/reports/2021-06-30/reports/#{percent_encode(report_id)}"
  delete(path, rate_limit:)
end

#cancel_report_schedule(report_schedule_id, rate_limit: 0.0222) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Cancels the report schedule that you specify.

Parameters:

  • report_schedule_id (String) —

    The identifier for the report schedule. This identifier is unique only in combination with a seller ID.

  • rate_limit (Float) (defaults to: 0.0222) —

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 0.0222)

Returns:



129
130
131
132
 
# File 'lib/peddler/apis/reports_2021_06_30.rb', line 129

def cancel_report_schedule(report_schedule_id, rate_limit: 0.0222)
  path = "/reports/2021-06-30/schedules/#{percent_encode(report_schedule_id)}"
  delete(path, rate_limit:)
end

#create_report(body, rate_limit: 0.0167) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Creates a report.

Parameters:

  • body (Hash) —

    Information required to create the report.

  • rate_limit (Float) (defaults to: 0.0167) —

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 0.0167)

Returns:



61
62
63
64
65
 
# File 'lib/peddler/apis/reports_2021_06_30.rb', line 61

def create_report(body, rate_limit: 0.0167)
  path = "/reports/2021-06-30/reports"
  parser = -> { CreateReportResponse }
  post(path, body:, rate_limit:, parser:)
end

#create_report_schedule(body, rate_limit: 0.0222) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one.

Parameters:

  • body (Hash) —

    Information required to create the report schedule.

  • rate_limit (Float) (defaults to: 0.0222) —

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 0.0222)

Returns:



116
117
118
119
120
 
# File 'lib/peddler/apis/reports_2021_06_30.rb', line 116

def create_report_schedule(body, rate_limit: 0.0222)
  path = "/reports/2021-06-30/schedules"
  parser = -> { CreateReportScheduleResponse }
  post(path, body:, rate_limit:, parser:)
end

#get_report(report_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns report details (including the reportDocumentId, if available) for the report that you specify.

Parameters:

  • report_id (String) —

    The identifier for the report. This identifier is unique only in combination with a seller ID.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



87
88
89
90
91
 
# File 'lib/peddler/apis/reports_2021_06_30.rb', line 87

def get_report(report_id, rate_limit: 2.0)
  path = "/reports/2021-06-30/reports/#{percent_encode(report_id)}"
  parser = -> { Report }
  get(path, rate_limit:, parser:)
end

#get_report_document(report_document_id, enable_content_encoding_url_header: nil, rate_limit: 0.0167) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns the information required for retrieving a report document's contents.

Parameters:

  • report_document_id (String) —

    The identifier for the report document.

  • enable_content_encoding_url_header (Boolean) (defaults to: nil) —

    When true, the Content-Encoding header on the returned URL is set to gzip instead of the default identity when compressionAlgorithm is GZIP. This allows automatic decompression by HTTP clients.

  • rate_limit (Float) (defaults to: 0.0167) —

    Requests per second

  • (String)
  • enable_content_encoding_url_header: (Boolean, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 0.0167)

Returns:



156
157
158
159
160
161
162
163
 
# File 'lib/peddler/apis/reports_2021_06_30.rb', line 156

def get_report_document(report_document_id, enable_content_encoding_url_header: nil, rate_limit: 0.0167)
  path = "/reports/2021-06-30/documents/#{percent_encode(report_document_id)}"
  params = {
    "enableContentEncodingUrlHeader" => enable_content_encoding_url_header,
  }.compact
  parser = -> { ReportDocument }
  get(path, params:, rate_limit:, parser:)
end

#get_report_schedule(report_schedule_id, rate_limit: 0.0222) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns report schedule details for the report schedule that you specify.

Parameters:

  • report_schedule_id (String) —

    The identifier for the report schedule. This identifier is unique only in combination with a seller ID.

  • rate_limit (Float) (defaults to: 0.0222) —

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 0.0222)

Returns:



141
142
143
144
145
 
# File 'lib/peddler/apis/reports_2021_06_30.rb', line 141

def get_report_schedule(report_schedule_id, rate_limit: 0.0222)
  path = "/reports/2021-06-30/schedules/#{percent_encode(report_schedule_id)}"
  parser = -> { ReportSchedule }
  get(path, rate_limit:, parser:)
end

#get_report_schedules(report_types, rate_limit: 0.0222) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns report schedule details that match the filters that you specify.

Parameters:

  • report_types (Array<String>) —

    A list of report types used to filter report schedules. Refer to Report Type Values for more information.

  • rate_limit (Float) (defaults to: 0.0222) —

    Requests per second

  • (Array[String])
  • rate_limit: (Float) (defaults to: 0.0222)

Returns:



100
101
102
103
104
105
106
107
 
# File 'lib/peddler/apis/reports_2021_06_30.rb', line 100

def get_report_schedules(report_types, rate_limit: 0.0222)
  path = "/reports/2021-06-30/schedules"
  params = {
    "reportTypes" => stringify_array(report_types),
  }.compact
  parser = -> { ReportScheduleList }
  get(path, params:, rate_limit:, parser:)
end

#get_reports(report_types: nil, processing_statuses: nil, marketplace_ids: nil, page_size: 10, created_since: nil, created_until: nil, next_token: nil, rate_limit: 0.0222) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns report details for the reports that match the filters that you specify.

Parameters:

  • report_types (Array<String>) (defaults to: nil) —

    A list of report types used to filter reports. Refer to Report Type Values for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required.

  • processing_statuses (Array<String>) (defaults to: nil) —

    A list of processing statuses used to filter reports. Known values: CANCELLED, DONE, FATAL, IN_PROGRESS, IN_QUEUE.

  • marketplace_ids (Array<String>) (defaults to: nil) —

    A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify.

  • page_size (Integer) (defaults to: 10) —

    The maximum number of reports to return in a single call.

  • created_since (String) (defaults to: nil) —

    The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days.

  • created_until (String) (defaults to: nil) —

    The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now.

  • next_token (String) (defaults to: nil) —

    A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.

  • rate_limit (Float) (defaults to: 0.0222) —

    Requests per second

  • report_types: (Array[String], nil) (defaults to: nil)
  • processing_statuses: (Array[String], nil) (defaults to: nil)
  • marketplace_ids: (Array[String], nil) (defaults to: nil)
  • page_size: (Integer, nil) (defaults to: 10)
  • created_since: (String, nil) (defaults to: nil)
  • created_until: (String, nil) (defaults to: nil)
  • next_token: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 0.0222)

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/peddler/apis/reports_2021_06_30.rb', line 39

def get_reports(report_types: nil, processing_statuses: nil, marketplace_ids: nil, page_size: 10,
  created_since: nil, created_until: nil, next_token: nil, rate_limit: 0.0222)
  path = "/reports/2021-06-30/reports"
  params = {
    "reportTypes" => stringify_array(report_types),
    "processingStatuses" => stringify_array(processing_statuses),
    "marketplaceIds" => stringify_array(marketplace_ids),
    "pageSize" => page_size,
    "createdSince" => created_since,
    "createdUntil" => created_until,
    "nextToken" => next_token,
  }.compact
  parser = -> { GetReportsResponse }
  get(path, params:, rate_limit:, parser:)
end