Go API client for backend

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
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 sw "./backend"

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

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

Templated Server URL

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

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

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

Documentation for API Endpoints

All URIs are relative to https://navigator-api.tweakwise.com

Class	Method	HTTP request	Description
CategoryApi	CategoryAddCategory	Post /category	Creates a new category.
CategoryApi	CategoryDeleteCategory	Delete /category/{categoryId}	Deletes a single category based on the category Id.
CategoryApi	CategoryGetAllCategories	Get /category	Returns all categories.
CategoryApi	CategoryGetCategory	Get /category/{categoryId}	Returns a single category with the specified categoryId.
CategoryApi	CategoryGetCategoryByKey	Get /category/getbykey/{key}	Returns a single category with the specified key.
CategoryApi	CategoryPatchCategory	Patch /category/{categoryId}	Patches a category with the specified change.
CategoryApi	CategoryUpdateCategory	Put /category	Update an existing category.
InstanceStatsApi	InstanceStatsTotalCategories	Get /stats/totalcategories	Get the number of total categories.
InstanceStatsApi	InstanceStatsTotalProducts	Get /stats/totalproducts	Get the number of total products.
ProductApi	ProductAddProduct	Post /product	Creates a new product.
ProductApi	ProductDeleteProduct	Delete /product/{articleNumber}	Deletes a single product based on the articlenumber.
ProductApi	ProductGetAllProducts	Get /product	Returns all products.
ProductApi	ProductGetProduct	Get /product/{articleNumber}	Returns a single product with the specified article number.
ProductApi	ProductPatchProduct	Patch /product/{articleNumber}	Patches a product with the specified change.
ProductApi	ProductUpdateProduct	Put /product	Updates a product with the specified data.
Shopware6Api	Shopware6Channels	Get /shopware6/channels	Get sales channels by shop
Shopware6Api	Shopware6CheckConnection	Get /shopware6/check-connection	Check whether a connection exists for this shopId
Shopware6Api	Shopware6Connect	Post /shopware6/connect	Connects Shopware6 store to the Tweakwise Instance
Shopware6Api	Shopware6GetActiveChannels	Get /shopware6/active-channel	Returns an active channelID
Shopware6Api	Shopware6ScheduleFullSync	Post /shopware6/schedule-full-sync	Schedules a full sync of the Shopware6 store into Tweakwise
Shopware6Api	Shopware6UpdateActiveChannels	Put /shopware6/active-channel	Updates an active channelID
TaskApi	TaskGetStatus	Get /task/status/{key}/{taskkey}
TaskApi	TaskStart	Get /task/trigger/{key}/{taskkey}	This service starts the specified task by the taskkey.
UserApi	UserGetInstances	Get /user/instances	Returns all instances for current Tweakwise Account User

Documentation For Models

Documentation For Authorization

apiKeyDefinition

Type: API key
API key parameter name: TWN-Authentication
Location: HTTP header

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

instanceKeyDefinition

Type: API key
API key parameter name: TWN-InstanceKey
Location: HTTP header

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

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

# README