feeds20210630

package
v1.0.1 Latest Latest
Warning

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

Go to latest
Published: Aug 31, 2023 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package feeds20210630 provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.13.4 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCancelFeedRequest

func NewCancelFeedRequest(server string, feedId string) (*http.Request, error)

NewCancelFeedRequest generates requests for CancelFeed

func NewCreateFeedDocumentRequest

func NewCreateFeedDocumentRequest(server string, body CreateFeedDocumentJSONRequestBody) (*http.Request, error)

NewCreateFeedDocumentRequest calls the generic CreateFeedDocument builder with application/json body

func NewCreateFeedDocumentRequestWithBody

func NewCreateFeedDocumentRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateFeedDocumentRequestWithBody generates requests for CreateFeedDocument with any type of body

func NewCreateFeedRequest

func NewCreateFeedRequest(server string, body CreateFeedJSONRequestBody) (*http.Request, error)

NewCreateFeedRequest calls the generic CreateFeed builder with application/json body

func NewCreateFeedRequestWithBody

func NewCreateFeedRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateFeedRequestWithBody generates requests for CreateFeed with any type of body

func NewGetFeedDocumentRequest

func NewGetFeedDocumentRequest(server string, feedDocumentId string) (*http.Request, error)

NewGetFeedDocumentRequest generates requests for GetFeedDocument

func NewGetFeedRequest

func NewGetFeedRequest(server string, feedId string) (*http.Request, error)

NewGetFeedRequest generates requests for GetFeed

func NewGetFeedsRequest

func NewGetFeedsRequest(server string, params *GetFeedsParams) (*http.Request, error)

NewGetFeedsRequest generates requests for GetFeeds

Types

type CancelFeedResp

type CancelFeedResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *ErrorList
	JSON401      *ErrorList
	JSON403      *ErrorList
	JSON404      *ErrorList
	JSON415      *ErrorList
	JSON429      *ErrorList
	JSON500      *ErrorList
	JSON503      *ErrorList
}

func ParseCancelFeedResp

func ParseCancelFeedResp(rsp *http.Response) (*CancelFeedResp, error)

ParseCancelFeedResp parses an HTTP response from a CancelFeedWithResponse call

func (CancelFeedResp) Status

func (r CancelFeedResp) Status() string

Status returns HTTPResponse.Status

func (CancelFeedResp) StatusCode

func (r CancelFeedResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn

	// A callback for modifying response which are generated after receive from the network.
	ResponseEditors []ResponseEditorFn

	// The user agent header identifies your application, its version number, and the platform and programming language you are using.
	// You must include a user agent header in each request submitted to the sales partner API.
	UserAgent string
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CancelFeed

func (c *Client) CancelFeed(ctx context.Context, feedId string) (*http.Response, error)

func (*Client) CreateFeed

func (c *Client) CreateFeed(ctx context.Context, body CreateFeedJSONRequestBody) (*http.Response, error)

func (*Client) CreateFeedDocument

func (c *Client) CreateFeedDocument(ctx context.Context, body CreateFeedDocumentJSONRequestBody) (*http.Response, error)

func (*Client) CreateFeedDocumentWithBody

func (c *Client) CreateFeedDocumentWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateFeedWithBody

func (c *Client) CreateFeedWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) GetFeed

func (c *Client) GetFeed(ctx context.Context, feedId string) (*http.Response, error)

func (*Client) GetFeedDocument

func (c *Client) GetFeedDocument(ctx context.Context, feedDocumentId string) (*http.Response, error)

func (*Client) GetFeeds

func (c *Client) GetFeeds(ctx context.Context, params *GetFeedsParams) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// CreateFeedDocumentWithBody request with any body
	CreateFeedDocumentWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	CreateFeedDocument(ctx context.Context, body CreateFeedDocumentJSONRequestBody) (*http.Response, error)

	// GetFeedDocument request
	GetFeedDocument(ctx context.Context, feedDocumentId string) (*http.Response, error)

	// GetFeeds request
	GetFeeds(ctx context.Context, params *GetFeedsParams) (*http.Response, error)

	// CreateFeedWithBody request with any body
	CreateFeedWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	CreateFeed(ctx context.Context, body CreateFeedJSONRequestBody) (*http.Response, error)

	// CancelFeed request
	CancelFeed(ctx context.Context, feedId string) (*http.Response, error)

	// GetFeed request
	GetFeed(ctx context.Context, feedId string) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

func WithResponseEditorFn

func WithResponseEditorFn(fn ResponseEditorFn) ClientOption

WithResponseEditorFn allows setting up a callback function, which will be called right after receive the response.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CancelFeedWithResponse

func (c *ClientWithResponses) CancelFeedWithResponse(ctx context.Context, feedId string) (*CancelFeedResp, error)

CancelFeedWithResponse request returning *CancelFeedResp

func (*ClientWithResponses) CreateFeedDocumentWithBodyWithResponse

func (c *ClientWithResponses) CreateFeedDocumentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*CreateFeedDocumentResp, error)

CreateFeedDocumentWithBodyWithResponse request with arbitrary body returning *CreateFeedDocumentResp

func (*ClientWithResponses) CreateFeedDocumentWithResponse

func (c *ClientWithResponses) CreateFeedDocumentWithResponse(ctx context.Context, body CreateFeedDocumentJSONRequestBody) (*CreateFeedDocumentResp, error)

func (*ClientWithResponses) CreateFeedWithBodyWithResponse

func (c *ClientWithResponses) CreateFeedWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*CreateFeedResp, error)

CreateFeedWithBodyWithResponse request with arbitrary body returning *CreateFeedResp

func (*ClientWithResponses) CreateFeedWithResponse

func (c *ClientWithResponses) CreateFeedWithResponse(ctx context.Context, body CreateFeedJSONRequestBody) (*CreateFeedResp, error)

func (*ClientWithResponses) GetFeedDocumentWithResponse

func (c *ClientWithResponses) GetFeedDocumentWithResponse(ctx context.Context, feedDocumentId string) (*GetFeedDocumentResp, error)

GetFeedDocumentWithResponse request returning *GetFeedDocumentResp

func (*ClientWithResponses) GetFeedWithResponse

func (c *ClientWithResponses) GetFeedWithResponse(ctx context.Context, feedId string) (*GetFeedResp, error)

GetFeedWithResponse request returning *GetFeedResp

func (*ClientWithResponses) GetFeedsWithResponse

func (c *ClientWithResponses) GetFeedsWithResponse(ctx context.Context, params *GetFeedsParams) (*GetFeedsResp, error)

GetFeedsWithResponse request returning *GetFeedsResp

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// CreateFeedDocumentWithBodyWithResponse request with any body
	CreateFeedDocumentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*CreateFeedDocumentResp, error)

	CreateFeedDocumentWithResponse(ctx context.Context, body CreateFeedDocumentJSONRequestBody) (*CreateFeedDocumentResp, error)

	// GetFeedDocumentWithResponse request
	GetFeedDocumentWithResponse(ctx context.Context, feedDocumentId string) (*GetFeedDocumentResp, error)

	// GetFeedsWithResponse request
	GetFeedsWithResponse(ctx context.Context, params *GetFeedsParams) (*GetFeedsResp, error)

	// CreateFeedWithBodyWithResponse request with any body
	CreateFeedWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*CreateFeedResp, error)

	CreateFeedWithResponse(ctx context.Context, body CreateFeedJSONRequestBody) (*CreateFeedResp, error)

	// CancelFeedWithResponse request
	CancelFeedWithResponse(ctx context.Context, feedId string) (*CancelFeedResp, error)

	// GetFeedWithResponse request
	GetFeedWithResponse(ctx context.Context, feedId string) (*GetFeedResp, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CreateFeedDocumentJSONRequestBody

type CreateFeedDocumentJSONRequestBody = CreateFeedDocumentSpecification

CreateFeedDocumentJSONRequestBody defines body for CreateFeedDocument for application/json ContentType.

type CreateFeedDocumentResp

type CreateFeedDocumentResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *CreateFeedDocumentResponse
	JSON400      *ErrorList
	JSON403      *ErrorList
	JSON404      *ErrorList
	JSON413      *ErrorList
	JSON415      *ErrorList
	JSON429      *ErrorList
	JSON500      *ErrorList
	JSON503      *ErrorList
}

func ParseCreateFeedDocumentResp

func ParseCreateFeedDocumentResp(rsp *http.Response) (*CreateFeedDocumentResp, error)

ParseCreateFeedDocumentResp parses an HTTP response from a CreateFeedDocumentWithResponse call

func (CreateFeedDocumentResp) Status

func (r CreateFeedDocumentResp) Status() string

Status returns HTTPResponse.Status

func (CreateFeedDocumentResp) StatusCode

func (r CreateFeedDocumentResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateFeedDocumentResponse

type CreateFeedDocumentResponse struct {
	// FeedDocumentId The identifier of the feed document.
	FeedDocumentId string `json:"feedDocumentId"`

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

CreateFeedDocumentResponse Information required to upload a feed document's contents.

type CreateFeedDocumentSpecification

type CreateFeedDocumentSpecification struct {
	// ContentType The content type of the feed.
	ContentType string `json:"contentType"`
}

CreateFeedDocumentSpecification Specifies the content type for the createFeedDocument operation.

type CreateFeedJSONRequestBody

type CreateFeedJSONRequestBody = CreateFeedSpecification

CreateFeedJSONRequestBody defines body for CreateFeed for application/json ContentType.

type CreateFeedResp

type CreateFeedResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *CreateFeedResponse
	JSON400      *ErrorList
	JSON401      *ErrorList
	JSON403      *ErrorList
	JSON404      *ErrorList
	JSON415      *ErrorList
	JSON429      *ErrorList
	JSON500      *ErrorList
	JSON503      *ErrorList
}

func ParseCreateFeedResp

func ParseCreateFeedResp(rsp *http.Response) (*CreateFeedResp, error)

ParseCreateFeedResp parses an HTTP response from a CreateFeedWithResponse call

func (CreateFeedResp) Status

func (r CreateFeedResp) Status() string

Status returns HTTPResponse.Status

func (CreateFeedResp) StatusCode

func (r CreateFeedResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateFeedResponse

type CreateFeedResponse struct {
	// FeedId The identifier for the feed. This identifier is unique only in combination with a seller ID.
	FeedId string `json:"feedId"`
}

CreateFeedResponse Response schema.

type CreateFeedSpecification

type CreateFeedSpecification struct {
	// FeedOptions Additional options to control the feed. These vary by feed type.
	FeedOptions *FeedOptions `json:"feedOptions,omitempty"`

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

	// InputFeedDocumentId The document identifier returned by the createFeedDocument operation. Upload the feed document contents before calling the createFeed operation.
	InputFeedDocumentId string `json:"inputFeedDocumentId"`

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

CreateFeedSpecification Information required to create the feed.

type Error

type Error struct {
	// Code An error code that identifies the type of error that occurred.
	Code string `json:"code"`

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

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

Error An error response returned when the request is unsuccessful.

type ErrorList

type ErrorList struct {
	Errors []Error `json:"errors"`
}

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

type Feed

type Feed struct {
	// CreatedTime The date and time when the feed was created, in ISO 8601 date time format.
	CreatedTime time.Time `json:"createdTime"`

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

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

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

	// ProcessingEndTime The date and time when feed processing completed, in ISO 8601 date time format.
	ProcessingEndTime *time.Time `json:"processingEndTime,omitempty"`

	// ProcessingStartTime The date and time when feed processing started, in ISO 8601 date time format.
	ProcessingStartTime *time.Time `json:"processingStartTime,omitempty"`

	// ProcessingStatus The processing status of the feed.
	ProcessingStatus FeedProcessingStatus `json:"processingStatus"`

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

Feed Detailed information about the feed.

type FeedDocument

type FeedDocument struct {
	// CompressionAlgorithm 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 7. Download the feed processing report](doc:feeds-api-v2021-06-30-use-case-guide#step-7-download-the-feed-processing-report) in the use case guide, where sample code is provided.
	CompressionAlgorithm *FeedDocumentCompressionAlgorithm `json:"compressionAlgorithm,omitempty"`

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

	// Url 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.
	Url string `json:"url"`
}

FeedDocument Information required for the feed document.

type FeedDocumentCompressionAlgorithm

type FeedDocumentCompressionAlgorithm string

FeedDocumentCompressionAlgorithm 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 7. Download the feed processing report](doc:feeds-api-v2021-06-30-use-case-guide#step-7-download-the-feed-processing-report) in the use case guide, where sample code is provided.

const (
	GZIP FeedDocumentCompressionAlgorithm = "GZIP"
)

Defines values for FeedDocumentCompressionAlgorithm.

type FeedList

type FeedList = []Feed

FeedList A list of feeds.

type FeedOptions

type FeedOptions map[string]string

FeedOptions Additional options to control the feed. These vary by feed type.

type FeedProcessingStatus

type FeedProcessingStatus string

FeedProcessingStatus The processing status of the feed.

const (
	FeedProcessingStatusCANCELLED  FeedProcessingStatus = "CANCELLED"
	FeedProcessingStatusDONE       FeedProcessingStatus = "DONE"
	FeedProcessingStatusFATAL      FeedProcessingStatus = "FATAL"
	FeedProcessingStatusINPROGRESS FeedProcessingStatus = "IN_PROGRESS"
	FeedProcessingStatusINQUEUE    FeedProcessingStatus = "IN_QUEUE"
)

Defines values for FeedProcessingStatus.

type GetFeedDocumentResp

type GetFeedDocumentResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *FeedDocument
	JSON400      *ErrorList
	JSON401      *ErrorList
	JSON403      *ErrorList
	JSON404      *ErrorList
	JSON415      *ErrorList
	JSON429      *ErrorList
	JSON500      *ErrorList
	JSON503      *ErrorList
}

func ParseGetFeedDocumentResp

func ParseGetFeedDocumentResp(rsp *http.Response) (*GetFeedDocumentResp, error)

ParseGetFeedDocumentResp parses an HTTP response from a GetFeedDocumentWithResponse call

func (GetFeedDocumentResp) Status

func (r GetFeedDocumentResp) Status() string

Status returns HTTPResponse.Status

func (GetFeedDocumentResp) StatusCode

func (r GetFeedDocumentResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFeedResp

type GetFeedResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Feed
	JSON400      *ErrorList
	JSON401      *ErrorList
	JSON403      *ErrorList
	JSON404      *ErrorList
	JSON415      *ErrorList
	JSON429      *ErrorList
	JSON500      *ErrorList
	JSON503      *ErrorList
}

func ParseGetFeedResp

func ParseGetFeedResp(rsp *http.Response) (*GetFeedResp, error)

ParseGetFeedResp parses an HTTP response from a GetFeedWithResponse call

func (GetFeedResp) Status

func (r GetFeedResp) Status() string

Status returns HTTPResponse.Status

func (GetFeedResp) StatusCode

func (r GetFeedResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFeedsParams

type GetFeedsParams struct {
	// FeedTypes A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required.
	FeedTypes *[]string `form:"feedTypes,omitempty" json:"feedTypes,omitempty"`

	// MarketplaceIds A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify.
	MarketplaceIds *[]string `form:"marketplaceIds,omitempty" json:"marketplaceIds,omitempty"`

	// PageSize The maximum number of feeds to return in a single call.
	PageSize *int `form:"pageSize,omitempty" json:"pageSize,omitempty"`

	// ProcessingStatuses A list of processing statuses used to filter feeds.
	ProcessingStatuses *[]GetFeedsParamsProcessingStatuses `form:"processingStatuses,omitempty" json:"processingStatuses,omitempty"`

	// CreatedSince The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.
	CreatedSince *time.Time `form:"createdSince,omitempty" json:"createdSince,omitempty"`

	// CreatedUntil The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now.
	CreatedUntil *time.Time `form:"createdUntil,omitempty" json:"createdUntil,omitempty"`

	// NextToken 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 getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.
	NextToken *string `form:"nextToken,omitempty" json:"nextToken,omitempty"`
}

GetFeedsParams defines parameters for GetFeeds.

type GetFeedsParamsProcessingStatuses

type GetFeedsParamsProcessingStatuses string

GetFeedsParamsProcessingStatuses defines parameters for GetFeeds.

const (
	GetFeedsParamsProcessingStatusesCANCELLED  GetFeedsParamsProcessingStatuses = "CANCELLED"
	GetFeedsParamsProcessingStatusesDONE       GetFeedsParamsProcessingStatuses = "DONE"
	GetFeedsParamsProcessingStatusesFATAL      GetFeedsParamsProcessingStatuses = "FATAL"
	GetFeedsParamsProcessingStatusesINPROGRESS GetFeedsParamsProcessingStatuses = "IN_PROGRESS"
	GetFeedsParamsProcessingStatusesINQUEUE    GetFeedsParamsProcessingStatuses = "IN_QUEUE"
)

Defines values for GetFeedsParamsProcessingStatuses.

type GetFeedsResp

type GetFeedsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetFeedsResponse
	JSON400      *ErrorList
	JSON401      *ErrorList
	JSON403      *ErrorList
	JSON404      *ErrorList
	JSON415      *ErrorList
	JSON429      *ErrorList
	JSON500      *ErrorList
	JSON503      *ErrorList
}

func ParseGetFeedsResp

func ParseGetFeedsResp(rsp *http.Response) (*GetFeedsResp, error)

ParseGetFeedsResp parses an HTTP response from a GetFeedsWithResponse call

func (GetFeedsResp) Status

func (r GetFeedsResp) Status() string

Status returns HTTPResponse.Status

func (GetFeedsResp) StatusCode

func (r GetFeedsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFeedsResponse

type GetFeedsResponse struct {
	// Feeds A list of feeds.
	Feeds FeedList `json:"feeds"`

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

GetFeedsResponse Response schema.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ResponseEditorFn

type ResponseEditorFn func(ctx context.Context, rsp *http.Response) error

ResponseEditorFn is the function signature for the ResponseEditor callback function

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL