Function OrganizationsApiFactory

Returns {
    organizationsCreate(requestParameters, options?) => AxiosPromise<OrganizationRead>;
    organizationsDestroy(requestParameters, options?) => AxiosPromise<void>;
    organizationsList(requestParameters?, options?) => AxiosPromise<PaginatedOrganizationReadList>;
    organizationsPartialUpdate(requestParameters, options?) => AxiosPromise<OrganizationRead>;
    organizationsRetrieve(requestParameters, options?) => AxiosPromise<OrganizationRead>;
}

• organizationsCreate:function

  • organizationsCreate(requestParameters, options?): AxiosPromise<OrganizationRead>

  • Parameters

    • requestParameters: OrganizationsApiOrganizationsCreateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<OrganizationRead>

    Summary

    Method creates an organization

    Throws

• organizationsDestroy:function

  • organizationsDestroy(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: OrganizationsApiOrganizationsDestroyRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method deletes an organization

    Throws

• organizationsList:function

  • organizationsList(requestParameters?, options?): AxiosPromise<PaginatedOrganizationReadList>

  • Parameters

    • requestParameters: OrganizationsApiOrganizationsListRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaginatedOrganizationReadList>

    Summary

    Method returns a paginated list of organizations

    Throws

• organizationsPartialUpdate:function

  • organizationsPartialUpdate(requestParameters, options?): AxiosPromise<OrganizationRead>

  • Parameters

    • requestParameters: OrganizationsApiOrganizationsPartialUpdateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<OrganizationRead>

    Summary

    Methods does a partial update of chosen fields in an organization

    Throws

• organizationsRetrieve:function

  • organizationsRetrieve(requestParameters, options?): AxiosPromise<OrganizationRead>

  • Parameters

    • requestParameters: OrganizationsApiOrganizationsRetrieveRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<OrganizationRead>

    Summary

    Method returns details of an organization

    Throws