# README

Go API client for productlist

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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
Generator version: 7.9.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 productlist "github.com/Gemini-Commerce/go-client-product-list"

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 productlist.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), productlist.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 productlist.ContextOperationServerIndices and productlist.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ProductListAPI	CreateProductList	Post /productlist.ProductList/CreateProductList	Create Collection
ProductListAPI	CreateProductListAssociation	Post /productlist.ProductList/CreateProductListAssociation	Create Collection/Product Association
ProductListAPI	DeleteProductList	Post /productlist.ProductList/DeleteProductList	Delete Collection
ProductListAPI	DeleteProductListAssociation	Post /productlist.ProductList/DeleteProductListAssociation	Delete Collection/Product Association
ProductListAPI	GetProductListAssociationsByProductGrn	Post /productlist.ProductList/GetProductListAssociationsByProductGrn	Get Collection/Product Associations by Product GRN
ProductListAPI	GetProductListByCode	Post /productlist.ProductList/GetProductListByCode	Get Collection by Code
ProductListAPI	GetProductListById	Post /productlist.ProductList/GetProductListById	Get Collection by Id
ProductListAPI	GetProductListByUrlKey	Post /productlist.ProductList/GetProductListByUrlKey	Get Collection by Url Key
ProductListAPI	GetProductListsCount	Post /productlist.ProductList/GetProductListsCount	Get Collection Product Count
ProductListAPI	ListProductListAssociations	Post /productlist.ProductList/ListProductListAssociations	List Collection/Product Associations
ProductListAPI	ListProductLists	Post /productlist.ProductList/ListProductLists	List Collections
ProductListAPI	ProductListBulkUpdateProductListAssociations	Post /productlist.ProductList/BulkUpdateProductListAssociations
ProductListAPI	SearchProductLists	Post /productlist.ProductList/SearchProductLists	Search Collections
ProductListAPI	SearchProductListsByIds	Post /productlist.ProductList/SearchProductListsByIds	Search Collections by Ids
ProductListAPI	SetProductListAssociations	Post /productlist.ProductList/SetProductListAssociations	Set Collection/Product Associations
ProductListAPI	UpdateProductList	Post /productlist.ProductList/UpdateProductList	Update Collection

Documentation For Models

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(),
		productlist.ContextAPIKeys,
		map[string]productlist.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(), productlist.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, productlist.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]