@wix/auto_sdk_get-paid_bulk-downloads 1.0.0

package/build/internal/cjs/src/get-paid-downloader-v1-bulk-download-bulk-downloads.universal.d.ts

@@ -0,0 +1,515 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+/** A bulk download contains the download information to retrieve items in the Get Paid APIs. */
+export interface BulkDownload {
+    /**
+     * Bulk download ID.
+     * @format GUID
+     * @readonly
+     * @immutable
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the bulk download is updated.
+     * To prevent conflicting changes, the current `revision` must be passed when updating the bulk download.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the bulk download was created.
+     * @readonly
+     * @immutable
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the bulk download was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Date and time the bulk download expires.
+     *
+     * The .zip file is available for download with the `downloadUrl` until this time.
+     *
+     * Default expiration date is 24 hours after creation.
+     * @readonly
+     * @immutable
+     */
+    expirationDate?: Date | null;
+    /**
+     * Status of the bulk download generation.
+     * @readonly
+     */
+    downloadGenerationStatus?: DownloadGenerationStatusWithLiterals;
+    /**
+     * URL to download the generated .zip file. Open this URL in a browser to download the file.
+     *
+     * Only available when the `downloadGenerationStatus` is `"PARTIAL_SUCCESS"` or `"SUCCESS"`.
+     * @format WEB_URL
+     * @readonly
+     */
+    downloadUrl?: string | null;
+    /**
+     * App namespace. Currently only supports `"RECEIPTS"`.
+     * @immutable
+     */
+    namespace?: NamespaceWithLiterals;
+    /**
+     * List of IDs of the entities to include in the bulk download.
+     * @format GUID
+     * @immutable
+     * @minSize 2
+     * @maxSize 100
+     */
+    entityIds?: string[];
+    /**
+     * IDs of the entities that aren't included in the .zip file.
+     *
+     * If `downloadGenerationStatus` is `"PARTIAL_SUCCESS"` then these entities may still be included once the initiated download is complete.
+     * If the value of `downloadGenerationDetails.processed` matches `downloadGenerationDetails.total` then all of the entities have been processed and
+     * the skipped entities aren't included in the bulk download.
+     * @format GUID
+     * @readonly
+     * @maxSize 100
+     */
+    skippedEntityIds?: string[];
+    /**
+     * Details about the number of files processed.
+     * @readonly
+     */
+    downloadGenerationDetails?: DownloadGenerationDetails;
+}
+export declare enum DownloadGenerationStatus {
+    /** Unknown download status. */
+    UNKNOWN_DOWNLOAD_STATUS = "UNKNOWN_DOWNLOAD_STATUS",
+    /** Generation is in progress. */
+    PROCESSING = "PROCESSING",
+    /** Generation was successful for some, but not all, entities. Check `skippedEntityIds` for entities not included. The `downloadUrl` is available to download the .zip file containing the successfully generated entities. */
+    PARTIAL_SUCCESS = "PARTIAL_SUCCESS",
+    /** Generation was successful. The .zip file is ready for download using the `downloadUrl`. */
+    SUCCESS = "SUCCESS",
+    /** Generation has failed. */
+    FAILED = "FAILED"
+}
+/** @enumType */
+export type DownloadGenerationStatusWithLiterals = DownloadGenerationStatus | 'UNKNOWN_DOWNLOAD_STATUS' | 'PROCESSING' | 'PARTIAL_SUCCESS' | 'SUCCESS' | 'FAILED';
+export declare enum Namespace {
+    /** Unknown namespace. */
+    UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
+    /** Receipts ([SDK](https://dev.wix.com/docs/sdk/backend-modules/get-paid/receipts/about-the-receipts-apis) | [REST](https://dev.wix.com/docs/rest/business-management/get-paid/receipts/about-the-receipts-apis)). */
+    RECEIPTS = "RECEIPTS"
+}
+/** @enumType */
+export type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'RECEIPTS';
+export interface DownloadGenerationDetails {
+    /** Number of files that have been processed. */
+    processed?: number;
+    /** Total number of files to process. */
+    total?: number;
+}
+export interface BulkDownloadStatusUpdate {
+    /**
+     * ID of the bulk download.
+     * @format GUID
+     */
+    downloadId?: string;
+    /** Status of the bulk download. */
+    downloadStatus?: DownloadStatusWithLiterals;
+    /**
+     * URL of the bulk download when it becomes ready.
+     * @format WEB_URL
+     */
+    downloadUrl?: string | null;
+    /**
+     * Application namespace.
+     * @immutable
+     */
+    namespace?: BulkDownloadStatusUpdateNamespaceWithLiterals;
+}
+export declare enum DownloadStatus {
+    /** Unknown download status. */
+    UNKNOWN_DOWNLOAD_STATUS = "UNKNOWN_DOWNLOAD_STATUS",
+    /** Generation was successful. You can download files using the `downloadUrl`. */
+    READY = "READY",
+    /** Generation has failed. */
+    FAILED = "FAILED"
+}
+/** @enumType */
+export type DownloadStatusWithLiterals = DownloadStatus | 'UNKNOWN_DOWNLOAD_STATUS' | 'READY' | 'FAILED';
+export declare enum BulkDownloadStatusUpdateNamespace {
+    /** Unknown namespace. */
+    UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
+    /** Receipts application. */
+    RECEIPTS = "RECEIPTS"
+}
+/** @enumType */
+export type BulkDownloadStatusUpdateNamespaceWithLiterals = BulkDownloadStatusUpdateNamespace | 'UNKNOWN_NAMESPACE' | 'RECEIPTS';
+export interface InitiateBulkDownloadZip {
+    /**
+     * ID of the bulk download.
+     * @format GUID
+     */
+    downloadId?: string;
+    /**
+     * Application namespace.
+     * @immutable
+     */
+    namespace?: InitiateBulkDownloadZipNamespaceWithLiterals;
+    /**
+     * List of entities' information.
+     * @immutable
+     * @minSize 2
+     * @maxSize 100
+     */
+    entityInfo?: EntityInfo[];
+}
+export declare enum InitiateBulkDownloadZipNamespace {
+    /** Unknown namespace. */
+    UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
+    /** Receipts application. */
+    RECEIPTS = "RECEIPTS"
+}
+/** @enumType */
+export type InitiateBulkDownloadZipNamespaceWithLiterals = InitiateBulkDownloadZipNamespace | 'UNKNOWN_NAMESPACE' | 'RECEIPTS';
+export interface EntityInfo {
+    /**
+     * The name of the entity which will be visible as a file inside the zip.
+     * @immutable
+     * @maxLength 30
+     */
+    entityName?: string;
+    /**
+     * The entity's ID to be downloaded.
+     * @immutable
+     * @format GUID
+     */
+    entityId?: string;
+}
+export interface InitiateBulkDownloadRequest {
+    /** Bulk download to initiate. */
+    bulkDownload: BulkDownload;
+}
+export interface InitiateBulkDownloadResponse {
+    /** The initiated bulk download. */
+    bulkDownload?: BulkDownload;
+}
+export interface GetBulkDownloadRequest {
+    /**
+     * Bulk download ID.
+     * @format GUID
+     */
+    bulkDownloadId: string;
+}
+export interface GetBulkDownloadResponse {
+    /** Retrieved bulk download. */
+    bulkDownload?: BulkDownload;
+}
+export interface ListMyBulkDownloadsRequest {
+    /** Namespace of the app to download from. */
+    namespace: NamespaceWithLiterals;
+}
+export interface ListMyBulkDownloadsResponse {
+    /** Retrieved bulk downloads. */
+    bulkDownloads?: BulkDownload[];
+}
+export interface UpdateDownloadGenerationDetailsRequest {
+    /**
+     * Bulk download ID of the `downloadGenerationStatus` to update.
+     * @format GUID
+     */
+    bulkDownloadId?: string;
+}
+export interface UpdateDownloadGenerationDetailsResponse {
+    /** Updated bulk download. */
+    bulkDownload?: BulkDownload;
+}
+export interface DeleteBulkDownloadRequest {
+    /**
+     * Bulk download ID to delete.
+     * @format GUID
+     */
+    bulkDownloadId: string;
+}
+export interface DeleteBulkDownloadResponse {
+}
+export interface Empty {
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+export interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+export interface BulkDownloadCreatedEnvelope {
+    entity: BulkDownload;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a bulk download is created.
+ * @permissionId GET_PAID.BULK_DOWNLOAD_DOMAIN_EVENTS_READ
+ * @webhook
+ * @eventType wix.get_paid.downloader.v1.bulk_download_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+export declare function onBulkDownloadCreated(handler: (event: BulkDownloadCreatedEnvelope) => void | Promise<void>): void;
+export interface BulkDownloadDeletedEnvelope {
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a bulk download is deleted.
+ * @permissionId GET_PAID.BULK_DOWNLOAD_DOMAIN_EVENTS_READ
+ * @webhook
+ * @eventType wix.get_paid.downloader.v1.bulk_download_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+export declare function onBulkDownloadDeleted(handler: (event: BulkDownloadDeletedEnvelope) => void | Promise<void>): void;
+export interface BulkDownloadUpdatedEnvelope {
+    entity: BulkDownload;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a bulk download is updated.
+ * @permissionId GET_PAID.BULK_DOWNLOAD_DOMAIN_EVENTS_READ
+ * @webhook
+ * @eventType wix.get_paid.downloader.v1.bulk_download_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+export declare function onBulkDownloadUpdated(handler: (event: BulkDownloadUpdatedEnvelope) => void | Promise<void>): void;
+type BulkDownloadNonNullablePaths = `downloadGenerationStatus` | `namespace` | `entityIds` | `skippedEntityIds` | `downloadGenerationDetails.processed` | `downloadGenerationDetails.total`;
+/**
+ * Initiates a bulk download process.
+ *
+ * The process creates a .zip file containing the requested files. The .zip file is available for download using the `downloadUrl` in the `bulkDownload` response.
+ * The `downloadUrl` is available for 24 hours after the process begins.
+ * @param bulkDownload - Bulk download to initiate.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField bulkDownload
+ * @requiredField bulkDownload.entityIds
+ * @requiredField bulkDownload.namespace
+ * @permissionId GET_PAID.BULK_DOWNLOAD_CREATE
+ * @permissionScope Manage Receipts
+ * @permissionScopeId SCOPE.RECEIPTS.MANAGE
+ * @applicableIdentity APP
+ * @returns The initiated bulk download.
+ * @fqn wix.get_paid.downloader.v1.BulkDownloads.InitiateBulkDownload
+ */
+export declare function initiateBulkDownload(bulkDownload: NonNullablePaths<BulkDownload, `entityIds` | `namespace`>): Promise<NonNullablePaths<BulkDownload, BulkDownloadNonNullablePaths>>;
+/**
+ * Retrieves a bulk download.
+ * @param bulkDownloadId - Bulk download ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField bulkDownloadId
+ * @permissionId GET_PAID.BULK_DOWNLOAD_READ
+ * @permissionScope Manage Receipts
+ * @permissionScopeId SCOPE.RECEIPTS.MANAGE
+ * @applicableIdentity APP
+ * @returns Retrieved bulk download.
+ * @fqn wix.get_paid.downloader.v1.BulkDownloads.GetBulkDownload
+ */
+export declare function getBulkDownload(bulkDownloadId: string): Promise<NonNullablePaths<BulkDownload, BulkDownloadNonNullablePaths>>;
+/**
+ * Lists all bulk downloads available for the user that initiated them.
+ * By default, response is sorted by `updatedDate` in descending order.
+ * @param namespace - Namespace of the app to download from.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField namespace
+ * @permissionId GET_PAID.BULK_DOWNLOAD_READ
+ * @permissionScope Manage Receipts
+ * @permissionScopeId SCOPE.RECEIPTS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.get_paid.downloader.v1.BulkDownloads.ListMyBulkDownloads
+ */
+export declare function listMyBulkDownloads(namespace: NamespaceWithLiterals): Promise<NonNullablePaths<ListMyBulkDownloadsResponse, {
+    [P in BulkDownloadNonNullablePaths]: `bulkDownloads.${number}.${P}`;
+}[BulkDownloadNonNullablePaths]>>;
+/**
+ * Deletes a bulk download.
+ * @param bulkDownloadId - Bulk download ID to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField bulkDownloadId
+ * @permissionId GET_PAID.BULK_DOWNLOAD_DELETE
+ * @permissionScope Manage Receipts
+ * @permissionScopeId SCOPE.RECEIPTS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.get_paid.downloader.v1.BulkDownloads.DeleteBulkDownload
+ */
+export declare function deleteBulkDownload(bulkDownloadId: string): Promise<void>;
+export {};