Skip to content

rekki/supplier-client-go-generated

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Go API client for client

The base URL for all API endpoints is https://api.rekki.com

Api key value contains of word Bearer together with api key that you can get from [email protected]

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:
  • 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 "./client"

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 identifield 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://api.rekki.com/api

Class Method HTTP request Description
CatalogApi DeleteCatalogItem Delete /integration/v1/catalog/items/{id} Delete an item from catalog
CatalogApi DeleteCatalogItemsV3 Post /integration/v3/catalog/items/delete Delete items from catalog
CatalogApi GetCatalogItem Get /integration/v1/catalog/items/{id} Lists all orders placed for the supplier that were placed through REKKI.
CatalogApi GetCatalogItemV3 Get /integration/v3/catalog/items/{id} Fetch a specific catalog item by its Id.
CatalogApi GetCatalogItems Get /integration/v1/catalog/items Get catalog items for authenticated supplier
CatalogApi GetCatalogItemsV3 Get /integration/v3/catalog/items Get catalog items for authenticated supplier
CatalogApi ReplaceCatalog Post /integration/v1/catalog/replace Drop all existing items from the catalog and upload new ones
CatalogApi ReplaceCatalogV3 Post /integration/v3/catalog/replace Drop all existing items from the catalog and upload new ones
CatalogApi UpdateCatalogItem Post /integration/v1/catalog/items Creates or Updates an item on your catalog. If item with this product_code already exists, you can update this item. Item is looked up by product code
CatalogApi UpdateCatalogItemAvailability Post /integration/v2/catalog/items/availability Update availability status for one of the items in the catalog
CatalogApi UpdateCatalogItemAvailabilityV3 Post /integration/v3/catalog/items/availability Update availability status for one of the items in the catalog
CatalogApi UpdateCatalogItemsV3 Post /integration/v3/catalog/items Creates or Updates multiple items on your catalog. If item with this product_code already exists, you can update this item. Item is looked up by product code
GeneralApi PostLogMessage Post /integration/v1/log Post a log message for the supplier for internal debugging. There is no need to handle response from this endpoint
GeneralApi PostLogMessageV3 Post /integration/v3/log Post a log message for the supplier for internal debugging. There is no need to handle response from this endpoint
OrdersApi ConfirmOrders Post /integration/v1/orders/confirm Confirm a pending order by its reference code.
OrdersApi ConfirmOrdersV3 Post /integration/v3/orders/confirm Confirm a pending order by its reference code.
OrdersApi ListNotIntegratedOrders Post /integration/v1/orders/list_not_integrated Lists all orders placed for the supplier that were placed through REKKI and not marked as integrated.
OrdersApi ListOrdersBySupplier Post /integration/v1/orders/list Lists all orders placed for the supplier that were placed through REKKI.
OrdersApi ListOrdersBySupplierV3 Post /integration/v3/orders/list Lists all orders placed for the supplier that were placed through REKKI.
OrdersApi MarkIntegrationError Post /integration/v1/orders/set_error Report failure to integrate an order
OrdersApi MarkIntegrationErrorV3 Post /integration/v3/orders/set_error Report failure to integrate an order
OrdersApi MarkOrdersIntegrated Post /integration/v1/orders/set_integrated Mark orders as integrated
OrdersApi MarkOrdersIntegratedV3 Post /integration/v3/orders/set_integrated Mark orders as integrated

Documentation For Models

Documentation For Authorization

ApiKeyAuth

  • 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.

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]