Function CloudstoragesApiFp

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

• cloudstoragesCreate:function

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

  • Parameters

    • cloudStorageWriteRequest: CloudStorageWriteRequest

    • Optional xOrganization: string

      Organization unique slug

    • Optional org: string

      Organization unique slug

    • Optional orgId: number

      Organization identifier

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method creates a cloud storage with a specified characteristics

    Throws

• cloudstoragesDestroy:function

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

  • Parameters

    • id: number

      A unique integer value identifying this cloud storage.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method deletes a specific cloud storage

    Throws

• cloudstoragesList:function

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

  • Parameters

    • Optional xOrganization: string

      Organization unique slug

    • Optional credentialsType: CloudstoragesListCredentialsTypeEnum

      A simple equality filter for the credentials_type field

    • 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;provider_type&#39;, &#39;name&#39;, &#39;resource&#39;, &#39;credentials_type&#39;, &#39;owner&#39;, &#39;description&#39;, &#39;id&#39;].

    • Optional name: string

      A simple equality filter for the name field

    • Optional org: string

      Organization unique slug

    • Optional orgId: number

      Organization identifier

    • 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 providerType: CloudstoragesListProviderTypeEnum

      A simple equality filter for the provider_type field

    • Optional resource: string

      A simple equality filter for the resource field

    • Optional search: 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;)

    • Optional sort: 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;]

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Returns a paginated list of storages

    Throws

• cloudstoragesPartialUpdate:function

  • cloudstoragesPartialUpdate(id, patchedCloudStorageWriteRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<CloudStorageRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this cloud storage.

    • Optional patchedCloudStorageWriteRequest: PatchedCloudStorageWriteRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Methods does a partial update of chosen fields in a cloud storage instance

    Throws

• cloudstoragesRetrieve:function

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

  • Parameters

    • id: number

      A unique integer value identifying this cloud storage.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method returns details of a specific cloud storage

    Throws

• cloudstoragesRetrieveActions:function

  • cloudstoragesRetrieveActions(id, options?): Promise<((axios?, basePath?) => 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.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method returns allowed actions for the cloud storage

    Throws

• cloudstoragesRetrieveContentV2:function

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

  • Parameters

    • id: number

      A unique integer value identifying this cloud storage.

    • Optional manifestPath: string

      Path to the manifest file in a cloud storage

    • Optional nextToken: string

      Used to continue listing files in the bucket

    • Optional pageSize: number

    • Optional prefix: string

      Prefix to filter data

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method returns the content of the cloud storage

    Throws

• cloudstoragesRetrievePreview:function

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

  • Parameters

    • id: number

      A unique integer value identifying this cloud storage.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method returns a preview image from a cloud storage

    Throws

• cloudstoragesRetrieveStatus:function

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

  • Parameters

    • id: number

      A unique integer value identifying this cloud storage.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method returns a cloud storage status

    Throws