@wix/auto_sdk_get-paid_bulk-downloads 1.0.0 → 1.0.2

package/build/{internal/cjs/src/get-paid-downloader-v1-bulk-download-bulk-downloads.universal.d.ts → get-paid-downloader-v1-bulk-download-bulk-downloads.universal-CMWCGM09.d.mts}

@@ -1,6 +1,5 @@
-import { NonNullablePaths } from '@wix/sdk-types';
 /** A bulk download contains the download information to retrieve items in the Get Paid APIs. */
-export interface BulkDownload {
+interface BulkDownload {
     /**
      * Bulk download ID.
      * @format GUID
@@ -78,7 +77,7 @@ export interface BulkDownload {
      */
     downloadGenerationDetails?: DownloadGenerationDetails;
 }
-export declare enum DownloadGenerationStatus {
+declare enum DownloadGenerationStatus {
     /** Unknown download status. */
     UNKNOWN_DOWNLOAD_STATUS = "UNKNOWN_DOWNLOAD_STATUS",
     /** Generation is in progress. */
@@ -91,22 +90,22 @@ export declare enum DownloadGenerationStatus {
     FAILED = "FAILED"
 }
 /** @enumType */
-export type DownloadGenerationStatusWithLiterals = DownloadGenerationStatus | 'UNKNOWN_DOWNLOAD_STATUS' | 'PROCESSING' | 'PARTIAL_SUCCESS' | 'SUCCESS' | 'FAILED';
-export declare enum Namespace {
+type DownloadGenerationStatusWithLiterals = DownloadGenerationStatus | 'UNKNOWN_DOWNLOAD_STATUS' | 'PROCESSING' | 'PARTIAL_SUCCESS' | 'SUCCESS' | 'FAILED';
+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 {
+type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'RECEIPTS';
+interface DownloadGenerationDetails {
     /** Number of files that have been processed. */
     processed?: number;
     /** Total number of files to process. */
     total?: number;
 }
-export interface BulkDownloadStatusUpdate {
+interface BulkDownloadStatusUpdate {
     /**
      * ID of the bulk download.
      * @format GUID
@@ -125,7 +124,7 @@ export interface BulkDownloadStatusUpdate {
      */
     namespace?: BulkDownloadStatusUpdateNamespaceWithLiterals;
 }
-export declare enum DownloadStatus {
+declare enum DownloadStatus {
     /** Unknown download status. */
     UNKNOWN_DOWNLOAD_STATUS = "UNKNOWN_DOWNLOAD_STATUS",
     /** Generation was successful. You can download files using the `downloadUrl`. */
@@ -134,16 +133,16 @@ export declare enum DownloadStatus {
     FAILED = "FAILED"
 }
 /** @enumType */
-export type DownloadStatusWithLiterals = DownloadStatus | 'UNKNOWN_DOWNLOAD_STATUS' | 'READY' | 'FAILED';
-export declare enum BulkDownloadStatusUpdateNamespace {
+type DownloadStatusWithLiterals = DownloadStatus | 'UNKNOWN_DOWNLOAD_STATUS' | 'READY' | 'FAILED';
+declare enum BulkDownloadStatusUpdateNamespace {
     /** Unknown namespace. */
     UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
     /** Receipts application. */
     RECEIPTS = "RECEIPTS"
 }
 /** @enumType */
-export type BulkDownloadStatusUpdateNamespaceWithLiterals = BulkDownloadStatusUpdateNamespace | 'UNKNOWN_NAMESPACE' | 'RECEIPTS';
-export interface InitiateBulkDownloadZip {
+type BulkDownloadStatusUpdateNamespaceWithLiterals = BulkDownloadStatusUpdateNamespace | 'UNKNOWN_NAMESPACE' | 'RECEIPTS';
+interface InitiateBulkDownloadZip {
     /**
      * ID of the bulk download.
      * @format GUID
@@ -162,15 +161,15 @@ export interface InitiateBulkDownloadZip {
      */
     entityInfo?: EntityInfo[];
 }
-export declare enum InitiateBulkDownloadZipNamespace {
+declare enum InitiateBulkDownloadZipNamespace {
     /** Unknown namespace. */
     UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
     /** Receipts application. */
     RECEIPTS = "RECEIPTS"
 }
 /** @enumType */
-export type InitiateBulkDownloadZipNamespaceWithLiterals = InitiateBulkDownloadZipNamespace | 'UNKNOWN_NAMESPACE' | 'RECEIPTS';
-export interface EntityInfo {
+type InitiateBulkDownloadZipNamespaceWithLiterals = InitiateBulkDownloadZipNamespace | 'UNKNOWN_NAMESPACE' | 'RECEIPTS';
+interface EntityInfo {
     /**
      * The name of the entity which will be visible as a file inside the zip.
      * @immutable
@@ -184,56 +183,56 @@ export interface EntityInfo {
      */
     entityId?: string;
 }
-export interface InitiateBulkDownloadRequest {
+interface InitiateBulkDownloadRequest {
     /** Bulk download to initiate. */
     bulkDownload: BulkDownload;
 }
-export interface InitiateBulkDownloadResponse {
+interface InitiateBulkDownloadResponse {
     /** The initiated bulk download. */
     bulkDownload?: BulkDownload;
 }
-export interface GetBulkDownloadRequest {
+interface GetBulkDownloadRequest {
     /**
      * Bulk download ID.
      * @format GUID
      */
     bulkDownloadId: string;
 }
-export interface GetBulkDownloadResponse {
+interface GetBulkDownloadResponse {
     /** Retrieved bulk download. */
     bulkDownload?: BulkDownload;
 }
-export interface ListMyBulkDownloadsRequest {
+interface ListMyBulkDownloadsRequest {
     /** Namespace of the app to download from. */
     namespace: NamespaceWithLiterals;
 }
-export interface ListMyBulkDownloadsResponse {
+interface ListMyBulkDownloadsResponse {
     /** Retrieved bulk downloads. */
     bulkDownloads?: BulkDownload[];
 }
-export interface UpdateDownloadGenerationDetailsRequest {
+interface UpdateDownloadGenerationDetailsRequest {
     /**
      * Bulk download ID of the `downloadGenerationStatus` to update.
      * @format GUID
      */
     bulkDownloadId?: string;
 }
-export interface UpdateDownloadGenerationDetailsResponse {
+interface UpdateDownloadGenerationDetailsResponse {
     /** Updated bulk download. */
     bulkDownload?: BulkDownload;
 }
-export interface DeleteBulkDownloadRequest {
+interface DeleteBulkDownloadRequest {
     /**
      * Bulk download ID to delete.
      * @format GUID
      */
     bulkDownloadId: string;
 }
-export interface DeleteBulkDownloadResponse {
+interface DeleteBulkDownloadResponse {
 }
-export interface Empty {
+interface Empty {
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -268,19 +267,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
+interface EntityCreatedEvent {
     entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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.
@@ -288,14 +287,14 @@ export interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
     deletedEntity?: string | null;
 }
-export interface ActionEvent {
+interface ActionEvent {
     body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -311,7 +310,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -336,7 +335,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -358,7 +357,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -366,8 +365,8 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-export interface BaseEventMetadata {
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -381,7 +380,7 @@ export interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-export interface EventMetadata extends BaseEventMetadata {
+interface EventMetadata extends BaseEventMetadata {
     /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
     _id?: string;
     /**
@@ -411,105 +410,16 @@ export interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-export interface BulkDownloadCreatedEnvelope {
+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 {
+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 {
+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 {};
+
+export { type ActionEvent as A, type BulkDownload as B, DownloadGenerationStatus as D, type EntityInfo as E, type GetBulkDownloadRequest as G, InitiateBulkDownloadZipNamespace as I, type ListMyBulkDownloadsResponse as L, type MessageEnvelope as M, type NamespaceWithLiterals as N, type RestoreInfo as R, type UpdateDownloadGenerationDetailsRequest as U, WebhookIdentityType as W, type BulkDownloadCreatedEnvelope as a, type BulkDownloadDeletedEnvelope as b, type BulkDownloadUpdatedEnvelope as c, Namespace as d, DownloadStatus as e, BulkDownloadStatusUpdateNamespace as f, type DownloadGenerationDetails as g, type BulkDownloadStatusUpdate as h, type InitiateBulkDownloadZip as i, type InitiateBulkDownloadRequest as j, type InitiateBulkDownloadResponse as k, type GetBulkDownloadResponse as l, type ListMyBulkDownloadsRequest as m, type UpdateDownloadGenerationDetailsResponse as n, type DeleteBulkDownloadRequest as o, type DeleteBulkDownloadResponse as p, type Empty as q, type DomainEvent as r, type DomainEventBodyOneOf as s, type EntityCreatedEvent as t, type EntityUpdatedEvent as u, type EntityDeletedEvent as v, type IdentificationData as w, type IdentificationDataIdOneOf as x, type BaseEventMetadata as y, type EventMetadata as z };