@wix/bex-utils 2.115.0 → 2.117.0

package/@wix/ambassador-hub-v1-job/es/build/proto/server/proto-generated.js

@@ -0,0 +1,5 @@
+import wrapper from '../proto-generated.js';
+export const services = wrapper;
+export const requests = wrapper;
+export const responses = wrapper;
+export default { services, requests, responses };

package/@wix/ambassador-hub-v1-job/es/build/rpc.impl.d.ts

@@ -0,0 +1,67 @@
+import { CreateFileUploadUrlRequest, CreateFileUploadUrlResponse, Empty, GetJobRequest, GetJobResponse, JobCallback, ListJobsRequest, ListJobsResponse, ListMovementLogsRequest, ListMovementLogsResponse, QueryJobsRequest, QueryJobsResponse, SubmitJobRequest, SubmitJobResponse, TerminateJobByIdRequest, TerminateJobByIdResponse, TerminateJobRequest, TerminateJobResponse } from './types.impl.js';
+import * as wrapper from './proto/proto-generated.js';
+declare const DataMovementService: typeof wrapper.wix.hub.v1.DataMovementService;
+export type RequestOptions<T = any, U = any> = {
+    _?: T;
+    requestData: any;
+    serviceArtifactId: string;
+    serviceProtoClass: U;
+    methodName: string;
+};
+/**
+ * Submit a data movement job.
+ *
+ * > **Note**: By default, the job is submitted for the current site.
+ */
+export declare function submitJob(payload: SubmitJobRequest): RequestOptions<SubmitJobResponse, typeof DataMovementService>;
+/**
+ * Creates an upload URL for a data source file.
+ *
+ * Before submitting a job to import data from a file to a collection, call this method to generate an upload URL. Use the `uploadUrl` in the response to upload your source file. For example:
+ *
+ * `curl --request PUT --upload-file "${path_to_file}" "${uploadUrl}"`
+ *
+ * > **Note**: The URL is valid for 15 minutes.
+ */
+export declare function createFileUploadUrl(payload: CreateFileUploadUrlRequest): RequestOptions<CreateFileUploadUrlResponse, typeof DataMovementService>;
+/**
+ * Retrieves the specified data movement job.
+ *
+ * > **Note**: You can only retrieve jobs submitted for the current site.
+ */
+export declare function getJob(payload: GetJobRequest): RequestOptions<GetJobResponse, typeof DataMovementService>;
+/**
+ * Lists data movement jobs for the current site.
+ *
+ * The `listJobs()` method builds a query to retrieve a list of jobs for the current site, and returns a [`JobsQueryBuilder`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/ascending) object. The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/find) method.
+ *
+ * You can refine the query by chaining `JobsQueryBuilder` methods onto the query. `JobsQueryBuilder` methods enable you to sort, filter, and control the results `listJobs()` returns.
+ *
+ * `listJobs()` runs with these `JobsQueryBuilder` defaults, which you can override:
+ *
+ * - [`skipTo`: `0`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/skip-to)
+ * - [`limit`: `50`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/limit)
+ * - [`ascending`: by `_id`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/ascending)
+ *
+ * The methods chained to `listJobs()` are applied in the order they're called. For example, if you apply `ascending('firstName')` and then `descending('age')`, the results are sorted first by firstName, and then, if there are multiple results with the same `firstName`, the items are sorted by `age`.
+ */
+export declare function listJobs(payload: ListJobsRequest): RequestOptions<ListJobsResponse, typeof DataMovementService>;
+/**
+ * Retrieves data movement jobs for the current site, on the basis of the filtering, sorting, and paging preferences you provide.
+ *
+ * Learn more about [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging) configuration.
+ */
+export declare function queryJobs(payload: QueryJobsRequest): RequestOptions<QueryJobsResponse, typeof DataMovementService>;
+/** Terminates the specified job. */
+export declare function terminateJob(payload: TerminateJobRequest): RequestOptions<TerminateJobResponse, typeof DataMovementService>;
+/**
+ * Lists logs for the specified job.
+ *
+ * Logs are generated by the destination for each item that failed to move. Some destinations also generate logs for items that moved successfully.
+ */
+export declare function listMovementLogs(payload: ListMovementLogsRequest): RequestOptions<ListMovementLogsResponse, typeof DataMovementService>;
+/** Callback sent from job executor pod */
+export declare function onJobCallback(payload: JobCallback): RequestOptions<Empty, typeof DataMovementService>;
+/** Get job by ID without restricting current metaSiteId */
+export declare function terminateJobById(payload: TerminateJobByIdRequest): RequestOptions<TerminateJobByIdResponse, typeof DataMovementService>;
+export {};

package/@wix/ambassador-hub-v1-job/es/build/rpc.impl.js

@@ -0,0 +1,158 @@
+import * as wrapper from './proto/proto-generated.js';
+var DataMovementService = wrapper.wix.hub.v1.DataMovementService;
+/**
+ * Submit a data movement job.
+ *
+ * > **Note**: By default, the job is submitted for the current site.
+ */
+export function submitJob(payload) {
+    var serviceArtifactId = 'com.wixpress.hub.wix-data-hub-fs2';
+    var serviceProtoClass = DataMovementService;
+    var methodName = 'submitJob';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+/**
+ * Creates an upload URL for a data source file.
+ *
+ * Before submitting a job to import data from a file to a collection, call this method to generate an upload URL. Use the `uploadUrl` in the response to upload your source file. For example:
+ *
+ * `curl --request PUT --upload-file "${path_to_file}" "${uploadUrl}"`
+ *
+ * > **Note**: The URL is valid for 15 minutes.
+ */
+export function createFileUploadUrl(payload) {
+    var serviceArtifactId = 'com.wixpress.hub.wix-data-hub-fs2';
+    var serviceProtoClass = DataMovementService;
+    var methodName = 'createFileUploadUrl';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+/**
+ * Retrieves the specified data movement job.
+ *
+ * > **Note**: You can only retrieve jobs submitted for the current site.
+ */
+export function getJob(payload) {
+    var serviceArtifactId = 'com.wixpress.hub.wix-data-hub-fs2';
+    var serviceProtoClass = DataMovementService;
+    var methodName = 'getJob';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+/**
+ * Lists data movement jobs for the current site.
+ *
+ * The `listJobs()` method builds a query to retrieve a list of jobs for the current site, and returns a [`JobsQueryBuilder`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/ascending) object. The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/find) method.
+ *
+ * You can refine the query by chaining `JobsQueryBuilder` methods onto the query. `JobsQueryBuilder` methods enable you to sort, filter, and control the results `listJobs()` returns.
+ *
+ * `listJobs()` runs with these `JobsQueryBuilder` defaults, which you can override:
+ *
+ * - [`skipTo`: `0`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/skip-to)
+ * - [`limit`: `50`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/limit)
+ * - [`ascending`: by `_id`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/ascending)
+ *
+ * The methods chained to `listJobs()` are applied in the order they're called. For example, if you apply `ascending('firstName')` and then `descending('age')`, the results are sorted first by firstName, and then, if there are multiple results with the same `firstName`, the items are sorted by `age`.
+ */
+export function listJobs(payload) {
+    var serviceArtifactId = 'com.wixpress.hub.wix-data-hub-fs2';
+    var serviceProtoClass = DataMovementService;
+    var methodName = 'listJobs';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+/**
+ * Retrieves data movement jobs for the current site, on the basis of the filtering, sorting, and paging preferences you provide.
+ *
+ * Learn more about [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging) configuration.
+ */
+export function queryJobs(payload) {
+    var serviceArtifactId = 'com.wixpress.hub.wix-data-hub-fs2';
+    var serviceProtoClass = DataMovementService;
+    var methodName = 'queryJobs';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+/** Terminates the specified job. */
+export function terminateJob(payload) {
+    var serviceArtifactId = 'com.wixpress.hub.wix-data-hub-fs2';
+    var serviceProtoClass = DataMovementService;
+    var methodName = 'terminateJob';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+/**
+ * Lists logs for the specified job.
+ *
+ * Logs are generated by the destination for each item that failed to move. Some destinations also generate logs for items that moved successfully.
+ */
+export function listMovementLogs(payload) {
+    var serviceArtifactId = 'com.wixpress.hub.wix-data-hub-fs2';
+    var serviceProtoClass = DataMovementService;
+    var methodName = 'listMovementLogs';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+/** Callback sent from job executor pod */
+export function onJobCallback(payload) {
+    var serviceArtifactId = 'com.wixpress.hub.wix-data-hub-fs2';
+    var serviceProtoClass = DataMovementService;
+    var methodName = 'onJobCallback';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+/** Get job by ID without restricting current metaSiteId */
+export function terminateJobById(payload) {
+    var serviceArtifactId = 'com.wixpress.hub.wix-data-hub-fs2';
+    var serviceProtoClass = DataMovementService;
+    var methodName = 'terminateJobById';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+//# sourceMappingURL=rpc.impl.js.map

package/@wix/ambassador-hub-v1-job/es/build/rpc.impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.impl.js","sourceRoot":"","sources":["../../rpc.impl.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,OAAO,MAAM,4BAA4B,CAAC;AAEtD,IAAM,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,mBAAmB,CAAC;AAUnE;;;;GAIG;AACH,MAAM,UAAU,SAAS,CACvB,OAAyB;IAEzB,IAAM,iBAAiB,GAAW,mCAAmC,CAAC;IACtE,IAAM,iBAAiB,GAA+B,mBAAmB,CAAC;IAC1E,IAAM,UAAU,GAAW,WAAW,CAAC;IACvC,IAAM,WAAW,GAAqB,OAAO,CAAC;IAC9C,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAAmC;IAEnC,IAAM,iBAAiB,GAAW,mCAAmC,CAAC;IACtE,IAAM,iBAAiB,GAA+B,mBAAmB,CAAC;IAC1E,IAAM,UAAU,GAAW,qBAAqB,CAAC;IACjD,IAAM,WAAW,GAA+B,OAAO,CAAC;IACxD,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,MAAM,CACpB,OAAsB;IAEtB,IAAM,iBAAiB,GAAW,mCAAmC,CAAC;IACtE,IAAM,iBAAiB,GAA+B,mBAAmB,CAAC;IAC1E,IAAM,UAAU,GAAW,QAAQ,CAAC;IACpC,IAAM,WAAW,GAAkB,OAAO,CAAC;IAC3C,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,QAAQ,CACtB,OAAwB;IAExB,IAAM,iBAAiB,GAAW,mCAAmC,CAAC;IACtE,IAAM,iBAAiB,GAA+B,mBAAmB,CAAC;IAC1E,IAAM,UAAU,GAAW,UAAU,CAAC;IACtC,IAAM,WAAW,GAAoB,OAAO,CAAC;IAC7C,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CACvB,OAAyB;IAEzB,IAAM,iBAAiB,GAAW,mCAAmC,CAAC;IACtE,IAAM,iBAAiB,GAA+B,mBAAmB,CAAC;IAC1E,IAAM,UAAU,GAAW,WAAW,CAAC;IACvC,IAAM,WAAW,GAAqB,OAAO,CAAC;IAC9C,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAED,oCAAoC;AACpC,MAAM,UAAU,YAAY,CAC1B,OAA4B;IAE5B,IAAM,iBAAiB,GAAW,mCAAmC,CAAC;IACtE,IAAM,iBAAiB,GAA+B,mBAAmB,CAAC;IAC1E,IAAM,UAAU,GAAW,cAAc,CAAC;IAC1C,IAAM,WAAW,GAAwB,OAAO,CAAC;IACjD,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAgC;IAEhC,IAAM,iBAAiB,GAAW,mCAAmC,CAAC;IACtE,IAAM,iBAAiB,GAA+B,mBAAmB,CAAC;IAC1E,IAAM,UAAU,GAAW,kBAAkB,CAAC;IAC9C,IAAM,WAAW,GAA4B,OAAO,CAAC;IACrD,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAED,0CAA0C;AAC1C,MAAM,UAAU,aAAa,CAC3B,OAAoB;IAEpB,IAAM,iBAAiB,GAAW,mCAAmC,CAAC;IACtE,IAAM,iBAAiB,GAA+B,mBAAmB,CAAC;IAC1E,IAAM,UAAU,GAAW,eAAe,CAAC;IAC3C,IAAM,WAAW,GAAgB,OAAO,CAAC;IACzC,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,gBAAgB,CAC9B,OAAgC;IAEhC,IAAM,iBAAiB,GAAW,mCAAmC,CAAC;IACtE,IAAM,iBAAiB,GAA+B,mBAAmB,CAAC;IAC1E,IAAM,UAAU,GAAW,kBAAkB,CAAC;IAC9C,IAAM,WAAW,GAA4B,OAAO,CAAC;IACrD,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC"}