Interface OrganizationApi

interface OrganizationApi {
    createOrganization(input): Promise<CreateOrganizationResponse<unknown>>;
    getOrganization(input): Promise<OrganizationResponse<unknown>>;
    getRequiredVersion(): string;
    listOrganizations(input): Promise<PaginatedResponse<OrganizationResponse<unknown>>>;
    listOrganizationsForUser(input): Promise<PaginatedResponse<OrganizationResponse<unknown>>>;
    listUsersForOrganization(input): Promise<PaginatedResponse<OrganizationUsersResponse>>;
    ping(): Promise<PingResponse>;
    updateOrganization(input): Promise<OrganizationResponse<unknown>>;
}

Hierarchy

BackendApi
- OrganizationApi

Implemented by

OrganizationDefaultAdapterApi

Index

Methods

createOrganization getOrganization getRequiredVersion listOrganizations listOrganizationsForUser listUsersForOrganization ping updateOrganization

Methods

createOrganization

createOrganization(input): Promise<CreateOrganizationResponse<unknown>>
Creates an organization in the organization service
Parameters
- input: CreateOrganizationDto<unknown>
Returns Promise<CreateOrganizationResponse<unknown>>
- Defined in src/api/organization.ts:26

getOrganization

getOrganization(input): Promise<OrganizationResponse<unknown>>
Gets an organization using an organization id
Parameters
- input: GetOrganizationInput
Returns Promise<OrganizationResponse<unknown>>
- Defined in src/api/organization.ts:32

getRequiredVersion

getRequiredVersion(): string
On setup, we can call getRequiredVersion and ping() to confirm that the service exists and that it is of a matching version semantically E.g. if required version is ~2.5 and the api returns 2.6.3, then no issue If returns 3.0.1, should log a warning If returns 1.0.2, should throw error saying it isn't new enough

Returns string
Inherited from BackendApi.getRequiredVersion
- Defined in src/api/types.ts:83

listOrganizations

listOrganizations(input): Promise<PaginatedResponse<OrganizationResponse<unknown>>>
Lists organizations using query parameters
Parameters
- input: ListOrganizationsInput
Returns Promise<PaginatedResponse<OrganizationResponse<unknown>>>
- Defined in src/api/organization.ts:36

listOrganizationsForUser

listOrganizationsForUser(input): Promise<PaginatedResponse<OrganizationResponse<unknown>>>
List organizations for a specified user using userId and query parameters
Parameters
- input: ListOrganizationsForUserInput
Returns Promise<PaginatedResponse<OrganizationResponse<unknown>>>
- Defined in src/api/organization.ts:43

listUsersForOrganization

listUsersForOrganization(input): Promise<PaginatedResponse<OrganizationUsersResponse>>
Lists users for an organization using the organization id and query parameters
Parameters
- input: ListUsersForOrganizationInput
Returns Promise<PaginatedResponse<OrganizationUsersResponse>>
- Defined in src/api/organization.ts:49

ping

ping(): Promise<PingResponse>
Ping the backend service to check that it is alive and well

Returns Promise<PingResponse>
Inherited from BackendApi.ping
- Defined in src/api/types.ts:88

updateOrganization

updateOrganization(input): Promise<OrganizationResponse<unknown>>
Updates an organization using the organization id and update payload
Parameters
- input: UpdateOrganizationInput<unknown>
Returns Promise<OrganizationResponse<unknown>>
- Defined in src/api/organization.ts:56

Generated using TypeDoc