node-zendesk

Appearance

node-zendesk • Docs

node-zendesk / clients/core/organizationmemberships / OrganizationMemberships

Class: OrganizationMemberships ​

Client class for interacting with the Zendesk Organization Memberships API.

See ​

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/

Extends ​

Constructors ​

new OrganizationMemberships() ​

new OrganizationMemberships(options): OrganizationMemberships

Parameters ​

• options: any

Returns ​

OrganizationMemberships

Overrides ​

Client.constructor

Defined in ​

clients/core/organizationmemberships.d.ts:6

Properties ​

_transporter ​

_transporter: Transporter

Inherited from ​

Client._transporter

Defined in ​

clients/client.d.ts:42

eventTarget ​

eventTarget: CustomEventTarget

Event target to handle custom events.

Inherited from ​

Client.eventTarget

Defined in ​

clients/client.d.ts:40

jsonAPINames ​

jsonAPINames: string[]

Array to hold names used in the JSON API.

Overrides ​

Client.jsonAPINames

Defined in ​

clients/core/organizationmemberships.d.ts:7

options ​

options: ZendeskClientOptions & object

Configuration options for the client.

Type declaration ​

get() ​

get: (key) => any

Parameters ​

• key: string

Returns ​

any

Inherited from ​

Client.options

Defined in ​

clients/client.d.ts:34

sideLoad ​

sideLoad: any[]

Array to handle side-loaded resources.

Inherited from ​

Client.sideLoad

Defined in ​

clients/client.d.ts:37

useDotJson ​

useDotJson: boolean

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

Inherited from ​

Client.useDotJson

Defined in ​

clients/client.d.ts:39

Accessors ​

transporter ​

Get Signature ​

get transporter(): Transporter

Returns ​

Transporter

Transporter for making requests.

Inherited from ​

Client.transporter

Defined in ​

clients/client.d.ts:41

Methods ​

_rawRequest() ​

_rawRequest(method, uri, ...arguments_): Promise<object>

Parameters ​

• method: any

• uri: any

• ...arguments_: any[]

Returns ​

Promise<object>

response ​

response: any

result ​

result: object

Inherited from ​

Client._rawRequest

Defined in ​

clients/client.d.ts:78

create() ​

create(organizationMembership): Promise<object>

Create a new organization membership.

Parameters ​

• organizationMembership

The organization membership data.

• organizationMembership.organization_id: number

The Zendesk identifier of the organization.

• organizationMembership.user_id: number

The Zendesk identifier of the user.

Returns ​

Promise<object>

A promise resolving to the created organization membership.

response ​

response: object

result ​

result: object

result.organization_id ​

organization_id: number

The Zendesk identifier of the organization.

result.user_id ​

user_id: number

The Zendesk identifier of the user.

See ​

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#create-membership

Example ​

ts
const newMembership = await client.organizationmemberships.create({ user_id: 123, organization_id: 456 });

Defined in ​

clients/core/organizationmemberships.d.ts:117

createByUser() ​

createByUser(userID, organizationMembership): Promise<object>

Create a new organization membership for a specific user.

Parameters ​

• userID: number

The user ID.

• organizationMembership

The organization membership data.

• organizationMembership.organization_id: number

The organization id of the membership.

Returns ​

Promise<object>

A promise resolving to the created organization membership.

response ​

response: object

result ​

result: object

result.organization_id ​

organization_id: number

The Zendesk identifier of the organization.

result.user_id ​

user_id: number

The Zendesk identifier of the user.

See ​

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#create-membership

Example ​

ts
const newMembership = await client.organizationmemberships.createByUser(123, { organization_id: 456 });

Defined in ​

clients/core/organizationmemberships.d.ts:151

createMany() ​

createMany(organizationMemberships): Promise<object>

Create multiple organization memberships at once.

Parameters ​

• organizationMemberships: object[]

An array of organization membership data.

Returns ​

Promise<object>

A promise resolving to a job status.

response ​

response: object

result ​

result: object

See ​

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#create-many-memberships

Example ​

ts
const jobStatus = await client.organizationmemberships.createMany([{ user_id: 123, organization_id: 456 }, ...]);

Defined in ​

clients/core/organizationmemberships.d.ts:182

delete() ​

delete(organizationMembershipID): Promise<void>

Delete a specific organization membership by its ID.

Parameters ​

• organizationMembershipID: number

The organization membership ID.

Returns ​

Promise<void>

A promise indicating the completion of the delete operation.

See ​

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#delete-membership

Example ​

ts
await client.organizationmemberships.delete(789);

Overrides ​

Client.delete

Defined in ​

clients/core/organizationmemberships.d.ts:204

deleteByUser() ​

deleteByUser(userID, organizationMembershipID): Promise<void>

Delete a specific organization membership by user ID and membership ID.

Parameters ​

• userID: number

The user ID.

• organizationMembershipID: number

The organization membership ID.

Returns ​

Promise<void>

A promise indicating the completion of the delete operation.

See ​

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#delete-membership

Example ​

ts
await client.organizationmemberships.deleteByUser(123, 789);

Defined in ​

clients/core/organizationmemberships.d.ts:214

deleteMany() ​

deleteMany(organizationMembershipIDs): Promise<object>

Delete multiple organization memberships by their IDs.

Parameters ​

• organizationMembershipIDs: number[]

An array of organization membership IDs.

Returns ​

Promise<object>

A promise resolving to a job status.

See ​

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#bulk-delete-memberships

Example ​

ts
const jobStatus = await client.organizationmemberships.deleteMany([789, 790, 791]);

Defined in ​

clients/core/organizationmemberships.d.ts:223

emit() ​

emit(eventType, eventData): void

Parameters ​

• eventType: any

• eventData: any

Returns ​

void

Inherited from ​

Client.emit

Defined in ​

clients/client.d.ts:43

get() ​

get(resource): Promise<NodeModule>

Parameters ​

• resource: any

Returns ​

Promise<NodeModule>

Inherited from ​

Client.get

Defined in ​

clients/client.d.ts:62

getAll() ​

getAll(resource): Promise<any[]>

Parameters ​

• resource: any

Returns ​

Promise<any[]>

Inherited from ​

Client.getAll

Defined in ​

clients/client.d.ts:77

list() ​

list(): Promise<object[]>

List all organization memberships.

Returns ​

Promise<object[]>

A promise resolving to an array of organization memberships.

See ​

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#list-memberships

Example ​

ts
const memberships = await client.organizationmemberships.list();

Defined in ​

clients/core/organizationmemberships.d.ts:15

listByOrganization() ​

listByOrganization(organiationID): Promise<object[]>

List organization memberships by a specific organization ID.

Parameters ​

• organiationID: number

The organization ID.

Returns ​

Promise<object[]>

A promise resolving to an array of organization memberships for the organization.

See ​

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#list-memberships

Example ​

ts
const memberships = await client.organizationmemberships.listByOrganization(456);

Defined in ​

clients/core/organizationmemberships.d.ts:53

listByUser() ​

listByUser(userID): Promise<object[]>

List organization memberships by a specific user ID.

Parameters ​

• userID: number

The user ID.

Returns ​

Promise<object[]>

A promise resolving to an array of organization memberships for the user.

See ​

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#list-memberships

Example ​

ts
const memberships = await client.organizationmemberships.listByUser(123);

Defined in ​

clients/core/organizationmemberships.d.ts:34

makeDefault() ​

makeDefault(userID, organizationMembershipID): Promise<object>

Set a specific organization membership as the default for a user.

Parameters ​

• userID: number

The user ID.

• organizationMembershipID: number

The organization membership ID.

Returns ​

Promise<object>

A promise resolving to the updated organization membership.

response ​

response: object

result ​

result: object

result.organization_id ​

organization_id: number

The Zendesk identifier of the organization.

result.user_id ​

user_id: number

The Zendesk identifier of the user.

See ​

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#set-membership-as-default

Example ​

ts
const updatedMembership = await client.organizationmemberships.setDefault(123, 789);

Defined in ​

clients/core/organizationmemberships.d.ts:233

on() ​

on(eventType, callback): void

Parameters ​

• eventType: any

• callback: any

Returns ​

void

Inherited from ​

Client.on

Defined in ​

clients/client.d.ts:44

patch() ​

patch(...arguments_): Promise<void | object>

Patches a resource.

Parameters ​

• ...arguments_: any[]

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:68

post() ​

post(resource, body): Promise<NodeModule>

Parameters ​

• resource: any

• body: any

Returns ​

Promise<NodeModule>

Inherited from ​

Client.post

Defined in ​

clients/client.d.ts:70

put() ​

put(resource, body): Promise<NodeModule>

Parameters ​

• resource: any

• body: any

Returns ​

Promise<NodeModule>

Inherited from ​

Client.put

Defined in ​

clients/client.d.ts:69

request() ​

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

Request method that handles various HTTP methods.

Type Parameters ​

• T

Parameters ​

• method: string

HTTP method (e.g., 'GET', 'POST').

• uri: string

The URI for the request.

• ...arguments_: any[]

Additional arguments for the request.

Returns ​

Promise<NodeModule>

  • The API response.

Inherited from ​

Client.request

Defined in ​

clients/client.d.ts:96

requestAll() ​

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

Parameters ​

• method: any

• uri: any

• ...arguments_: any[]

Returns ​

Promise<any[]>

Inherited from ​

Client.requestAll

Defined in ​

clients/client.d.ts:97

requestUpload() ​

requestUpload(uri, file): Promise<any>

Parameters ​

• uri: any

• file: any

Returns ​

Promise<any>

Inherited from ​

Client.requestUpload

Defined in ​

clients/client.d.ts:98

setSideLoad() ​

setSideLoad(array): void

Parameters ​

• array: any

Returns ​

void

Inherited from ​

Client.setSideLoad

Defined in ​

clients/client.d.ts:61

show() ​

show(organizationMembershipID): Promise<object>

Retrieve a specific organization membership by its ID.

Parameters ​

• organizationMembershipID: number

The organization membership ID.

Returns ​

Promise<object>

A promise resolving to the organization membership.

response ​

response: object

result ​

result: object

result.organization_id ​

organization_id: number

The Zendesk identifier of the organization.

result.user_id ​

user_id: number

The Zendesk identifier of the user.

See ​

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#show-membership

Example ​

ts
const membership = await client.organizationmemberships.show(789);

Defined in ​

clients/core/organizationmemberships.d.ts:72

showByUser() ​

showByUser(userID, organizationMembershipID): Promise<object>

Retrieve a specific organization membership by user ID and membership ID.

Parameters ​

• userID: number

The user ID.

• organizationMembershipID: number

The organization membership ID.

Returns ​

Promise<object>

A promise resolving to the organization membership.

response ​

response: object

result ​

result: object

result.organization_id ​

organization_id: number

The Zendesk identifier of the organization.

result.user_id ​

user_id: number

The Zendesk identifier of the user.

See ​

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#show-membership

Example ​

ts
const membership = await client.organizationmemberships.showByUser(123, 789);

Defined in ​

clients/core/organizationmemberships.d.ts:95

Released under the MIT License.

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