From 4ba20bc743d6acbf2d9d8c061af2bd841d669cfe Mon Sep 17 00:00:00 2001 From: egordidenko Date: Tue, 20 Feb 2024 09:59:43 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20uploadca?= =?UTF-8?q?re/uploadcare-js-api-clients@4540c456cc10260d2e40d2eab50b606d3e?= =?UTF-8?q?3ea6e3=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- image-shrink/assets/highlight.css | 49 ++++++++++++++++++ image-shrink/functions/shrinkFile.html | 2 +- image-shrink/index.html | 50 ++++++++++++++++++- image-shrink/types/TSetting.html | 2 +- rest-client/classes/Paginator.html | 18 +++---- rest-client/classes/RestClientError.html | 12 ++--- rest-client/classes/UploadcareAuthSchema.html | 8 +-- .../classes/UploadcareSimpleAuthSchema.html | 8 +-- rest-client/enums/AddonExecutionStatus.html | 10 ++-- rest-client/enums/AddonName.html | 10 ++-- rest-client/enums/BatchResponseStatus.html | 4 +- rest-client/enums/ConversionStatus.html | 12 ++--- rest-client/enums/ConversionType.html | 6 +-- rest-client/enums/WebhookEvent.html | 4 +- .../functions/addonExecutionStatus-1.html | 2 +- rest-client/functions/addonJobPoller.html | 2 +- rest-client/functions/conversionInfo.html | 2 +- .../functions/conversionJobPoller.html | 2 +- .../functions/conversionJobStatus.html | 2 +- rest-client/functions/convert.html | 2 +- .../functions/copyFileToLocalStorage.html | 2 +- .../functions/copyFileToRemoteStorage.html | 2 +- rest-client/functions/createSignature.html | 2 +- rest-client/functions/createWebhook.html | 2 +- rest-client/functions/deleteFile.html | 2 +- rest-client/functions/deleteFiles.html | 2 +- rest-client/functions/deleteGroup.html | 2 +- rest-client/functions/deleteMetadata.html | 2 +- rest-client/functions/deleteWebhook.html | 2 +- rest-client/functions/executeAddon.html | 2 +- rest-client/functions/fileInfo-1.html | 2 +- rest-client/functions/getMetadata.html | 2 +- rest-client/functions/getMetadataValue.html | 2 +- rest-client/functions/groupInfo-1.html | 2 +- rest-client/functions/listOfFiles.html | 2 +- rest-client/functions/listOfGroups.html | 2 +- rest-client/functions/listOfWebhooks.html | 2 +- rest-client/functions/paginate.html | 2 +- rest-client/functions/storeFile.html | 2 +- rest-client/functions/storeFiles.html | 2 +- rest-client/functions/updateMetadata.html | 2 +- rest-client/functions/updateWebhook.html | 2 +- .../interfaces/ConversionResultBase.html | 8 +-- .../interfaces/ConversionResultVideo.html | 10 ++-- .../ConversionStatusResultBase.html | 4 +- .../ConversionStatusResultVideo.html | 6 +-- ...AddonAwsRekognitionDetectLabelsParams.html | 2 +- ...nAwsRekognitionModerationLabelsParams.html | 2 +- rest-client/types/AddonData.html | 2 +- .../types/AddonExecutionStatusOptions.html | 2 +- .../types/AddonExecutionStatusResponse.html | 2 +- rest-client/types/AddonJobPollerOptions.html | 2 +- rest-client/types/AddonParams.html | 2 +- rest-client/types/AddonRemoveBgParams.html | 2 +- .../types/AddonUcClamavVirusScanParams.html | 2 +- rest-client/types/ApiMethod.html | 2 +- rest-client/types/ApiRequestSettings.html | 2 +- rest-client/types/AppData.html | 2 +- rest-client/types/AuthSchema.html | 4 +- rest-client/types/AwsLabel.html | 2 +- .../types/AwsRekognitionDetectLabel.html | 2 +- .../AwsRekognitionDetectLabelInstance.html | 2 +- .../AwsRekognitionDetectLabelParent.html | 2 +- .../types/AwsRekognitionDetectLabels.html | 2 +- .../AwsRekognitionDetectModerationLabel.html | 2 +- .../AwsRekognitionDetectModerationLabels.html | 2 +- rest-client/types/BaseConversionOption.html | 2 +- rest-client/types/BatchResponse.html | 2 +- rest-client/types/ClamavVirusScan.html | 2 +- rest-client/types/ConversionInfoOptions.html | 2 +- rest-client/types/ConversionInfoResponse.html | 2 +- .../types/ConversionJobPollerOptions.html | 2 +- rest-client/types/ConversionOptions.html | 2 +- rest-client/types/ConversionResponse.html | 2 +- rest-client/types/ConversionResult.html | 2 +- .../types/ConversionResultDocument.html | 2 +- .../types/ConversionStatusOptions.html | 2 +- .../types/ConversionStatusResponse.html | 2 +- rest-client/types/ConversionStatusResult.html | 2 +- .../types/ConversionStatusResultDocument.html | 2 +- .../types/CopyFileToLocalStorageOptions.html | 2 +- .../types/CopyFileToLocalStorageResponse.html | 2 +- .../types/CopyFileToRemoteStorageOptions.html | 2 +- .../CopyFileToRemoteStorageResponse.html | 2 +- .../types/CreateJobPollerPollOptions.html | 2 +- rest-client/types/CreateWebhookOptions.html | 2 +- rest-client/types/CreateWebhookResponse.html | 2 +- rest-client/types/DeleteFileOptions.html | 2 +- rest-client/types/DeleteFileResponse.html | 2 +- rest-client/types/DeleteFilesOptions.html | 2 +- rest-client/types/DeleteFilesResponse.html | 2 +- rest-client/types/DeleteGroupOptions.html | 2 +- rest-client/types/DeleteGroupResponse.html | 2 +- rest-client/types/DeleteMetadataOptions.html | 2 +- rest-client/types/DeleteMetadataResponse.html | 2 +- rest-client/types/DeleteWebhookOptions.html | 2 +- rest-client/types/DeleteWebhookResponse.html | 2 +- rest-client/types/ExecuteAddonOptions.html | 2 +- rest-client/types/ExecuteAddonResponse.html | 2 +- rest-client/types/FileInfo.html | 2 +- rest-client/types/FileInfoOptions.html | 2 +- rest-client/types/FileInfoResponse.html | 2 +- rest-client/types/FileInfoVariations.html | 2 +- rest-client/types/GetMetadataOptions.html | 2 +- rest-client/types/GetMetadataResponse.html | 2 +- .../types/GetMetadataValueOptions.html | 2 +- .../types/GetMetadataValueResponse.html | 2 +- rest-client/types/GroupInfo.html | 2 +- rest-client/types/GroupInfoOptions.html | 2 +- rest-client/types/GroupInfoResponse.html | 2 +- rest-client/types/GroupInfoShort.html | 2 +- rest-client/types/ListOfFilesOptions.html | 2 +- rest-client/types/ListOfFilesOrdering.html | 2 +- rest-client/types/ListOfFilesResponse.html | 2 +- rest-client/types/ListOfFilesTotals.html | 2 +- rest-client/types/ListOfGroupsOptions.html | 2 +- rest-client/types/ListOfGroupsOrdering.html | 2 +- rest-client/types/ListOfGroupsResponse.html | 2 +- rest-client/types/ListOfWebhooksOptions.html | 2 +- rest-client/types/ListOfWebhooksResponse.html | 2 +- rest-client/types/Md5Function.html | 2 +- rest-client/types/Paginatable.html | 2 +- rest-client/types/PaginatedList.html | 2 +- rest-client/types/Problems.html | 2 +- rest-client/types/RemoveBg.html | 2 +- rest-client/types/ServerErrorResponse.html | 2 +- rest-client/types/StoreFileOptions.html | 2 +- rest-client/types/StoreFileResponse.html | 2 +- rest-client/types/StoreFilesOptions.html | 2 +- rest-client/types/StoreFilesResponse.html | 2 +- rest-client/types/TechFieldsAppData.html | 2 +- rest-client/types/UpdateMetadataOptions.html | 2 +- rest-client/types/UpdateMetadataResponse.html | 2 +- rest-client/types/UpdateWebhookOptions.html | 2 +- rest-client/types/UpdateWebhookResponse.html | 2 +- ...oadcareAuthSchemaOptionsWithSecretKey.html | 2 +- ...uthSchemaOptionsWithSignatureResolver.html | 2 +- ...UploadcareAuthSchemaSignatureResolver.html | 2 +- .../UploadcareSimpleAuthSchemaOptions.html | 2 +- rest-client/types/UserSettings.html | 2 +- rest-client/types/ValueOf.html | 2 +- rest-client/types/Webhook.html | 2 +- .../functions/generateSecureSignature.html | 2 +- .../types/GenerateSecureSignatureOptions.html | 2 +- upload-client/classes/Queue.html | 14 +++--- upload-client/classes/UploadClient.html | 32 ++++++------ upload-client/classes/UploadError.html | 12 ++--- upload-client/classes/UploadcareFile.html | 34 ++++++------- upload-client/classes/UploadcareGroup.html | 22 ++++---- upload-client/enums/Status.html | 12 ++--- upload-client/enums/TypeEnum.html | 6 +-- upload-client/functions/base.html | 2 +- upload-client/functions/fromUrl.html | 2 +- upload-client/functions/fromUrlStatus.html | 2 +- upload-client/functions/group.html | 2 +- upload-client/functions/groupInfo-1.html | 2 +- upload-client/functions/info.html | 2 +- upload-client/functions/isReadyPoll.html | 2 +- .../functions/multipartComplete.html | 2 +- upload-client/functions/multipartStart.html | 2 +- upload-client/functions/multipartUpload.html | 2 +- upload-client/functions/uploadDirect.html | 2 +- upload-client/functions/uploadFile.html | 2 +- upload-client/functions/uploadFileGroup.html | 2 +- .../functions/uploadFromUploaded.html | 2 +- upload-client/functions/uploadFromUrl.html | 2 +- upload-client/functions/uploadMultipart.html | 2 +- upload-client/interfaces/Settings.html | 48 +++++++++--------- upload-client/types/BaseOptions.html | 2 +- upload-client/types/BaseResponse.html | 2 +- upload-client/types/BrowserFile.html | 2 +- .../types/ComputableProgressInfo.html | 2 +- upload-client/types/DirectOptions.html | 2 +- upload-client/types/ErrorRequestInfo.html | 2 +- upload-client/types/ErrorResponseInfo.html | 2 +- upload-client/types/FileFromOptions.html | 2 +- upload-client/types/FileInfo.html | 2 +- upload-client/types/FileInfoResponse.html | 2 +- upload-client/types/FromUploadedOptions.html | 2 +- upload-client/types/FromUrlOptions.html | 2 +- upload-client/types/FromUrlResponse.html | 2 +- upload-client/types/FromUrlStatusOptions.html | 2 +- .../types/FromUrlStatusResponse.html | 2 +- .../types/FromUrlSuccessResponse.html | 2 +- upload-client/types/GroupFileInfo.html | 2 +- upload-client/types/GroupFromOptions.html | 2 +- upload-client/types/GroupId.html | 2 +- upload-client/types/GroupInfo.html | 2 +- upload-client/types/GroupInfoOptions.html | 2 +- upload-client/types/GroupOptions.html | 2 +- upload-client/types/Headers.html | 2 +- upload-client/types/InfoOptions.html | 2 +- .../types/MultipartCompleteOptions.html | 2 +- upload-client/types/MultipartOptions.html | 2 +- upload-client/types/MultipartPart.html | 2 +- .../types/MultipartStartOptions.html | 2 +- .../types/MultipartStartResponse.html | 2 +- .../types/MultipartUploadOptions.html | 2 +- .../types/MultipartUploadResponse.html | 2 +- upload-client/types/NodeFile.html | 2 +- upload-client/types/ProgressCallback.html | 2 +- upload-client/types/ReactNativeAsset.html | 2 +- upload-client/types/Sliceable.html | 2 +- upload-client/types/StatusErrorResponse.html | 2 +- .../types/StatusProgressResponse.html | 2 +- .../types/StatusSuccessResponse.html | 2 +- .../types/StatusUnknownResponse.html | 2 +- .../types/StatusWaitingResponse.html | 2 +- upload-client/types/SupportedFileInput.html | 2 +- upload-client/types/Token.html | 2 +- upload-client/types/TokenResponse.html | 2 +- upload-client/types/UnknownProgressInfo.html | 2 +- upload-client/types/UploadFromUrlOptions.html | 2 +- upload-client/types/Url.html | 2 +- upload-client/types/Uuid.html | 2 +- .../variables/UploadClientError.html | 2 +- .../variables/UploadcareNetworkError.html | 2 +- 217 files changed, 441 insertions(+), 346 deletions(-) diff --git a/image-shrink/assets/highlight.css b/image-shrink/assets/highlight.css index 5674cf39..f1d945b5 100644 --- a/image-shrink/assets/highlight.css +++ b/image-shrink/assets/highlight.css @@ -1,22 +1,71 @@ :root { + --light-hl-0: #000000; + --dark-hl-0: #D4D4D4; + --light-hl-1: #A31515; + --dark-hl-1: #CE9178; + --light-hl-2: #AF00DB; + --dark-hl-2: #C586C0; + --light-hl-3: #001080; + --dark-hl-3: #9CDCFE; + --light-hl-4: #0000FF; + --dark-hl-4: #569CD6; + --light-hl-5: #0070C1; + --dark-hl-5: #4FC1FF; + --light-hl-6: #795E26; + --dark-hl-6: #DCDCAA; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); --code-background: var(--light-code-background); } } @media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); --code-background: var(--dark-code-background); } } :root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); --code-background: var(--light-code-background); } :root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); --code-background: var(--dark-code-background); } +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } pre, code { background: var(--code-background); } diff --git a/image-shrink/functions/shrinkFile.html b/image-shrink/functions/shrinkFile.html index b3a52768..34aa26be 100644 --- a/image-shrink/functions/shrinkFile.html +++ b/image-shrink/functions/shrinkFile.html @@ -28,7 +28,7 @@
file: settings: TSetting

Returns Promise<Blob>

+
  • Defined in utils/shrinkFile.ts:17
    • diff --git a/image-shrink/index.html b/image-shrink/index.html index 824b2ffd..5ab768cb 100644 --- a/image-shrink/index.html +++ b/image-shrink/index.html @@ -12,7 +12,40 @@

    @uploadcare/image-shrink

    -
    +

    Uploadcare Image Shrink

    + + + +

    File Uploader lets you accept hi-res images and shrink them in size to a reasonable resolution, keeping the original aspect ratio. See docs here wrapper to work with browser.

    +

    API Reference

    +

    Build Status +NPM version +GitHub release +Uploadcare stack on StackShare

    + + + + + +

    Install

    npm install @uploadcare/image-shrink
+
    +

    Usage

    import { shrinkFile } from '@uploadcare/image-shrink'

    const shrinkedBlob = shrinkImage(blob, {
        size: number,
        quality?: number
    })
+
    +

    Security issues

    If you think you ran into something in Uploadcare libraries that might have +security implications, please hit us up at +bugbounty@uploadcare.com or Hackerone.

    +

    We'll contact you personally in a short time to fix an issue through co-op and +prior to any public disclosure.

    +

    Feedback

    Issues and PRs are welcome. You can provide your feedback or drop us a support +request at hello@uploadcare.com.

    +
    @@ -26,7 +59,20 @@

    Member Visibility

    • -

    Theme

    +

    Theme

    +
    +

    On This Page

     +
    +
    +
  • Defined in utils/shrinkFile.ts:12
    • diff --git a/rest-client/classes/Paginator.html b/rest-client/classes/Paginator.html index 454f1e40..7769ded6 100644 --- a/rest-client/classes/Paginator.html +++ b/rest-client/classes/Paginator.html @@ -31,7 +31,7 @@

    Hierarchy

    • Paginator
    +
  • Defined in packages/rest-client/src/tools/paginate.ts:14
    • @@ -80,7 +80,7 @@
    options: settings: Settings

    Returns Paginator<Options, Settings, PageItem, PageExtra>

    +
  • Defined in packages/rest-client/src/tools/paginate.ts:20

    • Methods

    @@ -90,7 +90,7 @@

    generator

    Returns AsyncGenerator<PaginatedList<PageItem, PageExtra>, void, unknown>

    +
  • Defined in packages/rest-client/src/tools/paginate.ts:72

    • getCurrentPage

    +
  • Defined in packages/rest-client/src/tools/paginate.ts:46

    • hasNextPage

    +
  • Defined in packages/rest-client/src/tools/paginate.ts:38

    • hasPrevPage

    +
  • Defined in packages/rest-client/src/tools/paginate.ts:42

    • next

    +
  • Defined in packages/rest-client/src/tools/paginate.ts:50

    • prev

    +
  • Defined in packages/rest-client/src/tools/paginate.ts:63

    • updateOptions

      @@ -143,7 +143,7 @@

      Parameters

      options: Options

    Returns void

    +
  • Defined in packages/rest-client/src/tools/paginate.ts:30
    • diff --git a/rest-client/classes/RestClientError.html b/rest-client/classes/RestClientError.html index b9f97700..1f85ac6e 100644 --- a/rest-client/classes/RestClientError.html +++ b/rest-client/classes/RestClientError.html @@ -26,7 +26,7 @@

    Hierarchy

    • RestClientError
    +
  • Defined in packages/rest-client/src/tools/RestClientError.ts:14
    • @@ -69,7 +69,7 @@
    options: Returns RestClientError
    +
  • Defined in packages/rest-client/src/tools/RestClientError.ts:21

    • Properties

    @@ -88,12 +88,12 @@

    nameOptional Readonly request

    request?: Request
    +
  • Defined in packages/rest-client/src/tools/RestClientError.ts:18

    • Optional Readonly response

    response?: Response
    +
  • Defined in packages/rest-client/src/tools/RestClientError.ts:19

    • Optional stack

    stack?: string
    +
  • Defined in packages/rest-client/src/tools/RestClientError.ts:15

    • Optional Readonly statusText

    statusText?: string
    +
  • Defined in packages/rest-client/src/tools/RestClientError.ts:16

    • Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)
    diff --git a/rest-client/classes/UploadcareAuthSchema.html b/rest-client/classes/UploadcareAuthSchema.html index 23f9c40e..1af15aeb 100644 --- a/rest-client/classes/UploadcareAuthSchema.html +++ b/rest-client/classes/UploadcareAuthSchema.html @@ -24,7 +24,7 @@

    Implements

    +
  • Defined in packages/rest-client/src/auth/UploadcareAuthSchema.ts:54
    • @@ -56,7 +56,7 @@

    Parameters

    options: UploadcareAuthSchemaOptionsWithSignatureResolver | UploadcareAuthSchemaOptionsWithSecretKey

    Returns UploadcareAuthSchema

    +
  • Defined in packages/rest-client/src/auth/UploadcareAuthSchema.ts:59

    • Accessors

    @@ -67,7 +67,7 @@

    publicKeyReturns string

    +
  • Defined in packages/rest-client/src/auth/UploadcareAuthSchema.ts:105

    • Methods

    @@ -83,7 +83,7 @@
    request: Returns Promise<Headers>
    +
  • Defined in packages/rest-client/src/auth/UploadcareAuthSchema.ts:109
    • diff --git a/rest-client/classes/UploadcareSimpleAuthSchema.html b/rest-client/classes/UploadcareSimpleAuthSchema.html index 1f6adec0..6fcd70cf 100644 --- a/rest-client/classes/UploadcareSimpleAuthSchema.html +++ b/rest-client/classes/UploadcareSimpleAuthSchema.html @@ -24,7 +24,7 @@

    Implements

    +
  • Defined in packages/rest-client/src/auth/UploadcareSimpleAuthSchema.ts:11
    • @@ -56,7 +56,7 @@

    Parameters

    __namedParameters: UploadcareSimpleAuthSchemaOptions

    Returns UploadcareSimpleAuthSchema

    +
  • Defined in packages/rest-client/src/auth/UploadcareSimpleAuthSchema.ts:15

    • Accessors

    @@ -67,7 +67,7 @@

    publicKeyReturns string

    +
  • Defined in packages/rest-client/src/auth/UploadcareSimpleAuthSchema.ts:26

    • Methods

    @@ -83,7 +83,7 @@
    request: Returns Promise<Headers>
    +
  • Defined in packages/rest-client/src/auth/UploadcareSimpleAuthSchema.ts:30
    • diff --git a/rest-client/enums/AddonExecutionStatus.html b/rest-client/enums/AddonExecutionStatus.html index 5936fcdf..073da42b 100644 --- a/rest-client/enums/AddonExecutionStatus.html +++ b/rest-client/enums/AddonExecutionStatus.html @@ -16,7 +16,7 @@
  • AddonExecutionStatus

    • Enumeration AddonExecutionStatus

    +
  • Defined in packages/rest-client/src/types/AddonExecutionStatus.ts:1
    • @@ -35,22 +35,22 @@

    Enumeration Members

    DONE

    DONE: "done"
    +
  • Defined in packages/rest-client/src/types/AddonExecutionStatus.ts:4

    • ERROR

    ERROR: "error"
    +
  • Defined in packages/rest-client/src/types/AddonExecutionStatus.ts:3

    • IN_PROGRESS

    IN_PROGRESS: "in_progress"
    +
  • Defined in packages/rest-client/src/types/AddonExecutionStatus.ts:2

    • UNKNOWN

    UNKNOWN: "unknown"
    +
  • Defined in packages/rest-client/src/types/AddonExecutionStatus.ts:5
    • diff --git a/rest-client/enums/AddonName.html b/rest-client/enums/AddonName.html index ce412801..52c70564 100644 --- a/rest-client/enums/AddonName.html +++ b/rest-client/enums/AddonName.html @@ -16,7 +16,7 @@
  • AddonName

    • Enumeration AddonName

    +
  • Defined in packages/rest-client/src/types/AddonName.ts:1
    • @@ -35,22 +35,22 @@

    Enumeration Members

    AWS_REKOGNITION_DETECT_LABELS

    AWS_REKOGNITION_DETECT_LABELS: "aws_rekognition_detect_labels"
    +
  • Defined in packages/rest-client/src/types/AddonName.ts:3

    • AWS_REKOGNITION_DETECT_MODERATION_LABELS

    AWS_REKOGNITION_DETECT_MODERATION_LABELS: "aws_rekognition_detect_moderation_labels"
    +
  • Defined in packages/rest-client/src/types/AddonName.ts:4

    • REMOVE_BG

    REMOVE_BG: "remove_bg"
    +
  • Defined in packages/rest-client/src/types/AddonName.ts:5

    • UC_CLAMAV_VIRUS_SCAN

    UC_CLAMAV_VIRUS_SCAN: "uc_clamav_virus_scan"
    +
  • Defined in packages/rest-client/src/types/AddonName.ts:2
    • diff --git a/rest-client/enums/BatchResponseStatus.html b/rest-client/enums/BatchResponseStatus.html index 97812687..d0d712dc 100644 --- a/rest-client/enums/BatchResponseStatus.html +++ b/rest-client/enums/BatchResponseStatus.html @@ -16,7 +16,7 @@
  • BatchResponseStatus

    • Enumeration BatchResponseStatus

    +
  • Defined in packages/rest-client/src/types/BatchResponse.ts:3
    • @@ -32,7 +32,7 @@

    Enumeration Members

    OK

    OK: "ok"
    +
  • Defined in packages/rest-client/src/types/BatchResponse.ts:4
    • diff --git a/rest-client/enums/ConversionStatus.html b/rest-client/enums/ConversionStatus.html index dc65b3e7..e473c1d7 100644 --- a/rest-client/enums/ConversionStatus.html +++ b/rest-client/enums/ConversionStatus.html @@ -16,7 +16,7 @@
  • ConversionStatus

    • Enumeration ConversionStatus

    +
  • Defined in packages/rest-client/src/types/ConversionStatus.ts:1
    • @@ -36,27 +36,27 @@

    Enumeration Members

    CANCELLED

    CANCELLED: "cancelled"
    +
  • Defined in packages/rest-client/src/types/ConversionStatus.ts:6

    • FAILED

    FAILED: "failed"
    +
  • Defined in packages/rest-client/src/types/ConversionStatus.ts:5

    • FINISHED

    FINISHED: "finished"
    +
  • Defined in packages/rest-client/src/types/ConversionStatus.ts:4

    • PENDING

    PENDING: "pending"
    +
  • Defined in packages/rest-client/src/types/ConversionStatus.ts:2

    • PROCESSING

    PROCESSING: "processing"
    +
  • Defined in packages/rest-client/src/types/ConversionStatus.ts:3
    • diff --git a/rest-client/enums/ConversionType.html b/rest-client/enums/ConversionType.html index f74a0879..fc2c0087 100644 --- a/rest-client/enums/ConversionType.html +++ b/rest-client/enums/ConversionType.html @@ -16,7 +16,7 @@
  • ConversionType

    • Enumeration ConversionType

    +
  • Defined in packages/rest-client/src/types/ConversionType.ts:1
    • @@ -33,12 +33,12 @@

    Enumeration Members

    DOCUMENT

    DOCUMENT: "document"
    +
  • Defined in packages/rest-client/src/types/ConversionType.ts:3

    • VIDEO

    VIDEO: "video"
    +
  • Defined in packages/rest-client/src/types/ConversionType.ts:2
    • diff --git a/rest-client/enums/WebhookEvent.html b/rest-client/enums/WebhookEvent.html index 85c8fcde..8f253eba 100644 --- a/rest-client/enums/WebhookEvent.html +++ b/rest-client/enums/WebhookEvent.html @@ -16,7 +16,7 @@
  • WebhookEvent

    • Enumeration WebhookEvent

    +
  • Defined in packages/rest-client/src/types/WebhookEvent.ts:1
    • @@ -32,7 +32,7 @@

    Enumeration Members

    FILE_UPLOADED

    FILE_UPLOADED: "file.uploaded"
    +
  • Defined in packages/rest-client/src/types/WebhookEvent.ts:2
    • diff --git a/rest-client/functions/addonExecutionStatus-1.html b/rest-client/functions/addonExecutionStatus-1.html index 79a723f5..5545eeda 100644 --- a/rest-client/functions/addonExecutionStatus-1.html +++ b/rest-client/functions/addonExecutionStatus-1.html @@ -33,7 +33,7 @@
    options: userSettings: UserSettings

    Returns Promise<AddonExecutionStatusResponse>

    +
  • Defined in packages/rest-client/src/api/addons/addonExecutionStatus.ts:16
    • diff --git a/rest-client/functions/addonJobPoller.html b/rest-client/functions/addonJobPoller.html index ad59ff13..4b60dabd 100644 --- a/rest-client/functions/addonJobPoller.html +++ b/rest-client/functions/addonJobPoller.html @@ -33,7 +33,7 @@
    options: settings: UserSettings

    Returns Promise<{
        error: true;
        result: null;
    } | {
        error: false;
        result: NonNullable<AppData[T]>;
    }>

    +
  • Defined in packages/rest-client/src/tools/addonJobPoller.ts:23
    • diff --git a/rest-client/functions/conversionInfo.html b/rest-client/functions/conversionInfo.html index 26c6ec00..e35347b9 100644 --- a/rest-client/functions/conversionInfo.html +++ b/rest-client/functions/conversionInfo.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<ConversionInfoResponse>

    +
  • Defined in packages/rest-client/src/api/conversion/conversionInfo.ts:19
    • diff --git a/rest-client/functions/conversionJobPoller.html b/rest-client/functions/conversionJobPoller.html index d59c749d..6a89b50a 100644 --- a/rest-client/functions/conversionJobPoller.html +++ b/rest-client/functions/conversionJobPoller.html @@ -33,7 +33,7 @@
    options: settings: UserSettings

    Returns Promise<Promise<{
        path: string;
    } & ConversionStatusResponse<ConversionStatusResult[T]>>[]>

    +
  • Defined in packages/rest-client/src/tools/conversionJobPoller.ts:23
    • diff --git a/rest-client/functions/conversionJobStatus.html b/rest-client/functions/conversionJobStatus.html index 9bb8a333..753c54fb 100644 --- a/rest-client/functions/conversionJobStatus.html +++ b/rest-client/functions/conversionJobStatus.html @@ -33,7 +33,7 @@
    options: userSettings: UserSettings

    Returns Promise<ConversionStatusResponse<ConversionStatusResult[T]>>

    +
  • Defined in packages/rest-client/src/api/conversion/conversionJobStatus.ts:9
    • diff --git a/rest-client/functions/convert.html b/rest-client/functions/convert.html index 942f1915..d64c2ada 100644 --- a/rest-client/functions/convert.html +++ b/rest-client/functions/convert.html @@ -33,7 +33,7 @@
    options: userSettings: UserSettings

    Returns Promise<ConversionResponse<ConversionResult[T]>>

    +
  • Defined in packages/rest-client/src/api/conversion/convert.ts:10
    • diff --git a/rest-client/functions/copyFileToLocalStorage.html b/rest-client/functions/copyFileToLocalStorage.html index 3d7925fa..b6a39272 100644 --- a/rest-client/functions/copyFileToLocalStorage.html +++ b/rest-client/functions/copyFileToLocalStorage.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<CopyFileToLocalStorageResponse>

    +
  • Defined in packages/rest-client/src/api/file/copyFileToLocalStorage.ts:21
    • diff --git a/rest-client/functions/copyFileToRemoteStorage.html b/rest-client/functions/copyFileToRemoteStorage.html index 958f0d58..b1551b54 100644 --- a/rest-client/functions/copyFileToRemoteStorage.html +++ b/rest-client/functions/copyFileToRemoteStorage.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<CopyFileToRemoteStorageResponse>

    +
  • Defined in packages/rest-client/src/api/file/copyFileToRemoteStorage.ts:16
    • diff --git a/rest-client/functions/createSignature.html b/rest-client/functions/createSignature.html index a095c906..0d4e810b 100644 --- a/rest-client/functions/createSignature.html +++ b/rest-client/functions/createSignature.html @@ -26,7 +26,7 @@

    Parameters

    Rest ...args: [secretKey: string, signString: string]

    Returns Promise<string>

    +
  • Defined in packages/rest-client/src/auth/createSignature.ts:3
    • diff --git a/rest-client/functions/createWebhook.html b/rest-client/functions/createWebhook.html index eed8d93a..5c1a689a 100644 --- a/rest-client/functions/createWebhook.html +++ b/rest-client/functions/createWebhook.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<CreateWebhookResponse>

    +
  • Defined in packages/rest-client/src/api/webhooks/createWebhook.ts:10
    • diff --git a/rest-client/functions/deleteFile.html b/rest-client/functions/deleteFile.html index f6ab800d..d8faae3f 100644 --- a/rest-client/functions/deleteFile.html +++ b/rest-client/functions/deleteFile.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<DeleteFileResponse>

    +
  • Defined in packages/rest-client/src/api/file/deleteFile.ts:11
    • diff --git a/rest-client/functions/deleteFiles.html b/rest-client/functions/deleteFiles.html index cfc88eeb..e7b99099 100644 --- a/rest-client/functions/deleteFiles.html +++ b/rest-client/functions/deleteFiles.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<DeleteFilesResponse>

    +
  • Defined in packages/rest-client/src/api/file/deleteFiles.ts:12
    • diff --git a/rest-client/functions/deleteGroup.html b/rest-client/functions/deleteGroup.html index e26d0015..94ecc683 100644 --- a/rest-client/functions/deleteGroup.html +++ b/rest-client/functions/deleteGroup.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<DeleteGroupResponse>

    +
  • Defined in packages/rest-client/src/api/group/deleteGroup.ts:10
    • diff --git a/rest-client/functions/deleteMetadata.html b/rest-client/functions/deleteMetadata.html index a6b32815..cef931ae 100644 --- a/rest-client/functions/deleteMetadata.html +++ b/rest-client/functions/deleteMetadata.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<DeleteMetadataResponse>

    +
  • Defined in packages/rest-client/src/api/metadata/deleteMetadata.ts:11
    • diff --git a/rest-client/functions/deleteWebhook.html b/rest-client/functions/deleteWebhook.html index 96c770d1..dde16e5a 100644 --- a/rest-client/functions/deleteWebhook.html +++ b/rest-client/functions/deleteWebhook.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<DeleteWebhookResponse>

    +
  • Defined in packages/rest-client/src/api/webhooks/deleteWebhook.ts:9
    • diff --git a/rest-client/functions/executeAddon.html b/rest-client/functions/executeAddon.html index eba0a08e..c8500e3b 100644 --- a/rest-client/functions/executeAddon.html +++ b/rest-client/functions/executeAddon.html @@ -33,7 +33,7 @@
    options: userSettings: UserSettings

    Returns Promise<ExecuteAddonResponse>

    +
  • Defined in packages/rest-client/src/api/addons/executeAddon.ts:17
    • diff --git a/rest-client/functions/fileInfo-1.html b/rest-client/functions/fileInfo-1.html index 83c0b618..068977fc 100644 --- a/rest-client/functions/fileInfo-1.html +++ b/rest-client/functions/fileInfo-1.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<FileInfoResponse>

    +
  • Defined in packages/rest-client/src/api/file/fileInfo.ts:12
    • diff --git a/rest-client/functions/getMetadata.html b/rest-client/functions/getMetadata.html index 4edab74a..5d553dd2 100644 --- a/rest-client/functions/getMetadata.html +++ b/rest-client/functions/getMetadata.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<GetMetadataResponse>

    +
  • Defined in packages/rest-client/src/api/metadata/getMetadata.ts:11
    • diff --git a/rest-client/functions/getMetadataValue.html b/rest-client/functions/getMetadataValue.html index 29190f9d..37892eab 100644 --- a/rest-client/functions/getMetadataValue.html +++ b/rest-client/functions/getMetadataValue.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<GetMetadataValueResponse>

    +
  • Defined in packages/rest-client/src/api/metadata/getMetadataValue.ts:12
    • diff --git a/rest-client/functions/groupInfo-1.html b/rest-client/functions/groupInfo-1.html index d834e238..cfaab4e0 100644 --- a/rest-client/functions/groupInfo-1.html +++ b/rest-client/functions/groupInfo-1.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<GroupInfoResponse>

    +
  • Defined in packages/rest-client/src/api/group/groupInfo.ts:11
    • diff --git a/rest-client/functions/listOfFiles.html b/rest-client/functions/listOfFiles.html index af7a7846..d292d0a2 100644 --- a/rest-client/functions/listOfFiles.html +++ b/rest-client/functions/listOfFiles.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<ListOfFilesResponse>

    +
  • Defined in packages/rest-client/src/api/file/listOfFiles.ts:29
    • diff --git a/rest-client/functions/listOfGroups.html b/rest-client/functions/listOfGroups.html index 04c422c6..eda3f8d9 100644 --- a/rest-client/functions/listOfGroups.html +++ b/rest-client/functions/listOfGroups.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<ListOfGroupsResponse>

    +
  • Defined in packages/rest-client/src/api/group/listOfGroups.ts:16
    • diff --git a/rest-client/functions/listOfWebhooks.html b/rest-client/functions/listOfWebhooks.html index 8dc74e4f..345aed93 100644 --- a/rest-client/functions/listOfWebhooks.html +++ b/rest-client/functions/listOfWebhooks.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<ListOfWebhooksResponse>

    +
  • Defined in packages/rest-client/src/api/webhooks/listOfWebhooks.ts:9
    • diff --git a/rest-client/functions/paginate.html b/rest-client/functions/paginate.html index 6562c0b4..68a2f0be 100644 --- a/rest-client/functions/paginate.html +++ b/rest-client/functions/paginate.html @@ -50,7 +50,7 @@
    options: settings: Settings

    Returns AsyncGenerator<PaginatedList<PageItem, PageExtra>, void, unknown>

    +
  • Defined in packages/rest-client/src/tools/paginate.ts:77
    • diff --git a/rest-client/functions/storeFile.html b/rest-client/functions/storeFile.html index 419211dd..d9bf8e4e 100644 --- a/rest-client/functions/storeFile.html +++ b/rest-client/functions/storeFile.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<StoreFileResponse>

    +
  • Defined in packages/rest-client/src/api/file/storeFile.ts:11
    • diff --git a/rest-client/functions/storeFiles.html b/rest-client/functions/storeFiles.html index 5c3bfd11..5f6365c9 100644 --- a/rest-client/functions/storeFiles.html +++ b/rest-client/functions/storeFiles.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<StoreFilesResponse>

    +
  • Defined in packages/rest-client/src/api/file/storeFiles.ts:12
    • diff --git a/rest-client/functions/updateMetadata.html b/rest-client/functions/updateMetadata.html index 112a9566..78530af3 100644 --- a/rest-client/functions/updateMetadata.html +++ b/rest-client/functions/updateMetadata.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<UpdateMetadataResponse>

    +
  • Defined in packages/rest-client/src/api/metadata/updateMetadata.ts:12
    • diff --git a/rest-client/functions/updateWebhook.html b/rest-client/functions/updateWebhook.html index 29a8e7c6..df5586d4 100644 --- a/rest-client/functions/updateWebhook.html +++ b/rest-client/functions/updateWebhook.html @@ -28,7 +28,7 @@
    options: userSettings: UserSettings

    Returns Promise<UpdateWebhookResponse>

    +
  • Defined in packages/rest-client/src/api/webhooks/updateWebhook.ts:9
    • diff --git a/rest-client/interfaces/ConversionResultBase.html b/rest-client/interfaces/ConversionResultBase.html index c8563647..8509d5c8 100644 --- a/rest-client/interfaces/ConversionResultBase.html +++ b/rest-client/interfaces/ConversionResultBase.html @@ -22,7 +22,7 @@

    Hierarchy

    +
  • Defined in packages/rest-client/src/types/ConversionResult.ts:3
    • @@ -40,17 +40,17 @@

    Properties

    originalSource

    originalSource: string
    +
  • Defined in packages/rest-client/src/types/ConversionResult.ts:4

    • token

    token: number
    +
  • Defined in packages/rest-client/src/types/ConversionResult.ts:6

    • uuid

    uuid: string
    +
  • Defined in packages/rest-client/src/types/ConversionResult.ts:5
    • diff --git a/rest-client/interfaces/ConversionResultVideo.html b/rest-client/interfaces/ConversionResultVideo.html index 9f6a5a90..19a03752 100644 --- a/rest-client/interfaces/ConversionResultVideo.html +++ b/rest-client/interfaces/ConversionResultVideo.html @@ -22,7 +22,7 @@

    Hierarchy

    • ConversionResultVideo
    +
  • Defined in packages/rest-client/src/types/ConversionResult.ts:10
    • @@ -42,24 +42,24 @@

    originalSourceoriginalSource: string

    +
  • Defined in packages/rest-client/src/types/ConversionResult.ts:4

    • thumbnailsGroupUuid

    thumbnailsGroupUuid: string
    +
  • Defined in packages/rest-client/src/types/ConversionResult.ts:11

    • token

    token: number
    +
  • Defined in packages/rest-client/src/types/ConversionResult.ts:6

    • uuid

    uuid: string
    +
  • Defined in packages/rest-client/src/types/ConversionResult.ts:5
    • diff --git a/rest-client/interfaces/ConversionStatusResultBase.html b/rest-client/interfaces/ConversionStatusResultBase.html index 9625aaf4..daff2733 100644 --- a/rest-client/interfaces/ConversionStatusResultBase.html +++ b/rest-client/interfaces/ConversionStatusResultBase.html @@ -22,7 +22,7 @@

    Hierarchy

    +
  • Defined in packages/rest-client/src/types/ConversionStatusResult.ts:3
    • @@ -38,7 +38,7 @@

    Properties

    uuid

    uuid: string
    +
  • Defined in packages/rest-client/src/types/ConversionStatusResult.ts:4
    • diff --git a/rest-client/interfaces/ConversionStatusResultVideo.html b/rest-client/interfaces/ConversionStatusResultVideo.html index 18bba5d3..bf899a4b 100644 --- a/rest-client/interfaces/ConversionStatusResultVideo.html +++ b/rest-client/interfaces/ConversionStatusResultVideo.html @@ -22,7 +22,7 @@

    Hierarchy

    • ConversionStatusResultVideo
    +
  • Defined in packages/rest-client/src/types/ConversionStatusResult.ts:8
    • @@ -39,13 +39,13 @@

    Properties

    thumbnailsGroupUuid

    thumbnailsGroupUuid: string
    +
  • Defined in packages/rest-client/src/types/ConversionStatusResult.ts:10

    • uuid

    uuid: string
    +
  • Defined in packages/rest-client/src/types/ConversionStatusResult.ts:4
    • diff --git a/rest-client/types/AddonAwsRekognitionDetectLabelsParams.html b/rest-client/types/AddonAwsRekognitionDetectLabelsParams.html index 373960db..1f34589f 100644 --- a/rest-client/types/AddonAwsRekognitionDetectLabelsParams.html +++ b/rest-client/types/AddonAwsRekognitionDetectLabelsParams.html @@ -17,7 +17,7 @@

    Type alias AddonAwsRekognitionDetectLabelsParams

    AddonAwsRekognitionDetectLabelsParams: undefined
    +
  • Defined in packages/rest-client/src/types/AddonParams.ts:7
    • diff --git a/rest-client/types/AddonAwsRekognitionModerationLabelsParams.html b/rest-client/types/AddonAwsRekognitionModerationLabelsParams.html index ebe88ea1..d81024e6 100644 --- a/rest-client/types/AddonAwsRekognitionModerationLabelsParams.html +++ b/rest-client/types/AddonAwsRekognitionModerationLabelsParams.html @@ -17,7 +17,7 @@

    Type alias AddonAwsRekognitionModerationLabelsParams

    AddonAwsRekognitionModerationLabelsParams: undefined
    +
  • Defined in packages/rest-client/src/types/AddonParams.ts:9
    • diff --git a/rest-client/types/AddonData.html b/rest-client/types/AddonData.html index 6b780223..2f3e4c2f 100644 --- a/rest-client/types/AddonData.html +++ b/rest-client/types/AddonData.html @@ -22,7 +22,7 @@

    Type Parameters

  • T

    • +
  • Defined in packages/rest-client/src/types/AppData.ts:9
    • diff --git a/rest-client/types/AddonExecutionStatusOptions.html b/rest-client/types/AddonExecutionStatusOptions.html index bdfe6379..757ebf46 100644 --- a/rest-client/types/AddonExecutionStatusOptions.html +++ b/rest-client/types/AddonExecutionStatusOptions.html @@ -29,7 +29,7 @@
    addonName
    requestId: string
    +
  • Defined in packages/rest-client/src/api/addons/addonExecutionStatus.ts:7
    • diff --git a/rest-client/types/AddonExecutionStatusResponse.html b/rest-client/types/AddonExecutionStatusResponse.html index 3b79c9cc..74dd1142 100644 --- a/rest-client/types/AddonExecutionStatusResponse.html +++ b/rest-client/types/AddonExecutionStatusResponse.html @@ -22,7 +22,7 @@

    Type declaration

  • status: AddonExecutionStatus
    • +
  • Defined in packages/rest-client/src/api/addons/addonExecutionStatus.ts:12
    • diff --git a/rest-client/types/AddonJobPollerOptions.html b/rest-client/types/AddonJobPollerOptions.html index 1200cd8c..f5e86b2b 100644 --- a/rest-client/types/AddonJobPollerOptions.html +++ b/rest-client/types/AddonJobPollerOptions.html @@ -46,7 +46,7 @@

    Parameters

    response: AddonExecutionStatusResponse

    Returns void

    +
  • Defined in packages/rest-client/src/tools/addonJobPoller.ts:18
    • diff --git a/rest-client/types/AddonParams.html b/rest-client/types/AddonParams.html index 44204e05..7fdef874 100644 --- a/rest-client/types/AddonParams.html +++ b/rest-client/types/AddonParams.html @@ -28,7 +28,7 @@
    remove_bg
    uc_clamav_virus_scan: AddonUcClamavVirusScanParams
    +
  • Defined in packages/rest-client/src/types/AddonParams.ts:24
    • diff --git a/rest-client/types/AddonRemoveBgParams.html b/rest-client/types/AddonRemoveBgParams.html index c79e9d98..1b7be4eb 100644 --- a/rest-client/types/AddonRemoveBgParams.html +++ b/rest-client/types/AddonRemoveBgParams.html @@ -40,7 +40,7 @@
    Optional
    Optional type_level?: "none" | "1" | "2" | "latest"
    +
  • Defined in packages/rest-client/src/types/AddonParams.ts:11
    • diff --git a/rest-client/types/AddonUcClamavVirusScanParams.html b/rest-client/types/AddonUcClamavVirusScanParams.html index 6963ee5f..e6ddb277 100644 --- a/rest-client/types/AddonUcClamavVirusScanParams.html +++ b/rest-client/types/AddonUcClamavVirusScanParams.html @@ -22,7 +22,7 @@

    Type declaration

  • purge_infected: boolean
    • +
  • Defined in packages/rest-client/src/types/AddonParams.ts:3
    • diff --git a/rest-client/types/ApiMethod.html b/rest-client/types/ApiMethod.html index 10970fcd..2f66a778 100644 --- a/rest-client/types/ApiMethod.html +++ b/rest-client/types/ApiMethod.html @@ -41,7 +41,7 @@
    options: settings: Settings

    Returns Promise<Response>

    +
  • Defined in packages/rest-client/src/types/ApiMethod.ts:1
    • diff --git a/rest-client/types/ApiRequestSettings.html b/rest-client/types/ApiRequestSettings.html index a7d69a20..cc4ed845 100644 --- a/rest-client/types/ApiRequestSettings.html +++ b/rest-client/types/ApiRequestSettings.html @@ -17,7 +17,7 @@

    Type alias ApiRequestSettings

    ApiRequestSettings: UserSettings
    +
  • Defined in packages/rest-client/src/makeApiRequest.ts:21
    • diff --git a/rest-client/types/AppData.html b/rest-client/types/AppData.html index ecadb022..6c227002 100644 --- a/rest-client/types/AppData.html +++ b/rest-client/types/AppData.html @@ -28,7 +28,7 @@
    Optional
    Optional uc_clamav_virus_scan?: ClamavVirusScan
    +
  • Defined in packages/rest-client/src/types/AppData.ts:55
    • diff --git a/rest-client/types/AuthSchema.html b/rest-client/types/AuthSchema.html index d964667a..90360457 100644 --- a/rest-client/types/AuthSchema.html +++ b/rest-client/types/AuthSchema.html @@ -33,9 +33,9 @@

    Parameters

    request: Request

    Returns Promise<Headers>

    +
  • Defined in packages/rest-client/src/auth/types.ts:1
    • diff --git a/rest-client/types/AwsLabel.html b/rest-client/types/AwsLabel.html index dd9c3de7..ce50447b 100644 --- a/rest-client/types/AwsLabel.html +++ b/rest-client/types/AwsLabel.html @@ -22,7 +22,7 @@

    Type Parameters

  • T

    • +
  • Defined in packages/rest-client/src/types/AppData.ts:30
    • diff --git a/rest-client/types/AwsRekognitionDetectLabel.html b/rest-client/types/AwsRekognitionDetectLabel.html index 63e3867e..236c656d 100644 --- a/rest-client/types/AwsRekognitionDetectLabel.html +++ b/rest-client/types/AwsRekognitionDetectLabel.html @@ -17,7 +17,7 @@

    Type alias AwsRekognitionDetectLabel

    AwsRekognitionDetectLabel: AwsLabel<{
        Instances: AwsRekognitionDetectLabelInstance[];
        Parents: AwsRekognitionDetectLabelParent[];
    }>
    +
  • Defined in packages/rest-client/src/types/AppData.ts:32
    • diff --git a/rest-client/types/AwsRekognitionDetectLabelInstance.html b/rest-client/types/AwsRekognitionDetectLabelInstance.html index 455d40db..93bf50a4 100644 --- a/rest-client/types/AwsRekognitionDetectLabelInstance.html +++ b/rest-client/types/AwsRekognitionDetectLabelInstance.html @@ -33,7 +33,7 @@
    Width
    Confidence: number
    +
  • Defined in packages/rest-client/src/types/AppData.ts:20
    • diff --git a/rest-client/types/AwsRekognitionDetectLabelParent.html b/rest-client/types/AwsRekognitionDetectLabelParent.html index f83fcb78..d517aae8 100644 --- a/rest-client/types/AwsRekognitionDetectLabelParent.html +++ b/rest-client/types/AwsRekognitionDetectLabelParent.html @@ -22,7 +22,7 @@

    Type declaration

  • Name: string
    • +
  • Defined in packages/rest-client/src/types/AppData.ts:16
    • diff --git a/rest-client/types/AwsRekognitionDetectLabels.html b/rest-client/types/AwsRekognitionDetectLabels.html index 7e742e67..58c5ddc0 100644 --- a/rest-client/types/AwsRekognitionDetectLabels.html +++ b/rest-client/types/AwsRekognitionDetectLabels.html @@ -17,7 +17,7 @@

    Type alias AwsRekognitionDetectLabels

    AwsRekognitionDetectLabels: AddonData<{
        LabelModelVersion: string;
        Labels: AwsRekognitionDetectLabel[];
    }>
    +
  • Defined in packages/rest-client/src/types/AppData.ts:37
    • diff --git a/rest-client/types/AwsRekognitionDetectModerationLabel.html b/rest-client/types/AwsRekognitionDetectModerationLabel.html index 9ae4384c..7cb12819 100644 --- a/rest-client/types/AwsRekognitionDetectModerationLabel.html +++ b/rest-client/types/AwsRekognitionDetectModerationLabel.html @@ -17,7 +17,7 @@

    Type alias AwsRekognitionDetectModerationLabel

    AwsRekognitionDetectModerationLabel: AwsLabel<{
        ParentName: string;
    }>
    +
  • Defined in packages/rest-client/src/types/AppData.ts:42
    • diff --git a/rest-client/types/AwsRekognitionDetectModerationLabels.html b/rest-client/types/AwsRekognitionDetectModerationLabels.html index fb308ed3..71f1cd0b 100644 --- a/rest-client/types/AwsRekognitionDetectModerationLabels.html +++ b/rest-client/types/AwsRekognitionDetectModerationLabels.html @@ -17,7 +17,7 @@

    Type alias AwsRekognitionDetectModerationLabels

    AwsRekognitionDetectModerationLabels: AddonData<{
        ModerationLabels: AwsRekognitionDetectModerationLabel[];
        ModerationModelVersion: string;
    }>
    +
  • Defined in packages/rest-client/src/types/AppData.ts:46
    • diff --git a/rest-client/types/BaseConversionOption.html b/rest-client/types/BaseConversionOption.html index de662660..c996584c 100644 --- a/rest-client/types/BaseConversionOption.html +++ b/rest-client/types/BaseConversionOption.html @@ -31,7 +31,7 @@
    Optional
    type: T
    +
  • Defined in packages/rest-client/src/types/ConversionOptions.ts:5
    • diff --git a/rest-client/types/BatchResponse.html b/rest-client/types/BatchResponse.html index 4d5bd314..ffbc2b4b 100644 --- a/rest-client/types/BatchResponse.html +++ b/rest-client/types/BatchResponse.html @@ -31,7 +31,7 @@
    result
    status: BatchResponseStatus
    +
  • Defined in packages/rest-client/src/types/BatchResponse.ts:7
    • diff --git a/rest-client/types/ClamavVirusScan.html b/rest-client/types/ClamavVirusScan.html index a3e2762a..a15348f7 100644 --- a/rest-client/types/ClamavVirusScan.html +++ b/rest-client/types/ClamavVirusScan.html @@ -17,7 +17,7 @@

    Type alias ClamavVirusScan

    ClamavVirusScan: AddonData<{
        infected: boolean;
        infected_with: string;
    }>
    +
  • Defined in packages/rest-client/src/types/AppData.ts:11
    • diff --git a/rest-client/types/ConversionInfoOptions.html b/rest-client/types/ConversionInfoOptions.html index 18a649fe..5cb1847f 100644 --- a/rest-client/types/ConversionInfoOptions.html +++ b/rest-client/types/ConversionInfoOptions.html @@ -22,7 +22,7 @@

    Type declaration

  • uuid: string
    • +
  • Defined in packages/rest-client/src/api/conversion/conversionInfo.ts:4
    • diff --git a/rest-client/types/ConversionInfoResponse.html b/rest-client/types/ConversionInfoResponse.html index b312c90e..ec9fa179 100644 --- a/rest-client/types/ConversionInfoResponse.html +++ b/rest-client/types/ConversionInfoResponse.html @@ -31,7 +31,7 @@
    conversionFormats
    name: string
    +
  • Defined in packages/rest-client/src/api/conversion/conversionInfo.ts:8
    • diff --git a/rest-client/types/ConversionJobPollerOptions.html b/rest-client/types/ConversionJobPollerOptions.html index 43437471..08779231 100644 --- a/rest-client/types/ConversionJobPollerOptions.html +++ b/rest-client/types/ConversionJobPollerOptions.html @@ -51,7 +51,7 @@

    Parameters

    response: ConversionStatusResponse<ConversionStatusResult[T]>

    Returns void

    +
  • Defined in packages/rest-client/src/tools/conversionJobPoller.ts:14
    • diff --git a/rest-client/types/ConversionOptions.html b/rest-client/types/ConversionOptions.html index bda90c6d..e356b97f 100644 --- a/rest-client/types/ConversionOptions.html +++ b/rest-client/types/ConversionOptions.html @@ -22,7 +22,7 @@

    Type Parameters

  • T extends ValueOf<typeof ConversionType>

    • +
  • Defined in packages/rest-client/src/types/ConversionOptions.ts:11
    • diff --git a/rest-client/types/ConversionResponse.html b/rest-client/types/ConversionResponse.html index f9db57f0..638714e1 100644 --- a/rest-client/types/ConversionResponse.html +++ b/rest-client/types/ConversionResponse.html @@ -29,7 +29,7 @@
    problems
    result: T[]
    +
  • Defined in packages/rest-client/src/types/ConversionResponse.ts:5
    • diff --git a/rest-client/types/ConversionResult.html b/rest-client/types/ConversionResult.html index 8af925e7..56a553ac 100644 --- a/rest-client/types/ConversionResult.html +++ b/rest-client/types/ConversionResult.html @@ -24,7 +24,7 @@
    document
    video: ConversionResultVideo
    +
  • Defined in packages/rest-client/src/types/ConversionResult.ts:14
    • diff --git a/rest-client/types/ConversionResultDocument.html b/rest-client/types/ConversionResultDocument.html index 87b2cfce..1f00292b 100644 --- a/rest-client/types/ConversionResultDocument.html +++ b/rest-client/types/ConversionResultDocument.html @@ -17,7 +17,7 @@

    Type alias ConversionResultDocument

    ConversionResultDocument: ConversionResultBase
    +
  • Defined in packages/rest-client/src/types/ConversionResult.ts:9
    • diff --git a/rest-client/types/ConversionStatusOptions.html b/rest-client/types/ConversionStatusOptions.html index 7ba2ab53..723db31e 100644 --- a/rest-client/types/ConversionStatusOptions.html +++ b/rest-client/types/ConversionStatusOptions.html @@ -29,7 +29,7 @@
    token
    type: T
    +
  • Defined in packages/rest-client/src/types/ConversionStatusOptions.ts:4
    • diff --git a/rest-client/types/ConversionStatusResponse.html b/rest-client/types/ConversionStatusResponse.html index 3bca7178..e11e319e 100644 --- a/rest-client/types/ConversionStatusResponse.html +++ b/rest-client/types/ConversionStatusResponse.html @@ -31,7 +31,7 @@
    result
    status: ConversionStatus
    +
  • Defined in packages/rest-client/src/types/ConversionStatusResponse.ts:5
    • diff --git a/rest-client/types/ConversionStatusResult.html b/rest-client/types/ConversionStatusResult.html index 6ca9dc35..2faf1b09 100644 --- a/rest-client/types/ConversionStatusResult.html +++ b/rest-client/types/ConversionStatusResult.html @@ -24,7 +24,7 @@
    document
    video: ConversionStatusResultVideo
    +
  • Defined in packages/rest-client/src/types/ConversionStatusResult.ts:13
    • diff --git a/rest-client/types/ConversionStatusResultDocument.html b/rest-client/types/ConversionStatusResultDocument.html index d5591020..8dab711f 100644 --- a/rest-client/types/ConversionStatusResultDocument.html +++ b/rest-client/types/ConversionStatusResultDocument.html @@ -17,7 +17,7 @@

    Type alias ConversionStatusResultDocument

    ConversionStatusResultDocument: ConversionStatusResultBase
    +
  • Defined in packages/rest-client/src/types/ConversionStatusResult.ts:7
    • diff --git a/rest-client/types/CopyFileToLocalStorageOptions.html b/rest-client/types/CopyFileToLocalStorageOptions.html index fc489d07..14a135b9 100644 --- a/rest-client/types/CopyFileToLocalStorageOptions.html +++ b/rest-client/types/CopyFileToLocalStorageOptions.html @@ -26,7 +26,7 @@
    source
    Optional store?: boolean
    +
  • Defined in packages/rest-client/src/api/file/copyFileToLocalStorage.ts:6
    • diff --git a/rest-client/types/CopyFileToLocalStorageResponse.html b/rest-client/types/CopyFileToLocalStorageResponse.html index d67589e0..01054308 100644 --- a/rest-client/types/CopyFileToLocalStorageResponse.html +++ b/rest-client/types/CopyFileToLocalStorageResponse.html @@ -27,7 +27,7 @@
    result
    type: "file"
    +
  • Defined in packages/rest-client/src/api/file/copyFileToLocalStorage.ts:16
    • diff --git a/rest-client/types/CopyFileToRemoteStorageOptions.html b/rest-client/types/CopyFileToRemoteStorageOptions.html index 49ea8c6b..a1ed415e 100644 --- a/rest-client/types/CopyFileToRemoteStorageOptions.html +++ b/rest-client/types/CopyFileToRemoteStorageOptions.html @@ -28,7 +28,7 @@
    source
    target: string
    +
  • Defined in packages/rest-client/src/api/file/copyFileToRemoteStorage.ts:4
    • diff --git a/rest-client/types/CopyFileToRemoteStorageResponse.html b/rest-client/types/CopyFileToRemoteStorageResponse.html index 6964b5ce..f240f530 100644 --- a/rest-client/types/CopyFileToRemoteStorageResponse.html +++ b/rest-client/types/CopyFileToRemoteStorageResponse.html @@ -24,7 +24,7 @@
    result
    type: "url"
    +
  • Defined in packages/rest-client/src/api/file/copyFileToRemoteStorage.ts:11
    • diff --git a/rest-client/types/CreateJobPollerPollOptions.html b/rest-client/types/CreateJobPollerPollOptions.html index 650a7387..bde58bcc 100644 --- a/rest-client/types/CreateJobPollerPollOptions.html +++ b/rest-client/types/CreateJobPollerPollOptions.html @@ -29,7 +29,7 @@
    Optional
    Optional timeout?: number
    +
  • Defined in packages/rest-client/src/tools/createJobPoller.ts:66
    • diff --git a/rest-client/types/CreateWebhookOptions.html b/rest-client/types/CreateWebhookOptions.html index fb20002b..80513656 100644 --- a/rest-client/types/CreateWebhookOptions.html +++ b/rest-client/types/CreateWebhookOptions.html @@ -17,7 +17,7 @@

    Type alias CreateWebhookOptions

    CreateWebhookOptions: Pick<Webhook, "targetUrl" | "event"> & Partial<Pick<Webhook, "isActive" | "signingSecret" | "version">>
    +
  • Defined in packages/rest-client/src/api/webhooks/createWebhook.ts:5
    • diff --git a/rest-client/types/CreateWebhookResponse.html b/rest-client/types/CreateWebhookResponse.html index d94d9230..21cb4c45 100644 --- a/rest-client/types/CreateWebhookResponse.html +++ b/rest-client/types/CreateWebhookResponse.html @@ -17,7 +17,7 @@

    Type alias CreateWebhookResponse

    CreateWebhookResponse: Webhook
    +
  • Defined in packages/rest-client/src/api/webhooks/createWebhook.ts:8
    • diff --git a/rest-client/types/DeleteFileOptions.html b/rest-client/types/DeleteFileOptions.html index c82a9470..3f81ac46 100644 --- a/rest-client/types/DeleteFileOptions.html +++ b/rest-client/types/DeleteFileOptions.html @@ -22,7 +22,7 @@

    Type declaration

  • uuid: string
    • +
  • Defined in packages/rest-client/src/api/file/deleteFile.ts:5
    • diff --git a/rest-client/types/DeleteFileResponse.html b/rest-client/types/DeleteFileResponse.html index b77c29d4..8c50fc50 100644 --- a/rest-client/types/DeleteFileResponse.html +++ b/rest-client/types/DeleteFileResponse.html @@ -17,7 +17,7 @@

    Type alias DeleteFileResponse

    DeleteFileResponse: FileInfo
    +
  • Defined in packages/rest-client/src/api/file/deleteFile.ts:9
    • diff --git a/rest-client/types/DeleteFilesOptions.html b/rest-client/types/DeleteFilesOptions.html index 2ec9bdc2..6c87d0e0 100644 --- a/rest-client/types/DeleteFilesOptions.html +++ b/rest-client/types/DeleteFilesOptions.html @@ -22,7 +22,7 @@

    Type declaration

  • uuids: string[]
    • +
  • Defined in packages/rest-client/src/api/file/deleteFiles.ts:6
    • diff --git a/rest-client/types/DeleteFilesResponse.html b/rest-client/types/DeleteFilesResponse.html index d6e8a309..a5cd889c 100644 --- a/rest-client/types/DeleteFilesResponse.html +++ b/rest-client/types/DeleteFilesResponse.html @@ -17,7 +17,7 @@

    Type alias DeleteFilesResponse

    DeleteFilesResponse: BatchResponse<FileInfo>
    +
  • Defined in packages/rest-client/src/api/file/deleteFiles.ts:10
    • diff --git a/rest-client/types/DeleteGroupOptions.html b/rest-client/types/DeleteGroupOptions.html index dbf97ba7..ec9e1838 100644 --- a/rest-client/types/DeleteGroupOptions.html +++ b/rest-client/types/DeleteGroupOptions.html @@ -22,7 +22,7 @@

    Type declaration

  • uuid: string
    • +
  • Defined in packages/rest-client/src/api/group/deleteGroup.ts:4
    • diff --git a/rest-client/types/DeleteGroupResponse.html b/rest-client/types/DeleteGroupResponse.html index dc2533d8..472472ac 100644 --- a/rest-client/types/DeleteGroupResponse.html +++ b/rest-client/types/DeleteGroupResponse.html @@ -17,7 +17,7 @@

    Type alias DeleteGroupResponse

    DeleteGroupResponse: void
    +
  • Defined in packages/rest-client/src/api/group/deleteGroup.ts:8
    • diff --git a/rest-client/types/DeleteMetadataOptions.html b/rest-client/types/DeleteMetadataOptions.html index f5a35466..c948e806 100644 --- a/rest-client/types/DeleteMetadataOptions.html +++ b/rest-client/types/DeleteMetadataOptions.html @@ -24,7 +24,7 @@
    key
    uuid: string
    +
  • Defined in packages/rest-client/src/api/metadata/deleteMetadata.ts:4
    • diff --git a/rest-client/types/DeleteMetadataResponse.html b/rest-client/types/DeleteMetadataResponse.html index d4f998c0..1ea34bf9 100644 --- a/rest-client/types/DeleteMetadataResponse.html +++ b/rest-client/types/DeleteMetadataResponse.html @@ -17,7 +17,7 @@

    Type alias DeleteMetadataResponse

    DeleteMetadataResponse: void
    +
  • Defined in packages/rest-client/src/api/metadata/deleteMetadata.ts:9
    • diff --git a/rest-client/types/DeleteWebhookOptions.html b/rest-client/types/DeleteWebhookOptions.html index c1309b08..5985db08 100644 --- a/rest-client/types/DeleteWebhookOptions.html +++ b/rest-client/types/DeleteWebhookOptions.html @@ -17,7 +17,7 @@

    Type alias DeleteWebhookOptions

    DeleteWebhookOptions: Pick<Webhook, "targetUrl">
    +
  • Defined in packages/rest-client/src/api/webhooks/deleteWebhook.ts:5
    • diff --git a/rest-client/types/DeleteWebhookResponse.html b/rest-client/types/DeleteWebhookResponse.html index 653da7e9..c7c327ad 100644 --- a/rest-client/types/DeleteWebhookResponse.html +++ b/rest-client/types/DeleteWebhookResponse.html @@ -17,7 +17,7 @@

    Type alias DeleteWebhookResponse

    DeleteWebhookResponse: void
    +
  • Defined in packages/rest-client/src/api/webhooks/deleteWebhook.ts:7
    • diff --git a/rest-client/types/ExecuteAddonOptions.html b/rest-client/types/ExecuteAddonOptions.html index 643ac5b1..89cec800 100644 --- a/rest-client/types/ExecuteAddonOptions.html +++ b/rest-client/types/ExecuteAddonOptions.html @@ -31,7 +31,7 @@
    Optional
    target: string
    +
  • Defined in packages/rest-client/src/api/addons/executeAddon.ts:7
    • diff --git a/rest-client/types/ExecuteAddonResponse.html b/rest-client/types/ExecuteAddonResponse.html index 1be9d021..4c6dc69c 100644 --- a/rest-client/types/ExecuteAddonResponse.html +++ b/rest-client/types/ExecuteAddonResponse.html @@ -22,7 +22,7 @@

    Type declaration

  • requestId: string
    • +
  • Defined in packages/rest-client/src/api/addons/executeAddon.ts:13
    • diff --git a/rest-client/types/FileInfo.html b/rest-client/types/FileInfo.html index 4a207130..a22ec349 100644 --- a/rest-client/types/FileInfo.html +++ b/rest-client/types/FileInfo.html @@ -50,7 +50,7 @@
    uuid
    variations: FileInfoVariations | null
    +
  • Defined in packages/rest-client/src/types/FileInfo.ts:7
    • diff --git a/rest-client/types/FileInfoOptions.html b/rest-client/types/FileInfoOptions.html index 01f02f30..0b61bad5 100644 --- a/rest-client/types/FileInfoOptions.html +++ b/rest-client/types/FileInfoOptions.html @@ -24,7 +24,7 @@
    Optional
    uuid: string
    +
  • Defined in packages/rest-client/src/api/file/fileInfo.ts:5
    • diff --git a/rest-client/types/FileInfoResponse.html b/rest-client/types/FileInfoResponse.html index 487be819..1c20ca11 100644 --- a/rest-client/types/FileInfoResponse.html +++ b/rest-client/types/FileInfoResponse.html @@ -17,7 +17,7 @@

    Type alias FileInfoResponse

    FileInfoResponse: FileInfo
    +
  • Defined in packages/rest-client/src/api/file/fileInfo.ts:10
    • diff --git a/rest-client/types/FileInfoVariations.html b/rest-client/types/FileInfoVariations.html index 96f301be..88fd0f40 100644 --- a/rest-client/types/FileInfoVariations.html +++ b/rest-client/types/FileInfoVariations.html @@ -17,7 +17,7 @@

    Type alias FileInfoVariations

    FileInfoVariations: string[]
    +
  • Defined in packages/rest-client/src/types/FileInfo.ts:5
    • diff --git a/rest-client/types/GetMetadataOptions.html b/rest-client/types/GetMetadataOptions.html index 42e92516..33f60de8 100644 --- a/rest-client/types/GetMetadataOptions.html +++ b/rest-client/types/GetMetadataOptions.html @@ -22,7 +22,7 @@

    Type declaration

  • uuid: string
    • +
  • Defined in packages/rest-client/src/api/metadata/getMetadata.ts:5
    • diff --git a/rest-client/types/GetMetadataResponse.html b/rest-client/types/GetMetadataResponse.html index 9504daf3..56dabb43 100644 --- a/rest-client/types/GetMetadataResponse.html +++ b/rest-client/types/GetMetadataResponse.html @@ -17,7 +17,7 @@

    Type alias GetMetadataResponse

    GetMetadataResponse: Metadata
    +
  • Defined in packages/rest-client/src/api/metadata/getMetadata.ts:9
    • diff --git a/rest-client/types/GetMetadataValueOptions.html b/rest-client/types/GetMetadataValueOptions.html index 8a69040f..1aa3d7ec 100644 --- a/rest-client/types/GetMetadataValueOptions.html +++ b/rest-client/types/GetMetadataValueOptions.html @@ -24,7 +24,7 @@
    key
    uuid: string
    +
  • Defined in packages/rest-client/src/api/metadata/getMetadataValue.ts:5
    • diff --git a/rest-client/types/GetMetadataValueResponse.html b/rest-client/types/GetMetadataValueResponse.html index def61cf4..f3319b1e 100644 --- a/rest-client/types/GetMetadataValueResponse.html +++ b/rest-client/types/GetMetadataValueResponse.html @@ -17,7 +17,7 @@

    Type alias GetMetadataValueResponse

    GetMetadataValueResponse: Metadata
    +
  • Defined in packages/rest-client/src/api/metadata/getMetadataValue.ts:10
    • diff --git a/rest-client/types/GroupInfo.html b/rest-client/types/GroupInfo.html index cb1f80c1..5f172604 100644 --- a/rest-client/types/GroupInfo.html +++ b/rest-client/types/GroupInfo.html @@ -32,7 +32,7 @@
    id
  • url: string
    • +
  • Defined in packages/rest-client/src/types/GroupInfo.ts:3
    • diff --git a/rest-client/types/GroupInfoOptions.html b/rest-client/types/GroupInfoOptions.html index 4b841b8a..206294d5 100644 --- a/rest-client/types/GroupInfoOptions.html +++ b/rest-client/types/GroupInfoOptions.html @@ -22,7 +22,7 @@

    Type declaration

  • uuid: string
    • +
  • Defined in packages/rest-client/src/api/group/groupInfo.ts:5
    • diff --git a/rest-client/types/GroupInfoResponse.html b/rest-client/types/GroupInfoResponse.html index 7a402e17..0fef0020 100644 --- a/rest-client/types/GroupInfoResponse.html +++ b/rest-client/types/GroupInfoResponse.html @@ -17,7 +17,7 @@

    Type alias GroupInfoResponse

    GroupInfoResponse: GroupInfo
    +
  • Defined in packages/rest-client/src/api/group/groupInfo.ts:9
    • diff --git a/rest-client/types/GroupInfoShort.html b/rest-client/types/GroupInfoShort.html index bb813887..e1be011e 100644 --- a/rest-client/types/GroupInfoShort.html +++ b/rest-client/types/GroupInfoShort.html @@ -17,7 +17,7 @@

    Type alias GroupInfoShort

    GroupInfoShort: Omit<GroupInfo, "files">
    +
  • Defined in packages/rest-client/src/types/GroupInfo.ts:12
    • diff --git a/rest-client/types/ListOfFilesOptions.html b/rest-client/types/ListOfFilesOptions.html index 0fcbb0f0..cc84cdf1 100644 --- a/rest-client/types/ListOfFilesOptions.html +++ b/rest-client/types/ListOfFilesOptions.html @@ -30,7 +30,7 @@
    Optional
    Optional stored?: boolean
    +
  • Defined in packages/rest-client/src/api/file/listOfFiles.ts:8
    • diff --git a/rest-client/types/ListOfFilesOrdering.html b/rest-client/types/ListOfFilesOrdering.html index 5199596e..34181596 100644 --- a/rest-client/types/ListOfFilesOrdering.html +++ b/rest-client/types/ListOfFilesOrdering.html @@ -17,7 +17,7 @@

    Type alias ListOfFilesOrdering

    ListOfFilesOrdering: "datetime_uploaded" | "-datetime_uploaded"
    +
  • Defined in packages/rest-client/src/api/file/listOfFiles.ts:6
    • diff --git a/rest-client/types/ListOfFilesResponse.html b/rest-client/types/ListOfFilesResponse.html index 49752445..bfe797e1 100644 --- a/rest-client/types/ListOfFilesResponse.html +++ b/rest-client/types/ListOfFilesResponse.html @@ -17,7 +17,7 @@

    Type alias ListOfFilesResponse

    ListOfFilesResponse: PaginatedList<FileInfo, {
        totals: ListOfFilesTotals;
    }>
    +
  • Defined in packages/rest-client/src/api/file/listOfFiles.ts:22
    • diff --git a/rest-client/types/ListOfFilesTotals.html b/rest-client/types/ListOfFilesTotals.html index 56620bf8..5c2af532 100644 --- a/rest-client/types/ListOfFilesTotals.html +++ b/rest-client/types/ListOfFilesTotals.html @@ -26,7 +26,7 @@
    stored
    unstored: number
    +
  • Defined in packages/rest-client/src/api/file/listOfFiles.ts:16
    • diff --git a/rest-client/types/ListOfGroupsOptions.html b/rest-client/types/ListOfGroupsOptions.html index 45d23bbc..f3494e27 100644 --- a/rest-client/types/ListOfGroupsOptions.html +++ b/rest-client/types/ListOfGroupsOptions.html @@ -26,7 +26,7 @@
    Optional
    Optional ordering?: ListOfGroupsOrdering
    +
  • Defined in packages/rest-client/src/api/group/listOfGroups.ts:8
    • diff --git a/rest-client/types/ListOfGroupsOrdering.html b/rest-client/types/ListOfGroupsOrdering.html index dd1af133..55d293f8 100644 --- a/rest-client/types/ListOfGroupsOrdering.html +++ b/rest-client/types/ListOfGroupsOrdering.html @@ -17,7 +17,7 @@

    Type alias ListOfGroupsOrdering

    ListOfGroupsOrdering: "datetime_created" | "-datetime_created"
    +
  • Defined in packages/rest-client/src/api/group/listOfGroups.ts:6
    • diff --git a/rest-client/types/ListOfGroupsResponse.html b/rest-client/types/ListOfGroupsResponse.html index b1f51fb9..301632ef 100644 --- a/rest-client/types/ListOfGroupsResponse.html +++ b/rest-client/types/ListOfGroupsResponse.html @@ -17,7 +17,7 @@

    Type alias ListOfGroupsResponse

    ListOfGroupsResponse: PaginatedList<GroupInfoShort>
    +
  • Defined in packages/rest-client/src/api/group/listOfGroups.ts:14
    • diff --git a/rest-client/types/ListOfWebhooksOptions.html b/rest-client/types/ListOfWebhooksOptions.html index 72558f95..c39ac385 100644 --- a/rest-client/types/ListOfWebhooksOptions.html +++ b/rest-client/types/ListOfWebhooksOptions.html @@ -17,7 +17,7 @@

    Type alias ListOfWebhooksOptions

    ListOfWebhooksOptions: Record<string, never>
    +
  • Defined in packages/rest-client/src/api/webhooks/listOfWebhooks.ts:5
    • diff --git a/rest-client/types/ListOfWebhooksResponse.html b/rest-client/types/ListOfWebhooksResponse.html index 0f30be86..6257538f 100644 --- a/rest-client/types/ListOfWebhooksResponse.html +++ b/rest-client/types/ListOfWebhooksResponse.html @@ -17,7 +17,7 @@

    Type alias ListOfWebhooksResponse

    ListOfWebhooksResponse: Webhook[]
    +
  • Defined in packages/rest-client/src/api/webhooks/listOfWebhooks.ts:7
    • diff --git a/rest-client/types/Md5Function.html b/rest-client/types/Md5Function.html index 6cb17713..deb0456a 100644 --- a/rest-client/types/Md5Function.html +++ b/rest-client/types/Md5Function.html @@ -30,7 +30,7 @@

    Parameters

    input: string

    Returns string

    +
  • Defined in packages/rest-client/src/lib/md5/Md5Function.ts:1
    • diff --git a/rest-client/types/Paginatable.html b/rest-client/types/Paginatable.html index 2fd8bbb3..315ca051 100644 --- a/rest-client/types/Paginatable.html +++ b/rest-client/types/Paginatable.html @@ -43,7 +43,7 @@
    options: settings: Settings

    Returns Promise<PaginatedList<PageItem, PageExtra>>

    +
  • Defined in packages/rest-client/src/types/Paginatable.ts:3
    • diff --git a/rest-client/types/PaginatedList.html b/rest-client/types/PaginatedList.html index 2c17f5d9..502a7afe 100644 --- a/rest-client/types/PaginatedList.html +++ b/rest-client/types/PaginatedList.html @@ -24,7 +24,7 @@

    PageItem

  • PageExtra = Record<string, never>

    • +
  • Defined in packages/rest-client/src/types/PaginatedList.ts:1
    • diff --git a/rest-client/types/Problems.html b/rest-client/types/Problems.html index 36c17034..00ce8306 100644 --- a/rest-client/types/Problems.html +++ b/rest-client/types/Problems.html @@ -17,7 +17,7 @@

    Type alias Problems

    Problems: Record<string, string>
    +
  • Defined in packages/rest-client/src/types/Problems.ts:1
    • diff --git a/rest-client/types/RemoveBg.html b/rest-client/types/RemoveBg.html index 43a1aa56..cd05582e 100644 --- a/rest-client/types/RemoveBg.html +++ b/rest-client/types/RemoveBg.html @@ -17,7 +17,7 @@

    Type alias RemoveBg

    RemoveBg: AddonData<{
        foreground_type: string;
    }>
    +
  • Defined in packages/rest-client/src/types/AppData.ts:51
    • diff --git a/rest-client/types/ServerErrorResponse.html b/rest-client/types/ServerErrorResponse.html index 38120af2..046d912c 100644 --- a/rest-client/types/ServerErrorResponse.html +++ b/rest-client/types/ServerErrorResponse.html @@ -22,7 +22,7 @@

    Type declaration

  • detail: string
    • +
  • Defined in packages/rest-client/src/types/ServerErrorResponse.ts:1
    • diff --git a/rest-client/types/StoreFileOptions.html b/rest-client/types/StoreFileOptions.html index 502318e3..2e957271 100644 --- a/rest-client/types/StoreFileOptions.html +++ b/rest-client/types/StoreFileOptions.html @@ -22,7 +22,7 @@

    Type declaration

  • uuid: string
    • +
  • Defined in packages/rest-client/src/api/file/storeFile.ts:5
    • diff --git a/rest-client/types/StoreFileResponse.html b/rest-client/types/StoreFileResponse.html index f106f562..75e0ecdc 100644 --- a/rest-client/types/StoreFileResponse.html +++ b/rest-client/types/StoreFileResponse.html @@ -17,7 +17,7 @@

    Type alias StoreFileResponse

    StoreFileResponse: FileInfo
    +
  • Defined in packages/rest-client/src/api/file/storeFile.ts:9
    • diff --git a/rest-client/types/StoreFilesOptions.html b/rest-client/types/StoreFilesOptions.html index a9acc6b7..8ae3c933 100644 --- a/rest-client/types/StoreFilesOptions.html +++ b/rest-client/types/StoreFilesOptions.html @@ -22,7 +22,7 @@

    Type declaration

  • uuids: string[]
    • +
  • Defined in packages/rest-client/src/api/file/storeFiles.ts:6
    • diff --git a/rest-client/types/StoreFilesResponse.html b/rest-client/types/StoreFilesResponse.html index cee8f01f..9970b749 100644 --- a/rest-client/types/StoreFilesResponse.html +++ b/rest-client/types/StoreFilesResponse.html @@ -17,7 +17,7 @@

    Type alias StoreFilesResponse

    StoreFilesResponse: BatchResponse<FileInfo>
    +
  • Defined in packages/rest-client/src/api/file/storeFiles.ts:10
    • diff --git a/rest-client/types/TechFieldsAppData.html b/rest-client/types/TechFieldsAppData.html index 605348e2..164d32ab 100644 --- a/rest-client/types/TechFieldsAppData.html +++ b/rest-client/types/TechFieldsAppData.html @@ -26,7 +26,7 @@
    datetime_updated
    version: string
    +
  • Defined in packages/rest-client/src/types/AppData.ts:3
    • diff --git a/rest-client/types/UpdateMetadataOptions.html b/rest-client/types/UpdateMetadataOptions.html index b2ffbe41..8357d6f1 100644 --- a/rest-client/types/UpdateMetadataOptions.html +++ b/rest-client/types/UpdateMetadataOptions.html @@ -26,7 +26,7 @@
    uuid
    value: string
    +
  • Defined in packages/rest-client/src/api/metadata/updateMetadata.ts:4
    • diff --git a/rest-client/types/UpdateMetadataResponse.html b/rest-client/types/UpdateMetadataResponse.html index f9bf6eb4..d07840f8 100644 --- a/rest-client/types/UpdateMetadataResponse.html +++ b/rest-client/types/UpdateMetadataResponse.html @@ -17,7 +17,7 @@

    Type alias UpdateMetadataResponse

    UpdateMetadataResponse: string
    +
  • Defined in packages/rest-client/src/api/metadata/updateMetadata.ts:10
    • diff --git a/rest-client/types/UpdateWebhookOptions.html b/rest-client/types/UpdateWebhookOptions.html index 05e77248..9aa58fc0 100644 --- a/rest-client/types/UpdateWebhookOptions.html +++ b/rest-client/types/UpdateWebhookOptions.html @@ -17,7 +17,7 @@

    Type alias UpdateWebhookOptions

    UpdateWebhookOptions: Pick<Webhook, "id"> & Partial<Pick<Webhook, "targetUrl" | "event" | "isActive" | "signingSecret">>
    +
  • Defined in packages/rest-client/src/api/webhooks/updateWebhook.ts:5
    • diff --git a/rest-client/types/UpdateWebhookResponse.html b/rest-client/types/UpdateWebhookResponse.html index 070d46f6..acbb00ee 100644 --- a/rest-client/types/UpdateWebhookResponse.html +++ b/rest-client/types/UpdateWebhookResponse.html @@ -17,7 +17,7 @@

    Type alias UpdateWebhookResponse

    UpdateWebhookResponse: Webhook
    +
  • Defined in packages/rest-client/src/api/webhooks/updateWebhook.ts:7
    • diff --git a/rest-client/types/UploadcareAuthSchemaOptionsWithSecretKey.html b/rest-client/types/UploadcareAuthSchemaOptionsWithSecretKey.html index 078a3d8d..ac1c3a80 100644 --- a/rest-client/types/UploadcareAuthSchemaOptionsWithSecretKey.html +++ b/rest-client/types/UploadcareAuthSchemaOptionsWithSecretKey.html @@ -32,7 +32,7 @@
    publicKey
    secretKey: string
    +
  • Defined in packages/rest-client/src/auth/UploadcareAuthSchema.ts:31
    • diff --git a/rest-client/types/UploadcareAuthSchemaOptionsWithSignatureResolver.html b/rest-client/types/UploadcareAuthSchemaOptionsWithSignatureResolver.html index 558eed6a..33b92c3c 100644 --- a/rest-client/types/UploadcareAuthSchemaOptionsWithSignatureResolver.html +++ b/rest-client/types/UploadcareAuthSchemaOptionsWithSignatureResolver.html @@ -32,7 +32,7 @@
    publicKey
    signatureResolver: UploadcareAuthSchemaSignatureResolver
    +
  • Defined in packages/rest-client/src/auth/UploadcareAuthSchema.ts:25
    • diff --git a/rest-client/types/UploadcareAuthSchemaSignatureResolver.html b/rest-client/types/UploadcareAuthSchemaSignatureResolver.html index 7ece4627..16289a63 100644 --- a/rest-client/types/UploadcareAuthSchemaSignatureResolver.html +++ b/rest-client/types/UploadcareAuthSchemaSignatureResolver.html @@ -30,7 +30,7 @@

    Parameters

    signString: string

    Returns Promise<string>

    +
  • Defined in packages/rest-client/src/auth/UploadcareAuthSchema.ts:16
    • diff --git a/rest-client/types/UploadcareSimpleAuthSchemaOptions.html b/rest-client/types/UploadcareSimpleAuthSchemaOptions.html index fb29d4a9..fd3a4362 100644 --- a/rest-client/types/UploadcareSimpleAuthSchemaOptions.html +++ b/rest-client/types/UploadcareSimpleAuthSchemaOptions.html @@ -24,7 +24,7 @@
    publicKey
    secretKey: string
    +
  • Defined in packages/rest-client/src/auth/UploadcareSimpleAuthSchema.ts:6
    • diff --git a/rest-client/types/UserSettings.html b/rest-client/types/UserSettings.html index 964f72eb..98198384 100644 --- a/rest-client/types/UserSettings.html +++ b/rest-client/types/UserSettings.html @@ -32,7 +32,7 @@
    Optional
    Optional userAgent?: CustomUserAgent
    +
  • Defined in packages/rest-client/src/settings.ts:4
    • diff --git a/rest-client/types/ValueOf.html b/rest-client/types/ValueOf.html index 1c98bcb5..f5fa5583 100644 --- a/rest-client/types/ValueOf.html +++ b/rest-client/types/ValueOf.html @@ -22,7 +22,7 @@

    Type Parameters

  • T

    • +
  • Defined in packages/rest-client/src/types/ValueOf.ts:1
    • diff --git a/rest-client/types/Webhook.html b/rest-client/types/Webhook.html index bd806d0c..7093e6d0 100644 --- a/rest-client/types/Webhook.html +++ b/rest-client/types/Webhook.html @@ -38,7 +38,7 @@
    updated
    version: string
    +
  • Defined in packages/rest-client/src/types/Webhook.ts:3
    • diff --git a/signed-uploads/functions/generateSecureSignature.html b/signed-uploads/functions/generateSecureSignature.html index 3602b4bd..a8561c7d 100644 --- a/signed-uploads/functions/generateSecureSignature.html +++ b/signed-uploads/functions/generateSecureSignature.html @@ -39,7 +39,7 @@
    secureExpire
    secureSignature: string
    +
  • Defined in generateSecureSignature.ts:32
    • diff --git a/signed-uploads/types/GenerateSecureSignatureOptions.html b/signed-uploads/types/GenerateSecureSignatureOptions.html index 88eb5611..350cf5b9 100644 --- a/signed-uploads/types/GenerateSecureSignatureOptions.html +++ b/signed-uploads/types/GenerateSecureSignatureOptions.html @@ -17,7 +17,7 @@

    Type alias GenerateSecureSignatureOptions

    GenerateSecureSignatureOptions: {
        expire: number | Date;
    } | {
        lifetime: number;
    }
    +
  • Defined in generateSecureSignature.ts:3
    • diff --git a/upload-client/classes/Queue.html b/upload-client/classes/Queue.html index e45dbbaf..3f87f1ea 100644 --- a/upload-client/classes/Queue.html +++ b/upload-client/classes/Queue.html @@ -20,7 +20,7 @@

    Hierarchy

    • Queue
    +
  • Defined in packages/upload-client/src/tools/Queue.ts:5
    • @@ -54,7 +54,7 @@

    Parameters

    concurrency: number

    Returns Queue

    +
  • Defined in packages/upload-client/src/tools/Queue.ts:12

    • Accessors

    @@ -64,7 +64,7 @@

    concurrency

    Returns number

     +
  • Defined in packages/upload-client/src/tools/Queue.ts:66
  • set concurrency(value): void
  • @@ -74,7 +74,7 @@

    Parameters

    value: number

    • Returns void

    +
  • Defined in packages/upload-client/src/tools/Queue.ts:61

    • pending

    +
  • Defined in packages/upload-client/src/tools/Queue.ts:53

    • running

    +
  • Defined in packages/upload-client/src/tools/Queue.ts:57

    • Methods

    @@ -110,7 +110,7 @@

    Parameters

    task: Task<T>

    Returns Promise<T>

    +
  • Defined in packages/upload-client/src/tools/Queue.ts:43
    • diff --git a/upload-client/classes/UploadClient.html b/upload-client/classes/UploadClient.html index 879b050f..1f6ed577 100644 --- a/upload-client/classes/UploadClient.html +++ b/upload-client/classes/UploadClient.html @@ -20,7 +20,7 @@

    Hierarchy

    • UploadClient
    +
  • Defined in packages/upload-client/src/UploadClient.ts:41
    • @@ -61,7 +61,7 @@

    Parameters

    settings: Settings

    Returns UploadClient

    +
  • Defined in packages/upload-client/src/UploadClient.ts:44

    • Methods

    @@ -78,7 +78,7 @@
    file: options: Partial<BaseOptions> = {}

    Returns Promise<BaseResponse>

    +
  • Defined in packages/upload-client/src/UploadClient.ts:56

    • fromUrl

    Returns Promise<FromUrlSuccessResponse>

    +
  • Defined in packages/upload-client/src/UploadClient.ts:71

    • fromUrlStatus

    Returns Promise<FromUrlStatusResponse>

    +
  • Defined in packages/upload-client/src/UploadClient.ts:80

    • getSettings

    +
  • Defined in packages/upload-client/src/UploadClient.ts:52

    • group

    Returns Promise<GroupInfo>

    +
  • Defined in packages/upload-client/src/UploadClient.ts:89

    • groupInfo

    Returns Promise<GroupInfo>

    +
  • Defined in packages/upload-client/src/UploadClient.ts:98

    • info

    Returns Promise<FileInfo>

    +
  • Defined in packages/upload-client/src/UploadClient.ts:65

    • isReadyPoll

    Returns Promise<FileInfo>

    +
  • Defined in packages/upload-client/src/UploadClient.ts:160

    • multipartComplete

    Returns Promise<FileInfo>

    +
  • Defined in packages/upload-client/src/UploadClient.ts:130

    • multipartStart

    Returns Promise<MultipartStartResponse>

    +
  • Defined in packages/upload-client/src/UploadClient.ts:107

    • multipartUpload

    Returns Promise<MultipartUploadResponse>

    +
  • Defined in packages/upload-client/src/UploadClient.ts:116

    • updateSettings

    Returns void

    +
  • Defined in packages/upload-client/src/UploadClient.ts:48

    • uploadFile

    Returns Promise<UploadcareFile>

    +
  • Defined in packages/upload-client/src/UploadClient.ts:142

    • uploadFileGroup

    Returns Promise<UploadcareGroup>

    +
  • Defined in packages/upload-client/src/UploadClient.ts:151
    • diff --git a/upload-client/classes/UploadError.html b/upload-client/classes/UploadError.html index de68f8fa..8462cc08 100644 --- a/upload-client/classes/UploadError.html +++ b/upload-client/classes/UploadError.html @@ -22,7 +22,7 @@

    Hierarchy

    • UploadError
    +
  • Defined in packages/upload-client/src/tools/UploadError.ts:13
    • @@ -71,19 +71,19 @@
    Optional Returns UploadError
    +
  • Defined in packages/upload-client/src/tools/UploadError.ts:19

    • Properties

    Optional Readonly code

    code?: ServerErrorCode
    +
  • Defined in packages/upload-client/src/tools/UploadError.ts:14

    • Optional Readonly headers

    headers?: Headers
    +
  • Defined in packages/upload-client/src/tools/UploadError.ts:17

    • message

    message: string
    +
  • Defined in packages/upload-client/src/tools/UploadError.ts:15

    • Optional Readonly response

    response?: ErrorResponseInfo
    +
  • Defined in packages/upload-client/src/tools/UploadError.ts:16

    • Optional stack

    stack?: string
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:16
    • @@ -69,84 +69,84 @@
    Optional Optional fileName?: string

    Returns UploadcareFile

    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:33

    • Properties

    Readonly cdnUrl

    cdnUrl: null | string = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:23

    • Readonly contentInfo

    contentInfo: null | ContentInfo = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:28

    • Readonly defaultEffects

    defaultEffects: null | string = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:31

    • Readonly imageInfo

    imageInfo: null | ImageInfo = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:26

    • Readonly isImage

    isImage: null | boolean = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:21

    • Readonly isStored

    isStored: null | boolean = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:20

    • Readonly metadata

    metadata: null | Metadata = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:29

    • Readonly mimeType

    mimeType: null | string = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:22

    • Readonly name

    name: null | string = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:18

    • Readonly originalFilename

    originalFilename: null | string = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:25

    • Readonly s3Bucket

    s3Bucket: null | string = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:30

    • Readonly s3Url

    s3Url: null | string = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:24

    • Readonly size

    size: null | number = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:19

    • Readonly uuid

    uuid: string
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:17

    • Readonly videoInfo

    videoInfo: null | VideoInfo = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareFile.ts:27
    • diff --git a/upload-client/classes/UploadcareGroup.html b/upload-client/classes/UploadcareGroup.html index 86f27818..bb578c6e 100644 --- a/upload-client/classes/UploadcareGroup.html +++ b/upload-client/classes/UploadcareGroup.html @@ -20,7 +20,7 @@

    Hierarchy

    • UploadcareGroup
    +
  • Defined in packages/upload-client/src/tools/UploadcareGroup.ts:5
    • @@ -61,54 +61,54 @@
    __namedParameters: Optional baseCDN?: string

    Returns UploadcareGroup

    +
  • Defined in packages/upload-client/src/tools/UploadcareGroup.ts:16

    • Properties

    Readonly cdnUrl

    cdnUrl: string
    +
  • Defined in packages/upload-client/src/tools/UploadcareGroup.ts:11

    • Readonly createdAt

    createdAt: string
    +
  • Defined in packages/upload-client/src/tools/UploadcareGroup.ts:13

    • Readonly files

    files: UploadcareFile[]
    +
  • Defined in packages/upload-client/src/tools/UploadcareGroup.ts:12

    • Readonly filesCount

    filesCount: string
    +
  • Defined in packages/upload-client/src/tools/UploadcareGroup.ts:7

    • Readonly isImage

    isImage: boolean
    +
  • Defined in packages/upload-client/src/tools/UploadcareGroup.ts:10

    • Readonly isStored

    isStored: boolean
    +
  • Defined in packages/upload-client/src/tools/UploadcareGroup.ts:9

    • Readonly storedAt

    storedAt: null | string = null
    +
  • Defined in packages/upload-client/src/tools/UploadcareGroup.ts:14

    • Readonly totalSize

    totalSize: number
    +
  • Defined in packages/upload-client/src/tools/UploadcareGroup.ts:8

    • Readonly uuid

    uuid: string
    +
  • Defined in packages/upload-client/src/tools/UploadcareGroup.ts:6
    • diff --git a/upload-client/enums/Status.html b/upload-client/enums/Status.html index 1e7ad8bd..62a91828 100644 --- a/upload-client/enums/Status.html +++ b/upload-client/enums/Status.html @@ -16,7 +16,7 @@
  • Status

    • Enumeration Status

    +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:14
    • @@ -36,27 +36,27 @@

    Enumeration Members

    Error

    Error: "error"
    +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:18

    • Progress

    Progress: "progress"
    +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:17

    • Success

    Success: "success"
    +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:19

    • Unknown

    Unknown: "unknown"
    +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:15

    • Waiting

    Waiting: "waiting"
    +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:16
    • diff --git a/upload-client/enums/TypeEnum.html b/upload-client/enums/TypeEnum.html index ae82edf3..39e3b50a 100644 --- a/upload-client/enums/TypeEnum.html +++ b/upload-client/enums/TypeEnum.html @@ -16,7 +16,7 @@
  • TypeEnum

    • Enumeration TypeEnum

    +
  • Defined in packages/upload-client/src/api/fromUrl.ts:19
    • @@ -33,12 +33,12 @@

    Enumeration Members

    FileInfo

    FileInfo: "file_info"
    +
  • Defined in packages/upload-client/src/api/fromUrl.ts:21

    • Token

    Token: "token"
    +
  • Defined in packages/upload-client/src/api/fromUrl.ts:20
    • diff --git a/upload-client/functions/base.html b/upload-client/functions/base.html index cced5393..189469c6 100644 --- a/upload-client/functions/base.html +++ b/upload-client/functions/base.html @@ -31,7 +31,7 @@
    file: __namedParameters: BaseOptions

    Returns Promise<BaseResponse>

    +
  • Defined in packages/upload-client/src/api/base.ts:55
    • diff --git a/upload-client/functions/fromUrl.html b/upload-client/functions/fromUrl.html index 020cbaea..2dd420b9 100644 --- a/upload-client/functions/fromUrl.html +++ b/upload-client/functions/fromUrl.html @@ -30,7 +30,7 @@
    sourceUrl: __namedParameters: FromUrlOptions

    Returns Promise<FromUrlSuccessResponse>

    +
  • Defined in packages/upload-client/src/api/fromUrl.ts:76
    • diff --git a/upload-client/functions/fromUrlStatus.html b/upload-client/functions/fromUrlStatus.html index 4992250b..8d0c204d 100644 --- a/upload-client/functions/fromUrlStatus.html +++ b/upload-client/functions/fromUrlStatus.html @@ -30,7 +30,7 @@
    token: __namedParameters: FromUrlStatusOptions = {}

    Returns Promise<FromUrlStatusResponse>

    +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:77
    • diff --git a/upload-client/functions/group.html b/upload-client/functions/group.html index 616213c1..bae286f1 100644 --- a/upload-client/functions/group.html +++ b/upload-client/functions/group.html @@ -30,7 +30,7 @@
    uuids: __namedParameters: GroupOptions

    Returns Promise<GroupInfo>

    +
  • Defined in packages/upload-client/src/api/group.ts:35
    • diff --git a/upload-client/functions/groupInfo-1.html b/upload-client/functions/groupInfo-1.html index 484897de..b96b7c51 100644 --- a/upload-client/functions/groupInfo-1.html +++ b/upload-client/functions/groupInfo-1.html @@ -30,7 +30,7 @@
    id: __namedParameters: GroupInfoOptions

    Returns Promise<GroupInfo>

    +
  • Defined in packages/upload-client/src/api/groupInfo.ts:30
    • diff --git a/upload-client/functions/info.html b/upload-client/functions/info.html index 8ba00ca4..eac373a0 100644 --- a/upload-client/functions/info.html +++ b/upload-client/functions/info.html @@ -30,7 +30,7 @@
    uuid: __namedParameters: InfoOptions

    Returns Promise<FileInfo>

    +
  • Defined in packages/upload-client/src/api/info.ts:31
    • diff --git a/upload-client/functions/isReadyPoll.html b/upload-client/functions/isReadyPoll.html index fb327555..cf07f2b2 100644 --- a/upload-client/functions/isReadyPoll.html +++ b/upload-client/functions/isReadyPoll.html @@ -28,7 +28,7 @@
    uuid: __namedParameters: IsReadyPoolOptions

    Returns Promise<FileInfo>

    +
  • Defined in packages/upload-client/src/tools/isReadyPoll.ts:22
    • diff --git a/upload-client/functions/multipartComplete.html b/upload-client/functions/multipartComplete.html index 9228002f..74eda98e 100644 --- a/upload-client/functions/multipartComplete.html +++ b/upload-client/functions/multipartComplete.html @@ -30,7 +30,7 @@
    uuid: __namedParameters: MultipartCompleteOptions

    Returns Promise<FileInfo>

    +
  • Defined in packages/upload-client/src/api/multipartComplete.ts:27
    • diff --git a/upload-client/functions/multipartStart.html b/upload-client/functions/multipartStart.html index e205654d..b85d9b05 100644 --- a/upload-client/functions/multipartStart.html +++ b/upload-client/functions/multipartStart.html @@ -30,7 +30,7 @@
    size: __namedParameters: MultipartStartOptions

    Returns Promise<MultipartStartResponse>

    +
  • Defined in packages/upload-client/src/api/multipartStart.ts:51
    • diff --git a/upload-client/functions/multipartUpload.html b/upload-client/functions/multipartUpload.html index 71aa1968..8255a9f7 100644 --- a/upload-client/functions/multipartUpload.html +++ b/upload-client/functions/multipartUpload.html @@ -32,7 +32,7 @@
    url: __namedParameters: MultipartUploadOptions

    Returns Promise<MultipartUploadResponse>

    +
  • Defined in packages/upload-client/src/api/multipartUpload.ts:26
    • diff --git a/upload-client/functions/uploadDirect.html b/upload-client/functions/uploadDirect.html index d607f4c9..dd701b62 100644 --- a/upload-client/functions/uploadDirect.html +++ b/upload-client/functions/uploadDirect.html @@ -28,7 +28,7 @@
    file: __namedParameters: DirectOptions

    Returns Promise<UploadcareFile>

    +
  • Defined in packages/upload-client/src/uploadFile/uploadDirect.ts:37
    • diff --git a/upload-client/functions/uploadFile.html b/upload-client/functions/uploadFile.html index a40a89d1..b63e3eed 100644 --- a/upload-client/functions/uploadFile.html +++ b/upload-client/functions/uploadFile.html @@ -30,7 +30,7 @@
    data: __namedParameters: FileFromOptions

    Returns Promise<UploadcareFile>

    +
  • Defined in packages/upload-client/src/uploadFile/uploadFile.ts:56
    • diff --git a/upload-client/functions/uploadFileGroup.html b/upload-client/functions/uploadFileGroup.html index 69fbf3fa..110404a2 100644 --- a/upload-client/functions/uploadFileGroup.html +++ b/upload-client/functions/uploadFileGroup.html @@ -28,7 +28,7 @@
    data: __namedParameters: FileFromOptions & GroupFromOptions

    Returns Promise<UploadcareGroup>

    +
  • Defined in packages/upload-client/src/uploadFileGroup/uploadFileGroup.ts:23
    • diff --git a/upload-client/functions/uploadFromUploaded.html b/upload-client/functions/uploadFromUploaded.html index 7b45a542..49e26ff6 100644 --- a/upload-client/functions/uploadFromUploaded.html +++ b/upload-client/functions/uploadFromUploaded.html @@ -28,7 +28,7 @@
    uuid: __namedParameters: FromUploadedOptions

    Returns Promise<UploadcareFile>

    +
  • Defined in packages/upload-client/src/uploadFile/uploadFromUploaded.ts:28
    • diff --git a/upload-client/functions/uploadFromUrl.html b/upload-client/functions/uploadFromUrl.html index 7358eca5..8717fef6 100644 --- a/upload-client/functions/uploadFromUrl.html +++ b/upload-client/functions/uploadFromUrl.html @@ -28,7 +28,7 @@
    sourceUrl: __namedParameters: UploadFromUrlOptions

    Returns Promise<UploadcareFile>

    +
  • Defined in packages/upload-client/src/uploadFile/uploadFromUrl.ts:155
    • diff --git a/upload-client/functions/uploadMultipart.html b/upload-client/functions/uploadMultipart.html index 56accda1..904e2a1f 100644 --- a/upload-client/functions/uploadMultipart.html +++ b/upload-client/functions/uploadMultipart.html @@ -28,7 +28,7 @@
    file: __namedParameters: MultipartOptions

    Returns Promise<UploadcareFile>

    +
  • Defined in packages/upload-client/src/uploadFile/uploadMultipart.ts:73
    • diff --git a/upload-client/interfaces/Settings.html b/upload-client/interfaces/Settings.html index ff2176d1..a500bc2f 100644 --- a/upload-client/interfaces/Settings.html +++ b/upload-client/interfaces/Settings.html @@ -22,7 +22,7 @@

    Hierarchy

    • Settings
    +
  • Defined in packages/upload-client/src/types.ts:17
    • @@ -61,127 +61,127 @@

    OptionalbaseCDN?: string

    +
  • Defined in packages/upload-client/src/types.ts:4

    • Optional baseURL

    baseURL?: string
    +
  • Defined in packages/upload-client/src/types.ts:5

    • Optional checkForUrlDuplicates

    checkForUrlDuplicates?: boolean
    +
  • Defined in packages/upload-client/src/types.ts:26

    • Optional contentType

    contentType?: string
    +
  • Defined in packages/upload-client/src/types.ts:20

    • Optional fileName

    fileName?: string
    +
  • Defined in packages/upload-client/src/types.ts:19

    • Optional integration

    integration?: string
    +
  • Defined in packages/upload-client/src/types.ts:24

    • Optional jsonpCallback

    jsonpCallback?: string
    +
  • Defined in packages/upload-client/src/types.ts:29

    • Optional maxConcurrentRequests

    maxConcurrentRequests?: number
    +
  • Defined in packages/upload-client/src/types.ts:12

    • Optional maxContentLength

    maxContentLength?: number
    +
  • Defined in packages/upload-client/src/types.ts:6

    • Optional multipartChunkSize

    multipartChunkSize?: number
    +
  • Defined in packages/upload-client/src/types.ts:10

    • Optional multipartMinFileSize

    multipartMinFileSize?: number
    +
  • Defined in packages/upload-client/src/types.ts:9

    • Optional multipartMinLastPartSize

    multipartMinLastPartSize?: number
    +
  • Defined in packages/upload-client/src/types.ts:11

    • Optional pollingTimeoutMilliseconds

    pollingTimeoutMilliseconds?: number
    +
  • Defined in packages/upload-client/src/types.ts:13

    • publicKey

    publicKey: string
    +
  • Defined in packages/upload-client/src/types.ts:18

    • Optional pusherKey

    pusherKey?: string
    +
  • Defined in packages/upload-client/src/types.ts:14

    • Optional retryNetworkErrorMaxTimes

    retryNetworkErrorMaxTimes?: number
    +
  • Defined in packages/upload-client/src/types.ts:8

    • Optional retryThrottledRequestMaxTimes

    retryThrottledRequestMaxTimes?: number
    +
  • Defined in packages/upload-client/src/types.ts:7

    • Optional saveUrlForRecurrentUploads

    saveUrlForRecurrentUploads?: boolean
    +
  • Defined in packages/upload-client/src/types.ts:27

    • Optional secureExpire

    secureExpire?: string
    +
  • Defined in packages/upload-client/src/types.ts:23

    • Optional secureSignature

    secureSignature?: string
    +
  • Defined in packages/upload-client/src/types.ts:22

    • Optional source

    source?: string
    +
  • Defined in packages/upload-client/src/types.ts:28

    • Optional store

    store?: StoreValue
    +
  • Defined in packages/upload-client/src/types.ts:21

    • Optional userAgent

    userAgent?: CustomUserAgent
    +
  • Defined in packages/upload-client/src/types.ts:25
    • diff --git a/upload-client/types/BaseOptions.html b/upload-client/types/BaseOptions.html index c325fbd1..95153f78 100644 --- a/upload-client/types/BaseOptions.html +++ b/upload-client/types/BaseOptions.html @@ -50,7 +50,7 @@
    Optional
    Optional userAgent?: CustomUserAgent
    +
  • Defined in packages/upload-client/src/api/base.ts:29
    • diff --git a/upload-client/types/BaseResponse.html b/upload-client/types/BaseResponse.html index 124f55eb..8852cef8 100644 --- a/upload-client/types/BaseResponse.html +++ b/upload-client/types/BaseResponse.html @@ -22,7 +22,7 @@

    Type declaration

  • file: Uuid
    • +
  • Defined in packages/upload-client/src/api/base.ts:23
    • diff --git a/upload-client/types/BrowserFile.html b/upload-client/types/BrowserFile.html index 249ab4a2..97eedbb1 100644 --- a/upload-client/types/BrowserFile.html +++ b/upload-client/types/BrowserFile.html @@ -17,7 +17,7 @@

    Type alias BrowserFile

    BrowserFile: Blob | File
    +
  • Defined in packages/upload-client/src/types.ts:32
    • diff --git a/upload-client/types/ComputableProgressInfo.html b/upload-client/types/ComputableProgressInfo.html index c6c64f7e..8243b5ff 100644 --- a/upload-client/types/ComputableProgressInfo.html +++ b/upload-client/types/ComputableProgressInfo.html @@ -24,7 +24,7 @@
    isComputable
    value: number
    +
  • Defined in packages/upload-client/src/api/types.ts:51
    • diff --git a/upload-client/types/DirectOptions.html b/upload-client/types/DirectOptions.html index bdd09adb..cdd71be0 100644 --- a/upload-client/types/DirectOptions.html +++ b/upload-client/types/DirectOptions.html @@ -52,7 +52,7 @@
    Optional
    Optional userAgent?: CustomUserAgent
    +
  • Defined in packages/upload-client/src/uploadFile/uploadDirect.ts:13
    • diff --git a/upload-client/types/ErrorRequestInfo.html b/upload-client/types/ErrorRequestInfo.html index 2b0f10ec..31a7ada1 100644 --- a/upload-client/types/ErrorRequestInfo.html +++ b/upload-client/types/ErrorRequestInfo.html @@ -30,7 +30,7 @@
    Optional
    url: string
    +
  • Defined in packages/upload-client/src/request/types.ts:24
    • diff --git a/upload-client/types/ErrorResponseInfo.html b/upload-client/types/ErrorResponseInfo.html index 82257b8a..166a477b 100644 --- a/upload-client/types/ErrorResponseInfo.html +++ b/upload-client/types/ErrorResponseInfo.html @@ -29,7 +29,7 @@
    errorCode
    statusCode: number
    +
  • Defined in packages/upload-client/src/tools/UploadError.ts:5
    • diff --git a/upload-client/types/FileFromOptions.html b/upload-client/types/FileFromOptions.html index 1bdb0edd..3057cd8b 100644 --- a/upload-client/types/FileFromOptions.html +++ b/upload-client/types/FileFromOptions.html @@ -64,7 +64,7 @@
    Optional
    Optional userAgent?: CustomUserAgent
    +
  • Defined in packages/upload-client/src/uploadFile/uploadFile.ts:21
    • diff --git a/upload-client/types/FileInfo.html b/upload-client/types/FileInfo.html index 2230ab23..280232a9 100644 --- a/upload-client/types/FileInfo.html +++ b/upload-client/types/FileInfo.html @@ -52,7 +52,7 @@
    uuid
    videoInfo: VideoInfo | null
    +
  • Defined in packages/upload-client/src/api/types.ts:8
    • diff --git a/upload-client/types/FileInfoResponse.html b/upload-client/types/FileInfoResponse.html index 4f433483..a4487029 100644 --- a/upload-client/types/FileInfoResponse.html +++ b/upload-client/types/FileInfoResponse.html @@ -17,7 +17,7 @@

    Type alias FileInfoResponse

    FileInfoResponse: {
        type: FileInfo;
    } & FileInfo
    +
  • Defined in packages/upload-client/src/api/fromUrl.ts:29
    • diff --git a/upload-client/types/FromUploadedOptions.html b/upload-client/types/FromUploadedOptions.html index e554c74e..8486bce3 100644 --- a/upload-client/types/FromUploadedOptions.html +++ b/upload-client/types/FromUploadedOptions.html @@ -42,7 +42,7 @@
    Optional
    Optional userAgent?: CustomUserAgent
    +
  • Defined in packages/upload-client/src/uploadFile/uploadFromUploaded.ts:9
    • diff --git a/upload-client/types/FromUrlOptions.html b/upload-client/types/FromUrlOptions.html index 603cf27e..31716a46 100644 --- a/upload-client/types/FromUrlOptions.html +++ b/upload-client/types/FromUrlOptions.html @@ -50,7 +50,7 @@
    Optional
    Optional userAgent?: CustomUserAgent
    +
  • Defined in packages/upload-client/src/api/fromUrl.ts:53
    • diff --git a/upload-client/types/FromUrlResponse.html b/upload-client/types/FromUrlResponse.html index 0f92092d..687d85d5 100644 --- a/upload-client/types/FromUrlResponse.html +++ b/upload-client/types/FromUrlResponse.html @@ -17,7 +17,7 @@

    Type alias FromUrlResponse

    FromUrlResponse: FromUrlSuccessResponse
    +
  • Defined in packages/upload-client/src/api/fromUrl.ts:37
    • diff --git a/upload-client/types/FromUrlStatusOptions.html b/upload-client/types/FromUrlStatusOptions.html index b01472dd..d078c549 100644 --- a/upload-client/types/FromUrlStatusOptions.html +++ b/upload-client/types/FromUrlStatusOptions.html @@ -34,7 +34,7 @@
    Optional
    Optional userAgent?: CustomUserAgent
    +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:62
    • diff --git a/upload-client/types/FromUrlStatusResponse.html b/upload-client/types/FromUrlStatusResponse.html index b4eef7c0..8aebbef1 100644 --- a/upload-client/types/FromUrlStatusResponse.html +++ b/upload-client/types/FromUrlStatusResponse.html @@ -17,7 +17,7 @@

    Type alias FromUrlStatusResponse

    FromUrlStatusResponse: StatusUnknownResponse | StatusWaitingResponse | StatusProgressResponse | StatusErrorResponse | StatusSuccessResponse
    +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:47
    • diff --git a/upload-client/types/FromUrlSuccessResponse.html b/upload-client/types/FromUrlSuccessResponse.html index 43cb7377..3f8bce01 100644 --- a/upload-client/types/FromUrlSuccessResponse.html +++ b/upload-client/types/FromUrlSuccessResponse.html @@ -17,7 +17,7 @@

    Type alias FromUrlSuccessResponse

    FromUrlSuccessResponse: FileInfoResponse | TokenResponse
    +
  • Defined in packages/upload-client/src/api/fromUrl.ts:33
    • diff --git a/upload-client/types/GroupFileInfo.html b/upload-client/types/GroupFileInfo.html index 0f9a170c..07d62f54 100644 --- a/upload-client/types/GroupFileInfo.html +++ b/upload-client/types/GroupFileInfo.html @@ -17,7 +17,7 @@

    Type alias GroupFileInfo

    GroupFileInfo: FileInfo & {
        defaultEffects: string;
    }
    +
  • Defined in packages/upload-client/src/api/types.ts:28
    • diff --git a/upload-client/types/GroupFromOptions.html b/upload-client/types/GroupFromOptions.html index c2c980cb..4ebabea7 100644 --- a/upload-client/types/GroupFromOptions.html +++ b/upload-client/types/GroupFromOptions.html @@ -22,7 +22,7 @@

    Type declaration

  • Optional jsonpCallback?: string
    • +
  • Defined in packages/upload-client/src/uploadFileGroup/uploadFileGroup.ts:19
    • diff --git a/upload-client/types/GroupId.html b/upload-client/types/GroupId.html index e043794a..1127e063 100644 --- a/upload-client/types/GroupId.html +++ b/upload-client/types/GroupId.html @@ -17,7 +17,7 @@

    Type alias GroupId

    GroupId: string
    +
  • Defined in packages/upload-client/src/api/types.ts:47
    • diff --git a/upload-client/types/GroupInfo.html b/upload-client/types/GroupInfo.html index f154b46a..eb290b36 100644 --- a/upload-client/types/GroupInfo.html +++ b/upload-client/types/GroupInfo.html @@ -34,7 +34,7 @@
    id
  • url: string
    • +
  • Defined in packages/upload-client/src/api/types.ts:32
    • diff --git a/upload-client/types/GroupInfoOptions.html b/upload-client/types/GroupInfoOptions.html index d17fd65e..aa65a880 100644 --- a/upload-client/types/GroupInfoOptions.html +++ b/upload-client/types/GroupInfoOptions.html @@ -36,7 +36,7 @@
    Optional
    Optional userAgent?: CustomUserAgent
    +
  • Defined in packages/upload-client/src/api/groupInfo.ts:13
    • diff --git a/upload-client/types/GroupOptions.html b/upload-client/types/GroupOptions.html index 199d0b55..d7c3c1be 100644 --- a/upload-client/types/GroupOptions.html +++ b/upload-client/types/GroupOptions.html @@ -42,7 +42,7 @@
    Optional
    Optional userAgent?: CustomUserAgent
    +
  • Defined in packages/upload-client/src/api/group.ts:14
    • diff --git a/upload-client/types/Headers.html b/upload-client/types/Headers.html index 329da72a..2acb4721 100644 --- a/upload-client/types/Headers.html +++ b/upload-client/types/Headers.html @@ -22,7 +22,7 @@

    Type declaration

  • [key: string]: string | string[] | undefined
    • +
  • Defined in packages/upload-client/src/request/types.ts:10
    • diff --git a/upload-client/types/InfoOptions.html b/upload-client/types/InfoOptions.html index 9c0ba8c0..f8eae3f8 100644 --- a/upload-client/types/InfoOptions.html +++ b/upload-client/types/InfoOptions.html @@ -36,7 +36,7 @@
    Optional
    Optional userAgent?: CustomUserAgent
    +
  • Defined in packages/upload-client/src/api/info.ts:15
    • diff --git a/upload-client/types/MultipartCompleteOptions.html b/upload-client/types/MultipartCompleteOptions.html index 3adcde4e..455a0a26 100644 --- a/upload-client/types/MultipartCompleteOptions.html +++ b/upload-client/types/MultipartCompleteOptions.html @@ -36,7 +36,7 @@
    Optional
    Optional userAgent?: CustomUserAgent
    +
  • Defined in packages/upload-client/src/api/multipartComplete.ts:13
    • diff --git a/upload-client/types/MultipartOptions.html b/upload-client/types/MultipartOptions.html index ae363720..c7735e1e 100644 --- a/upload-client/types/MultipartOptions.html +++ b/upload-client/types/MultipartOptions.html @@ -58,7 +58,7 @@
    Optional
    Optional userAgent?: CustomUserAgent
    +
  • Defined in packages/upload-client/src/uploadFile/uploadMultipart.ts:28
    • diff --git a/upload-client/types/MultipartPart.html b/upload-client/types/MultipartPart.html index 0e73b431..f31c8bc0 100644 --- a/upload-client/types/MultipartPart.html +++ b/upload-client/types/MultipartPart.html @@ -17,7 +17,7 @@

    Type alias MultipartPart

    MultipartPart: string
    +
  • Defined in packages/upload-client/src/api/multipartStart.ts:41
    • diff --git a/upload-client/types/MultipartStartOptions.html b/upload-client/types/MultipartStartOptions.html index 40357b5e..a52f16fa 100644 --- a/upload-client/types/MultipartStartOptions.html +++ b/upload-client/types/MultipartStartOptions.html @@ -50,7 +50,7 @@
    Optional
    Optional userAgent?: CustomUserAgent
    +
  • Defined in packages/upload-client/src/api/multipartStart.ts:23
    • diff --git a/upload-client/types/MultipartStartResponse.html b/upload-client/types/MultipartStartResponse.html index 3fd25061..12bd7d1a 100644 --- a/upload-client/types/MultipartStartResponse.html +++ b/upload-client/types/MultipartStartResponse.html @@ -24,7 +24,7 @@
    parts
    uuid: Uuid
    +
  • Defined in packages/upload-client/src/api/multipartStart.ts:43
    • diff --git a/upload-client/types/MultipartUploadOptions.html b/upload-client/types/MultipartUploadOptions.html index 76b1f856..07534f1b 100644 --- a/upload-client/types/MultipartUploadOptions.html +++ b/upload-client/types/MultipartUploadOptions.html @@ -34,7 +34,7 @@
    Optional
    Optional signal?: AbortSignal
    +
  • Defined in packages/upload-client/src/api/multipartUpload.ts:10
    • diff --git a/upload-client/types/MultipartUploadResponse.html b/upload-client/types/MultipartUploadResponse.html index fe408379..305ef083 100644 --- a/upload-client/types/MultipartUploadResponse.html +++ b/upload-client/types/MultipartUploadResponse.html @@ -22,7 +22,7 @@

    Type declaration

  • Optional code?: number
    • +
  • Defined in packages/upload-client/src/api/multipartUpload.ts:20
    • diff --git a/upload-client/types/NodeFile.html b/upload-client/types/NodeFile.html index 01dd90c7..35179e14 100644 --- a/upload-client/types/NodeFile.html +++ b/upload-client/types/NodeFile.html @@ -17,7 +17,7 @@

    Type alias NodeFile

    NodeFile: Buffer
    +
  • Defined in packages/upload-client/src/types.ts:33
    • diff --git a/upload-client/types/ProgressCallback.html b/upload-client/types/ProgressCallback.html index 6e7b9a78..a3ad3a87 100644 --- a/upload-client/types/ProgressCallback.html +++ b/upload-client/types/ProgressCallback.html @@ -35,7 +35,7 @@

    Parameters

    arg: T

    Returns void

    +
  • Defined in packages/upload-client/src/api/types.ts:60
    • diff --git a/upload-client/types/ReactNativeAsset.html b/upload-client/types/ReactNativeAsset.html index 285bf60a..e441616e 100644 --- a/upload-client/types/ReactNativeAsset.html +++ b/upload-client/types/ReactNativeAsset.html @@ -26,7 +26,7 @@
    type
    uri: string
    +
  • Defined in packages/upload-client/src/types.ts:34
    • diff --git a/upload-client/types/Sliceable.html b/upload-client/types/Sliceable.html index 012bb3f7..265320e1 100644 --- a/upload-client/types/Sliceable.html +++ b/upload-client/types/Sliceable.html @@ -17,7 +17,7 @@

    Type alias Sliceable

    Sliceable: BrowserFile | NodeFile
    +
  • Defined in packages/upload-client/src/types.ts:41
    • diff --git a/upload-client/types/StatusErrorResponse.html b/upload-client/types/StatusErrorResponse.html index 70f535d8..794736d2 100644 --- a/upload-client/types/StatusErrorResponse.html +++ b/upload-client/types/StatusErrorResponse.html @@ -26,7 +26,7 @@
    errorCode
    status: Error
    +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:37
    • diff --git a/upload-client/types/StatusProgressResponse.html b/upload-client/types/StatusProgressResponse.html index 6d06c35b..fac927bc 100644 --- a/upload-client/types/StatusProgressResponse.html +++ b/upload-client/types/StatusProgressResponse.html @@ -28,7 +28,7 @@
    status
    total: number | "unknown"
    +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:30
    • diff --git a/upload-client/types/StatusSuccessResponse.html b/upload-client/types/StatusSuccessResponse.html index a0350965..c7c83e04 100644 --- a/upload-client/types/StatusSuccessResponse.html +++ b/upload-client/types/StatusSuccessResponse.html @@ -17,7 +17,7 @@

    Type alias StatusSuccessResponse

    StatusSuccessResponse: {
        status: Success;
    } & FileInfo
    +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:43
    • diff --git a/upload-client/types/StatusUnknownResponse.html b/upload-client/types/StatusUnknownResponse.html index 9577709d..c1aad12a 100644 --- a/upload-client/types/StatusUnknownResponse.html +++ b/upload-client/types/StatusUnknownResponse.html @@ -22,7 +22,7 @@

    Type declaration

  • status: Unknown
    • +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:22
    • diff --git a/upload-client/types/StatusWaitingResponse.html b/upload-client/types/StatusWaitingResponse.html index 62f34687..64d64a83 100644 --- a/upload-client/types/StatusWaitingResponse.html +++ b/upload-client/types/StatusWaitingResponse.html @@ -22,7 +22,7 @@

    Type declaration

  • status: Waiting
    • +
  • Defined in packages/upload-client/src/api/fromUrlStatus.ts:26
    • diff --git a/upload-client/types/SupportedFileInput.html b/upload-client/types/SupportedFileInput.html index 73f4221a..c85033d4 100644 --- a/upload-client/types/SupportedFileInput.html +++ b/upload-client/types/SupportedFileInput.html @@ -17,7 +17,7 @@

    Type alias SupportedFileInput

    SupportedFileInput: BrowserFile | NodeFile | ReactNativeAsset
    +
  • Defined in packages/upload-client/src/types.ts:40
    • diff --git a/upload-client/types/Token.html b/upload-client/types/Token.html index c26f2a46..76b2313f 100644 --- a/upload-client/types/Token.html +++ b/upload-client/types/Token.html @@ -17,7 +17,7 @@

    Type alias Token

    Token: string
    +
  • Defined in packages/upload-client/src/api/types.ts:43
    • diff --git a/upload-client/types/TokenResponse.html b/upload-client/types/TokenResponse.html index e0fd1305..78568777 100644 --- a/upload-client/types/TokenResponse.html +++ b/upload-client/types/TokenResponse.html @@ -24,7 +24,7 @@
    token
    type: Token
    +
  • Defined in packages/upload-client/src/api/fromUrl.ts:24
    • diff --git a/upload-client/types/UnknownProgressInfo.html b/upload-client/types/UnknownProgressInfo.html index 32cae2d1..7b9c82b5 100644 --- a/upload-client/types/UnknownProgressInfo.html +++ b/upload-client/types/UnknownProgressInfo.html @@ -22,7 +22,7 @@

    Type declaration

  • isComputable: false
    • +
  • Defined in packages/upload-client/src/api/types.ts:56
    • diff --git a/upload-client/types/UploadFromUrlOptions.html b/upload-client/types/UploadFromUrlOptions.html index 772976b4..b8acf27b 100644 --- a/upload-client/types/UploadFromUrlOptions.html +++ b/upload-client/types/UploadFromUrlOptions.html @@ -17,7 +17,7 @@

    Type alias UploadFromUrlOptions

    UploadFromUrlOptions: {
        baseCDN?: string;
        onProgress?: ProgressCallback;
        pusherKey?: string;
    } & FromUrlOptions
    +
  • Defined in packages/upload-client/src/uploadFile/uploadFromUrl.ts:90
    • diff --git a/upload-client/types/Url.html b/upload-client/types/Url.html index bebda7b1..27cae37a 100644 --- a/upload-client/types/Url.html +++ b/upload-client/types/Url.html @@ -17,7 +17,7 @@

    Type alias Url

    Url: string
    +
  • Defined in packages/upload-client/src/api/types.ts:49
    • diff --git a/upload-client/types/Uuid.html b/upload-client/types/Uuid.html index 00d1eba1..5946691f 100644 --- a/upload-client/types/Uuid.html +++ b/upload-client/types/Uuid.html @@ -17,7 +17,7 @@

    Type alias Uuid

    Uuid: string
    +
  • Defined in packages/upload-client/src/api/types.ts:45
    • diff --git a/upload-client/variables/UploadClientError.html b/upload-client/variables/UploadClientError.html index 11dea44c..4e965955 100644 --- a/upload-client/variables/UploadClientError.html +++ b/upload-client/variables/UploadClientError.html @@ -20,7 +20,7 @@

    Variable UploadClientErrorConst Deprecated

    Please use UploadError instead.

    +
  • Defined in packages/upload-client/src/index.ts:96
    • diff --git a/upload-client/variables/UploadcareNetworkError.html b/upload-client/variables/UploadcareNetworkError.html index 4e9fc5dd..08f00431 100644 --- a/upload-client/variables/UploadcareNetworkError.html +++ b/upload-client/variables/UploadcareNetworkError.html @@ -20,7 +20,7 @@

    Variable UploadcareNetworkErrorConstDeprecated

    Please use NetworkError instead.

    +
  • Defined in packages/upload-client/src/index.ts:86