solicitationsv1

package
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: Oct 28, 2024 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

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

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

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

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

func ParseCreateProductReviewAndSellerFeedbackSolicitationResp 

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

ParseCreateProductReviewAndSellerFeedbackSolicitationResp parses an HTTP response from a CreateProductReviewAndSellerFeedbackSolicitationWithResponse call

func (CreateProductReviewAndSellerFeedbackSolicitationResp) Status 

func (r CreateProductReviewAndSellerFeedbackSolicitationResp) Status() string

Status returns HTTPResponse.Status

func (CreateProductReviewAndSellerFeedbackSolicitationResp) StatusCode 

func (r CreateProductReviewAndSellerFeedbackSolicitationResp) StatusCode() int

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 in a human-readable form.
	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 {
	Links *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 {
	Embedded *struct {
		Schema *GetSchemaResponse `json:"schema,omitempty"`
	} `json:"_embedded,omitempty"`
	Links *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 

type GetSolicitationActionsForOrderResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetSolicitationActionsForOrderResponse
	JSON400      *GetSolicitationActionsForOrderResponse
	JSON403      *GetSolicitationActionsForOrderResponse
	JSON404      *GetSolicitationActionsForOrderResponse
	JSON413      *GetSolicitationActionsForOrderResponse
	JSON415      *GetSolicitationActionsForOrderResponse
	JSON429      *GetSolicitationActionsForOrderResponse
	JSON500      *GetSolicitationActionsForOrderResponse
	JSON503      *GetSolicitationActionsForOrderResponse
}

func ParseGetSolicitationActionsForOrderResp 

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

ParseGetSolicitationActionsForOrderResp parses an HTTP response from a GetSolicitationActionsForOrderWithResponse call

func (GetSolicitationActionsForOrderResp) Status 

func (r GetSolicitationActionsForOrderResp) Status() string

Status returns HTTPResponse.Status

func (GetSolicitationActionsForOrderResp) StatusCode 

func (r GetSolicitationActionsForOrderResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSolicitationActionsForOrderResponse 

type GetSolicitationActionsForOrderResponse struct {
	Embedded *struct {
		Actions []GetSolicitationActionResponse `json:"actions"`
	} `json:"_embedded,omitempty"`
	Links *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 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

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.

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.