# README

Go API client for order

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 order "github.com/Gemini-Commerce/go-client-order"

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

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

Templated Server URL

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

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

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
OrderAPI	ApproveOrder	Post /order.Order/ApproveOrder	Approve Order
OrderAPI	AssignShipment	Post /order.Order/AssignShipment	Assign Shipment
OrderAPI	CalculateRefund	Post /order.Order/CalculateRefund	Calculate Refund
OrderAPI	CancelFulfillment	Post /order.Order/CancelFulfillment	Cancel Fulfillment
OrderAPI	CancelOrder	Post /order.Order/CancelOrder	Cancel Order
OrderAPI	CancelShipment	Post /order.Order/CancelShipment	Cancel Shipment
OrderAPI	CompleteShipmentPacking	Post /order.Order/CompleteShipmentPacking	Complete Shipment Packing
OrderAPI	CreateFulfillment	Post /order.Order/CreateFulfillment	Create Fulfillment
OrderAPI	CreateOrder	Post /order.Order/CreateOrder	Create Order
OrderAPI	CreateOrderHistory	Post /order.Order/CreateHistory	Create Order History
OrderAPI	CreatePayment	Post /order.Order/CreatePayment	Create Payment
OrderAPI	CreatePaymentTransaction	Post /order.Order/CreatePaymentTransaction	Create Payment Transaction
OrderAPI	CreateRefund	Post /order.Order/CreateRefund	Create Refund
OrderAPI	CreateRefundTransaction	Post /order.Order/CreateRefundTransaction	Create Refund Transaction
OrderAPI	CreateShipment	Post /order.Order/CreateShipment	Create Shipment
OrderAPI	DeleteOrder	Post /order.Order/DeleteOrder	Delete Order
OrderAPI	GetFulfillment	Post /order.Order/GetFulfillment	Get Fulfillment
OrderAPI	GetOrder	Post /order.Order/GetOrder	Get Order
OrderAPI	GetOrderByCartId	Post /order.Order/GetOrderByCartId	Get Order by Cart ID
OrderAPI	GetOrderByOrderNumber	Post /order.Order/GetOrderByOrderNumber	Get Order by Order Number
OrderAPI	GetPayment	Post /order.Order/GetPayment	Get Payment
OrderAPI	GetShipment	Post /order.Order/GetShipment	Get Shipment
OrderAPI	GetTransaction	Post /order.Order/GetTransaction	Get Transaction
OrderAPI	HoldOrder	Post /order.Order/HoldOrder	Hold Order
OrderAPI	ImportOrder	Post /order.Order/ImportOrder	Import Order
OrderAPI	ListFulfillments	Post /order.Order/ListFulfillments	List Fulfillments
OrderAPI	ListOrders	Post /order.Order/ListOrders	List Orders
OrderAPI	ListOrdersByCustomer	Post /order.Order/ListOrdersByCustomer	List Orders by Customer
OrderAPI	ListOrdersByNumbers	Post /order.Order/ListOrdersByNumbers	List Orders by Numbers
OrderAPI	ListShipments	Post /order.Order/ListShipments	List Shipments
OrderAPI	OrderAddDocument	Post /order.Order/AddDocument	Documents
OrderAPI	OrderRemoveDocumentByCode	Post /order.Order/RemoveDocumentByCode
OrderAPI	PrintOrdersLabels	Post /order.Order/PrintOrdersLabels	Print Orders Labels
OrderAPI	QuashFulfillment	Post /order.Order/QuashFulfillment	Quash Fulfillment
OrderAPI	QuashShipment	Post /order.Order/QuashShipment	Quash Shipment
OrderAPI	ReceiveFulfillment	Post /order.Order/ReceiveFulfillment	Receive Fulfillment
OrderAPI	ReportFulfillmentError	Post /order.Order/ReportFulfillmentError	Report Fulfillment Error
OrderAPI	ReportFulfillmentNotResolvable	Post /order.Order/ReportFulfillmentNotResolvable	Report Fulfillment Not Resolvable
OrderAPI	ReportFulfillmentReady	Post /order.Order/ReportFulfillmentReady	Report Fulfillment Ready
OrderAPI	ReportShipmentDelivery	Post /order.Order/ReportShipmentDelivery	Report Shipment Delivery
OrderAPI	ReportShipmentMissingStock	Post /order.Order/ReportShipmentMissingStock	Report Shipment Missing Stock
OrderAPI	ResolveShipmentMissingStock	Post /order.Order/ResolveShipmentMissingStock	Resolve Shipment Missing Stock
OrderAPI	RetryFulfillment	Post /order.Order/RetryFulfillment	Retry Fulfillment
OrderAPI	SearchOrders	Post /order.Order/SearchOrders	Search Orders
OrderAPI	SendFulfillment	Post /order.Order/SendFulfillment	Send Fulfillment
OrderAPI	SendOrderNotification	Post /order.Order/SendOrderNotification	Send Order Notification
OrderAPI	StartFulfillmentProcessing	Post /order.Order/StartFulfillmentProcessing	Start Fulfillment Processing
OrderAPI	StartShipmentProcessing	Post /order.Order/StartShipmentProcessing	Start Shipment Processing
OrderAPI	UnholdOrder	Post /order.Order/UnholdOrder	Unhold Order
OrderAPI	UpdateOrder	Post /order.Order/UpdateOrder	Update Order
OrderAPI	UpdatePayment	Post /order.Order/UpdatePayment	Update Payment

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