reports_2021_06_30_models

package
v0.24.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 15, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// CreateReportScheduleSpecificationPeriodPT5M captures enum value "PT5M"
	CreateReportScheduleSpecificationPeriodPT5M string = "PT5M"

	// CreateReportScheduleSpecificationPeriodPT15M captures enum value "PT15M"
	CreateReportScheduleSpecificationPeriodPT15M string = "PT15M"

	// CreateReportScheduleSpecificationPeriodPT30M captures enum value "PT30M"
	CreateReportScheduleSpecificationPeriodPT30M string = "PT30M"

	// CreateReportScheduleSpecificationPeriodPT1H captures enum value "PT1H"
	CreateReportScheduleSpecificationPeriodPT1H string = "PT1H"

	// CreateReportScheduleSpecificationPeriodPT2H captures enum value "PT2H"
	CreateReportScheduleSpecificationPeriodPT2H string = "PT2H"

	// CreateReportScheduleSpecificationPeriodPT4H captures enum value "PT4H"
	CreateReportScheduleSpecificationPeriodPT4H string = "PT4H"

	// CreateReportScheduleSpecificationPeriodPT8H captures enum value "PT8H"
	CreateReportScheduleSpecificationPeriodPT8H string = "PT8H"

	// CreateReportScheduleSpecificationPeriodPT12H captures enum value "PT12H"
	CreateReportScheduleSpecificationPeriodPT12H string = "PT12H"

	// CreateReportScheduleSpecificationPeriodP1D captures enum value "P1D"
	CreateReportScheduleSpecificationPeriodP1D string = "P1D"

	// CreateReportScheduleSpecificationPeriodP2D captures enum value "P2D"
	CreateReportScheduleSpecificationPeriodP2D string = "P2D"

	// CreateReportScheduleSpecificationPeriodP3D captures enum value "P3D"
	CreateReportScheduleSpecificationPeriodP3D string = "P3D"

	// CreateReportScheduleSpecificationPeriodPT84H captures enum value "PT84H"
	CreateReportScheduleSpecificationPeriodPT84H string = "PT84H"

	// CreateReportScheduleSpecificationPeriodP7D captures enum value "P7D"
	CreateReportScheduleSpecificationPeriodP7D string = "P7D"

	// CreateReportScheduleSpecificationPeriodP14D captures enum value "P14D"
	CreateReportScheduleSpecificationPeriodP14D string = "P14D"

	// CreateReportScheduleSpecificationPeriodP15D captures enum value "P15D"
	CreateReportScheduleSpecificationPeriodP15D string = "P15D"

	// CreateReportScheduleSpecificationPeriodP18D captures enum value "P18D"
	CreateReportScheduleSpecificationPeriodP18D string = "P18D"

	// CreateReportScheduleSpecificationPeriodP30D captures enum value "P30D"
	CreateReportScheduleSpecificationPeriodP30D string = "P30D"

	// CreateReportScheduleSpecificationPeriodP1M captures enum value "P1M"
	CreateReportScheduleSpecificationPeriodP1M string = "P1M"
)
View Source 
const (

	// ReportProcessingStatusCANCELLED captures enum value "CANCELLED"
	ReportProcessingStatusCANCELLED string = "CANCELLED"

	// ReportProcessingStatusDONE captures enum value "DONE"
	ReportProcessingStatusDONE string = "DONE"

	// ReportProcessingStatusFATAL captures enum value "FATAL"
	ReportProcessingStatusFATAL string = "FATAL"

	// ReportProcessingStatusINPROGRESS captures enum value "IN_PROGRESS"
	ReportProcessingStatusINPROGRESS string = "IN_PROGRESS"

	// ReportProcessingStatusINQUEUE captures enum value "IN_QUEUE"
	ReportProcessingStatusINQUEUE string = "IN_QUEUE"
)
View Source 
const (

	// ReportDocumentCompressionAlgorithmGZIP captures enum value "GZIP"
	ReportDocumentCompressionAlgorithmGZIP string = "GZIP"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateReportResponse 

type CreateReportResponse struct {

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

CreateReportResponse The response schema.

swagger:model CreateReportResponse

func (*CreateReportResponse) ContextValidate 

func (m *CreateReportResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this create report response based on context it is used

func (*CreateReportResponse) MarshalBinary 

func (m *CreateReportResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateReportResponse) UnmarshalBinary 

func (m *CreateReportResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateReportResponse) Validate 

func (m *CreateReportResponse) Validate(formats strfmt.Registry) error

Validate validates this create report response

type CreateReportScheduleResponse 

type CreateReportScheduleResponse struct {

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

CreateReportScheduleResponse Response schema.

swagger:model CreateReportScheduleResponse

func (*CreateReportScheduleResponse) ContextValidate 

func (m *CreateReportScheduleResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this create report schedule response based on context it is used

func (*CreateReportScheduleResponse) MarshalBinary 

func (m *CreateReportScheduleResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateReportScheduleResponse) UnmarshalBinary 

func (m *CreateReportScheduleResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateReportScheduleResponse) Validate 

func (m *CreateReportScheduleResponse) Validate(formats strfmt.Registry) error

Validate validates this create report schedule response

type CreateReportScheduleSpecification 

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 <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format.
	// Format: date-time
	NextReportCreationTime strfmt.DateTime `json:"nextReportCreationTime,omitempty"`

	// 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.
	// 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. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.
	// Required: true
	ReportType *string `json:"reportType"`
}

CreateReportScheduleSpecification Information required to create the report schedule.

swagger:model CreateReportScheduleSpecification

func (*CreateReportScheduleSpecification) ContextValidate 

func (m *CreateReportScheduleSpecification) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create report schedule specification based on the context it is used

func (*CreateReportScheduleSpecification) MarshalBinary 

func (m *CreateReportScheduleSpecification) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateReportScheduleSpecification) UnmarshalBinary 

func (m *CreateReportScheduleSpecification) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateReportScheduleSpecification) Validate 

func (m *CreateReportScheduleSpecification) Validate(formats strfmt.Registry) error

Validate validates this create report schedule specification

type CreateReportSpecification 

type CreateReportSpecification struct {

	// 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.
	// Format: date-time
	DataEndTime strfmt.DateTime `json:"dataEndTime,omitempty"`

	// 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.
	// 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. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.
	// Required: true
	ReportType *string `json:"reportType"`
}

CreateReportSpecification Information required to create the report.

swagger:model CreateReportSpecification

func (*CreateReportSpecification) ContextValidate 

func (m *CreateReportSpecification) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create report specification based on the context it is used

func (*CreateReportSpecification) MarshalBinary 

func (m *CreateReportSpecification) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateReportSpecification) UnmarshalBinary 

func (m *CreateReportSpecification) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateReportSpecification) Validate 

func (m *CreateReportSpecification) Validate(formats strfmt.Registry) error

Validate validates this create report specification

type Error 

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

Error Error response returned when the request is unsuccessful.

swagger:model Error

func (*Error) ContextValidate 

func (m *Error) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error based on context it is used

func (*Error) MarshalBinary 

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error) UnmarshalBinary 

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error) Validate 

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type ErrorList 

type ErrorList struct {

	// Error response returned when the request is unsuccessful.
	// Required: true
	Errors []*Error `json:"errors"`
}

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

swagger:model ErrorList

func (*ErrorList) ContextValidate 

func (m *ErrorList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this error list based on the context it is used

func (*ErrorList) MarshalBinary 

func (m *ErrorList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorList) UnmarshalBinary 

func (m *ErrorList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorList) Validate 

func (m *ErrorList) Validate(formats strfmt.Registry) error

Validate validates this error list

type GetReportsResponse 

type GetReportsResponse struct {

	// 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 reports.
	// Required: true
	Reports ReportList `json:"reports"`
}

GetReportsResponse The response for the `getReports` operation.

swagger:model GetReportsResponse

func (*GetReportsResponse) ContextValidate 

func (m *GetReportsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get reports response based on the context it is used

func (*GetReportsResponse) MarshalBinary 

func (m *GetReportsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetReportsResponse) UnmarshalBinary 

func (m *GetReportsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetReportsResponse) Validate 

func (m *GetReportsResponse) Validate(formats strfmt.Registry) error

Validate validates this get reports response

type Report 

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 <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format.
	// Format: date-time
	ProcessingEndTime strfmt.DateTime `json:"processingEndTime,omitempty"`

	// 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.
	// 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 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. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.
	// Required: true
	ReportType *string `json:"reportType"`
}

Report Detailed information about the report.

swagger:model Report

func (*Report) ContextValidate 

func (m *Report) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this report based on context it is used

func (*Report) MarshalBinary 

func (m *Report) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Report) UnmarshalBinary 

func (m *Report) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Report) Validate 

func (m *Report) Validate(formats strfmt.Registry) error

Validate validates this report

type ReportDocument 

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 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.
	// Enum: [GZIP]
	CompressionAlgorithm string `json:"compressionAlgorithm,omitempty"`

	// 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"`
}

ReportDocument Information required for the report document.

swagger:model ReportDocument

func (*ReportDocument) ContextValidate 

func (m *ReportDocument) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this report document based on context it is used

func (*ReportDocument) MarshalBinary 

func (m *ReportDocument) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReportDocument) UnmarshalBinary 

func (m *ReportDocument) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReportDocument) Validate 

func (m *ReportDocument) Validate(formats strfmt.Registry) error

Validate validates this report document

type ReportList 

type ReportList []*Report

ReportList A list of reports.

swagger:model ReportList

func (ReportList) ContextValidate 

func (m ReportList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this report list based on the context it is used

func (ReportList) Validate 

func (m ReportList) Validate(formats strfmt.Registry) error

Validate validates this report list

type ReportOptions 

type ReportOptions map[string]string

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

swagger:model ReportOptions

func (ReportOptions) ContextValidate 

func (m ReportOptions) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this report options based on context it is used

func (ReportOptions) Validate 

func (m ReportOptions) Validate(formats strfmt.Registry) error

Validate validates this report options

type ReportSchedule 

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 <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format.
	// Format: date-time
	NextReportCreationTime strfmt.DateTime `json:"nextReportCreationTime,omitempty"`

	// 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.
	// 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. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.
	// Required: true
	ReportType *string `json:"reportType"`
}

ReportSchedule Detailed information about a report schedule.

swagger:model ReportSchedule

func (*ReportSchedule) ContextValidate 

func (m *ReportSchedule) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this report schedule based on the context it is used

func (*ReportSchedule) MarshalBinary 

func (m *ReportSchedule) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReportSchedule) UnmarshalBinary 

func (m *ReportSchedule) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReportSchedule) Validate 

func (m *ReportSchedule) Validate(formats strfmt.Registry) error

Validate validates this report schedule

type ReportScheduleList 

type ReportScheduleList struct {

	// Detailed information about a report schedule.
	// Required: true
	ReportSchedules []*ReportSchedule `json:"reportSchedules"`
}

ReportScheduleList A list of report schedules.

swagger:model ReportScheduleList

func (*ReportScheduleList) ContextValidate 

func (m *ReportScheduleList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this report schedule list based on the context it is used

func (*ReportScheduleList) MarshalBinary 

func (m *ReportScheduleList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReportScheduleList) UnmarshalBinary 

func (m *ReportScheduleList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReportScheduleList) Validate 

func (m *ReportScheduleList) Validate(formats strfmt.Registry) error

Validate validates this report schedule list

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.