node-zendesk / Exports / clients/core/organizationmemberships / OrganizationMemberships

Class: OrganizationMemberships

clients/core/organizationmemberships.OrganizationMemberships

Client class for interacting with the Zendesk Organization Memberships API.

See

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

Hierarchy

• Client

  ↳ OrganizationMemberships

Table of contents

Constructors

• constructor

Properties

• _transporter
• eventTarget
• jsonAPINames
• options
• sideLoad
• useDotJson

Accessors

• transporter

Methods

• _rawRequest
• create
• createByUser
• createMany
• delete
• deleteByUser
• deleteMany
• emit
• get
• getAll
• list
• listByOrganization
• listByUser
• makeDefault
• on
• patch
• post
• put
• request
• requestAll
• requestUpload
• setSideLoad
• show
• showByUser

Constructors

constructor

• new OrganizationMemberships(options): OrganizationMemberships

Parameters

Name	Type
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: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/organizationmemberships.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

Name	Type
method	any
uri	any
...args	any[]

Returns

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

Inherited from

Client._rawRequest

Defined in

clients/client.d.ts:130

---

create

▸ create(organizationMembership): Promise<{ organization_id: number ; user_id: number }>

Create a new organization membership.

Parameters

Name	Type	Description
organizationMembership	Object	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<{ organization_id: number ; user_id: number }>

A promise resolving to the created organization membership.

Async

See

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

Example

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

Defined in

clients/core/organizationmemberships.d.ts:67

---

createByUser

▸ createByUser(userID, organizationMembership): Promise<{ organization_id: number ; user_id: number }>

Create a new organization membership for a specific user.

Parameters

Name	Type	Description
userID	number	The user ID.
organizationMembership	Object	The organization membership data.
organizationMembership.organization_id	number	The organization id of the membership.

Returns

Promise<{ organization_id: number ; user_id: number }>

A promise resolving to the created organization membership.

Async

See

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

Example

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

Defined in

clients/core/organizationmemberships.d.ts:99

---

createMany

▸ createMany(organizationMemberships): Promise<object>

Create multiple organization memberships at once.

Parameters

Name	Type	Description
organizationMemberships	{ organization_id: number ; user_id: number }[]	An array of organization membership data.

Returns

Promise<object>

A promise resolving to a job status.

Async

See

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

Example

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

Defined in

clients/core/organizationmemberships.d.ts:128

---

delete

▸ delete(organizationMembershipID): Promise<void>

Delete a specific organization membership by its ID.

Parameters

Name	Type	Description
organizationMembershipID	number	The organization membership ID.

Returns

Promise<void>

A promise indicating the completion of the delete operation.

Async

See

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

Example

await client.organizationmemberships.delete(789);

Overrides

Client.delete

Defined in

clients/core/organizationmemberships.d.ts:148

---

deleteByUser

▸ deleteByUser(userID, organizationMembershipID): Promise<void>

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

Parameters

Name	Type	Description
userID	number	The user ID.
organizationMembershipID	number	The organization membership ID.

Returns

Promise<void>

A promise indicating the completion of the delete operation.

Async

See

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

Example

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

Defined in

clients/core/organizationmemberships.d.ts:159

---

deleteMany

▸ deleteMany(organizationMembershipIDs): Promise<object>

Delete multiple organization memberships by their IDs.

Parameters

Name	Type	Description
organizationMembershipIDs	number[]	An array of organization membership IDs.

Returns

Promise<object>

A promise resolving to a job status.

Async

See

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

Example

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

Defined in

clients/core/organizationmemberships.d.ts:169

---

emit

▸ emit(eventType, eventData): void

Parameters

Name	Type
eventType	any
eventData	any

Returns

void

Inherited from

Client.emit

Defined in

clients/client.d.ts:95

---

get

▸ get(resource): Promise<NodeModule>

Parameters

Name	Type
resource	any

Returns

Promise<NodeModule>

Inherited from

Client.get

Defined in

clients/client.d.ts:114

---

getAll

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

Parameters

Name	Type
resource	any

Returns

Promise<any[]>

Inherited from

Client.getAll

Defined in

clients/client.d.ts:129

---

list

▸ list(): Promise<object[]>

List all organization memberships.

Returns

Promise<object[]>

A promise resolving to an array of organization memberships.

Async

See

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

Example

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

Defined in

clients/core/organizationmemberships.d.ts:16

---

listByOrganization

▸ listByOrganization(organiationID): Promise<object[]>

List organization memberships by a specific organization ID.

Parameters

Name	Type	Description
organiationID	number	The organization ID.

Returns

Promise<object[]>

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

Async

See

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

Example

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

Defined in

clients/core/organizationmemberships.d.ts:36

---

listByUser

▸ listByUser(userID): Promise<object[]>

List organization memberships by a specific user ID.

Parameters

Name	Type	Description
userID	number	The user ID.

Returns

Promise<object[]>

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

Async

See

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

Example

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

Defined in

clients/core/organizationmemberships.d.ts:26

---

makeDefault

▸ makeDefault(userID, organizationMembershipID): Promise<object>

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

Parameters

Name	Type	Description
userID	number	The user ID.
organizationMembershipID	number	The organization membership ID.

Returns

Promise<object>

A promise resolving to the updated organization membership.

Async

See

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

Example

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

Defined in

clients/core/organizationmemberships.d.ts:180

---

on

▸ on(eventType, callback): void

Parameters

Name	Type
eventType	any
callback	any

Returns

void

Inherited from

Client.on

Defined in

clients/client.d.ts:96

---

patch

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

Patches a resource.

Parameters

Name	Type	Description
...args	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:120

---

post

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

Parameters

Name	Type
resource	any
body	any

Returns

Promise<NodeModule>

Inherited from

Client.post

Defined in

clients/client.d.ts:122

---

put

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

Parameters

Name	Type
resource	any
body	any

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

Name	Type	Description
method	string	HTTP method (e.g., 'GET', 'POST').
uri	string	The URI for the request.
...args	any[]	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

Name	Type
method	any
uri	any
...args	any[]

Returns

Promise<any[]>

Inherited from

Client.requestAll

Defined in

clients/client.d.ts:149

---

requestUpload

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

Parameters

Name	Type
uri	any
file	any

Returns

Promise<any>

Inherited from

Client.requestUpload

Defined in

clients/client.d.ts:150

---

setSideLoad

▸ setSideLoad(array): void

Parameters

Name	Type
array	any

Returns

void

Inherited from

Client.setSideLoad

Defined in

clients/client.d.ts:113

---

show

▸ show(organizationMembershipID): Promise<object>

Retrieve a specific organization membership by its ID.

Parameters

Name	Type	Description
organizationMembershipID	number	The organization membership ID.

Returns

Promise<object>

A promise resolving to the organization membership.

Async

See

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

Example

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

Defined in

clients/core/organizationmemberships.d.ts:46

---

showByUser

▸ showByUser(userID, organizationMembershipID): Promise<object>

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

Parameters

Name	Type	Description
userID	number	The user ID.
organizationMembershipID	number	The organization membership ID.

Returns

Promise<object>

A promise resolving to the organization membership.

Async

See

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

Example

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

Defined in

clients/core/organizationmemberships.d.ts:57