Class OrganizationService

Index

Constructors

Methods

createOrganization deleteOrganization getOrganization listOrganization updateOrganization

Constructors

constructor

new OrganizationService(): OrganizationService
Returns OrganizationService

Methods

`Static`createOrganization

createOrganization<ThrowOnError extends boolean = false>(
    options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & CreateOrganizationData & Pick<
        RequestOptions<ThrowOnError, string>,
        "headers",
    >,
): RequestResult<entity_Organization, unknown, ThrowOnError>
Create organization Create a new organization
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & CreateOrganizationData & Pick<
  RequestOptions<ThrowOnError, string>,
  "headers",
  >
Returns RequestResult<entity_Organization, unknown, ThrowOnError>
- Defined in sdk.gen.ts:154

`Static`deleteOrganization

deleteOrganization<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & DeleteOrganizationData,
): RequestResult<string, unknown, ThrowOnError>
Delete organization Delete specified organization by ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & DeleteOrganizationData
Returns RequestResult<string, unknown, ThrowOnError>
- Defined in sdk.gen.ts:165

`Static`getOrganization

getOrganization<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GetOrganizationData,
): RequestResult<entity_Organization, unknown, ThrowOnError>
Get organization Get organization information by organization ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GetOrganizationData
Returns RequestResult<entity_Organization, unknown, ThrowOnError>
- Defined in sdk.gen.ts:176

`Static`listOrganization

listOrganization<ThrowOnError extends boolean = false>(
options?: OmitKeys<RequestOptions<ThrowOnError, string>, "url">,
): RequestResult<ListOrganizationResponse, unknown, ThrowOnError>
List organizations List all organizations
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- Optionaloptions: OmitKeys<RequestOptions<ThrowOnError, string>, "url">
Returns RequestResult<ListOrganizationResponse, unknown, ThrowOnError>
- Defined in sdk.gen.ts:143

`Static`updateOrganization

updateOrganization<ThrowOnError extends boolean = false>(
    options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & UpdateOrganizationData & Pick<
        RequestOptions<ThrowOnError, string>,
        "headers",
    >,
): RequestResult<entity_Organization, unknown, ThrowOnError>
Update organization Update the specified organization
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & UpdateOrganizationData & Pick<
  RequestOptions<ThrowOnError, string>,
  "headers",
  >
Returns RequestResult<entity_Organization, unknown, ThrowOnError>
- Defined in sdk.gen.ts:187