Class PlaceApiKey

Hierarchy (View Summary)

PlaceResource
- PlaceApiKey

Index

Constructors

Properties

authority? authority_id created_at description expires_at? id name permissions scopes secret ttl? updated_at user? user_id version x_api_key

Methods

toJSON

Constructors

constructor

new PlaceApiKey(raw_data?: Partial<PlaceApiKey>): PlaceApiKey
Parameters
- raw_data: Partial<PlaceApiKey> = {}
Returns PlaceApiKey
Overrides PlaceResource.constructor
- Defined in api-keys/api-key.ts:25

Properties

`Optional` `Readonly`authority

authority?: PlaceAuthority

`Readonly`authority_id

authority_id: string

`Readonly`created_at

created_at: number

Unix epoch in seconds of the creation time of the object

`Readonly`description

description: string

`Optional` `Readonly`expires_at

expires_at?: number

`Readonly`id

id: string

Unique Identifier of the object

`Readonly`name

name: string

Human readable name of the object

`Readonly`permissions

permissions: "" | PlaceApiKeyPermission

`Readonly`scopes

scopes: HashMap<any>[]

`Readonly`secret

secret: string

`Optional` `Readonly`ttl

ttl?: number

`Readonly`updated_at

updated_at: number

Unix epoch in seconds of the creation time of the object

`Optional` `Readonly`user

user?: PlaceUser

`Readonly`user_id

user_id: string

`Readonly`version

version: number

Version of the data

`Readonly`x_api_key

x_api_key: string

Methods

toJSON

toJSON(): HashMap
Convert object into plain object

Returns HashMap
Inherited from PlaceResource.toJSON
- Defined in resources/resource.ts:28

Class PlaceApiKey

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PlaceApiKey

Properties

`Optional` `Readonly`authority

`Readonly`authority_id

`Readonly`created_at

`Readonly`description

`Optional` `Readonly`expires_at

`Readonly`id

`Readonly`name

`Readonly`permissions

`Readonly`scopes

`Readonly`secret

`Optional` `Readonly`ttl

`Readonly`updated_at

`Optional` `Readonly`user

`Readonly`user_id

`Readonly`version

`Readonly`x_api_key

Methods

toJSON

Returns HashMap

Settings

On This Page

Class PlaceApiKey

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PlaceApiKey

Properties

Optional Readonlyauthority

Readonlyauthority_id

Readonlycreated_at

Readonlydescription

Optional Readonlyexpires_at

Readonlyid

Readonlyname

Readonlypermissions

Readonlyscopes

Readonlysecret

Optional Readonlyttl

Readonlyupdated_at

Optional Readonlyuser

Readonlyuser_id

Readonlyversion

Readonlyx_api_key

Methods

toJSON

Returns HashMap

Settings

On This Page

`Optional` `Readonly`authority

`Readonly`authority_id

`Readonly`created_at

`Readonly`description

`Optional` `Readonly`expires_at

`Readonly`id

`Readonly`name

`Readonly`permissions

`Readonly`scopes

`Readonly`secret

`Optional` `Readonly`ttl

`Readonly`updated_at

`Optional` `Readonly`user

`Readonly`user_id

`Readonly`version

`Readonly`x_api_key