@wix/auto_sdk_loyalty_imports 1.0.3 → 1.0.5

package/build/index.d.mts

@@ -0,0 +1,88 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { C as CreateLoyaltyImportOptions, a as CreateLoyaltyImportResponse, L as LoyaltyImport, G as GetErrorFileDownloadUrlResponse, E as ExecuteLoyaltyImportOptions, b as ExecuteLoyaltyImportResponse, c as CreateLoyaltyImportFileUrlResponse, d as LoyaltyImportsQueryBuilder } from './loyalty-imports-v1-loyalty-import-imports.universal-2D8oFVKm.mjs';
+export { J as ActionEvent, U as BaseEventMetadata, e as ColumnName, o as CreateLoyaltyImportFileUrlRequest, j as CreateLoyaltyImportRequest, s as CursorPaging, u as CursorPagingMetadata, p as CursorQuery, q as CursorQueryPagingMethodOneOf, v as Cursors, D as DeleteLoyaltyImportRequest, w as DeleteLoyaltyImportResponse, x as DomainEvent, y as DomainEventBodyOneOf, K as Empty, z as EntityCreatedEvent, B as EntityDeletedEvent, A as EntityUpdatedEvent, V as EventMetadata, n as ExecuteLoyaltyImportRequest, f as FileHeader, F as FileMetadata, m as GetErrorFileDownloadUrlRequest, k as GetLoyaltyImportRequest, l as GetLoyaltyImportResponse, g as HeaderMapping, H as HeaderMappingInfo, O as IdentificationData, T as IdentificationDataIdOneOf, M as ImportFinished, i as ImportResult, I as ImportStatus, X as LoyaltyImportCreatedEnvelope, Y as LoyaltyImportsQueryResult, N as MessageEnvelope, P as ParseResult, Q as QueryLoyaltyImportsRequest, t as QueryLoyaltyImportsResponse, R as RestoreInfo, h as SampleDataRow, S as SortOrder, r as Sorting, W as WebhookIdentityType } from './loyalty-imports-v1-loyalty-import-imports.universal-2D8oFVKm.mjs';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function createLoyaltyImport$1(httpClient: HttpClient): CreateLoyaltyImportSignature;
+interface CreateLoyaltyImportSignature {
+    /**
+     * Creates an import object based on an uploaded file.
+     *
+     * Call this method after uploading your file to the URL obtained from `createLoyaltyImportFileUrl()`.
+     * @param - URL of the file to import.
+     */
+    (fileUrl: string, options?: CreateLoyaltyImportOptions | undefined): Promise<CreateLoyaltyImportResponse>;
+}
+declare function getLoyaltyImport$1(httpClient: HttpClient): GetLoyaltyImportSignature;
+interface GetLoyaltyImportSignature {
+    /**
+     * Retrieves a loyalty import.
+     * @param - Loyalty import ID.
+     * @returns Retrieved loyalty import.
+     */
+    (loyaltyImportId: string): Promise<LoyaltyImport>;
+}
+declare function getErrorFileDownloadUrl$1(httpClient: HttpClient): GetErrorFileDownloadUrlSignature;
+interface GetErrorFileDownloadUrlSignature {
+    /**
+     * Retrieves the download URL for the error file of a failed loyalty import.
+     *
+     * If an import fails, the `importResult.errorFileExists` field in the `LoyaltyImport` object is set to `true`.
+     *
+     * Use this method to get the URL of the error file, which contains details about which items couldn't be imported and why.
+     * @param - Loyalty import ID.
+     */
+    (loyaltyImportId: string): Promise<GetErrorFileDownloadUrlResponse>;
+}
+declare function executeLoyaltyImport$1(httpClient: HttpClient): ExecuteLoyaltyImportSignature;
+interface ExecuteLoyaltyImportSignature {
+    /**
+     * Starts the actual import process for a loyalty import.
+     *
+     * Call this method after the loyalty import object reaches the `PARSED` status.
+     * @param - Loyalty import ID.
+     */
+    (loyaltyImportId: string, options?: ExecuteLoyaltyImportOptions | undefined): Promise<ExecuteLoyaltyImportResponse>;
+}
+declare function createLoyaltyImportFileUrl$1(httpClient: HttpClient): CreateLoyaltyImportFileUrlSignature;
+interface CreateLoyaltyImportFileUrlSignature {
+    /**
+     * Creates a URL for uploading a loyalty import file.
+     *
+     * This method is the first step in the loyalty import process. It returns a file path and an upload URL, which you'll use in subsequent steps of the import process.
+     */
+    (): Promise<CreateLoyaltyImportFileUrlResponse>;
+}
+declare function queryLoyaltyImports$1(httpClient: HttpClient): QueryLoyaltyImportsSignature;
+interface QueryLoyaltyImportsSignature {
+    /**
+     * Creates a query to retrieve a list of loyalty imports.
+     *
+     * The `queryLoyaltyImports()` function builds a query to retrieve a list of imports and returns a `LoyaltyImportsQueryBuilder` object.
+     *
+     * The returned object contains the query definition, which is typically used to run the query using the `find()` function.
+     *
+     * You can refine the query by chaining `LoyaltyImportsQueryBuilder` functions onto the query. `LoyaltyImportsQueryBuilder` functions enable you to sort, filter, and control the results `queryLoyaltyImports()` returns.
+     *
+     * `queryLoyaltyImports()` runs with these `LoyaltyImportsQueryBuilder` defaults, which you can override:
+     *
+     * - `limit(50)`
+     * - `descending("_createdDate")`
+     *
+     * The functions that are chained to `queryLoyaltyImports()` are applied in the order they're called. For example, if you apply ascending('status') and then descending('_createdDate'), the results are sorted first by the status, and then, if there are multiple results with the same status, the items are sorted by the created date.
+     */
+    (): LoyaltyImportsQueryBuilder;
+}
+
+declare const createLoyaltyImport: MaybeContext<BuildRESTFunction<typeof createLoyaltyImport$1> & typeof createLoyaltyImport$1>;
+declare const getLoyaltyImport: MaybeContext<BuildRESTFunction<typeof getLoyaltyImport$1> & typeof getLoyaltyImport$1>;
+declare const getErrorFileDownloadUrl: MaybeContext<BuildRESTFunction<typeof getErrorFileDownloadUrl$1> & typeof getErrorFileDownloadUrl$1>;
+declare const executeLoyaltyImport: MaybeContext<BuildRESTFunction<typeof executeLoyaltyImport$1> & typeof executeLoyaltyImport$1>;
+declare const createLoyaltyImportFileUrl: MaybeContext<BuildRESTFunction<typeof createLoyaltyImportFileUrl$1> & typeof createLoyaltyImportFileUrl$1>;
+declare const queryLoyaltyImports: MaybeContext<BuildRESTFunction<typeof queryLoyaltyImports$1> & typeof queryLoyaltyImports$1>;
+/**
+ * Triggered when a loyalty import is created.
+ */
+declare const onLoyaltyImportCreated: ReturnType<typeof createEventModule<typeof publicOnLoyaltyImportCreated>>;
+
+export { CreateLoyaltyImportFileUrlResponse, CreateLoyaltyImportOptions, CreateLoyaltyImportResponse, ExecuteLoyaltyImportOptions, ExecuteLoyaltyImportResponse, GetErrorFileDownloadUrlResponse, LoyaltyImport, LoyaltyImportsQueryBuilder, createLoyaltyImport, createLoyaltyImportFileUrl, executeLoyaltyImport, getErrorFileDownloadUrl, getLoyaltyImport, onLoyaltyImportCreated, queryLoyaltyImports };

package/build/index.d.ts

@@ -0,0 +1,88 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { C as CreateLoyaltyImportOptions, a as CreateLoyaltyImportResponse, L as LoyaltyImport, G as GetErrorFileDownloadUrlResponse, E as ExecuteLoyaltyImportOptions, b as ExecuteLoyaltyImportResponse, c as CreateLoyaltyImportFileUrlResponse, d as LoyaltyImportsQueryBuilder } from './loyalty-imports-v1-loyalty-import-imports.universal-2D8oFVKm.js';
+export { J as ActionEvent, U as BaseEventMetadata, e as ColumnName, o as CreateLoyaltyImportFileUrlRequest, j as CreateLoyaltyImportRequest, s as CursorPaging, u as CursorPagingMetadata, p as CursorQuery, q as CursorQueryPagingMethodOneOf, v as Cursors, D as DeleteLoyaltyImportRequest, w as DeleteLoyaltyImportResponse, x as DomainEvent, y as DomainEventBodyOneOf, K as Empty, z as EntityCreatedEvent, B as EntityDeletedEvent, A as EntityUpdatedEvent, V as EventMetadata, n as ExecuteLoyaltyImportRequest, f as FileHeader, F as FileMetadata, m as GetErrorFileDownloadUrlRequest, k as GetLoyaltyImportRequest, l as GetLoyaltyImportResponse, g as HeaderMapping, H as HeaderMappingInfo, O as IdentificationData, T as IdentificationDataIdOneOf, M as ImportFinished, i as ImportResult, I as ImportStatus, X as LoyaltyImportCreatedEnvelope, Y as LoyaltyImportsQueryResult, N as MessageEnvelope, P as ParseResult, Q as QueryLoyaltyImportsRequest, t as QueryLoyaltyImportsResponse, R as RestoreInfo, h as SampleDataRow, S as SortOrder, r as Sorting, W as WebhookIdentityType } from './loyalty-imports-v1-loyalty-import-imports.universal-2D8oFVKm.js';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function createLoyaltyImport$1(httpClient: HttpClient): CreateLoyaltyImportSignature;
+interface CreateLoyaltyImportSignature {
+    /**
+     * Creates an import object based on an uploaded file.
+     *
+     * Call this method after uploading your file to the URL obtained from `createLoyaltyImportFileUrl()`.
+     * @param - URL of the file to import.
+     */
+    (fileUrl: string, options?: CreateLoyaltyImportOptions | undefined): Promise<CreateLoyaltyImportResponse>;
+}
+declare function getLoyaltyImport$1(httpClient: HttpClient): GetLoyaltyImportSignature;
+interface GetLoyaltyImportSignature {
+    /**
+     * Retrieves a loyalty import.
+     * @param - Loyalty import ID.
+     * @returns Retrieved loyalty import.
+     */
+    (loyaltyImportId: string): Promise<LoyaltyImport>;
+}
+declare function getErrorFileDownloadUrl$1(httpClient: HttpClient): GetErrorFileDownloadUrlSignature;
+interface GetErrorFileDownloadUrlSignature {
+    /**
+     * Retrieves the download URL for the error file of a failed loyalty import.
+     *
+     * If an import fails, the `importResult.errorFileExists` field in the `LoyaltyImport` object is set to `true`.
+     *
+     * Use this method to get the URL of the error file, which contains details about which items couldn't be imported and why.
+     * @param - Loyalty import ID.
+     */
+    (loyaltyImportId: string): Promise<GetErrorFileDownloadUrlResponse>;
+}
+declare function executeLoyaltyImport$1(httpClient: HttpClient): ExecuteLoyaltyImportSignature;
+interface ExecuteLoyaltyImportSignature {
+    /**
+     * Starts the actual import process for a loyalty import.
+     *
+     * Call this method after the loyalty import object reaches the `PARSED` status.
+     * @param - Loyalty import ID.
+     */
+    (loyaltyImportId: string, options?: ExecuteLoyaltyImportOptions | undefined): Promise<ExecuteLoyaltyImportResponse>;
+}
+declare function createLoyaltyImportFileUrl$1(httpClient: HttpClient): CreateLoyaltyImportFileUrlSignature;
+interface CreateLoyaltyImportFileUrlSignature {
+    /**
+     * Creates a URL for uploading a loyalty import file.
+     *
+     * This method is the first step in the loyalty import process. It returns a file path and an upload URL, which you'll use in subsequent steps of the import process.
+     */
+    (): Promise<CreateLoyaltyImportFileUrlResponse>;
+}
+declare function queryLoyaltyImports$1(httpClient: HttpClient): QueryLoyaltyImportsSignature;
+interface QueryLoyaltyImportsSignature {
+    /**
+     * Creates a query to retrieve a list of loyalty imports.
+     *
+     * The `queryLoyaltyImports()` function builds a query to retrieve a list of imports and returns a `LoyaltyImportsQueryBuilder` object.
+     *
+     * The returned object contains the query definition, which is typically used to run the query using the `find()` function.
+     *
+     * You can refine the query by chaining `LoyaltyImportsQueryBuilder` functions onto the query. `LoyaltyImportsQueryBuilder` functions enable you to sort, filter, and control the results `queryLoyaltyImports()` returns.
+     *
+     * `queryLoyaltyImports()` runs with these `LoyaltyImportsQueryBuilder` defaults, which you can override:
+     *
+     * - `limit(50)`
+     * - `descending("_createdDate")`
+     *
+     * The functions that are chained to `queryLoyaltyImports()` are applied in the order they're called. For example, if you apply ascending('status') and then descending('_createdDate'), the results are sorted first by the status, and then, if there are multiple results with the same status, the items are sorted by the created date.
+     */
+    (): LoyaltyImportsQueryBuilder;
+}
+
+declare const createLoyaltyImport: MaybeContext<BuildRESTFunction<typeof createLoyaltyImport$1> & typeof createLoyaltyImport$1>;
+declare const getLoyaltyImport: MaybeContext<BuildRESTFunction<typeof getLoyaltyImport$1> & typeof getLoyaltyImport$1>;
+declare const getErrorFileDownloadUrl: MaybeContext<BuildRESTFunction<typeof getErrorFileDownloadUrl$1> & typeof getErrorFileDownloadUrl$1>;
+declare const executeLoyaltyImport: MaybeContext<BuildRESTFunction<typeof executeLoyaltyImport$1> & typeof executeLoyaltyImport$1>;
+declare const createLoyaltyImportFileUrl: MaybeContext<BuildRESTFunction<typeof createLoyaltyImportFileUrl$1> & typeof createLoyaltyImportFileUrl$1>;
+declare const queryLoyaltyImports: MaybeContext<BuildRESTFunction<typeof queryLoyaltyImports$1> & typeof queryLoyaltyImports$1>;
+/**
+ * Triggered when a loyalty import is created.
+ */
+declare const onLoyaltyImportCreated: ReturnType<typeof createEventModule<typeof publicOnLoyaltyImportCreated>>;
+
+export { CreateLoyaltyImportFileUrlResponse, CreateLoyaltyImportOptions, CreateLoyaltyImportResponse, ExecuteLoyaltyImportOptions, ExecuteLoyaltyImportResponse, GetErrorFileDownloadUrlResponse, LoyaltyImport, LoyaltyImportsQueryBuilder, createLoyaltyImport, createLoyaltyImportFileUrl, executeLoyaltyImport, getErrorFileDownloadUrl, getLoyaltyImport, onLoyaltyImportCreated, queryLoyaltyImports };