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 Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the Product Type Definitions 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: 2020-09-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
DefinitionsApi	GetDefinitionsProductType	Get /definitions/2020-09-01/productTypes/{productType}
DefinitionsApi	SearchDefinitionsProductTypes	Get /definitions/2020-09-01/productTypes

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* Selling Partner API for Product Type Definitions * * The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the [Product Type Definitions API Use Case Guide](doc:product-type-api-use-case-guide). * * API version: 2020-09-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 DefinitionsApiGetDefinitionsProductTypeOpts
type DefinitionsApiSearchDefinitionsProductTypesOpts
type DefinitionsApiService
- func (a *DefinitionsApiService) GetDefinitionsProductType(ctx context.Context, productType string, marketplaceIds []string, ...) (ProductTypeDefinition, *http.Response, error)
- func (a *DefinitionsApiService) SearchDefinitionsProductTypes(ctx context.Context, marketplaceIds []string, ...) (ProductTypeList, *http.Response, error)
type ErrorList
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type ModelError
type ProductType
type ProductTypeDefinition
type ProductTypeList
type ProductTypeVersion
type PropertyGroup
type SchemaLink
type SchemaLinkLink

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 {
	DefinitionsApi *DefinitionsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Selling Partner API for Product Type Definitions API v2020-09-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 DefinitionsApiGetDefinitionsProductTypeOpts ¶

type DefinitionsApiGetDefinitionsProductTypeOpts struct {
	SellerId             optional.String
	ProductTypeVersion   optional.String
	Requirements         optional.String
	RequirementsEnforced optional.String
	Locale               optional.String
}

type DefinitionsApiSearchDefinitionsProductTypesOpts ¶

type DefinitionsApiSearchDefinitionsProductTypesOpts struct {
	Keywords optional.Interface
}

type DefinitionsApiService ¶

type DefinitionsApiService service

func (*DefinitionsApiService) GetDefinitionsProductType ¶

func (a *DefinitionsApiService) GetDefinitionsProductType(ctx context.Context, productType string, marketplaceIds []string, localVarOptionals *DefinitionsApiGetDefinitionsProductTypeOpts) (ProductTypeDefinition, *http.Response, error)

func (*DefinitionsApiService) SearchDefinitionsProductTypes ¶

func (a *DefinitionsApiService) SearchDefinitionsProductTypes(ctx context.Context, marketplaceIds []string, localVarOptionals *DefinitionsApiSearchDefinitionsProductTypesOpts) (ProductTypeList, *http.Response, error)

type ErrorList ¶

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

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

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 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 ProductType ¶

type ProductType struct {
	// The name of the Amazon product type.
	Name string `json:"name"`
	// The Amazon marketplace identifiers for which the product type definition is available.
	MarketplaceIds []string `json:"marketplaceIds"`
}

An Amazon product type with a definition available.

type ProductTypeDefinition ¶

type ProductTypeDefinition struct {
	MetaSchema *SchemaLink `json:"metaSchema,omitempty"`
	Schema     *SchemaLink `json:"schema"`
	// Name of the requirements set represented in this product type definition.
	Requirements string `json:"requirements"`
	// Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all of the required attributes being present (such as for partial updates).
	RequirementsEnforced string `json:"requirementsEnforced"`
	// Mapping of property group names to property groups. Property groups represent logical groupings of schema properties that can be used for display or informational purposes.
	PropertyGroups map[string]PropertyGroup `json:"propertyGroups"`
	// Locale of the display elements contained in the product type definition.
	Locale string `json:"locale"`
	// Amazon marketplace identifiers for which the product type definition is applicable.
	MarketplaceIds []string `json:"marketplaceIds"`
	// The name of the Amazon product type that this product type definition applies to.
	ProductType        string              `json:"productType"`
	ProductTypeVersion *ProductTypeVersion `json:"productTypeVersion"`
}

A product type definition represents the attributes and data requirements for a product type in the Amazon catalog. Product type definitions are used interchangeably between the Selling Partner API for Listings Items, Selling Partner API for Catalog Items, and JSON-based listings feeds in the Selling Partner API for Feeds.

type ProductTypeList ¶

type ProductTypeList struct {
	ProductTypes []ProductType `json:"productTypes"`
}

A list of Amazon product types with definitions available.

type ProductTypeVersion ¶

type ProductTypeVersion struct {
	// Version identifier.
	Version string `json:"version"`
	// When true, the version indicated by the version identifier is the latest available for the Amazon product type.
	Latest bool `json:"latest"`
	// When true, the version indicated by the version identifier is the prerelease (release candidate) for the Amazon product type.
	ReleaseCandidate bool `json:"releaseCandidate,omitempty"`
}

The version details for an Amazon product type.

type PropertyGroup ¶

type PropertyGroup struct {
	// The display label of the property group.
	Title string `json:"title,omitempty"`
	// The description of the property group.
	Description string `json:"description,omitempty"`
	// The names of the schema properties for the property group.
	PropertyNames []string `json:"propertyNames,omitempty"`
}

A property group represents a logical grouping of schema properties that can be used for display or informational purposes.

type SchemaLink ¶

type SchemaLink struct {
	Link *SchemaLinkLink `json:"link"`
	// Checksum hash of the schema (Base64 MD5). Can be used to verify schema contents, identify changes between schema versions, and for caching.
	Checksum string `json:"checksum"`
}

type SchemaLinkLink ¶

type SchemaLinkLink struct {
	// URI resource for the link.
	Resource string `json:"resource"`
	// HTTP method for the link operation.
	Verb string `json:"verb"`
}

Link to retrieve the schema.

Source Files ¶

View all Source files

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