Interface: IdentitiesApi

The methods of Talkline.identities.

Methods

get()

get(identity): Promise<IdentitySettings>;

GET /v1/identities/{identity}.

Parameters

Parameter	Type
identity	string

Returns

Promise<IdentitySettings>

---

iterateDevices()

iterateDevices(identity, query?): AsyncIterable<Device>;

GET /v1/identities/{identity}/devices, every page in turn.

Parameters

Parameter	Type
identity	string
query?	Pageless<PageQuery>

Returns

AsyncIterable<Device>

---

listDevices()

listDevices(identity, query?): Promise<Page<Device>>;

GET /v1/identities/{identity}/devices, one page.

Parameters

Parameter	Type
identity	string
query?	PageQuery

Returns

Promise<Page<Device>>

---

removeDevice()

removeDevice(identity, deviceId): Promise<void>;

DELETE /v1/identities/{identity}/devices/{deviceId}.

Parameters

Parameter	Type
identity	string
deviceId	string

Returns

Promise<void>

---

upsert()

upsert(identity, body): Promise<IdentitySettings>;

PUT /v1/identities/{identity}: the whole record; a field it leaves out returns to its default.

Parameters

Parameter	Type
identity	string
body	UpsertIdentityRequest

Returns

Promise<IdentitySettings>

---

upsertDevice()

upsertDevice(
   identity, 
   deviceId, 
   body
): Promise<Device>;

PUT /v1/identities/{identity}/devices/{deviceId}: the whole registration; a field left out is cleared.

Parameters

Parameter	Type
identity	string
deviceId	string
body	UpsertDeviceRequest

Returns

Promise<Device>