Class Organizations

Hierarchy

Organizations

Constructors

constructor

new Organizations(client): Organizations
Parameters
- client: Client
Returns Organizations
- Defined in api/organizations.ts:7

Properties

`Private` client

client: Client

Methods

addOrganizationMember

addOrganizationMember<T>(parameters, callback): Promise<void>
Add a member to a Workspace or update their member type.
Type Parameters
- T = unknown
Parameters
- parameters: AddOrganizationMember
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:383
addOrganizationMember<T>(parameters, callback?): Promise<T>
Add a member to a Workspace or update their member type.
Type Parameters
- T = unknown
Parameters
- parameters: AddOrganizationMember
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:388

createOrganization

createOrganization<T>(parameters, callback): Promise<void>
Create a new Workspace
Type Parameters
- T = unknown
Parameters
- parameters: CreateOrganization
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:10
createOrganization<T>(parameters, callback?): Promise<T>
Create a new Workspace
Type Parameters
- T = unknown
Parameters
- parameters: CreateOrganization
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:15

createOrganizationTag

createOrganizationTag<T>(parameters, callback): Promise<void>
Create a Tag in an Organization
Type Parameters
- T = unknown
Parameters
- parameters: CreateOrganizationTag
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:364
createOrganizationTag<T>(parameters, callback?): Promise<T>
Create a Tag in an Organization
Type Parameters
- T = unknown
Parameters
- parameters: CreateOrganizationTag
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:369

deleteOrganization

deleteOrganization<T>(parameters, callback): Promise<void>
Delete an Organization
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganization
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:88
deleteOrganization<T>(parameters, callback?): Promise<T>
Delete an Organization
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganization
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:93

deleteOrganizationAssociatedDomain

deleteOrganizationAssociatedDomain<T>(parameters, callback): Promise<void>
Remove the associated Google Apps domain from a Workspace
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganizationAssociatedDomain
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:517
deleteOrganizationAssociatedDomain<T>(parameters, callback?): Promise<T>
Remove the associated Google Apps domain from a Workspace
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganizationAssociatedDomain
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:522

deleteOrganizationInvites

deleteOrganizationInvites<T>(parameters, callback): Promise<void>
Remove the email domain restriction on who can be invited to the Workspace
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganizationInvites
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:539
deleteOrganizationInvites<T>(parameters, callback?): Promise<T>
Remove the email domain restriction on who can be invited to the Workspace
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganizationInvites
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:544

deleteOrganizationLogo

deleteOrganizationLogo<T>(parameters, callback): Promise<void>
Delete a logo from a Workspace
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganizationLogo
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:473
deleteOrganizationLogo<T>(parameters, callback?): Promise<T>
Delete a logo from a Workspace
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganizationLogo
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:478

deleteOrganizationMember

deleteOrganizationMember<T>(parameters, callback): Promise<void>
Remove a member from a Workspace
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganizationMember
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:405
deleteOrganizationMember<T>(parameters, callback?): Promise<T>
Remove a member from a Workspace
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganizationMember
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:410

deleteOrganizationMemberFromAll

deleteOrganizationMemberFromAll<T>(parameters, callback): Promise<void>
Remove a member from a Workspace and from all Workspace boards
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganizationMemberFromAll
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:495
deleteOrganizationMemberFromAll<T>(parameters, callback?): Promise<T>
Remove a member from a Workspace and from all Workspace boards
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganizationMemberFromAll
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:500

deleteOrganizationTag

deleteOrganizationTag<T>(parameters, callback): Promise<void>
Delete an organization's tag
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganizationTag
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:561
deleteOrganizationTag<T>(parameters, callback?): Promise<T>
Delete an organization's tag
Type Parameters
- T = unknown
Parameters
- parameters: DeleteOrganizationTag
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:566

exportOrganizationCSV

exportOrganizationCSV<T>(parameters, callback): Promise<void>
Kick off CSV export for an organization
Type Parameters
- T = Export
Parameters
- parameters: ExportOrganizationCSV
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:197
exportOrganizationCSV<T>(parameters, callback?): Promise<T>
Kick off CSV export for an organization
Type Parameters
- T = Export
Parameters
- parameters: ExportOrganizationCSV
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:202

getOrganization

getOrganization<T>(parameters, callback): Promise<void>
Type Parameters
- T = Organization
Parameters
- parameters: GetOrganization
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:34
getOrganization<T>(parameters, callback?): Promise<T>
Type Parameters
- T = Organization
Parameters
- parameters: GetOrganization
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:38

getOrganizationActions

getOrganizationActions<T>(parameters, callback): Promise<void>
List the actions on a Workspace
Type Parameters
- T = Action[]
Parameters
- parameters: GetOrganizationActions
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:127
getOrganizationActions<T>(parameters, callback?): Promise<T>
List the actions on a Workspace
Type Parameters
- T = Action[]
Parameters
- parameters: GetOrganizationActions
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:132

getOrganizationBoards

getOrganizationBoards<T>(parameters, callback): Promise<void>
List the boards in a Workspace
Type Parameters
- T = Board[]
Parameters
- parameters: GetOrganizationBoards
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:149
getOrganizationBoards<T>(parameters, callback?): Promise<T>
List the boards in a Workspace
Type Parameters
- T = Board[]
Parameters
- parameters: GetOrganizationBoards
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:154

getOrganizationExports

getOrganizationExports<T>(parameters, callback): Promise<void>
Retrieve the exports that exist for the given organization
Type Parameters
- T = Export[]
Parameters
- parameters: GetOrganizationExports
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:175
getOrganizationExports<T>(parameters, callback?): Promise<T>
Retrieve the exports that exist for the given organization
Type Parameters
- T = Export[]
Parameters
- parameters: GetOrganizationExports
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:180

getOrganizationField

getOrganizationField<T>(parameters, callback): Promise<void>
Type Parameters
- T = Organization
Parameters
- parameters: GetOrganizationField
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:106
getOrganizationField<T>(parameters, callback?): Promise<T>
Type Parameters
- T = Organization
Parameters
- parameters: GetOrganizationField
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:110

getOrganizationMembers

getOrganizationMembers<T>(parameters, callback): Promise<void>
List the members in a Workspace
Type Parameters
- T = Member[]
Parameters
- parameters: GetOrganizationMembers
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:222
getOrganizationMembers<T>(parameters, callback?): Promise<T>
List the members in a Workspace
Type Parameters
- T = Member[]
Parameters
- parameters: GetOrganizationMembers
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:227

getOrganizationMembership

getOrganizationMembership<T>(parameters, callback): Promise<void>
Get a single Membership for an Organization
Type Parameters
- T = unknown
Parameters
- parameters: GetOrganizationMembership
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:295
getOrganizationMembership<T>(parameters, callback?): Promise<T>
Get a single Membership for an Organization
Type Parameters
- T = unknown
Parameters
- parameters: GetOrganizationMembership
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:300

getOrganizationMemberships

getOrganizationMemberships<T>(parameters, callback): Promise<void>
List the memberships of a Workspace
Type Parameters
- T = Memberships[]
Parameters
- parameters: GetOrganizationMemberships
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:269
getOrganizationMemberships<T>(parameters, callback?): Promise<T>
List the memberships of a Workspace
Type Parameters
- T = Memberships[]
Parameters
- parameters: GetOrganizationMemberships
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:274

getOrganizationNewBillableGuestBoard

getOrganizationNewBillableGuestBoard<T>(parameters, callback): Promise<void>
Used to check whether the given board has new billable guests on it.
Type Parameters
- T = unknown
Parameters
- parameters: GetOrganizationNewBillableGuestBoard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:580
getOrganizationNewBillableGuestBoard<T>(parameters, callback?): Promise<T>
Used to check whether the given board has new billable guests on it.
Type Parameters
- T = unknown
Parameters
- parameters: GetOrganizationNewBillableGuestBoard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:585

getOrganizationPluginData

getOrganizationPluginData<T>(parameters, callback): Promise<void>
Get organization scoped pluginData on this Workspace
Type Parameters
- T = PluginData[]
Parameters
- parameters: GetOrganizationPluginData
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:320
getOrganizationPluginData<T>(parameters, callback?): Promise<T>
Get organization scoped pluginData on this Workspace
Type Parameters
- T = PluginData[]
Parameters
- parameters: GetOrganizationPluginData
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:325

getOrganizationTags

getOrganizationTags<T>(parameters, callback): Promise<void>
List the organization's collections
Type Parameters
- T = Tag[]
Parameters
- parameters: GetOrganizationTags
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:342
getOrganizationTags<T>(parameters, callback?): Promise<T>
List the organization's collections
Type Parameters
- T = Tag[]
Parameters
- parameters: GetOrganizationTags
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:347

setOrganizationLogo

setOrganizationLogo<T>(parameters, callback): Promise<void>
Set the logo image for a Workspace
Type Parameters
- T = unknown
Parameters
- parameters: SetOrganizationLogo
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:452

updateOrganization

updateOrganization<T>(parameters, callback): Promise<void>
Update an organization
Type Parameters
- T = Organization
Parameters
- parameters: UpdateOrganization
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:52
updateOrganization<T>(parameters, callback?): Promise<T>
Update an organization
Type Parameters
- T = Organization
Parameters
- parameters: UpdateOrganization
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:57

updateOrganizationDeactivateStatus

updateOrganizationDeactivateStatus<T>(parameters, callback): Promise<void>
Deactivate or reactivate a member of a Workspace
Type Parameters
- T = unknown
Parameters
- parameters: UpdateOrganizationDeactivateStatus
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:427
updateOrganizationDeactivateStatus<T>(parameters, callback?): Promise<T>
Deactivate or reactivate a member of a Workspace
Type Parameters
- T = unknown
Parameters
- parameters: UpdateOrganizationDeactivateStatus
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:432

updateOrganizationMember

updateOrganizationMember<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: UpdateOrganizationMember
- callback: Callback<T>
Returns Promise<void>
- Defined in api/organizations.ts:243
updateOrganizationMember<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: UpdateOrganizationMember
- Optional callback: undefined
Returns Promise<T>
- Defined in api/organizations.ts:247

Class Organizations

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns Organizations

Properties

Private client

Methods

addOrganizationMember

Type Parameters

T = unknown

Parameters

parameters: AddOrganizationMember

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: AddOrganizationMember

Optional callback: undefined

Returns Promise<T>

createOrganization

Type Parameters

T = unknown

Parameters

parameters: CreateOrganization

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: CreateOrganization

Optional callback: undefined

Returns Promise<T>

createOrganizationTag

Type Parameters

T = unknown

Parameters

parameters: CreateOrganizationTag

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: CreateOrganizationTag

Optional callback: undefined

Returns Promise<T>

deleteOrganization

Type Parameters

T = unknown

Parameters

parameters: DeleteOrganization

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: DeleteOrganization

Optional callback: undefined

Returns Promise<T>

deleteOrganizationAssociatedDomain

Type Parameters

T = unknown

Parameters

parameters: DeleteOrganizationAssociatedDomain

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: DeleteOrganizationAssociatedDomain

Optional callback: undefined

Returns Promise<T>

deleteOrganizationInvites

`Private` client

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined