Function CloudstoragesApiFp

Returns {
    cloudstoragesCreate(
        cloudStorageWriteRequest: CloudStorageWriteRequest,
        xOrganization?: string,
        org?: string,
        orgId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CloudStorageRead>,
    >;
    cloudstoragesDestroy(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    cloudstoragesList(
        xOrganization?: string,
        credentialsType?: CloudstoragesListCredentialsTypeEnum,
        filter?: string,
        name?: string,
        org?: string,
        orgId?: number,
        owner?: string,
        page?: number,
        pageSize?: number,
        providerType?: CloudstoragesListProviderTypeEnum,
        resource?: string,
        search?: string,
        sort?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedCloudStorageReadList>,
    >;
    cloudstoragesPartialUpdate(
        id: number,
        patchedCloudStorageWriteRequest?: PatchedCloudStorageWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CloudStorageRead>,
    >;
    cloudstoragesRetrieve(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CloudStorageRead>,
    >;
    cloudstoragesRetrieveActions(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >;
    cloudstoragesRetrieveContentV2(
        id: number,
        manifestPath?: string,
        nextToken?: string,
        pageSize?: number,
        prefix?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CloudStorageContent>,
    >;
    cloudstoragesRetrievePreview(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    cloudstoragesRetrieveStatus(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >;
}

• cloudstoragesCreate:function

  • cloudstoragesCreate(
        cloudStorageWriteRequest: CloudStorageWriteRequest,
        xOrganization?: string,
        org?: string,
        orgId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CloudStorageRead>,
    >

    Parameters

    • cloudStorageWriteRequest: CloudStorageWriteRequest
    • OptionalxOrganization: string

      Organization unique slug
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• cloudstoragesDestroy:function

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

    Parameters

    • id: number

      A unique integer value identifying this cloud storage.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• cloudstoragesList:function

  • cloudstoragesList(
        xOrganization?: string,
        credentialsType?: CloudstoragesListCredentialsTypeEnum,
        filter?: string,
        name?: string,
        org?: string,
        orgId?: number,
        owner?: string,
        page?: number,
        pageSize?: number,
        providerType?: CloudstoragesListProviderTypeEnum,
        resource?: string,
        search?: string,
        sort?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedCloudStorageReadList>,
    >

    Parameters

    • OptionalxOrganization: string

      Organization unique slug
    • OptionalcredentialsType: CloudstoragesListCredentialsTypeEnum

      A simple equality filter for the credentials_type field
    • 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;provider_type&#39;, &#39;name&#39;, &#39;resource&#39;, &#39;credentials_type&#39;, &#39;owner&#39;, &#39;description&#39;, &#39;id&#39;].
    • Optionalname: string

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

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • 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.
    • OptionalproviderType: CloudstoragesListProviderTypeEnum

      A simple equality filter for the provider_type field
    • Optionalresource: string

      A simple equality filter for the resource field
    • Optionalsearch: string

      A search term. Available search_fields: (&#39;provider_type&#39;, &#39;name&#39;, &#39;resource&#39;, &#39;credentials_type&#39;, &#39;owner&#39;, &#39;description&#39;)
    • Optionalsort: string

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

      Override http request option.

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

    Throws

• cloudstoragesPartialUpdate:function

  • cloudstoragesPartialUpdate(
        id: number,
        patchedCloudStorageWriteRequest?: PatchedCloudStorageWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CloudStorageRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this cloud storage.
    • OptionalpatchedCloudStorageWriteRequest: PatchedCloudStorageWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• cloudstoragesRetrieve:function

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

    Parameters

    • id: number

      A unique integer value identifying this cloud storage.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• cloudstoragesRetrieveActions:function

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

    Method return allowed actions for cloud storage. It's required for reading/writing

    Parameters

    • id: number

      A unique integer value identifying this cloud storage.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• cloudstoragesRetrieveContentV2:function

  • cloudstoragesRetrieveContentV2(
        id: number,
        manifestPath?: string,
        nextToken?: string,
        pageSize?: number,
        prefix?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CloudStorageContent>,
    >

    Parameters

    • id: number

      A unique integer value identifying this cloud storage.
    • OptionalmanifestPath: string

      Path to the manifest file in a cloud storage
    • OptionalnextToken: string

      Used to continue listing files in the bucket
    • OptionalpageSize: number
    • Optionalprefix: string

      Prefix to filter data
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• cloudstoragesRetrievePreview:function

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

    Parameters

    • id: number

      A unique integer value identifying this cloud storage.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• cloudstoragesRetrieveStatus:function

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

    Parameters

    • id: number

      A unique integer value identifying this cloud storage.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws