# README

Go API client for arborapi

This API provides a RESTful interface to interact with your organization's data.

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.1.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 arborapi "github.com/heru-inc/arbor-api-go"

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

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

Templated Server URL

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

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

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

Documentation for API Endpoints

All URIs are relative to https://api.xrdm.app/api/v2

Class	Method	HTTP request
APIInfoAPI	APIInfoInfo	Get /
AppsAPI	AppsApp	Get /apps/{appId}
AppsAPI	AppsApps	Get /apps
AppsAPI	AppsCompleteVersionUpload	Post /apps/{appId}/versions/{versionId}/complete
AppsAPI	AppsPreSignVersionUploadUrl	Post /apps/{appId}/versions/{versionId}/pre-sign
AppsAPI	AppsReleaseChannel	Get /apps/{appId}/release-channels/{releaseChannelId}
AppsAPI	AppsReleaseChannels	Get /apps/{appId}/release-channels
AppsAPI	AppsRevokeReleaseChannel	Delete /apps/{appId}/release-channels/{releaseChannelId}/share
AppsAPI	AppsShareReleaseChannel	Post /apps/{appId}/release-channels/{releaseChannelId}/share
AppsAPI	AppsStartVersionUpload	Post /apps/{appId}/versions
AppsAPI	AppsUpdateApp	Put /apps/{appId}
AppsAPI	AppsUpdateReleaseChannel	Put /apps/{appId}/release-channels/{releaseChannelId}
AppsAPI	AppsVersions	Get /apps/{appId}/versions
DeviceGroupsAPI	DeviceGroupsAddReleaseChannel	Post /device-groups/{deviceGroupId}/release-channels
DeviceGroupsAPI	DeviceGroupsGroups	Get /device-groups
DeviceGroupsAPI	DeviceGroupsRemoveReleaseChannel	Delete /device-groups/{deviceGroupId}/release-channels
DeviceModelsAPI	DeviceModelsDeviceModel	Get /device-models/{deviceModelId}
DeviceModelsAPI	DeviceModelsDeviceModels	Get /device-models
DevicesAPI	DevicesAddReleaseChannel	Post /devices/{deviceId}/release-channels
DevicesAPI	DevicesCheckFingerprint	Post /devices/{deviceId}/fingerprint
DevicesAPI	DevicesDevice	Get /devices/{deviceId}
DevicesAPI	DevicesDevices	Get /devices
DevicesAPI	DevicesLaunchApp	Post /devices/{deviceId}/launch/{appId}
DevicesAPI	DevicesReboot	Post /devices/{deviceId}/reboot
DevicesAPI	DevicesRemoveReleaseChannel	Delete /devices/{deviceId}/release-channels
DevicesAPI	DevicesUpdateDevice	Put /devices/{deviceId}
FilesAPI	FilesFile	Get /files/{fileId}
FilesAPI	FilesFiles	Get /files
InviteUsersAPI	InviteUsersInviteUser	Post /invite-users
OrganizationRolesAPI	OrganizationRolesOrganizationRole	Get /organization-roles/{organizationRoleId}
OrganizationRolesAPI	OrganizationRolesOrganizationRoles	Get /organization-roles
UsersAPI	UsersCreateUser	Post /users
UsersAPI	UsersDeleteUser	Delete /users/{userId}
UsersAPI	UsersUpdateUser	Put /users/{userId}
UsersAPI	UsersUser	Get /users/{userId}
UsersAPI	UsersUsers	Get /users

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), arborapi.ContextAccessToken, "BEARER_TOKEN_STRING")
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