Function OrganizationsApiFp

Returns {
    organizationsCreate(organizationWriteRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<OrganizationRead>)>;
    organizationsDestroy(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    organizationsList(filter?, name?, owner?, page?, pageSize?, search?, slug?, sort?, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaginatedOrganizationReadList>)>;
    organizationsPartialUpdate(id, patchedOrganizationWriteRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<OrganizationRead>)>;
    organizationsRetrieve(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<OrganizationRead>)>;
}

• organizationsCreate:function

  • organizationsCreate(organizationWriteRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<OrganizationRead>)>

  • Parameters

    • organizationWriteRequest: OrganizationWriteRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<OrganizationRead>)>

    Summary

    Method creates an organization

    Throws

• organizationsDestroy:function

  • organizationsDestroy(id, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • id: number

      A unique integer value identifying this organization.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Method deletes an organization

    Throws

• organizationsList:function

  • organizationsList(filter?, name?, owner?, page?, pageSize?, search?, slug?, sort?, options?): Promise<((axios?, basePath?) => AxiosPromise<PaginatedOrganizationReadList>)>

  • Parameters

    • Optional filter: string

      JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;name&#39;, &#39;owner&#39;, &#39;slug&#39;, &#39;id&#39;].

    • Optional name: string

      A simple equality filter for the name field

    • Optional owner: string

      A simple equality filter for the owner field

    • Optional page: number

      A page number within the paginated result set.

    • Optional pageSize: number

      Number of results to return per page.

    • Optional search: string

      A search term. Available search_fields: (&#39;name&#39;, &#39;owner&#39;, &#39;slug&#39;)

    • Optional slug: string

      A simple equality filter for the slug field

    • Optional sort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;name&#39;, &#39;owner&#39;, &#39;slug&#39;, &#39;id&#39;]

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<PaginatedOrganizationReadList>)>

    Summary

    Method returns a paginated list of organizations

    Throws

• organizationsPartialUpdate:function

  • organizationsPartialUpdate(id, patchedOrganizationWriteRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<OrganizationRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this organization.

    • Optional patchedOrganizationWriteRequest: PatchedOrganizationWriteRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<OrganizationRead>)>

    Summary

    Methods does a partial update of chosen fields in an organization

    Throws

• organizationsRetrieve:function

  • organizationsRetrieve(id, options?): Promise<((axios?, basePath?) => AxiosPromise<OrganizationRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this organization.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<OrganizationRead>)>

    Summary

    Method returns details of an organization

    Throws