Go API client for product

API for managing products

Overview

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

• API version: v1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

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

import product "github.com/gemini-commerce/go-client-product"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value product.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), product.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value product.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), product.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using product.ContextOperationServerIndices and product.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), product.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), product.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://product.api.gogemini.io

Class	Method	HTTP request	Description
ProductAPI	ProductAddMediaGalleryEntry	Post /product.Product/AddMediaGalleryEntry
ProductAPI	ProductBulkAddAssetsEntries	Post /product.Product/BulkAddAssetsEntries	Assets endpoints
ProductAPI	ProductBulkCreateAttribute	Post /product.Product/BulkCreateAttribute
ProductAPI	ProductBulkDeleteProducts	Post /product.Product/BulkDeleteProducts
ProductAPI	ProductBulkRemoveAssetsEntries	Post /product.Product/BulkRemoveAssetsEntries
ProductAPI	ProductBulkUpdate	Post /product.Product/BulkUpdate
ProductAPI	ProductBulkUpdateAssetsEntries	Post /product.Product/BulkUpdateAssetsEntries
ProductAPI	ProductBulkUpdateV2	Post /product.Product/BulkUpdateV2
ProductAPI	ProductCreateAttributeGroup	Post /product.Product/CreateAttributeGroup
ProductAPI	ProductCreateAttributeOptions	Post /product.Product/CreateAttributeOptions
ProductAPI	ProductCreateEntity	Post /product.Product/CreateEntity
ProductAPI	ProductCreateOptionsList	Post /product.Product/CreateOptionsList
ProductAPI	ProductCreateProduct	Post /product.Product/CreateProduct
ProductAPI	ProductCreateProductV2	Post /product.Product/CreateProductV2
ProductAPI	ProductDelete	Post /product.Product/Delete
ProductAPI	ProductDeleteAttribute	Post /product.Product/DeleteAttribute
ProductAPI	ProductDeleteProduct	Post /product.Product/DeleteProduct
ProductAPI	ProductGetAttributeGroup	Post /product.Product/GetAttributeGroup
ProductAPI	ProductGetAttributeOption	Post /product.Product/GetAttributeOption
ProductAPI	ProductGetAttributeOptions	Post /product.Product/GetAttributeOptions
ProductAPI	ProductGetEntity	Post /product.Product/GetEntity
ProductAPI	ProductGetOptionsList	Post /product.Product/GetOptionsList
ProductAPI	ProductGetProduct	Post /product.Product/GetProduct
ProductAPI	ProductGetProductByCode	Post /product.Product/GetProductByCode
ProductAPI	ProductGetProductByUrlKey	Post /product.Product/GetProductByUrlKey
ProductAPI	ProductListAttributeGroups	Post /product.Product/ListAttributeGroups	Attribute Groups endpoints
ProductAPI	ProductListAttributeOptions	Post /product.Product/ListAttributeOptions
ProductAPI	ProductListEntities	Post /product.Product/ListEntities
ProductAPI	ProductListOptionsLists	Post /product.Product/ListOptionsLists
ProductAPI	ProductListProducts	Post /product.Product/ListProducts
ProductAPI	ProductListProductsByIds	Post /product.Product/ListProductsByIds
ProductAPI	ProductListProductsBySku	Post /product.Product/ListProductsBySku
ProductAPI	ProductListVariantsBySku	Post /product.Product/ListVariantsBySku
ProductAPI	ProductRemoveMediaGalleryEntry	Post /product.Product/RemoveMediaGalleryEntry
ProductAPI	ProductUpdateAttribute	Post /product.Product/UpdateAttribute
ProductAPI	ProductUpdateAttributeGroup	Post /product.Product/UpdateAttributeGroup
ProductAPI	ProductUpdateAttributeOptions	Post /product.Product/UpdateAttributeOptions	rpc GetAttributeOptionByCode (product.entitymanager.GetAttributeOptionByCodeRequest) returns (product.entitymanager.GetAttributeOptionByCodeResponse) {}
ProductAPI	ProductUpdateMediaGalleryEntry	Post /product.Product/UpdateMediaGalleryEntry
ProductAPI	ProductUpdateOptionsList	Post /product.Product/UpdateOptionsList
ProductAPI	ProductUpdateProduct	Post /product.Product/UpdateProduct
ProductAPI	ProductUpdateProductV2	Post /product.Product/UpdateProductV2

Documentation For Models

• BulkUpdateAssetsEntriesRequestUpdateEntity
• EntitymanagerAttribute
• EntitymanagerAttributeGroup
• EntitymanagerAttributeOption
• EntitymanagerAttributeOptionErrors
• EntitymanagerAttributeOptionSwatch
• EntitymanagerAttributeWriteError
• EntitymanagerAttributeWriteErrors
• EntitymanagerBulkCreateAttributeRequest
• EntitymanagerBulkCreateAttributeResponse
• EntitymanagerCreateAttributeGroupRequest
• EntitymanagerCreateAttributeOptionsRequest
• EntitymanagerCreateAttributeOptionsResponse
• EntitymanagerCreateEntityResponse
• EntitymanagerCreateOptionsListRequest
• EntitymanagerCreateOptionsListResponse
• EntitymanagerDeleteAttributeRequest
• EntitymanagerEntity
• EntitymanagerEntityIdentifier
• EntitymanagerEntityRequest
• EntitymanagerGetAttributeGroupRequest
• EntitymanagerGetAttributeOptionRequest
• EntitymanagerGetAttributeOptionResponse
• EntitymanagerGetAttributeOptionsRequest
• EntitymanagerGetAttributeOptionsRequestOption
• EntitymanagerGetAttributeOptionsResponse
• EntitymanagerGetAttributeOptionsResponseOption
• EntitymanagerGetOptionsListRequest
• EntitymanagerGetOptionsListResponse
• EntitymanagerListAttributeGroupsRequest
• EntitymanagerListAttributeGroupsResponse
• EntitymanagerListAttributeOptionsRequest
• EntitymanagerListAttributeOptionsResponse
• EntitymanagerListEntitiesRequest
• EntitymanagerListEntitiesResponse
• EntitymanagerListOptionsListsRequest
• EntitymanagerListOptionsListsResponse
• EntitymanagerOptionsList
• EntitymanagerRenderAs
• EntitymanagerTypes
• EntitymanagerUpdateAttributeGroupRequest
• EntitymanagerUpdateAttributeGroupRequestPayload
• EntitymanagerUpdateAttributeOptionsRequest
• EntitymanagerUpdateAttributeOptionsResponse
• EntitymanagerUpdateAttributeRequest
• EntitymanagerUpdateAttributeRequestPayload
• EntitymanagerUpdateOptionsListRequest
• EntitymanagerUpdateOptionsListResponse
• ListProductsRequestFilter
• ProductAddMediaGalleryEntryRequest
• ProductAddMediaGalleryEntryResponse
• ProductAssetData
• ProductAssets
• ProductAssetsEntry
• ProductAssetsEntryMetadata
• ProductAttributeResponseError
• ProductBulkAddAssetsEntriesRequest
• ProductBulkAddAssetsEntriesResponse
• ProductBulkDeleteProductsRequest
• ProductBulkRemoveAssetsEntriesRequest
• ProductBulkUpdateAssetsEntriesRequest
• ProductBulkUpdateAssetsEntriesResponse
• ProductBulkUpdateRequest
• ProductBulkUpdateRequestPayload
• ProductBulkUpdateRequestV2
• ProductBulkUpdateRequestV2Payload
• ProductBulkUpdateResponse
• ProductBulkUpdateResponseResponse
• ProductBulkUpdateResponseV2
• ProductBulkUpdateResponseV2Response
• ProductCreateProductRequest
• ProductCreateProductRequestV2
• ProductCreateProductResponse
• ProductCreateProductResponseV2
• ProductDeleteProductRequest
• ProductDeleteRequest
• ProductDeleteResponse
• ProductFieldMask
• ProductGetProductByCodeRequest
• ProductGetProductByCodeResponse
• ProductGetProductByUrlKeyRequest
• ProductGetProductByUrlKeyResponse
• ProductGetProductRequest
• ProductGetProductResponse
• ProductListProductsByIdsRequest
• ProductListProductsByIdsResponse
• ProductListProductsBySkuRequest
• ProductListProductsBySkuResponse
• ProductListProductsRequest
• ProductListProductsResponse
• ProductListVariantsBySkuRequest
• ProductListVariantsBySkuResponse
• ProductLocalizedAsset
• ProductLocalizedText
• ProductMediaGallery
• ProductMediaGalleryEntry
• ProductMediaGalleryEntryMetadata
• ProductProductEntity
• ProductProductResponseError
• ProductProductVariant
• ProductRemoveMediaGalleryEntryRequest
• ProductUpdateAssetEntryPayload
• ProductUpdateMediaGalleryEntryRequest
• ProductUpdateProductRequest
• ProductUpdateProductRequestV2
• ProductUpdateProductResponse
• ProductentitymanagerLocalizedText
• ProtobufAny
• RpcStatus

Documentation For Authorization

Authentication schemes defined for the API:

Authorization

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		product.ContextAPIKeys,
		map[string]product.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

standardAuthorization

• Type: OAuth
• Flow: implicit
• Authorization URL:
• Scopes: N/A

Example

auth := context.WithValue(context.Background(), product.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, product.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

[email protected]