Module: Peddler::Types::Reports20210630

Defined in:: lib/peddler/types/reports_2021_06_30/error.rb,
lib/peddler/types/reports_2021_06_30/report.rb,
lib/peddler/types/reports_2021_06_30/error_list.rb,
lib/peddler/types/reports_2021_06_30/report_options.rb,
lib/peddler/types/reports_2021_06_30/report_document.rb,
lib/peddler/types/reports_2021_06_30/report_schedule.rb,
lib/peddler/types/reports_2021_06_30/get_reports_response.rb,
lib/peddler/types/reports_2021_06_30/report_schedule_list.rb,
lib/peddler/types/reports_2021_06_30/create_report_response.rb,
lib/peddler/types/reports_2021_06_30/create_report_specification.rb,
lib/peddler/types/reports_2021_06_30/create_report_schedule_response.rb,
lib/peddler/types/reports_2021_06_30/create_report_schedule_specification.rb

Constant Summary collapse

Error = Error response returned when the request is unsuccessful.

Structure.new do
  # @return [String] An error code that identifies the type of error that occurred.
  attribute(:code, String)

  # @return [String] A message that describes the error condition.
  attribute(:message, String)

  # @return [String] Additional details that can help the caller understand or fix the issue.
  attribute(:details, String)
end

Report = Detailed information about the report.

Structure.new do
  # @return [Array<String>] A list of marketplace identifiers for the report.
  attribute(:marketplace_ids, [String], from: "marketplaceIds")

  # @return [String] The identifier for the report. This identifier is unique only in combination with a seller
  # ID.
  attribute(:report_id, String, from: "reportId")

  # @return [String] The report type. Refer to [Report Type
  # Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.
  attribute(:report_type, String, from: "reportType")

  # @return [String] The start of a date and time range used for selecting the data to report.
  attribute(:data_start_time, String, from: "dataStartTime")

  # @return [String] The end of a date and time range used for selecting the data to report.
  attribute(:data_end_time, String, from: "dataEndTime")

  # @return [String] The identifier of the report schedule that created this report (if any). This identifier is
  # unique only in combination with a seller ID.
  attribute(:report_schedule_id, String, from: "reportScheduleId")

  # @return [String] The date and time when the report was created.
  attribute(:created_time, String, from: "createdTime")

  # @return [String] The processing status of the report.
  attribute(:processing_status, String, from: "processingStatus")

  # @return [String] The date and time when the report processing started, in <a
  # href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format.
  attribute(:processing_start_time, String, from: "processingStartTime")

  # @return [String] The date and time when the report processing completed, in <a
  # href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format.
  attribute(:processing_end_time, String, from: "processingEndTime")

  # @return [String] The identifier for the report document. Pass this into the `getReportDocument` operation to
  # get the information you will need to retrieve the report document's contents.
  attribute(:report_document_id, String, from: "reportDocumentId")
end

ErrorList = A list of error responses returned when a request is unsuccessful.

Structure.new do
  # @return [Array<Error>] Error response returned when the request is unsuccessful.
  attribute(:errors, [Error])
end

ReportOptions = Additional information passed to reports. This varies by report type.

Structure.new do
end

ReportDocument = Information required for the report document.

Structure.new do
  # @return [String] The identifier for the report document. This identifier is unique only in combination with a
  # seller ID.
  attribute(:report_document_id, String, from: "reportDocumentId")

  # @return [String] A presigned URL for the report document. If `compressionAlgorithm` is not returned, you can
  # download the report directly from this URL. This URL expires after 5 minutes.
  attribute(:url, String)

  # @return [String] If the report document contents have been compressed, the compression algorithm used is
  # returned in this property and you must decompress the report when you download. Otherwise, you can download
  # the report directly. Refer to [Step 2. Download the
  # report](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-retrieve-a-report#step-2-download-the-report)
  # in the use case guide, where sample code is provided.
  attribute(:compression_algorithm, String, from: "compressionAlgorithm")
end

ReportSchedule = Detailed information about a report schedule.

Structure.new do
  # @return [String] The identifier for the report schedule. This identifier is unique only in combination with a
  # seller ID.
  attribute(:report_schedule_id, String, from: "reportScheduleId")

  # @return [String] The report type. Refer to [Report Type
  # Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.
  attribute(:report_type, String, from: "reportType")

  # @return [Array<String>] A list of marketplace identifiers. The report document's contents will contain data
  # for all of the specified marketplaces, unless the report type indicates otherwise.
  attribute(:marketplace_ids, [String], from: "marketplaceIds")

  # @return [ReportOptions]
  attribute(:report_options, ReportOptions, from: "reportOptions")

  # @return [String] An <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> period value
  # that indicates how often a report should be created.
  attribute(:period, String)

  # @return [String] The date and time when the schedule will create its next report, in <a
  # href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format.
  attribute(:next_report_creation_time, String, from: "nextReportCreationTime")
end

GetReportsResponse = The response for the getReports operation.

Structure.new do
  # @return [Array<Report>] The reports.
  attribute(:reports, [Report])

  # @return [String] Returned when the number of results exceeds `pageSize`. To get the next page of results, call
  # `getReports` with this token as the only parameter.
  attribute(:next_token, String, from: "nextToken")
end

ReportScheduleList = A list of report schedules.

Structure.new do
  # @return [Array<ReportSchedule>] Detailed information about a report schedule.
  attribute(:report_schedules, [ReportSchedule], from: "reportSchedules")
end

CreateReportResponse = The response schema.

Structure.new do
  # @return [String] The identifier for the report. This identifier is unique only in combination with a seller
  # ID.
  attribute(:report_id, String, from: "reportId")
end

CreateReportSpecification = Information required to create the report.

Structure.new do
  # @return [ReportOptions]
  attribute(:report_options, ReportOptions, from: "reportOptions")

  # @return [String] The report type. Refer to [Report Type
  # Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.
  attribute(:report_type, String, from: "reportType")

  # @return [String] The start of a date and time range, in <a
  # href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format, used for
  # selecting the data to report. The default is now. The value must be prior to or equal to the current date and
  # time. Not all report types make use of this.
  attribute(:data_start_time, String, from: "dataStartTime")

  # @return [String] The end of a date and time range, in <a
  # href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format, used for
  # selecting the data to report. The default is now. The value must be prior to or equal to the current date and
  # time. Not all report types make use of this.
  attribute(:data_end_time, String, from: "dataEndTime")

  # @return [Array<String>] A list of marketplace identifiers. The report document's contents will contain data
  # for all of the specified marketplaces, unless the report type indicates otherwise.
  attribute(:marketplace_ids, [String], from: "marketplaceIds")
end

CreateReportScheduleResponse = Response schema.

Structure.new do
  # @return [String] The identifier for the report schedule. This identifier is unique only in combination with a
  # seller ID.
  attribute(:report_schedule_id, String, from: "reportScheduleId")
end

CreateReportScheduleSpecification = Information required to create the report schedule.

Structure.new do
  # @return [String] The report type. Refer to [Report Type
  # Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.
  attribute(:report_type, String, from: "reportType")

  # @return [Array<String>] A list of marketplace identifiers for the report schedule.
  attribute(:marketplace_ids, [String], from: "marketplaceIds")

  # @return [ReportOptions]
  attribute(:report_options, ReportOptions, from: "reportOptions")

  # @return [String] One of a set of predefined <a
  # href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> periods that specifies how often a
  # report should be created.
  attribute(:period, String)

  # @return [String] The date and time when the schedule will create its next report, in <a
  # href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format.
  attribute(:next_report_creation_time, String, from: "nextReportCreationTime")
end