solicitations

package
v2.0.1 Latest Latest
Warning

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

Go to latest
Published: Mar 27, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.6.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

View Source
var (
	JSONMarshal    = json.Marshal
	JSONUnmarshal  = json.Unmarshal
	JSONNewDecoder = func(r io.Reader) interface{ Decode(v any) error } { return json.NewDecoder(r) }
	JSONNewEncoder = func(w io.Writer) interface{ Encode(v any) error } { return json.NewEncoder(w) }
)
View Source
var DefaultRetryOptions = RetryOptions{
	MaxRetries: 3,
	RetryOn: func(resp *http.Response, err error) bool {
		if err != nil {
			return true
		}

		if resp.StatusCode == 429 || resp.StatusCode >= 500 {
			return true
		}
		return false
	},
	Backoff: func(attempt int, resp *http.Response) time.Duration {

		return time.Duration(100*(1<<uint(attempt))) * time.Millisecond
	},
}

DefaultRetryOptions provides a basic DIY example for SP-API retries.

Functions

func NewCreateProductReviewAndSellerFeedbackSolicitationRequest

func NewCreateProductReviewAndSellerFeedbackSolicitationRequest(server string, amazonOrderId string, params *CreateProductReviewAndSellerFeedbackSolicitationParams) (*http.Request, error)

NewCreateProductReviewAndSellerFeedbackSolicitationRequest generates requests for CreateProductReviewAndSellerFeedbackSolicitation

func NewGetSolicitationActionsForOrderRequest

func NewGetSolicitationActionsForOrderRequest(server string, amazonOrderId string, params *GetSolicitationActionsForOrderParams) (*http.Request, error)

NewGetSolicitationActionsForOrderRequest generates requests for GetSolicitationActionsForOrder

Types

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

	// 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) CreateProductReviewAndSellerFeedbackSolicitation

func (c *Client) CreateProductReviewAndSellerFeedbackSolicitation(ctx context.Context, amazonOrderId string, params *CreateProductReviewAndSellerFeedbackSolicitationParams) (*http.Response, error)

func (*Client) GetSolicitationActionsForOrder

func (c *Client) GetSolicitationActionsForOrder(ctx context.Context, amazonOrderId string, params *GetSolicitationActionsForOrderParams) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// GetSolicitationActionsForOrder request
	GetSolicitationActionsForOrder(ctx context.Context, amazonOrderId string, params *GetSolicitationActionsForOrderParams) (*http.Response, error)

	// CreateProductReviewAndSellerFeedbackSolicitation request
	CreateProductReviewAndSellerFeedbackSolicitation(ctx context.Context, amazonOrderId string, params *CreateProductReviewAndSellerFeedbackSolicitationParams) (*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.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

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

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

func (*ClientWithResponses) CreateProductReviewAndSellerFeedbackSolicitationWithResponse

func (c *ClientWithResponses) CreateProductReviewAndSellerFeedbackSolicitationWithResponse(ctx context.Context, amazonOrderId string, params *CreateProductReviewAndSellerFeedbackSolicitationParams) (*CreateProductReviewAndSellerFeedbackSolicitationResp, error)

CreateProductReviewAndSellerFeedbackSolicitationWithResponse request returning *CreateProductReviewAndSellerFeedbackSolicitationResp

func (*ClientWithResponses) GetSolicitationActionsForOrderWithResponse

func (c *ClientWithResponses) GetSolicitationActionsForOrderWithResponse(ctx context.Context, amazonOrderId string, params *GetSolicitationActionsForOrderParams) (*GetSolicitationActionsForOrderResp, error)

GetSolicitationActionsForOrderWithResponse request returning *GetSolicitationActionsForOrderResp

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetSolicitationActionsForOrderWithResponse request
	GetSolicitationActionsForOrderWithResponse(ctx context.Context, amazonOrderId string, params *GetSolicitationActionsForOrderParams) (*GetSolicitationActionsForOrderResp, error)

	// CreateProductReviewAndSellerFeedbackSolicitationWithResponse request
	CreateProductReviewAndSellerFeedbackSolicitationWithResponse(ctx context.Context, amazonOrderId string, params *CreateProductReviewAndSellerFeedbackSolicitationParams) (*CreateProductReviewAndSellerFeedbackSolicitationResp, error)
}

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

type CreateProductReviewAndSellerFeedbackSolicitationParams

type CreateProductReviewAndSellerFeedbackSolicitationParams struct {
	// MarketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
	MarketplaceIds []string `form:"marketplaceIds" json:"marketplaceIds"`
}

CreateProductReviewAndSellerFeedbackSolicitationParams defines parameters for CreateProductReviewAndSellerFeedbackSolicitation.

type CreateProductReviewAndSellerFeedbackSolicitationResp

func ParseCreateProductReviewAndSellerFeedbackSolicitationResp

func ParseCreateProductReviewAndSellerFeedbackSolicitationResp(rsp *http.Response) (*CreateProductReviewAndSellerFeedbackSolicitationResp, error)

ParseCreateProductReviewAndSellerFeedbackSolicitationResp parses an HTTP response from a CreateProductReviewAndSellerFeedbackSolicitationWithResponse call

func (CreateProductReviewAndSellerFeedbackSolicitationResp) Status

Status returns HTTPResponse.Status

func (CreateProductReviewAndSellerFeedbackSolicitationResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CreateProductReviewAndSellerFeedbackSolicitationResponse

type CreateProductReviewAndSellerFeedbackSolicitationResponse struct {
	// Errors A list of error responses returned when a request is unsuccessful.
	Errors *ErrorList `json:"errors,omitempty"`
}

CreateProductReviewAndSellerFeedbackSolicitationResponse The response schema for the createProductReviewAndSellerFeedbackSolicitation operation.

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

Error Error response returned when the request is unsuccessful.

type ErrorList

type ErrorList = []Error

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

type GetSchemaResponse

type GetSchemaResponse struct {
	UnderscoreLinks *struct {
		// Self A Link object.
		Self LinkObject `json:"self"`
	} `json:"_links,omitempty"`

	// Errors A list of error responses returned when a request is unsuccessful.
	Errors *ErrorList `json:"errors,omitempty"`

	// Payload A JSON schema document describing the expected payload of the action. This object can be validated against <a href=http://json-schema.org/draft-04/schema>http://json-schema.org/draft-04/schema</a>.
	Payload *Schema `json:"payload,omitempty"`
}

GetSchemaResponse defines model for GetSchemaResponse.

type GetSolicitationActionResponse

type GetSolicitationActionResponse struct {
	UnderscoreEmbedded *struct {
		Schema *GetSchemaResponse `json:"schema,omitempty"`
	} `json:"_embedded,omitempty"`
	UnderscoreLinks *struct {
		// Schema A Link object.
		Schema LinkObject `json:"schema"`

		// Self A Link object.
		Self LinkObject `json:"self"`
	} `json:"_links,omitempty"`

	// Errors A list of error responses returned when a request is unsuccessful.
	Errors *ErrorList `json:"errors,omitempty"`

	// Payload A simple object containing the name of the template.
	Payload *SolicitationsAction `json:"payload,omitempty"`
}

GetSolicitationActionResponse Describes a solicitation action that can be taken for an order. Provides a JSON Hypertext Application Language (HAL) link to the JSON schema document that describes the expected input.

type GetSolicitationActionsForOrderParams

type GetSolicitationActionsForOrderParams struct {
	// MarketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
	MarketplaceIds []string `form:"marketplaceIds" json:"marketplaceIds"`
}

GetSolicitationActionsForOrderParams defines parameters for GetSolicitationActionsForOrder.

type GetSolicitationActionsForOrderResp

func ParseGetSolicitationActionsForOrderResp

func ParseGetSolicitationActionsForOrderResp(rsp *http.Response) (*GetSolicitationActionsForOrderResp, error)

ParseGetSolicitationActionsForOrderResp parses an HTTP response from a GetSolicitationActionsForOrderWithResponse call

func (GetSolicitationActionsForOrderResp) Status

Status returns HTTPResponse.Status

func (GetSolicitationActionsForOrderResp) StatusCode

func (r GetSolicitationActionsForOrderResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSolicitationActionsForOrderResponse

type GetSolicitationActionsForOrderResponse struct {
	UnderscoreEmbedded *struct {
		Actions []GetSolicitationActionResponse `json:"actions"`
	} `json:"_embedded,omitempty"`
	UnderscoreLinks *struct {
		// Actions Eligible actions for the specified amazonOrderId.
		Actions []LinkObject `json:"actions"`

		// Self A Link object.
		Self LinkObject `json:"self"`
	} `json:"_links,omitempty"`

	// Errors A list of error responses returned when a request is unsuccessful.
	Errors *ErrorList `json:"errors,omitempty"`
}

GetSolicitationActionsForOrderResponse The response schema for the getSolicitationActionsForOrder operation.

type HttpRequestDoer

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type LinkObject

type LinkObject struct {
	// Href A URI for this object.
	Href string `json:"href"`

	// Name An identifier for this object.
	Name *string `json:"name,omitempty"`
}

LinkObject A Link object.

type RetryOptions

type RetryOptions struct {
	MaxRetries int
	// RetryOn returns true if the request should be retried.
	RetryOn func(resp *http.Response, err error) bool
	// Backoff returns the duration to wait before the next retry.
	// It can use the attempt count or inspect response headers (e.g., x-amzn-RateLimit-Limit).
	Backoff func(attempt int, resp *http.Response) time.Duration
}

RetryOptions defines the configuration for RetryTransport. It allows users to DIY their retry strategy, such as exponential backoff or header-based rate-limit backoff.

type RetryTransport

type RetryTransport struct {
	Next    http.RoundTripper
	Options RetryOptions
}

RetryTransport is an http.RoundTripper that retries requests based on RetryOptions.

func (*RetryTransport) RoundTrip

func (t *RetryTransport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip implements http.RoundTripper

type Schema

type Schema map[string]interface{}

Schema A JSON schema document describing the expected payload of the action. This object can be validated against <a href=http://json-schema.org/draft-04/schema>http://json-schema.org/draft-04/schema</a>.

type SolicitationsAction

type SolicitationsAction struct {
	Name string `json:"name"`
}

SolicitationsAction A simple object containing the name of the template.

Jump to

Keyboard shortcuts

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