OrganizationManagement | @signageos/sdk

Hierarchy

OrganizationManagement

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OrganizationManagement(options: IOptions): OrganizationManagement

- Defined in src/RestApi/Organization/OrganizationManagement.ts:15
Parameters
- options: IOptions
Returns OrganizationManagement

Properties

Private options

options: IOptions

Static Readonly RESOURCE

RESOURCE: string = "organization"

Methods

create

create(settings: IOrganizationCreatable): Promise<Organization>

- Defined in src/RestApi/Organization/OrganizationManagement.ts:40
Parameters
- settings: IOrganizationCreatable
Returns Promise<Organization>

delete

delete(organizationUid: string): Promise<void>

- Defined in src/RestApi/Organization/OrganizationManagement.ts:61
Parameters
- organizationUid: string
Returns Promise<void>

get

get(orgUid: string, filter?: IOrganizationFilter): Promise<Organization>

- Defined in src/RestApi/Organization/OrganizationManagement.ts:34
Parameters
- orgUid: string
- Default value filter: IOrganizationFilter = {}
Returns Promise<Organization>

list

list(filter?: IOrganizationFilter): Promise<IOrganization[]>

- Defined in src/RestApi/Organization/OrganizationManagement.ts:20
Parameters
- Default value filter: IOrganizationFilter = {}
Returns Promise<IOrganization[]>

setSubscriptionType

setSubscriptionType(organizationUid: string, subscription: SubscriptionType): Promise<void>

- Defined in src/RestApi/Organization/OrganizationManagement.ts:53
Parameters
- organizationUid: string
- subscription: SubscriptionType
Returns Promise<void>

update

update(organizationUid: string, values: OrganizationUpdatableValues): Promise<void>

- Defined in src/RestApi/Organization/OrganizationManagement.ts:68
Parameters
- organizationUid: string
- values: OrganizationUpdatableValues
Returns Promise<void>

Generated using TypeDoc