node-zendesk

Appearance

node-zendesk / Exports / clients/core/sessions / Sessions

Class: Sessions ​

clients/core/sessions.Sessions

Client class for interacting with Zendesk's Sessions API.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Accessors ​

Methods ​

Constructors ​

constructor ​

• new Sessions(options): Sessions

Parameters ​

NameType
optionsany

Returns ​

Sessions

Overrides ​

Client.constructor

Defined in ​

clients/core/sessions.d.ts:6

Properties ​

_transporter ​

• _transporter: Transporter

Inherited from ​

Client._transporter

Defined in ​

clients/client.d.ts:94

eventTarget ​

• eventTarget: CustomEventTarget

Event target to handle custom events.

Inherited from ​

Client.eventTarget

Defined in ​

clients/client.d.ts:92

jsonAPINames ​

• jsonAPINames: string[]

Array to hold names used in the JSON API.

Overrides ​

Client.jsonAPINames

Defined in ​

clients/core/sessions.d.ts:7

options ​

• options: ClientOptions & { get: (key: string) => any }

Configuration options for the client.

Inherited from ​

Client.options

Defined in ​

clients/client.d.ts:86

sideLoad ​

• sideLoad: any[]

Array to handle side-loaded resources.

Inherited from ​

Client.sideLoad

Defined in ​

clients/client.d.ts:89

useDotJson ​

• useDotJson: boolean

Flag to indicate if the API endpoint should use '.json' ending.

Inherited from ​

Client.useDotJson

Defined in ​

clients/client.d.ts:91

Accessors ​

transporter ​

• get transporter(): Transporter

Transporter for making requests.

Returns ​

Transporter

Inherited from ​

Client.transporter

Defined in ​

clients/client.d.ts:93

Methods ​

_rawRequest ​

▸ _rawRequest(method, uri, ...args): Promise<{ response: any ; result: {} }>

Parameters ​

NameType
methodany
uriany
...argsany[]

Returns ​

Promise<{ response: any ; result: {} }>

Inherited from ​

Client._rawRequest

Defined in ​

clients/client.d.ts:130

bulkDeleteByUserId ​

▸ bulkDeleteByUserId(userId): Promise<void>

Delete all sessions for a specific user by user ID.

Parameters ​

NameTypeDescription
userIdnumberThe ID of the user.

Returns ​

Promise<void>

Async

Throws

Will throw an error if the request fails.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/#bulk-delete-sessions

Example

ts
await client.sessions.bulkDeleteByUserId(12345);

Defined in ​

clients/core/sessions.d.ts:69

delete ​

▸ delete(...args): Promise<void | object>

Deletes a resource.

Parameters ​

NameTypeDescription
...argsany[]The resources or parts of the resource path.

Returns ​

Promise<void | object>

  • Either void or response object

Inherited from ​

Client.delete

Defined in ​

clients/client.d.ts:128

deleteByUserIdBySessionId ​

▸ deleteByUserIdBySessionId(userId, sessionId): Promise<void>

Delete a specific session by user ID and session ID.

Parameters ​

NameTypeDescription
userIdnumberThe ID of the user.
sessionIdnumberThe ID of the session.

Returns ​

Promise<void>

Async

Throws

Will throw an error if the request fails.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/#delete-session

Example

ts
await client.sessions.deleteByUserIdBySessionId(12345, 67890);

Defined in ​

clients/core/sessions.d.ts:58

emit ​

▸ emit(eventType, eventData): void

Parameters ​

NameType
eventTypeany
eventDataany

Returns ​

void

Inherited from ​

Client.emit

Defined in ​

clients/client.d.ts:95

get ​

▸ get(resource): Promise<NodeModule>

Parameters ​

NameType
resourceany

Returns ​

Promise<NodeModule>

Inherited from ​

Client.get

Defined in ​

clients/client.d.ts:114

getAll ​

▸ getAll(resource): Promise<any[]>

Parameters ​

NameType
resourceany

Returns ​

Promise<any[]>

Inherited from ​

Client.getAll

Defined in ​

clients/client.d.ts:129

getByUserId ​

▸ getByUserId(userId): Promise<object[]>

List sessions by user ID.

Parameters ​

NameTypeDescription
userIdnumberThe ID of the user.

Returns ​

Promise<object[]>

Array of sessions.

Async

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/#list-sessions

Example

ts
const sessions = await client.sessions.getByUserId(12345);

Defined in ​

clients/core/sessions.d.ts:26

getByUserIdBySessionId ​

▸ getByUserIdBySessionId(userId, sessionId): Promise<object>

Retrieve a specific session by user ID and session ID.

Parameters ​

NameTypeDescription
userIdnumberThe ID of the user.
sessionIdnumberThe ID of the session.

Returns ​

Promise<object>

Session details.

Async

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/#show-session

Example

ts
const session = await client.sessions.getByUserIdBySessionId(12345, 67890);

Defined in ​

clients/core/sessions.d.ts:37

getMyAuthenticatedSession ​

▸ getMyAuthenticatedSession(): Promise<object>

Retrieve details of the currently authenticated session.

Returns ​

Promise<object>

Session details.

Async

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/#show-the-currently-authenticated-session

Example

ts
const session = await client.sessions.getMyAuthenticatedSession();

Defined in ​

clients/core/sessions.d.ts:46

list ​

▸ list(): Promise<object[]>

List all sessions.

Returns ​

Promise<object[]>

Array of sessions.

Async

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/#list-sessions

Example

ts
const sessions = await client.sessions.get();

Defined in ​

clients/core/sessions.d.ts:16

logMeOut ​

▸ logMeOut(): Promise<void>

Logs out the current authenticated user.

Returns ​

Promise<void>

Async

Throws

Will throw an error if the request fails.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/#delete-the-authenticated-session

Example

ts
await client.sessions.logMeOut();

Defined in ​

clients/core/sessions.d.ts:79

on ​

▸ on(eventType, callback): void

Parameters ​

NameType
eventTypeany
callbackany

Returns ​

void

Inherited from ​

Client.on

Defined in ​

clients/client.d.ts:96

patch ​

▸ patch(...args): Promise<void | object>

Patches a resource.

Parameters ​

NameTypeDescription
...argsany[]The resources or parts of the resource path followed by the body.

Returns ​

Promise<void | object>

  • Either void or response object

Inherited from ​

Client.patch

Defined in ​

clients/client.d.ts:120

post ​

▸ post(resource, body): Promise<NodeModule>

Parameters ​

NameType
resourceany
bodyany

Returns ​

Promise<NodeModule>

Inherited from ​

Client.post

Defined in ​

clients/client.d.ts:122

put ​

▸ put(resource, body): Promise<NodeModule>

Parameters ​

NameType
resourceany
bodyany

Returns ​

Promise<NodeModule>

Inherited from ​

Client.put

Defined in ​

clients/client.d.ts:121

request ​

▸ request<T>(method, uri, ...args): Promise<NodeModule>

Request method that handles various HTTP methods.

Type parameters ​

Name
T

Parameters ​

NameTypeDescription
methodstringHTTP method (e.g., 'GET', 'POST').
uristringThe URI for the request.
...argsany[]Additional arguments for the request.

Returns ​

Promise<NodeModule>

  • The API response.

Inherited from ​

Client.request

Defined in ​

clients/client.d.ts:148

requestAll ​

▸ requestAll(method, uri, ...args): Promise<any[]>

Parameters ​

NameType
methodany
uriany
...argsany[]

Returns ​

Promise<any[]>

Inherited from ​

Client.requestAll

Defined in ​

clients/client.d.ts:149

requestUpload ​

▸ requestUpload(uri, file): Promise<any>

Parameters ​

NameType
uriany
fileany

Returns ​

Promise<any>

Inherited from ​

Client.requestUpload

Defined in ​

clients/client.d.ts:150

setSideLoad ​

▸ setSideLoad(array): void

Parameters ​

NameType
arrayany

Returns ​

void

Inherited from ​

Client.setSideLoad

Defined in ​

clients/client.d.ts:113

Released under the MIT License.

Copyright © 2012-present | Made by Farrin A. Reid with ❤️