feeds_2020_09_04_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 (

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

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

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

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

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

	// FeedDocumentCompressionAlgorithmGZIP captures enum value "GZIP"
	FeedDocumentCompressionAlgorithmGZIP string = "GZIP"
)
View Source 
const (

	// FeedDocumentEncryptionDetailsStandardAES captures enum value "AES"
	FeedDocumentEncryptionDetailsStandardAES string = "AES"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CancelFeedResponse 

type CancelFeedResponse struct {

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

CancelFeedResponse Response schema.

swagger:model CancelFeedResponse

func (*CancelFeedResponse) ContextValidate 

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

ContextValidate validate this cancel feed response based on the context it is used

func (*CancelFeedResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*CancelFeedResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CancelFeedResponse) Validate 

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

Validate validates this cancel feed response

type CreateFeedDocumentResponse 

type CreateFeedDocumentResponse struct {

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

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

CreateFeedDocumentResponse The response for the createFeedDocument operation.

swagger:model CreateFeedDocumentResponse

func (*CreateFeedDocumentResponse) ContextValidate 

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

ContextValidate validate this create feed document response based on the context it is used

func (*CreateFeedDocumentResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*CreateFeedDocumentResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CreateFeedDocumentResponse) Validate 

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

Validate validates this create feed document response

type CreateFeedDocumentResult 

type CreateFeedDocumentResult struct {

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

	// The identifier of the feed document.
	// Required: true
	FeedDocumentID *string `json:"feedDocumentId"`

	// The presigned URL for uploading the feed contents. This URL expires after 5 minutes.
	// Required: true
	URL *string `json:"url"`
}

CreateFeedDocumentResult Information required to encrypt and upload a feed document's contents.

swagger:model CreateFeedDocumentResult

func (*CreateFeedDocumentResult) ContextValidate 

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

ContextValidate validate this create feed document result based on the context it is used

func (*CreateFeedDocumentResult) MarshalBinary 

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

MarshalBinary interface implementation

func (*CreateFeedDocumentResult) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CreateFeedDocumentResult) Validate 

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

Validate validates this create feed document result

type CreateFeedDocumentSpecification 

type CreateFeedDocumentSpecification struct {

	// The content type of the feed.
	// Required: true
	ContentType *string `json:"contentType"`
}

CreateFeedDocumentSpecification create feed document specification

swagger:model CreateFeedDocumentSpecification

func (*CreateFeedDocumentSpecification) ContextValidate 

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

ContextValidate validates this create feed document specification based on context it is used

func (*CreateFeedDocumentSpecification) MarshalBinary 

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

MarshalBinary interface implementation

func (*CreateFeedDocumentSpecification) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CreateFeedDocumentSpecification) Validate 

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

Validate validates this create feed document specification

type CreateFeedResponse 

type CreateFeedResponse struct {

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

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

CreateFeedResponse Response schema.

swagger:model CreateFeedResponse

func (*CreateFeedResponse) ContextValidate 

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

ContextValidate validate this create feed response based on the context it is used

func (*CreateFeedResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*CreateFeedResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CreateFeedResponse) Validate 

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

Validate validates this create feed response

type CreateFeedResult 

type CreateFeedResult struct {

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

CreateFeedResult create feed result

swagger:model CreateFeedResult

func (*CreateFeedResult) ContextValidate 

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

ContextValidate validates this create feed result based on context it is used

func (*CreateFeedResult) MarshalBinary 

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

MarshalBinary interface implementation

func (*CreateFeedResult) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CreateFeedResult) Validate 

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

Validate validates this create feed result

type CreateFeedSpecification 

type CreateFeedSpecification struct {

	// feed options
	FeedOptions FeedOptions `json:"feedOptions,omitempty"`

	// The feed type.
	// Required: true
	FeedType *string `json:"feedType"`

	// The document identifier returned by the createFeedDocument operation. Encrypt and upload the feed document contents before calling the createFeed operation.
	// Required: true
	InputFeedDocumentID *string `json:"inputFeedDocumentId"`

	// A list of identifiers for marketplaces that you want the feed to be applied to.
	// Required: true
	// Max Items: 25
	// Min Items: 1
	MarketplaceIds []string `json:"marketplaceIds"`
}

CreateFeedSpecification create feed specification

swagger:model CreateFeedSpecification

func (*CreateFeedSpecification) ContextValidate 

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

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

func (*CreateFeedSpecification) MarshalBinary 

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

MarshalBinary interface implementation

func (*CreateFeedSpecification) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CreateFeedSpecification) Validate 

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

Validate validates this create feed 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 in a human-readable form.
	// Required: true
	Message *string `json:"message"`
}

Error An 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 []*Error

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) Validate 

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

Validate validates this error list

type Feed 

type Feed struct {

	// The date and time when the feed was created, in ISO 8601 date time format.
	// Required: true
	// Format: date-time
	CreatedTime *strfmt.DateTime `json:"createdTime"`

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

	// The feed type.
	// Required: true
	FeedType *string `json:"feedType"`

	// A list of identifiers for the marketplaces that the feed is applied to.
	MarketplaceIds []string `json:"marketplaceIds"`

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

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

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

	// The identifier for the feed document. This identifier is unique only in combination with a seller ID.
	ResultFeedDocumentID string `json:"resultFeedDocumentId,omitempty"`
}

Feed feed

swagger:model Feed

func (*Feed) ContextValidate 

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

ContextValidate validates this feed based on context it is used

func (*Feed) MarshalBinary 

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

MarshalBinary interface implementation

func (*Feed) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*Feed) Validate 

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

Validate validates this feed

type FeedDocument 

type FeedDocument struct {

	// If the feed document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the feed when you download. Otherwise, you can download the feed directly. Refer to [Step 6. Download and decrypt the feed processing report](doc:feeds-api-v2020-09-04-use-case-guide#step-6-download-and-decrypt-the-feed-processing-report) in the use case guide, where sample code is provided.
	// Enum: [GZIP]
	CompressionAlgorithm string `json:"compressionAlgorithm,omitempty"`

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

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

	// A presigned URL for the feed document. If `compressionAlgorithm` is not returned, you can download the feed directly from this URL. This URL expires after 5 minutes.
	// Required: true
	URL *string `json:"url"`
}

FeedDocument feed document

swagger:model FeedDocument

func (*FeedDocument) ContextValidate 

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

ContextValidate validate this feed document based on the context it is used

func (*FeedDocument) MarshalBinary 

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

MarshalBinary interface implementation

func (*FeedDocument) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*FeedDocument) Validate 

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

Validate validates this feed document

type FeedDocumentEncryptionDetails 

type FeedDocumentEncryptionDetails struct {

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

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

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

FeedDocumentEncryptionDetails Encryption details for required client-side encryption and decryption of document contents.

swagger:model FeedDocumentEncryptionDetails

func (*FeedDocumentEncryptionDetails) ContextValidate 

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

ContextValidate validates this feed document encryption details based on context it is used

func (*FeedDocumentEncryptionDetails) MarshalBinary 

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

MarshalBinary interface implementation

func (*FeedDocumentEncryptionDetails) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*FeedDocumentEncryptionDetails) Validate 

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

Validate validates this feed document encryption details

type FeedList 

type FeedList []*Feed

FeedList feed list

swagger:model FeedList

func (FeedList) ContextValidate 

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

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

func (FeedList) Validate 

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

Validate validates this feed list

type FeedOptions 

type FeedOptions map[string]string

FeedOptions Additional options to control the feed. For feeds that use the feedOptions parameter, you can find the parameter values in the feed description in [feedType values](https://github.com/amzn/selling-partner-api-docs/blob/main/references/feeds-api/feedtype-values.md).

swagger:model FeedOptions

func (FeedOptions) ContextValidate 

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

ContextValidate validates this feed options based on context it is used

func (FeedOptions) Validate 

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

Validate validates this feed options

type GetFeedDocumentResponse 

type GetFeedDocumentResponse struct {

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

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

GetFeedDocumentResponse Response schema.

swagger:model GetFeedDocumentResponse

func (*GetFeedDocumentResponse) ContextValidate 

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

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

func (*GetFeedDocumentResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*GetFeedDocumentResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*GetFeedDocumentResponse) Validate 

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

Validate validates this get feed document response

type GetFeedResponse 

type GetFeedResponse struct {

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

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

GetFeedResponse Response schema.

swagger:model GetFeedResponse

func (*GetFeedResponse) ContextValidate 

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

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

func (*GetFeedResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*GetFeedResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*GetFeedResponse) Validate 

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

Validate validates this get feed response

type GetFeedsResponse 

type GetFeedsResponse struct {

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

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

	// payload
	Payload FeedList `json:"payload,omitempty"`
}

GetFeedsResponse Response schema.

swagger:model GetFeedsResponse

func (*GetFeedsResponse) ContextValidate 

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

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

func (*GetFeedsResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*GetFeedsResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*GetFeedsResponse) Validate 

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

Validate validates this get feeds response

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.