# README

Go API client for transport

Transporting Packages: https://docs.saviyntcloud.com/bundle/EIC-Admin-AMS/page/Content/Chapter07-General-Administrator/Transporting-Packages.htm

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: 1.0
  • Package version: 1.0.0
  • Generator version: 7.10.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/net/context

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

import transport "github.com/GIT_USER_ID/GIT_REPO_ID"

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

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

Templated Server URL

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

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

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

Documentation for API Endpoints

All URIs are relative to http://localhost:3000

ClassMethodHTTP requestDescription
TransportAPIExportTransportPackagePost /ECM/api/v5/exportTransportPackageExport Transport Package
TransportAPIImportTransportPackagePost /ECM/api/v5/importTransportPackageImport Transport Package
TransportAPITransportPackageStatusGet /ECM/api/v5/transportPackageStatusTransport Package Status

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

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

https://github.com/saviynt

# Packages

No description provided by the author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
IsNil checks if an input is nil.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
NewExportTransportPackageRequest instantiates a new ExportTransportPackageRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExportTransportPackageRequestWithDefaults instantiates a new ExportTransportPackageRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExportTransportPackageResponse instantiates a new ExportTransportPackageResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExportTransportPackageResponseWithDefaults instantiates a new ExportTransportPackageResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewImportTransportPackageRequest instantiates a new ImportTransportPackageRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewImportTransportPackageRequestWithDefaults instantiates a new ImportTransportPackageRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewImportTransportPackageResponse instantiates a new ImportTransportPackageResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewImportTransportPackageResponseWithDefaults instantiates a new ImportTransportPackageResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewObjectsToExport instantiates a new ObjectsToExport object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewObjectsToExportWithDefaults instantiates a new ObjectsToExport object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportPackageStatusRequest instantiates a new TransportPackageStatusRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportPackageStatusRequestWithDefaults instantiates a new TransportPackageStatusRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportPackageStatusResponse instantiates a new TransportPackageStatusResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportPackageStatusResponseWithDefaults instantiates a new TransportPackageStatusResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Variables

ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.
No description provided by the author
No description provided by the author

# Structs

APIClient manages communication with the Saviynt Transport API API v1.0 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
ExportTransportPackageRequest .
ExportTransportPackageResponse struct for ExportTransportPackageResponse.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
ImportTransportPackageRequest struct for ImportTransportPackageRequest.
ImportTransportPackageResponse struct for ImportTransportPackageResponse.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ObjectsToExport struct for ObjectsToExport.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
TransportPackageStatusRequest struct for TransportPackageStatusRequest.
TransportPackageStatusResponse struct for TransportPackageStatusResponse.

# Interfaces

No description provided by the author

# Type aliases

ServerConfigurations stores multiple ServerConfiguration items.
TransportAPIService TransportAPI service.