reports_2020_09_04_models

type CancelReportResponse struct {

	// errors
	Errors ErrorList `json:"errors,omitempty"`
}

type CancelReportScheduleResponse struct {

	// errors
	Errors ErrorList `json:"errors,omitempty"`
}

type CreateReportResponse struct {

	// errors
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for the createReport operation.
	Payload *CreateReportResult `json:"payload,omitempty"`
}

type CreateReportResult struct {

	// The identifier for the report. This identifier is unique only in combination with a seller ID.
	// Required: true
	ReportID *string `json:"reportId"`
}

type CreateReportScheduleResponse struct {

	// errors
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for the createReportSchedule operation.
	Payload *CreateReportScheduleResult `json:"payload,omitempty"`
}

type CreateReportScheduleResult struct {

	// The identifier for the report schedule. This identifier is unique only in combination with a seller ID.
	// Required: true
	ReportScheduleID *string `json:"reportScheduleId"`
}

type CreateReportScheduleSpecification struct {

	// A list of marketplace identifiers for the report schedule.
	// Required: true
	// Max Items: 25
	// Min Items: 1
	MarketplaceIds []string `json:"marketplaceIds"`

	// The date and time when the schedule will create its next report, in ISO 8601 date time format.
	// Format: date-time
	NextReportCreationTime strfmt.DateTime `json:"nextReportCreationTime,omitempty"`

	// One of a set of predefined ISO 8601 periods that specifies how often a report should be created.
	// Required: true
	// Enum: [PT5M PT15M PT30M PT1H PT2H PT4H PT8H PT12H P1D P2D P3D PT84H P7D P14D P15D P18D P30D P1M]
	Period *string `json:"period"`

	// report options
	ReportOptions ReportOptions `json:"reportOptions,omitempty"`

	// The report type.
	// Required: true
	ReportType *string `json:"reportType"`
}

type CreateReportSpecification struct {

	// The end of a date and time range, in ISO 8601 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.
	// Format: date-time
	DataEndTime strfmt.DateTime `json:"dataEndTime,omitempty"`

	// The start of a date and time range, in ISO 8601 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.
	// Format: date-time
	DataStartTime strfmt.DateTime `json:"dataStartTime,omitempty"`

	// 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.
	// Required: true
	// Max Items: 25
	// Min Items: 1
	MarketplaceIds []string `json:"marketplaceIds"`

	// report options
	ReportOptions ReportOptions `json:"reportOptions,omitempty"`

	// The report type.
	// Required: true
	ReportType *string `json:"reportType"`
}

type Error struct {

	// An error code that identifies the type of error that occurred.
	// Required: true
	Code *string `json:"code"`

	// Additional details that can help the caller understand or fix the issue.
	Details string `json:"details,omitempty"`

	// A message that describes the error condition in a human-readable form.
	// Required: true
	Message *string `json:"message"`
}

type ErrorList []*Error

type GetReportDocumentResponse struct {

	// errors
	Errors ErrorList `json:"errors,omitempty"`

	// payload
	Payload *ReportDocument `json:"payload,omitempty"`
}

type GetReportResponse struct {

	// errors
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for the getReport operation.
	Payload *Report `json:"payload,omitempty"`
}

type GetReportScheduleResponse struct {

	// errors
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for the getReportSchedule operation.
	Payload *ReportSchedule `json:"payload,omitempty"`
}

type GetReportSchedulesResponse struct {

	// errors
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for the getReportSchedules operation.
	Payload ReportScheduleList `json:"payload,omitempty"`
}

type GetReportsResponse struct {

	// errors
	Errors ErrorList `json:"errors,omitempty"`

	// Returned when the number of results exceeds pageSize. To get the next page of results, call getReports with this token as the only parameter.
	NextToken string `json:"nextToken,omitempty"`

	// The payload for the getReports operation.
	Payload ReportList `json:"payload,omitempty"`
}

type Report struct {

	// The date and time when the report was created.
	// Required: true
	// Format: date-time
	CreatedTime *strfmt.DateTime `json:"createdTime"`

	// The end of a date and time range used for selecting the data to report.
	// Format: date-time
	DataEndTime strfmt.DateTime `json:"dataEndTime,omitempty"`

	// The start of a date and time range used for selecting the data to report.
	// Format: date-time
	DataStartTime strfmt.DateTime `json:"dataStartTime,omitempty"`

	// A list of marketplace identifiers for the report.
	MarketplaceIds []string `json:"marketplaceIds"`

	// The date and time when the report processing completed, in ISO 8601 date time format.
	// Format: date-time
	ProcessingEndTime strfmt.DateTime `json:"processingEndTime,omitempty"`

	// The date and time when the report processing started, in ISO 8601 date time format.
	// Format: date-time
	ProcessingStartTime strfmt.DateTime `json:"processingStartTime,omitempty"`

	// The processing status of the report.
	// Required: true
	// Enum: [CANCELLED DONE FATAL IN_PROGRESS IN_QUEUE]
	ProcessingStatus *string `json:"processingStatus"`

	// The identifier for the report document. Pass this into the getReportDocument operation to get the information you will need to retrieve and decrypt the report document's contents.
	ReportDocumentID string `json:"reportDocumentId,omitempty"`

	// The identifier for the report. This identifier is unique only in combination with a seller ID.
	// Required: true
	ReportID *string `json:"reportId"`

	// The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID.
	ReportScheduleID string `json:"reportScheduleId,omitempty"`

	// The report type.
	// Required: true
	ReportType *string `json:"reportType"`
}

type ReportDocument struct {

	// 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 and decrypt the report](doc:reports-api-v2020-09-04-use-case-guide#step-2-download-and-decrypt-the-report) in the use case guide, where sample code is provided.
	// Enum: [GZIP]
	CompressionAlgorithm string `json:"compressionAlgorithm,omitempty"`

	// encryption details
	// Required: true
	EncryptionDetails *ReportDocumentEncryptionDetails `json:"encryptionDetails"`

	// The identifier for the report document. This identifier is unique only in combination with a seller ID.
	// Required: true
	ReportDocumentID *string `json:"reportDocumentId"`

	// 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.
	// Required: true
	URL *string `json:"url"`
}

type ReportDocumentEncryptionDetails struct {

	// The vector to decrypt the document contents using Cipher Block Chaining (CBC).
	// Required: true
	InitializationVector *string `json:"initializationVector"`

	// The encryption key used to decrypt the document contents.
	// Required: true
	Key *string `json:"key"`

	// The encryption standard required to decrypt the document contents.
	// Required: true
	// Enum: [AES]
	Standard *string `json:"standard"`
}

type ReportList []*Report

type ReportOptions map[string]string

type ReportSchedule struct {

	// 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.
	MarketplaceIds []string `json:"marketplaceIds"`

	// The date and time when the schedule will create its next report, in ISO 8601 date time format.
	// Format: date-time
	NextReportCreationTime strfmt.DateTime `json:"nextReportCreationTime,omitempty"`

	// An ISO 8601 period value that indicates how often a report should be created.
	// Required: true
	Period *string `json:"period"`

	// report options
	ReportOptions ReportOptions `json:"reportOptions,omitempty"`

	// The identifier for the report schedule. This identifier is unique only in combination with a seller ID.
	// Required: true
	ReportScheduleID *string `json:"reportScheduleId"`

	// The report type.
	// Required: true
	ReportType *string `json:"reportType"`
}

type ReportScheduleList []*ReportSchedule