Skip to content

AccountsApi.md

Latest commit

 

History

History
272 lines (203 loc) · 8.17 KB

AccountsApi.md

File metadata and controls

272 lines (203 loc) · 8.17 KB

AccountsApi

All URIs are relative to https://api.frame.io

Method HTTP request Description
deviceIdentify GET /v2/devices/me Device Information
deviceListAccounts GET /v2/devices/accounts List accounts
getAccount GET /v2/accounts/{account_id} Get Account
getAccountMembership GET /v2/accounts/{account_id}/membership Get Account membership
getAccounts GET /v2/accounts Get Accounts for User

deviceIdentify

ProjectDeviceAuthorization deviceIdentify(xClientVersion)

Device Information

Fetches information about the current device connection. Can be used to verify authorization token and returns information useful to present useful information in your user interface.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = AccountsApi()
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
try {
    val result : ProjectDeviceAuthorization = apiInstance.deviceIdentify(xClientVersion)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AccountsApi#deviceIdentify")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AccountsApi#deviceIdentify")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
xClientVersion kotlin.String Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ [optional] [default to "0.0.0"]

Return type

ProjectDeviceAuthorization

Authorization

Configure C2CDeviceAuth: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deviceListAccounts

kotlin.collections.Set<DeviceListAccounts200ResponseInner> deviceListAccounts(xClientVersion)

List accounts

List available accounts to pair your C2C device with.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = AccountsApi()
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
try {
    val result : kotlin.collections.Set<DeviceListAccounts200ResponseInner> = apiInstance.deviceListAccounts(xClientVersion)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AccountsApi#deviceListAccounts")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AccountsApi#deviceListAccounts")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
xClientVersion kotlin.String Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ [optional] [default to "0.0.0"]

Return type

kotlin.collections.Set<DeviceListAccounts200ResponseInner>

Authorization

Configure C2COAuth2: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getAccount

Account getAccount(accountId)

Get Account

Fetch a particular account by ID

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = AccountsApi()
val accountId : kotlin.String = 38400000-8cf0-11bd-b23e-10b96e4ef00d // kotlin.String | Account ID
try {
    val result : Account = apiInstance.getAccount(accountId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AccountsApi#getAccount")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AccountsApi#getAccount")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
accountId kotlin.String Account ID

Return type

Account

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getAccountMembership

AccountMembership getAccountMembership(accountId)

Get Account membership

Get the membership status for the auth token making the request

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = AccountsApi()
val accountId : kotlin.String = 38400000-8cf0-11bd-b23e-10b96e4ef00d // kotlin.String | Account ID
try {
    val result : AccountMembership = apiInstance.getAccountMembership(accountId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AccountsApi#getAccountMembership")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AccountsApi#getAccountMembership")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
accountId kotlin.String Account ID

Return type

AccountMembership

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getAccounts

kotlin.collections.List<Account> getAccounts()

Get Accounts for User

Fetch all Accounts that a given User has access to

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = AccountsApi()
try {
    val result : kotlin.collections.List<Account> = apiInstance.getAccounts()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AccountsApi#getAccounts")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AccountsApi#getAccounts")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<Account>

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json