@wix/auto_sdk_loyalty_imports 1.0.7 → 1.0.8

package/build/{internal/loyalty-imports-v1-loyalty-import-imports.universal-2D8oFVKm.d.ts → es/src/loyalty-imports-v1-loyalty-import-imports.universal.d.ts}

@@ -1,9 +1,10 @@
+import { NonNullablePaths } from '@wix/sdk-types';
 /**
  * An Import object is a batch import of loyalty points for existing customers.
  * You can use Loyalty Imports to import loyalty points from 3rd-party providers or update existing customer point balances.
  * This object tracks the entire import process from file upload to data processing.
  */
-interface LoyaltyImport {
+export interface LoyaltyImport {
     /**
      * The ID of the import.
      * @format GUID
@@ -46,7 +47,7 @@ interface LoyaltyImport {
     /** Results of the import process, including success and failure counts. */
     importResult?: ImportResult;
 }
-declare enum ImportStatus {
+export declare enum ImportStatus {
     /** Status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
     /** The import has been initiated but processing has not yet begun. */
@@ -62,7 +63,7 @@ declare enum ImportStatus {
     /** The import process has failed. */
     FAILED = "FAILED"
 }
-interface FileMetadata {
+export interface FileMetadata {
     /**
      * Size of the uploaded file in bytes. Max: `10 MB`.
      * @max 104857600
@@ -95,7 +96,7 @@ interface FileMetadata {
      */
     sampleDataRows?: SampleDataRow[];
 }
-interface FileHeader {
+export interface FileHeader {
     /**
      * Column headings from the first row of the uploaded file.
      * @maxSize 100
@@ -103,7 +104,7 @@ interface FileHeader {
      */
     values?: string[];
 }
-interface HeaderMappingInfo {
+export interface HeaderMappingInfo {
     /**
      * Mappings between required loyalty data fields and file columns.
      * Must contain exactly 2 mappings: one for `EMAIL` and one for `POINTS`.
@@ -112,7 +113,7 @@ interface HeaderMappingInfo {
      */
     headerMappings?: HeaderMapping[];
 }
-interface HeaderMapping {
+export interface HeaderMapping {
     /** The required loyalty data field that this mapping corresponds to. Must be either `EMAIL` or `POINTS`. */
     columnName?: ColumnName;
     /**
@@ -121,13 +122,13 @@ interface HeaderMapping {
      */
     columnIndex?: number;
 }
-declare enum ColumnName {
+export declare enum ColumnName {
     /** Column containing the customer's email address. */
     EMAIL = "EMAIL",
     /** Column containing the customer's loyalty point balance to be imported or updated. */
     POINTS = "POINTS"
 }
-interface SampleDataRow {
+export interface SampleDataRow {
     /**
      * Values in one sample data row. Each value corresponds to a column in the CSV file.
      * The number of values matches the number of columns in the file.
@@ -136,7 +137,7 @@ interface SampleDataRow {
      */
     values?: string[];
 }
-interface ParseResult {
+export interface ParseResult {
     /**
      * Number of rows parsed from the uploaded import file.
      * @readonly
@@ -149,7 +150,7 @@ interface ParseResult {
      */
     parseErrorReason?: string | null;
 }
-interface ImportResult {
+export interface ImportResult {
     /** Whether an error file detailing import failures is available for download. The file includes row-by-row import status, error reasons, and original data. */
     errorFileExists?: boolean;
     /**
@@ -163,7 +164,7 @@ interface ImportResult {
      */
     failureCount?: number | null;
 }
-interface CreateLoyaltyImportRequest {
+export interface CreateLoyaltyImportRequest {
     /** URL of the file to import. */
     fileUrl: string | null;
     /** Name of the file to import. */
@@ -171,45 +172,45 @@ interface CreateLoyaltyImportRequest {
     /** Size of the file to import, in bytes. */
     fileSize?: number | null;
 }
-interface CreateLoyaltyImportResponse {
+export interface CreateLoyaltyImportResponse {
     /** Created loyalty import. */
     loyaltyImport?: LoyaltyImport;
 }
-interface GetLoyaltyImportRequest {
+export interface GetLoyaltyImportRequest {
     /** Loyalty import ID. */
     loyaltyImportId: string;
 }
-interface GetLoyaltyImportResponse {
+export interface GetLoyaltyImportResponse {
     /** Retrieved loyalty import. */
     loyaltyImport?: LoyaltyImport;
 }
-interface GetErrorFileDownloadUrlRequest {
+export interface GetErrorFileDownloadUrlRequest {
     /** Loyalty import ID. */
     loyaltyImportId: string;
 }
-interface GetErrorFileDownloadUrlResponse {
+export interface GetErrorFileDownloadUrlResponse {
     /** URL for downloading the error file. */
     url?: string | null;
 }
-interface ExecuteLoyaltyImportRequest {
+export interface ExecuteLoyaltyImportRequest {
     /** Loyalty import ID. */
     loyaltyImportId: string;
     /** Header mapping information for the import file. */
     headerMappingInfo?: HeaderMappingInfo;
 }
-interface ExecuteLoyaltyImportResponse {
+export interface ExecuteLoyaltyImportResponse {
     /** Executed loyalty import. */
     loyaltyImport?: LoyaltyImport;
 }
-interface CreateLoyaltyImportFileUrlRequest {
+export interface CreateLoyaltyImportFileUrlRequest {
 }
-interface CreateLoyaltyImportFileUrlResponse {
+export interface CreateLoyaltyImportFileUrlResponse {
     /** Path where the file will be stored. */
     filePath?: string | null;
     /** URL for uploading the loyalty import file. */
     uploadUrl?: string | null;
 }
-interface QueryLoyaltyImportsRequest {
+export interface QueryLoyaltyImportsRequest {
     /**
      * Filter object.
      * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
@@ -220,7 +221,7 @@ interface QueryLoyaltyImportsRequest {
      */
     query: CursorQuery;
 }
-interface CursorQuery extends CursorQueryPagingMethodOneOf {
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Cursor paging options.
      *
@@ -242,7 +243,7 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-interface CursorQueryPagingMethodOneOf {
+export interface CursorQueryPagingMethodOneOf {
     /**
      * Cursor paging options.
      *
@@ -250,7 +251,7 @@ interface CursorQueryPagingMethodOneOf {
      */
     cursorPaging?: CursorPaging;
 }
-interface Sorting {
+export interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -259,11 +260,11 @@ interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
-declare enum SortOrder {
+export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-interface CursorPaging {
+export interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -278,13 +279,13 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface QueryLoyaltyImportsResponse {
+export interface QueryLoyaltyImportsResponse {
     /** List of loyalty imports matching the query. */
     loyaltyImports?: LoyaltyImport[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
-interface CursorPagingMetadata {
+export interface CursorPagingMetadata {
     /** Number of items returned in current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -297,7 +298,7 @@ interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-interface Cursors {
+export interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -309,7 +310,7 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface DeleteLoyaltyImportRequest {
+export interface DeleteLoyaltyImportRequest {
     /**
      * Loyalty import ID.
      * @format GUID
@@ -321,9 +322,9 @@ interface DeleteLoyaltyImportRequest {
      */
     revision?: string;
 }
-interface DeleteLoyaltyImportResponse {
+export interface DeleteLoyaltyImportResponse {
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -366,19 +367,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
+export interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-interface EntityCreatedEvent {
+export interface EntityCreatedEvent {
     entity?: string;
 }
-interface RestoreInfo {
+export interface RestoreInfo {
     deletedDate?: Date | null;
 }
-interface EntityUpdatedEvent {
+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.
@@ -386,20 +387,20 @@ interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-interface EntityDeletedEvent {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-interface ActionEvent {
+export interface ActionEvent {
     body?: string;
 }
-interface Empty {
+export interface Empty {
 }
-interface ImportFinished {
+export interface ImportFinished {
     /** Completed loyalty import. */
     loyaltyImport?: LoyaltyImport;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -415,7 +416,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -440,7 +441,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -462,14 +463,14 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface BaseEventMetadata {
+export interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -483,7 +484,7 @@ interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-interface EventMetadata extends BaseEventMetadata {
+export interface EventMetadata extends BaseEventMetadata {
     /**
      * Unique event ID.
      * Allows clients to ignore duplicate webhooks.
@@ -521,20 +522,137 @@ interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-interface LoyaltyImportCreatedEnvelope {
+export interface LoyaltyImportCreatedEnvelope {
     entity: LoyaltyImport;
     metadata: EventMetadata;
 }
-interface CreateLoyaltyImportOptions {
+/**
+ * Triggered when a loyalty import is created.
+ * @webhook
+ * @eventType wix.loyalty.imports.v1.loyalty_import_created
+ * @serviceIdentifier wix.loyalty.imports.v1.LoyaltyImports
+ * @slug created
+ */
+export declare function onLoyaltyImportCreated(handler: (event: LoyaltyImportCreatedEnvelope) => void | Promise<void>): void;
+type LoyaltyImportNonNullablePaths = `status` | `fileMetadata.url` | `fileMetadata.header.values` | `fileMetadata.headerMappingInfo.headerMappings` | `fileMetadata.headerMappingInfo.headerMappings.${number}.columnName` | `fileMetadata.headerMappingInfo.headerMappings.${number}.columnIndex` | `fileMetadata.sampleDataRows` | `fileMetadata.sampleDataRows.${number}.values` | `importResult.errorFileExists`;
+/**
+ * Creates an import object based on an uploaded file.
+ *
+ * Call this method after uploading your file to the URL obtained from `createLoyaltyImportFileUrl()`.
+ * @param fileUrl - URL of the file to import.
+ * @public
+ * @requiredField fileUrl
+ * @permissionId LOYALTY.MANAGE_IMPORTS
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn wix.loyalty.imports.v1.LoyaltyImports.CreateLoyaltyImport
+ */
+export declare function createLoyaltyImport(fileUrl: string, options?: CreateLoyaltyImportOptions): Promise<NonNullablePaths<CreateLoyaltyImportResponse, {
+    [P in LoyaltyImportNonNullablePaths]: `loyaltyImport.${P}`;
+}[LoyaltyImportNonNullablePaths]>>;
+export interface CreateLoyaltyImportOptions {
     /** Name of the file to import. */
     fileName?: string | null;
     /** Size of the file to import, in bytes. */
     fileSize?: number | null;
 }
-interface ExecuteLoyaltyImportOptions {
+/**
+ * Retrieves a loyalty import.
+ * @param loyaltyImportId - Loyalty import ID.
+ * @public
+ * @requiredField loyaltyImportId
+ * @permissionId LOYALTY.MANAGE_IMPORTS
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @returns Retrieved loyalty import.
+ * @fqn wix.loyalty.imports.v1.LoyaltyImports.GetLoyaltyImport
+ */
+export declare function getLoyaltyImport(loyaltyImportId: string): Promise<NonNullablePaths<LoyaltyImport, LoyaltyImportNonNullablePaths>>;
+/**
+ * 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 loyaltyImportId - Loyalty import ID.
+ * @public
+ * @requiredField loyaltyImportId
+ * @permissionId LOYALTY.MANAGE_IMPORTS
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn wix.loyalty.imports.v1.LoyaltyImports.GetErrorFileDownloadUrl
+ */
+export declare function getErrorFileDownloadUrl(loyaltyImportId: string): Promise<GetErrorFileDownloadUrlResponse>;
+/**
+ * Starts the actual import process for a loyalty import.
+ *
+ * Call this method after the loyalty import object reaches the `PARSED` status.
+ * @param loyaltyImportId - Loyalty import ID.
+ * @public
+ * @requiredField loyaltyImportId
+ * @permissionId LOYALTY.MANAGE_IMPORTS
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn wix.loyalty.imports.v1.LoyaltyImports.ExecuteLoyaltyImport
+ */
+export declare function executeLoyaltyImport(loyaltyImportId: string, options?: ExecuteLoyaltyImportOptions): Promise<NonNullablePaths<ExecuteLoyaltyImportResponse, {
+    [P in LoyaltyImportNonNullablePaths]: `loyaltyImport.${P}`;
+}[LoyaltyImportNonNullablePaths]>>;
+export interface ExecuteLoyaltyImportOptions {
     /** Header mapping information for the import file. */
     headerMappingInfo?: HeaderMappingInfo;
 }
+/**
+ * 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.
+ * @public
+ * @permissionId LOYALTY.MANAGE_IMPORTS
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn wix.loyalty.imports.v1.LoyaltyImports.CreateLoyaltyImportFileUrl
+ */
+export declare function createLoyaltyImportFileUrl(): Promise<CreateLoyaltyImportFileUrlResponse>;
+/**
+ * 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.
+ * @public
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId LOYALTY.MANAGE_IMPORTS
+ * @applicableIdentity APP
+ * @fqn wix.loyalty.imports.v1.LoyaltyImports.QueryLoyaltyImports
+ */
+export declare function queryLoyaltyImports(): LoyaltyImportsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -542,13 +660,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-interface LoyaltyImportsQueryResult extends QueryCursorResult {
+export interface LoyaltyImportsQueryResult extends QueryCursorResult {
     items: LoyaltyImport[];
     query: LoyaltyImportsQueryBuilder;
     next: () => Promise<LoyaltyImportsQueryResult>;
     prev: () => Promise<LoyaltyImportsQueryResult>;
 }
-interface LoyaltyImportsQueryBuilder {
+export interface LoyaltyImportsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
@@ -589,5 +707,4 @@ interface LoyaltyImportsQueryBuilder {
     skipTo: (cursor: string) => LoyaltyImportsQueryBuilder;
     find: () => Promise<LoyaltyImportsQueryResult>;
 }
-
-export { type EntityUpdatedEvent as A, type EntityDeletedEvent as B, type CreateLoyaltyImportOptions as C, type DeleteLoyaltyImportRequest as D, type ExecuteLoyaltyImportOptions as E, type FileMetadata as F, type GetErrorFileDownloadUrlResponse as G, type HeaderMappingInfo as H, ImportStatus as I, type ActionEvent as J, type Empty as K, type LoyaltyImport as L, type ImportFinished as M, type MessageEnvelope as N, type IdentificationData as O, type ParseResult as P, type QueryLoyaltyImportsRequest as Q, type RestoreInfo as R, SortOrder as S, type IdentificationDataIdOneOf as T, type BaseEventMetadata as U, type EventMetadata as V, WebhookIdentityType as W, type LoyaltyImportCreatedEnvelope as X, type LoyaltyImportsQueryResult as Y, type CreateLoyaltyImportResponse as a, type ExecuteLoyaltyImportResponse as b, type CreateLoyaltyImportFileUrlResponse as c, type LoyaltyImportsQueryBuilder as d, ColumnName as e, type FileHeader as f, type HeaderMapping as g, type SampleDataRow as h, type ImportResult as i, type CreateLoyaltyImportRequest as j, type GetLoyaltyImportRequest as k, type GetLoyaltyImportResponse as l, type GetErrorFileDownloadUrlRequest as m, type ExecuteLoyaltyImportRequest as n, type CreateLoyaltyImportFileUrlRequest as o, type CursorQuery as p, type CursorQueryPagingMethodOneOf as q, type Sorting as r, type CursorPaging as s, type QueryLoyaltyImportsResponse as t, type CursorPagingMetadata as u, type Cursors as v, type DeleteLoyaltyImportResponse as w, type DomainEvent as x, type DomainEventBodyOneOf as y, type EntityCreatedEvent as z };
+export {};