Class Enterprises

Hierarchy

Enterprises

Index

Constructors

Properties

Methods

createEnterpriseToken deactivateEnterpriseMember deleteEnterpriseMemberAdmin deleteEnterpriseOrganization getEnterprise getEnterpriseAdmins getEnterpriseAuditLog getEnterpriseMember getEnterpriseMembers getEnterpriseSignupUrl getEnterpriseTransferrableOrganization getEnterprisesIdClaimableOrganizations getEnterprisesIdPendingOrganizations makeEnterpriseMemberAdmin transferOrganizationToEnterprise updateEnterpriseMemberLicense

Constructors

constructor

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

Properties

`Private` client

client: Client

Methods

createEnterpriseToken

createEnterpriseToken<T>(parameters, callback): Promise<void>
Create an auth Token for an Enterprise.
Type Parameters
- T = unknown
Parameters
- parameters: CreateEnterpriseToken
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:253
createEnterpriseToken<T>(parameters, callback?): Promise<T>
Create an auth Token for an Enterprise.
Type Parameters
- T = unknown
Parameters
- parameters: CreateEnterpriseToken
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:258

deactivateEnterpriseMember

deactivateEnterpriseMember<T>(parameters, callback): Promise<void>
Deactivate a Member of an Enterprise.
Type Parameters
- T = unknown
Parameters
- parameters: DeactivateEnterpriseMember
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:325
deactivateEnterpriseMember<T>(parameters, callback?): Promise<T>
Deactivate a Member of an Enterprise.
Type Parameters
- T = unknown
Parameters
- parameters: DeactivateEnterpriseMember
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:330

deleteEnterpriseMemberAdmin

deleteEnterpriseMemberAdmin<T>(parameters, callback): Promise<void>
Remove a member as admin from an enterprise.
Type Parameters
- T = unknown
Parameters
- parameters: DeleteEnterpriseMemberAdmin
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:375
deleteEnterpriseMemberAdmin<T>(parameters, callback?): Promise<T>
Remove a member as admin from an enterprise.
Type Parameters
- T = unknown
Parameters
- parameters: DeleteEnterpriseMemberAdmin
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:380

deleteEnterpriseOrganization

deleteEnterpriseOrganization<T>(parameters, callback): Promise<void>
Remove an organization from an enterprise.
Type Parameters
- T = unknown
Parameters
- parameters: DeleteEnterpriseOrganization
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:397
deleteEnterpriseOrganization<T>(parameters, callback?): Promise<T>
Remove an organization from an enterprise.
Type Parameters
- T = unknown
Parameters
- parameters: DeleteEnterpriseOrganization
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:402

getEnterprise

getEnterprise<T>(parameters, callback): Promise<void>
Get an enterprise by its ID.
Type Parameters
- T = Enterprise
Parameters
- parameters: GetEnterprise
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:10
getEnterprise<T>(parameters, callback?): Promise<T>
Get an enterprise by its ID.
Type Parameters
- T = Enterprise
Parameters
- parameters: GetEnterprise
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:15

getEnterpriseAdmins

getEnterpriseAdmins<T>(parameters, callback): Promise<void>
Get an enterprise's admin members.
Type Parameters
- T = EnterpriseAdmin
Parameters
- parameters: GetEnterpriseAdmins
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:74
getEnterpriseAdmins<T>(parameters, callback?): Promise<T>
Get an enterprise's admin members.
Type Parameters
- T = EnterpriseAdmin
Parameters
- parameters: GetEnterpriseAdmins
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:79

getEnterpriseAuditLog

getEnterpriseAuditLog<T>(parameters, callback?): Promise<void>
Returns an array of Actions related to the Enterprise object. Used for populating data sent to Google Sheets from an Enterprise's audit log page: https://trello.com/e/{enterprise_name}/admin/auditlog. An Enterprise admin token is required for this route.
Type Parameters
- T = EnterpriseAuditLog[]
Parameters
- parameters: GetEnterpriseAuditLog
- Optional callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:48
getEnterpriseAuditLog<T>(parameters, callback?): Promise<T>
Returns an array of Actions related to the Enterprise object. Used for populating data sent to Google Sheets from an Enterprise's audit log page: https://trello.com/e/{enterprise_name}/admin/auditlog. An Enterprise admin token is required for this route.
Type Parameters
- T = EnterpriseAuditLog[]
Parameters
- parameters: GetEnterpriseAuditLog
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:57

getEnterpriseMember

getEnterpriseMember<T>(parameters, callback): Promise<void>
Get a specific member of an enterprise by ID.
Type Parameters
- T = Member
Parameters
- parameters: GetEnterpriseMember
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:160
getEnterpriseMember<T>(parameters, callback?): Promise<T>
Get a specific member of an enterprise by ID.
Type Parameters
- T = Member
Parameters
- parameters: GetEnterpriseMember
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:165

getEnterpriseMembers

getEnterpriseMembers<T>(parameters, callback): Promise<void>
Get the members of an enterprise.
Type Parameters
- T = Member[]
Parameters
- parameters: GetEnterpriseMembers
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:127
getEnterpriseMembers<T>(parameters, callback?): Promise<T>
Get the members of an enterprise.
Type Parameters
- T = Member[]
Parameters
- parameters: GetEnterpriseMembers
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:132

getEnterpriseSignupUrl

getEnterpriseSignupUrl<T>(parameters, callback): Promise<void>
Get the signup URL for an enterprise.
Type Parameters
- T = GetEnterprisesIdSignupUrl
Parameters
- parameters: GetEnterpriseSignupUrl
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:99
getEnterpriseSignupUrl<T>(parameters, callback?): Promise<T>
Get the signup URL for an enterprise.
Type Parameters
- T = GetEnterprisesIdSignupUrl
Parameters
- parameters: GetEnterpriseSignupUrl
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:104

getEnterpriseTransferrableOrganization

getEnterpriseTransferrableOrganization<T>(parameters, callback): Promise<void>
Get whether an organization can be transferred to an enterprise.
Type Parameters
- T = TransferrableOrganization
Parameters
- parameters: GetEnterpriseTransferrableOrganization
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:187
getEnterpriseTransferrableOrganization<T>(parameters, callback?): Promise<T>
Get whether an organization can be transferred to an enterprise.
Type Parameters
- T = TransferrableOrganization
Parameters
- parameters: GetEnterpriseTransferrableOrganization
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:192

getEnterprisesIdClaimableOrganizations

getEnterprisesIdClaimableOrganizations<T>(parameters, callback): Promise<void>
Get the Workspaces that are claimable by the enterprise by ID.
Type Parameters
- T = ClaimableOrganizations
Parameters
- parameters: GetEnterprisesIdClaimableOrganizations
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:209
getEnterprisesIdClaimableOrganizations<T>(parameters, callback?): Promise<T>
Get the Workspaces that are claimable by the enterprise by ID.
Type Parameters
- T = ClaimableOrganizations
Parameters
- parameters: GetEnterprisesIdClaimableOrganizations
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:214

getEnterprisesIdPendingOrganizations

getEnterprisesIdPendingOrganizations<T>(parameters, callback): Promise<void>
Get the Workspaces that are pending for the enterprise by ID.
Type Parameters
- T = PendingOrganizations[]
Parameters
- parameters: GetEnterprisesIdPendingOrganizations
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:231
getEnterprisesIdPendingOrganizations<T>(parameters, callback?): Promise<T>
Get the Workspaces that are pending for the enterprise by ID.
Type Parameters
- T = PendingOrganizations[]
Parameters
- parameters: GetEnterprisesIdPendingOrganizations
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:236

makeEnterpriseMemberAdmin

makeEnterpriseMemberAdmin<T>(parameters, callback): Promise<void>
Make Member an admin of Enterprise.
Type Parameters
- T = unknown
Parameters
- parameters: MakeEnterpriseMemberAdmin
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:353
makeEnterpriseMemberAdmin<T>(parameters, callback?): Promise<T>
Make Member an admin of Enterprise.
Type Parameters
- T = unknown
Parameters
- parameters: MakeEnterpriseMemberAdmin
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:358

transferOrganizationToEnterprise

transferOrganizationToEnterprise<T>(parameters, callback): Promise<void>
Transfer an organization to an enterprise.
Type Parameters
- T = Organization[]
Parameters
- parameters: TransferOrganizationToEnterprise
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:275
transferOrganizationToEnterprise<T>(parameters, callback?): Promise<T>
Transfer an organization to an enterprise.
Type Parameters
- T = Organization[]
Parameters
- parameters: TransferOrganizationToEnterprise
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:280

updateEnterpriseMemberLicense

updateEnterpriseMemberLicense<T>(parameters, callback): Promise<void>
This endpoint is used to update whether the provided Member should use one of the Enterprise's available licenses or not.
Type Parameters
- T = Member
Parameters
- parameters: UpdateEnterpriseMemberLicense
- callback: Callback<T>
Returns Promise<void>
- Defined in api/enterprises.ts:300
updateEnterpriseMemberLicense<T>(parameters, callback?): Promise<T>
This endpoint is used to update whether the provided Member should use one of the Enterprise's available licenses or not.
Type Parameters
- T = Member
Parameters
- parameters: UpdateEnterpriseMemberLicense
- Optional callback: undefined
Returns Promise<T>
- Defined in api/enterprises.ts:305

Class Enterprises

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns Enterprises

Properties

Private client

Methods

createEnterpriseToken

Type Parameters

T = unknown

Parameters

parameters: CreateEnterpriseToken

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: CreateEnterpriseToken

Optional callback: undefined

Returns Promise<T>

deactivateEnterpriseMember

Type Parameters

T = unknown

Parameters

parameters: DeactivateEnterpriseMember

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: DeactivateEnterpriseMember

Optional callback: undefined

Returns Promise<T>

deleteEnterpriseMemberAdmin

Type Parameters

T = unknown

Parameters

parameters: DeleteEnterpriseMemberAdmin

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: DeleteEnterpriseMemberAdmin

Optional callback: undefined

Returns Promise<T>

deleteEnterpriseOrganization

Type Parameters

T = unknown

Parameters

parameters: DeleteEnterpriseOrganization

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: DeleteEnterpriseOrganization

Optional callback: undefined

Returns Promise<T>

getEnterprise

Type Parameters

T = Enterprise

Parameters

parameters: GetEnterprise

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = Enterprise

Parameters

parameters: GetEnterprise

Optional callback: undefined

Returns Promise<T>

getEnterpriseAdmins

`Private` client

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: Callback<T>

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined