Function CloudstoragesApiAxiosParamCreator

  • CloudstoragesApi - axios parameter creator

    Parameters

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

    • cloudstoragesCreate: ((cloudStorageWriteRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>)
        • (cloudStorageWriteRequest, xOrganization?, org?, orgId?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

          Summary

          Method creates a cloud storage with a specified characteristics

          Throws

    • cloudstoragesDestroy: ((id, options?) => Promise<RequestArgs>)
        • (id, options?): Promise<RequestArgs>
        • Parameters

          • id: number

            A unique integer value identifying this cloud storage.

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method deletes a specific cloud storage

          Throws

    • cloudstoragesList: ((xOrganization?, credentialsType?, filter?, name?, org?, orgId?, owner?, page?, pageSize?, providerType?, resource?, search?, sort?, options?) => Promise<RequestArgs>)
        • (xOrganization?, credentialsType?, filter?, name?, org?, orgId?, owner?, page?, pageSize?, providerType?, resource?, search?, sort?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

          Summary

          Returns a paginated list of storages

          Throws

    • cloudstoragesPartialUpdate: ((id, patchedCloudStorageWriteRequest?, options?) => Promise<RequestArgs>)
        • (id, patchedCloudStorageWriteRequest?, options?): Promise<RequestArgs>
        • Parameters

          • id: number

            A unique integer value identifying this cloud storage.

          • Optional patchedCloudStorageWriteRequest: PatchedCloudStorageWriteRequest
          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

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

          Throws

    • cloudstoragesRetrieve: ((id, options?) => Promise<RequestArgs>)
        • (id, options?): Promise<RequestArgs>
        • Parameters

          • id: number

            A unique integer value identifying this cloud storage.

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method returns details of a specific cloud storage

          Throws

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

          Summary

          Method returns allowed actions for the cloud storage

          Throws

    • cloudstoragesRetrieveContentV2: ((id, manifestPath?, nextToken?, pageSize?, prefix?, options?) => Promise<RequestArgs>)
        • (id, manifestPath?, nextToken?, pageSize?, prefix?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

          Summary

          Method returns the content of the cloud storage

          Throws

    • cloudstoragesRetrievePreview: ((id, options?) => Promise<RequestArgs>)
        • (id, options?): Promise<RequestArgs>
        • Parameters

          • id: number

            A unique integer value identifying this cloud storage.

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method returns a preview image from a cloud storage

          Throws

    • cloudstoragesRetrieveStatus: ((id, options?) => Promise<RequestArgs>)
        • (id, options?): Promise<RequestArgs>
        • Parameters

          • id: number

            A unique integer value identifying this cloud storage.

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method returns a cloud storage status

          Throws

    Export

Generated using TypeDoc