Function OrganizationsApiFp

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

• organizationsCreate:function

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

    Parameters

    • organizationWriteRequest: OrganizationWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• organizationsDestroy:function

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

    Parameters

    • id: number

      A unique integer value identifying this organization.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• organizationsList:function

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

    Parameters

    • Optionalfilter: 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;].
    • Optionalname: string

      A simple equality filter for the name field
    • Optionalowner: string

      A simple equality filter for the owner field
    • Optionalpage: number

      A page number within the paginated result set.
    • OptionalpageSize: number

      Number of results to return per page.
    • Optionalsearch: string

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

      A simple equality filter for the slug field
    • Optionalsort: string

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

      Override http request option.

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

    Throws

• organizationsPartialUpdate:function

  • organizationsPartialUpdate(
        id: number,
        patchedOrganizationWriteRequest?: PatchedOrganizationWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<OrganizationRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this organization.
    • OptionalpatchedOrganizationWriteRequest: PatchedOrganizationWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• organizationsRetrieve:function

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

    Parameters

    • id: number

      A unique integer value identifying this organization.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws