swagger

package

v0.0.0-...-c324a2f Latest Latest Go to latest Published: May 6, 2023 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/skeleton1231/amz-sp-api-gosdk

Links

Open Source Insights

README ¶

Go API client for swagger

The Selling Partner API for Listings Restrictions provides programmatic access to restrictions on Amazon catalog listings. For more information, see the Listings Restrictions API Use Case Guide.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 2021-08-01
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://sellercentral.amazon.com/gp/mws/contactus.html

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://sellingpartnerapi-na.amazon.com/

Class	Method	HTTP request	Description
ListingsApi	GetListingsRestrictions	Get /listings/2021-08-01/restrictions

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* Selling Partner API for Listings Restrictions * * The Selling Partner API for Listings Restrictions provides programmatic access to restrictions on Amazon catalog listings. For more information, see the [Listings Restrictions API Use Case Guide](doc:listings-restrictions-api-v2021-08-01-use-case-guide). * * API version: 2021-08-01 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type BasicAuth
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type Link
type ListingsApiGetListingsRestrictionsOpts
type ListingsApiService
- func (a *ListingsApiService) GetListingsRestrictions(ctx context.Context, asin string, sellerId string, marketplaceIds []string, ...) (RestrictionList, *http.Response, error)
type ModelError
type Reason
type Restriction
type RestrictionList

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	ListingsApi *ListingsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Selling Partner API for Listings Restrictions API v2021-08-01 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type Link ¶

type Link struct {
	// The URI of the related resource.
	Resource string `json:"resource"`
	// The HTTP verb used to interact with the related resource.
	Verb string `json:"verb"`
	// The title of the related resource.
	Title string `json:"title,omitempty"`
	// The media type of the related resource.
	Type_ string `json:"type,omitempty"`
}

A link to resources related to a listing restriction.

type ListingsApiGetListingsRestrictionsOpts ¶

type ListingsApiGetListingsRestrictionsOpts struct {
	ConditionType optional.String
	ReasonLocale  optional.String
}

type ListingsApiService ¶

type ListingsApiService service

func (*ListingsApiService) GetListingsRestrictions ¶

func (a *ListingsApiService) GetListingsRestrictions(ctx context.Context, asin string, sellerId string, marketplaceIds []string, localVarOptionals *ListingsApiGetListingsRestrictionsOpts) (RestrictionList, *http.Response, error)

type ModelError ¶

type ModelError struct {
	// An error code that identifies the type of error that occurred.
	Code string `json:"code"`
	// A message that describes the error condition.
	Message string `json:"message"`
	// Additional details that can help the caller understand or fix the issue.
	Details string `json:"details,omitempty"`
}

Error response returned when the request is unsuccessful.

type Reason ¶

type Reason struct {
	// A message describing the reason for the restriction.
	Message string `json:"message"`
	// A code indicating why the listing is restricted.
	ReasonCode string `json:"reasonCode,omitempty"`
	// A list of path forward links that may allow Selling Partners to remove the restriction.
	Links []Link `json:"links,omitempty"`
}

A reason for the restriction, including path forward links that may allow Selling Partners to remove the restriction, if available.

type Restriction ¶

type Restriction struct {
	// A marketplace identifier. Identifies the Amazon marketplace where the restriction is enforced.
	MarketplaceId string `json:"marketplaceId"`
	// The condition that applies to the restriction.
	ConditionType string `json:"conditionType,omitempty"`
	// A list of reasons for the restriction.
	Reasons []Reason `json:"reasons,omitempty"`
}

A listing restriction, optionally qualified by a condition, with a list of reasons for the restriction.

type RestrictionList ¶

type RestrictionList struct {
	Restrictions []Restriction `json:"restrictions"`
}

A list of restrictions for the specified Amazon catalog item.

Source Files ¶

View all Source files

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