Class: AppResource

App Tokens

.createToken(publicKey, redirectUrl): Promise<AppToken> 1.0.0

POST /apps/{public_key}/token

Creates app token

Parameters

Name	Type	Description
publicKey	string	App public key
redirectUrl	string	Redirect URL

Returns

Promise<AppToken>

AppToken Created app token

Throws

If parameters are invalid

Example

const token = await rest.apps.createToken('public_key_here', 'https://example.com/callback');

---

.deleteToken(token): Promise<BaseOkay> 1.0.0

DELETE /apps/tokens/{token}

Deletes app token

Parameters

Name	Type	Description
token	string	App token

Returns

Promise<BaseOkay>

BaseOkay Delete response

Throws

If token is invalid

Example

await rest.apps.deleteToken('token_here');

---

.getToken(publicKey): Promise<AppToken> 1.0.0

GET /apps/{public_key}/token

Gets app token

Parameters

Name	Type	Description
publicKey	string	App public key

Returns

Promise<AppToken>

AppToken object

Throws

If public key is invalid

Example

const token = await rest.apps.getToken('public_key_here');

---

.getTokens(publicKey): Promise<AppToken[]> 1.0.0

GET /apps/tokens

Gets app tokens

Parameters

Name	Type	Description
publicKey	string	App public key

Returns

Promise<AppToken[]>

Array of AppToken objects

Throws

If public key is invalid

Example

const tokens = await rest.apps.getTokens('public_key_here');

---

.getUser(token, secretKey): Promise<ShortUserModel> 1.0.0

GET /apps/user/{token}

Gets user by app token

Parameters

Name	Type	Description
token	string	App token
secretKey	string	App secret key

Returns

Promise<ShortUserModel>

ShortUserModel object

Throws

If parameters are invalid

Example

const user = await rest.apps.getUser('token_here', 'secret_key_here');

Apps Core

.create(payload): Promise<App> 1.0.0

POST /apps

Creates a new app

Parameters

Name	Type	Description
payload	CreateAppPayload	CreateAppPayload App creation data

Returns

Promise<App>

App Created app

Throws

If payload is invalid

Example

const app = await rest.apps.create({
  name: 'My App',
  redirectUrl: 'https://example.com/callback'
});

---

.delete(appId): Promise<BaseOkay> 1.0.0

DELETE /apps/{app_id}

Deletes an app

Parameters

Name	Type	Description
appId	number	App identifier

Returns

Promise<BaseOkay>

BaseOkay Delete response

Throws

If app ID is invalid

Example

await rest.apps.delete(123);

---

.get(publicKey): Promise<App> 1.0.0

GET /apps/{public_key}

Gets an app by public key

Parameters

Name	Type	Description
publicKey	string	App public key

Returns

Promise<App>

App object

Throws

If public key is invalid or app not found

Example

const app = await rest.apps.get('public_key_here');

---

getAll()

getAll(): Promise<App[]>

Gets all apps

Returns

Promise<App[]>

Array of App objects

Throws

If apps cannot be retrieved

Example

const apps = await rest.apps.getAll();