Skip to content

heru-inc/arbor-api-go

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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: v2
  • Package version: 1.2.0
  • Generator version: 7.13.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://arborxr.com

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 Description
APIInfoAPI GetApiInfo Get /
AppsAPI CompleteAppVersionUpload Post /apps/{appId}/versions/{versionId}/complete
AppsAPI GetApp Get /apps/{appId}
AppsAPI GetAppReleaseChannel Get /apps/{appId}/release-channels/{releaseChannelId}
AppsAPI GetAppReleaseChannels Get /apps/{appId}/release-channels
AppsAPI GetAppVersions Get /apps/{appId}/versions
AppsAPI GetApps Get /apps
AppsAPI InitiateAppVersionUpload Post /apps/{appId}/versions
AppsAPI PreSignAppVersionUpload Post /apps/{appId}/versions/{versionId}/pre-sign
AppsAPI ShareReleaseChannel Post /apps/{appId}/release-channels/{releaseChannelId}/share
AppsAPI UnshareReleaseChannel Delete /apps/{appId}/release-channels/{releaseChannelId}/share
AppsAPI UpdateApp Put /apps/{appId}
AppsAPI UpdateReleaseChannel Put /apps/{appId}/release-channels/{releaseChannelId}
DeviceModelsAPI GetDeviceModel Get /device-models/{deviceModelId}
DeviceModelsAPI GetDeviceModels Get /device-models
DevicesAPI AddFileToDevice Post /devices/{deviceId}/files
DevicesAPI AddReleaseChannelToDevice Post /devices/{deviceId}/release-channels
DevicesAPI CheckFingerprint Post /devices/{deviceId}/fingerprint
DevicesAPI GetDevice Get /devices/{deviceId}
DevicesAPI GetDevices Get /devices
DevicesAPI LaunchApp Post /devices/{deviceId}/launch/{appId}
DevicesAPI RebootDevice Post /devices/{deviceId}/reboot
DevicesAPI RemoveFileFromDevice Delete /devices/{deviceId}/files
DevicesAPI RemoveReleaseChannelFromDevice Delete /devices/{deviceId}/release-channels
DevicesAPI UpdateDevice Put /devices/{deviceId}
FilesAPI CompleteFileUpload Post /files/{fileId}/complete
FilesAPI GetFile Get /files/{fileId}
FilesAPI GetFiles Get /files
FilesAPI InitiateFileUpload Post /files
FilesAPI PreSignFileUpload Post /files/{fileId}/pre-sign
GroupsAPI AddFileToGroup Post /groups/{groupId}/files
GroupsAPI AddReleaseChannelToDeviceGroup Post /device-groups/{groupId}/release-channels
GroupsAPI AddReleaseChannelToGroup Post /groups/{groupId}/release-channels
GroupsAPI GetDeviceGroups Get /device-groups
GroupsAPI GetGroupReleaseChannels Get /groups/{groupId}/release-channels
GroupsAPI GetGroups Get /groups
GroupsAPI RemoveFileFromGroup Delete /groups/{groupId}/files
GroupsAPI RemoveReleaseChannelFromDeviceGroup Delete /device-groups/{groupId}/release-channels
GroupsAPI RemoveReleaseChannelFromGroup Delete /groups/{groupId}/release-channels
RolesAPI GetGroupRole Get /group-roles/{roleId}
RolesAPI GetGroupRoles Get /group-roles
RolesAPI GetOrganizationRole Get /organization-roles/{roleId}
RolesAPI GetOrganizationRoles Get /organization-roles
UserInvitesAPI CreateUserInvite Post /user-invites
UserInvitesAPI InviteUser Post /invite-user
UsersAPI CreateUser Post /users
UsersAPI DeleteUser Delete /users/{userId}
UsersAPI GetUser Get /users/{userId}
UsersAPI GetUsers Get /users
UsersAPI UpdateUser Put /users/{userId}

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

Author

support@arborxr.com

About

ArborXR web API Go library.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages