@wix/auto_sdk_get-paid_bulk-downloads 1.0.0

package/build/internal/es/src/get-paid-downloader-v1-bulk-download-bulk-downloads.universal.js

@@ -0,0 +1,202 @@
+import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
+import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
+import * as ambassadorWixGetPaidDownloaderV1BulkDownload from './get-paid-downloader-v1-bulk-download-bulk-downloads.http.js';
+export var DownloadGenerationStatus;
+(function (DownloadGenerationStatus) {
+    /** Unknown download status. */
+    DownloadGenerationStatus["UNKNOWN_DOWNLOAD_STATUS"] = "UNKNOWN_DOWNLOAD_STATUS";
+    /** Generation is in progress. */
+    DownloadGenerationStatus["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. */
+    DownloadGenerationStatus["PARTIAL_SUCCESS"] = "PARTIAL_SUCCESS";
+    /** Generation was successful. The .zip file is ready for download using the `downloadUrl`. */
+    DownloadGenerationStatus["SUCCESS"] = "SUCCESS";
+    /** Generation has failed. */
+    DownloadGenerationStatus["FAILED"] = "FAILED";
+})(DownloadGenerationStatus || (DownloadGenerationStatus = {}));
+export var Namespace;
+(function (Namespace) {
+    /** Unknown namespace. */
+    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)). */
+    Namespace["RECEIPTS"] = "RECEIPTS";
+})(Namespace || (Namespace = {}));
+export var DownloadStatus;
+(function (DownloadStatus) {
+    /** Unknown download status. */
+    DownloadStatus["UNKNOWN_DOWNLOAD_STATUS"] = "UNKNOWN_DOWNLOAD_STATUS";
+    /** Generation was successful. You can download files using the `downloadUrl`. */
+    DownloadStatus["READY"] = "READY";
+    /** Generation has failed. */
+    DownloadStatus["FAILED"] = "FAILED";
+})(DownloadStatus || (DownloadStatus = {}));
+export var BulkDownloadStatusUpdateNamespace;
+(function (BulkDownloadStatusUpdateNamespace) {
+    /** Unknown namespace. */
+    BulkDownloadStatusUpdateNamespace["UNKNOWN_NAMESPACE"] = "UNKNOWN_NAMESPACE";
+    /** Receipts application. */
+    BulkDownloadStatusUpdateNamespace["RECEIPTS"] = "RECEIPTS";
+})(BulkDownloadStatusUpdateNamespace || (BulkDownloadStatusUpdateNamespace = {}));
+export var InitiateBulkDownloadZipNamespace;
+(function (InitiateBulkDownloadZipNamespace) {
+    /** Unknown namespace. */
+    InitiateBulkDownloadZipNamespace["UNKNOWN_NAMESPACE"] = "UNKNOWN_NAMESPACE";
+    /** Receipts application. */
+    InitiateBulkDownloadZipNamespace["RECEIPTS"] = "RECEIPTS";
+})(InitiateBulkDownloadZipNamespace || (InitiateBulkDownloadZipNamespace = {}));
+export var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (WebhookIdentityType = {}));
+/**
+ * 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 async function initiateBulkDownload(bulkDownload) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        bulkDownload: bulkDownload,
+    });
+    const reqOpts = ambassadorWixGetPaidDownloaderV1BulkDownload.initiateBulkDownload(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data)?.bulkDownload;
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { bulkDownload: '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['bulkDownload']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * 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 async function getBulkDownload(bulkDownloadId) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        bulkDownloadId: bulkDownloadId,
+    });
+    const reqOpts = ambassadorWixGetPaidDownloaderV1BulkDownload.getBulkDownload(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data)?.bulkDownload;
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { bulkDownloadId: '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['bulkDownloadId']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * 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 async function listMyBulkDownloads(namespace) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        namespace: namespace,
+    });
+    const reqOpts = ambassadorWixGetPaidDownloaderV1BulkDownload.listMyBulkDownloads(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { namespace: '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['namespace']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * 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 async function deleteBulkDownload(bulkDownloadId) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        bulkDownloadId: bulkDownloadId,
+    });
+    const reqOpts = ambassadorWixGetPaidDownloaderV1BulkDownload.deleteBulkDownload(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { bulkDownloadId: '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['bulkDownloadId']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+//# sourceMappingURL=get-paid-downloader-v1-bulk-download-bulk-downloads.universal.js.map

package/build/internal/es/src/get-paid-downloader-v1-bulk-download-bulk-downloads.universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-paid-downloader-v1-bulk-download-bulk-downloads.universal.js","sourceRoot":"","sources":["../../../../src/get-paid-downloader-v1-bulk-download-bulk-downloads.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,4CAA4C,MAAM,+DAA+D,CAAC;AAkF9H,MAAM,CAAN,IAAY,wBAWX;AAXD,WAAY,wBAAwB;IAClC,+BAA+B;IAC/B,+EAAmD,CAAA;IACnD,iCAAiC;IACjC,qDAAyB,CAAA;IACzB,8NAA8N;IAC9N,+DAAmC,CAAA;IACnC,8FAA8F;IAC9F,+CAAmB,CAAA;IACnB,6BAA6B;IAC7B,6CAAiB,CAAA;AACnB,CAAC,EAXW,wBAAwB,KAAxB,wBAAwB,QAWnC;AAWD,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,yBAAyB;IACzB,oDAAuC,CAAA;IACvC,sNAAsN;IACtN,kCAAqB,CAAA;AACvB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAmCD,MAAM,CAAN,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,+BAA+B;IAC/B,qEAAmD,CAAA;IACnD,iFAAiF;IACjF,iCAAe,CAAA;IACf,6BAA6B;IAC7B,mCAAiB,CAAA;AACnB,CAAC,EAPW,cAAc,KAAd,cAAc,QAOzB;AASD,MAAM,CAAN,IAAY,iCAKX;AALD,WAAY,iCAAiC;IAC3C,yBAAyB;IACzB,4EAAuC,CAAA;IACvC,4BAA4B;IAC5B,0DAAqB,CAAA;AACvB,CAAC,EALW,iCAAiC,KAAjC,iCAAiC,QAK5C;AA4BD,MAAM,CAAN,IAAY,gCAKX;AALD,WAAY,gCAAgC;IAC1C,yBAAyB;IACzB,2EAAuC,CAAA;IACvC,4BAA4B;IAC5B,yDAAqB,CAAA;AACvB,CAAC,EALW,gCAAgC,KAAhC,gCAAgC,QAK3C;AAwND,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AAmHD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,YAAuE;IAEvE,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,YAAY,EAAE,YAAY;KAC3B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,4CAA4C,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAE7E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,YAAa,CAAC;IAC7E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE;YAClD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,cAAc,CAAC,CACjB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,cAAsB;IAEtB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,cAAc,EAAE,cAAc;KAC/B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,4CAA4C,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAExE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,YAAa,CAAC;IAC7E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE;YACpD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,gBAAgB,CAAC,CACnB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,SAAgC;IAShC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,4CAA4C,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE5E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE;YAC/C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,cAAsB;IAEtB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,cAAc,EAAE,cAAc;KAC/B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,4CAA4C,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAE3E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE;YACpD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,gBAAgB,CAAC,CACnB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}

package/meta/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "../build/cjs/meta.js"
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@wix/auto_sdk_get-paid_bulk-downloads",
+  "version": "1.0.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "keywords": [],
+  "sideEffects": false,
+  "main": "./build/cjs/index.js",
+  "types": "./build/es/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/es/index.js",
+      "require": "./build/cjs/index.js",
+      "types": "./build/es/index.d.ts"
+    },
+    "./package.json": "./package.json",
+    "./meta": {
+      "import": "./build/es/meta.js",
+      "require": "./build/cjs/meta.js",
+      "types": "./build/es/meta.d.ts"
+    }
+  },
+  "files": [
+    "build",
+    "meta",
+    "service-plugins"
+  ],
+  "dependencies": {
+    "@wix/sdk-runtime": "^0.3.49",
+    "@wix/sdk-types": "^1.13.28"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.2"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.json tsconfig.esm.json tsconfig.internal.json tsconfig.internal.esm.json",
+    "test": ":"
+  },
+  "wix": {
+    "artifact": {
+      "artifactId": "auto-sdk-get-paid-bulk-downloads",
+      "groupId": "com.wixpress.public-sdk-dependencies"
+    },
+    "sdkDependency": {
+      "fqdnNamespace": "bulkDownloads",
+      "fqdn": "wix.get_paid.downloader.v1.bulk_download"
+    }
+  },
+  "falconPackageHash": "9e1cc643a480cf008910c36e72efffad5e3f93cc4c5e10c12eb66298"
+}