Company | iland-sdk

Company.

Hierarchy

Entity
- Company

Index

Constructors

constructor

Accessors

Constructors

constructor

new Company(_json: CompanyJson): Company

Overrides Entity.constructor
- Defined in model/company/company.ts:56
Parameters
- _json: CompanyJson
Returns Company

Accessors

companyId

companyId:

Gets the ID of the company that the entity belongs to.

deleted

deleted:

Indicates whether the entity is deleted.

deletedDate

deletedDate:

Gets the date that the entity was deleted, or null if it is not deleted.

entityType

entityType:

hasIlandBackup

hasIlandBackup:

Indicates whether the company has the iland backup product.

hasIlandCloud

hasIlandCloud:

Indicates whether the company has the iland cloud product.

hasIlandObjectStorage

hasIlandObjectStorage:

Indicates whether the company has the iland Object Storage product

json

json:

Gets the raw JSON object from the API.

name

name:

Gets the name.

updatedDate

updatedDate:

Gets the last date that the entity was updated.

uuid

uuid:

Gets the UUID.

Methods

createRole

createRole(request: RoleCreationRequest): Promise<Role>

- Defined in model/company/company.ts:155
Creates a new company role.

Parameters
- request: RoleCreationRequest
Returns Promise<Role>

a promise with the newly created role

createSupportTicket

createSupportTicket(newSupportTicket: SupportTicketCreateRequest): Promise<SupportTicket>

- Defined in model/company/company.ts:449
Creates a new support ticket. @param {SupportTicketCreateRequest} newSupportTicket @returns {Promise}

Parameters
- newSupportTicket: SupportTicketCreateRequest
Returns Promise<SupportTicket>

createUser

createUser(request: UserCreateRequest): Promise<User>

- Defined in model/company/company.ts:222
Creates a new company user.

Parameters
- request: UserCreateRequest
Returns Promise<User>

a promise with the newly created user

deleteLogo

deleteLogo(): Promise<any>

- Defined in model/company/company.ts:439
Delete a company logo

Returns Promise<any>

deleteRole

deleteRole(uuid: string): Promise<void>

- Defined in model/company/company.ts:177
Deletes a new company role.

Parameters
- uuid: string
Returns Promise<void>

a promise that indicates success or failure

getCatalogs

getCatalogs(locationId: string): Promise<Array<Catalog>>

- Defined in model/company/company.ts:372
Gets all catalogs in the company location.

Parameters
- locationId: string
Returns Promise<Array<Catalog>>

getCloudTenantBillingHistory

getCloudTenantBillingHistory(location?: undefined | string, startYear?: undefined | number, startMonth?: undefined | number, endYear?: undefined | number, endMonth?: undefined | number): Promise<CloudTenantBillHistory>

- Defined in model/company/company.ts:507
Get the billing history for the cloud tenants.

Parameters
- Optional location: undefined | string
- Optional startYear: undefined | number
- Optional startMonth: undefined | number
- Optional endYear: undefined | number
- Optional endMonth: undefined | number
Returns Promise<CloudTenantBillHistory>

promise resolving to the cloud tenant billing history

getCloudTenants

getCloudTenants(location?: undefined | string): Promise<Array<CloudTenant>>

- Defined in model/company/company.ts:477
Get all cloud tenants in company location.

Parameters
- Optional location: undefined | string
Returns Promise<Array<CloudTenant>>

getEdges

getEdges(locationId: string): Promise<Array<Edge>>

- Defined in model/company/company.ts:315
Get all edges in the company location.

Parameters
- locationId: string
Returns Promise<Array<Edge>>

getLogo

getLogo(): Promise<Uint8Array | null>

- Defined in model/company/company.ts:422
Get a company logo

Returns Promise<Uint8Array | null>

getMedia

getMedia(locationId: string): Promise<Array<Media>>

- Defined in model/company/company.ts:328
Get all media in the company location.

Parameters
- locationId: string
Returns Promise<Array<Media>>

getOrgVdcNetworks

getOrgVdcNetworks(locationId: string): Promise<Array<InternalNetwork>>

- Defined in model/company/company.ts:385
Gets all internal networks in the company location.

Parameters
- locationId: string
Returns Promise<Array<InternalNetwork>>

getOrganizations

getOrganizations(locationId: string): Promise<Array<Org>>

- Defined in model/company/company.ts:266
Get all organizations in the company location

Parameters
- locationId: string
Returns Promise<Array<Org>>

getRole

getRole(uuid: string): Promise<Role>

- Defined in model/company/company.ts:144
Get a company role.

Parameters
- uuid: string
Returns Promise<Role>

a promise with the queried role

getRoles

getRoles(): Promise<Array<Role>>

- Defined in model/company/company.ts:133
Get company roles.

Returns Promise<Array<Role>>

task promise

getSupportTicket

getSupportTicket(ticketId: number): Promise<SupportTicket>

- Defined in model/company/company.ts:254
Get a specified support ticket.

Parameters
- ticketId: number
Returns Promise<SupportTicket>

getSupportTicketRegardingOptions

getSupportTicketRegardingOptions(): Promise<Array<SupportRegardingOption>>

- Defined in model/company/company.ts:495
Get support ticket regarding options.

Returns Promise<Array<SupportRegardingOption>>

getSupportTickets

getSupportTickets(offset?: undefined | number, limit?: undefined | number, search?: undefined | string): Promise<Array<SupportTicket>>

- Defined in model/company/company.ts:236
Get all support tickets

Parameters
- Optional offset: undefined | number
- Optional limit: undefined | number
- Optional search: undefined | string
Returns Promise<Array<SupportTicket>>

getTasks

getTasks(filters?: CompanyTaskFilterParams): Promise<TaskList>

- Defined in model/company/company.ts:528
Get company tasks.

Parameters
- Optional filters: CompanyTaskFilterParams
  
  used to get tasks matching specific criteria
Returns Promise<TaskList>

a promise that resolves with a task list

getUserDomains

getUserDomains(): Promise<Array<string>>

- Defined in model/company/company.ts:212
A company may have multiple user domains if they have users that are shared with other companies. This method returns the identifiers for all domains that are associated with this company.

Returns Promise<Array<string>>

a promise with the list of the company user domains

getUsers

getUsers(): Promise<Array<CompanyUser>>

- Defined in model/company/company.ts:185
Gets all company users.

Returns Promise<Array<CompanyUser>>

a promise with the list of the company users

getUsersWithRole

getUsersWithRole(roleUuid: string): Promise<Array<User>>

- Defined in model/company/company.ts:196
Gets all company users that are assigned to a specified role.

Parameters
- roleUuid: string
Returns Promise<Array<User>>

a promise with the list of the company users that are assigned to the role

getVappNetworks

getVappNetworks(locationId: string): Promise<Array<VappNetwork>>

- Defined in model/company/company.ts:398
Gets all the vApp networks in the company location.

Parameters
- locationId: string
Returns Promise<Array<VappNetwork>>

getVappTemplates

getVappTemplates(locationId: string): Promise<Array<VappTemplate>>

- Defined in model/company/company.ts:341
Get all vApp templates in the company location.

Parameters
- locationId: string
Returns Promise<Array<VappTemplate>>

getVapps

getVapps(locationId: string): Promise<Array<Vapp>>

- Defined in model/company/company.ts:278
Get all vApps in the company location

Parameters
- locationId: string
Returns Promise<Array<Vapp>>

getVdcs

getVdcs(locationId: string): Promise<Array<Vdc>>

- Defined in model/company/company.ts:290
Get all vDCs in the company location

Parameters
- locationId: string
Returns Promise<Array<Vdc>>

getVms

getVms(locationId: string): Promise<Array<Vm>>

- Defined in model/company/company.ts:302
Get all VMs in the company location

Parameters
- locationId: string
Returns Promise<Array<Vm>>

getVpgs

getVpgs(locationId: string, expand?: Array<VpgSubEntityRequest>): Promise<Array<ExpandedVpg>>

- Defined in model/company/company.ts:355
Gets all VPGs in the company location.

Parameters
- locationId: string
- Optional expand: Array<VpgSubEntityRequest>
Returns Promise<Array<ExpandedVpg>>

refresh

refresh(): Promise<Company>

- Defined in model/company/company.ts:122
Refreshes the Company data by retrieving it from the API again.

Returns Promise<Company>

promise that resolves with this object

search

search(query?: undefined | string, pageOffset?: undefined | number, pageSize?: undefined | number): Promise<SearchResult>

- Defined in model/company/company.ts:546
Perform a full-text search of entities pertaining to this company.

Parameters
- Optional query: undefined | string
  
  Query string
- Optional pageOffset: undefined | number
  
  Page offset for return documents
- Optional pageSize: undefined | number
  
  Number of hits per page (default value is 10 and maximum is 50)
Returns Promise<SearchResult>

a promise that resolves with a SearchResult

setLogo

setLogo(logo: Uint8Array): Promise<any>

- Defined in model/company/company.ts:410
Change the company logo

Parameters
- logo: Uint8Array
Returns Promise<any>

toString

toString(): string

- Defined in model/company/company.ts:114
JSON format.

Returns string

updateRole

updateRole(uuid: string, request: RoleCreationRequest): Promise<Role>

- Defined in model/company/company.ts:166
Updates a company role.

Parameters
- uuid: string
- request: RoleCreationRequest
Returns Promise<Role>

a promise with the newly created role that has replaced the original

updateSupportTicket

updateSupportTicket(ticketId: number, supportTicket: SupportTicketUpdateRequest): Promise<SupportTicket>

- Defined in model/company/company.ts:463
Updates a support ticket.

Parameters
- ticketId: number
- supportTicket: SupportTicketUpdateRequest
Returns Promise<SupportTicket>

Static getCompany

getCompany(id: string): Promise<Company>

- Defined in model/company/company.ts:67
Gets an Company by ID.

Parameters
- id: string
  
  Company ID
Returns Promise<Company>

promise that resolves with the Company

Generated using TypeDoc

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

_json: CompanyJson

Returns Company

Accessors

companyId

deleted

deletedDate

entityType

hasIlandBackup

hasIlandCloud

hasIlandObjectStorage

json

name

updatedDate

uuid

Methods

createRole

Parameters

request: RoleCreationRequest

Returns Promise<Role>

createSupportTicket

Parameters

newSupportTicket: SupportTicketCreateRequest

Returns Promise<SupportTicket>

createUser

Parameters

request: UserCreateRequest

Returns Promise<User>

deleteLogo

Returns Promise<any>

deleteRole

Parameters

uuid: string

Returns Promise<void>

getCatalogs

Parameters

locationId: string

Returns Promise<Array<Catalog>>

getCloudTenantBillingHistory

Parameters

Optional location: undefined | string

Optional startYear: undefined | number

Optional startMonth: undefined | number

Optional endYear: undefined | number

Optional endMonth: undefined | number

Returns Promise<CloudTenantBillHistory>

getCloudTenants

Parameters

Optional location: undefined | string

Returns Promise<Array<CloudTenant>>

getEdges

Parameters

locationId: string

Returns Promise<Array<Edge>>

getLogo

Returns Promise<Uint8Array | null>

getMedia

Parameters

locationId: string

Returns Promise<Array<Media>>

getOrgVdcNetworks

Parameters

locationId: string

Returns Promise<Array<InternalNetwork>>

getOrganizations

Parameters

locationId: string

Returns Promise<Array<Org>>

getRole

Parameters

uuid: string

Returns Promise<Role>

getRoles