@wix/auto_sdk_loyalty_imports 1.0.11 → 1.0.13

package/build/internal/{cjs/src/loyalty-imports-v1-loyalty-import-imports.universal.d.ts → loyalty-imports-v1-loyalty-import-imports.universal-CPUezeMW.d.mts}

@@ -1,10 +1,9 @@
-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.
  */
-export interface LoyaltyImport {
+interface LoyaltyImport {
     /**
      * The ID of the import.
      * @format GUID
@@ -39,7 +38,7 @@ export interface LoyaltyImport {
      * Current status of the import process.
      * @readonly
      */
-    status?: ImportStatus;
+    status?: ImportStatusWithLiterals;
     /** Metadata of the uploaded file containing loyalty points data. */
     fileMetadata?: FileMetadata;
     /** Results of parsing the uploaded file, including the number of rows parsed and any parse errors. */
@@ -47,7 +46,7 @@ export interface LoyaltyImport {
     /** Results of the import process, including success and failure counts. */
     importResult?: ImportResult;
 }
-export declare enum ImportStatus {
+declare enum ImportStatus {
     /** Status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
     /** The import has been initiated but processing has not yet begun. */
@@ -63,7 +62,9 @@ export declare enum ImportStatus {
     /** The import process has failed. */
     FAILED = "FAILED"
 }
-export interface FileMetadata {
+/** @enumType */
+type ImportStatusWithLiterals = ImportStatus | 'UNKNOWN' | 'INITIATED' | 'PARSING' | 'PARSED' | 'IMPORTING' | 'IMPORTED' | 'FAILED';
+interface FileMetadata {
     /**
      * Size of the uploaded file in bytes. Max: `10 MB`.
      * @max 104857600
@@ -96,7 +97,7 @@ export interface FileMetadata {
      */
     sampleDataRows?: SampleDataRow[];
 }
-export interface FileHeader {
+interface FileHeader {
     /**
      * Column headings from the first row of the uploaded file.
      * @maxSize 100
@@ -104,7 +105,7 @@ export interface FileHeader {
      */
     values?: string[];
 }
-export interface HeaderMappingInfo {
+interface HeaderMappingInfo {
     /**
      * Mappings between required loyalty data fields and file columns.
      * Must contain exactly 2 mappings: one for `EMAIL` and one for `POINTS`.
@@ -113,22 +114,24 @@ export interface HeaderMappingInfo {
      */
     headerMappings?: HeaderMapping[];
 }
-export interface HeaderMapping {
+interface HeaderMapping {
     /** The required loyalty data field that this mapping corresponds to. Must be either `EMAIL` or `POINTS`. */
-    columnName?: ColumnName;
+    columnName?: ColumnNameWithLiterals;
     /**
      * The zero-based index of the column in the uploaded file that contains the data for this loyalty field.
      * For example, if the email addresses are in the second column of the CSV file, this value would be 1.
      */
     columnIndex?: number;
 }
-export declare enum ColumnName {
+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"
 }
-export interface SampleDataRow {
+/** @enumType */
+type ColumnNameWithLiterals = ColumnName | 'EMAIL' | 'POINTS';
+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.
@@ -137,7 +140,7 @@ export interface SampleDataRow {
      */
     values?: string[];
 }
-export interface ParseResult {
+interface ParseResult {
     /**
      * Number of rows parsed from the uploaded import file.
      * @readonly
@@ -150,7 +153,7 @@ export interface ParseResult {
      */
     parseErrorReason?: string | null;
 }
-export interface ImportResult {
+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;
     /**
@@ -164,7 +167,7 @@ export interface ImportResult {
      */
     failureCount?: number | null;
 }
-export interface CreateLoyaltyImportRequest {
+interface CreateLoyaltyImportRequest {
     /** URL of the file to import. */
     fileUrl: string | null;
     /** Name of the file to import. */
@@ -172,45 +175,45 @@ export interface CreateLoyaltyImportRequest {
     /** Size of the file to import, in bytes. */
     fileSize?: number | null;
 }
-export interface CreateLoyaltyImportResponse {
+interface CreateLoyaltyImportResponse {
     /** Created loyalty import. */
     loyaltyImport?: LoyaltyImport;
 }
-export interface GetLoyaltyImportRequest {
+interface GetLoyaltyImportRequest {
     /** Loyalty import ID. */
     loyaltyImportId: string;
 }
-export interface GetLoyaltyImportResponse {
+interface GetLoyaltyImportResponse {
     /** Retrieved loyalty import. */
     loyaltyImport?: LoyaltyImport;
 }
-export interface GetErrorFileDownloadUrlRequest {
+interface GetErrorFileDownloadUrlRequest {
     /** Loyalty import ID. */
     loyaltyImportId: string;
 }
-export interface GetErrorFileDownloadUrlResponse {
+interface GetErrorFileDownloadUrlResponse {
     /** URL for downloading the error file. */
     url?: string | null;
 }
-export interface ExecuteLoyaltyImportRequest {
+interface ExecuteLoyaltyImportRequest {
     /** Loyalty import ID. */
     loyaltyImportId: string;
     /** Header mapping information for the import file. */
     headerMappingInfo?: HeaderMappingInfo;
 }
-export interface ExecuteLoyaltyImportResponse {
+interface ExecuteLoyaltyImportResponse {
     /** Executed loyalty import. */
     loyaltyImport?: LoyaltyImport;
 }
-export interface CreateLoyaltyImportFileUrlRequest {
+interface CreateLoyaltyImportFileUrlRequest {
 }
-export interface CreateLoyaltyImportFileUrlResponse {
+interface CreateLoyaltyImportFileUrlResponse {
     /** Path where the file will be stored. */
     filePath?: string | null;
     /** URL for uploading the loyalty import file. */
     uploadUrl?: string | null;
 }
-export interface QueryLoyaltyImportsRequest {
+interface QueryLoyaltyImportsRequest {
     /**
      * Filter object.
      * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
@@ -221,7 +224,7 @@ export interface QueryLoyaltyImportsRequest {
      */
     query: CursorQuery;
 }
-export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Cursor paging options.
      *
@@ -243,7 +246,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-export interface CursorQueryPagingMethodOneOf {
+interface CursorQueryPagingMethodOneOf {
     /**
      * Cursor paging options.
      *
@@ -251,20 +254,22 @@ export interface CursorQueryPagingMethodOneOf {
      */
     cursorPaging?: CursorPaging;
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
     /** Sort order. */
-    order?: SortOrder;
+    order?: SortOrderWithLiterals;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-export interface CursorPaging {
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -279,13 +284,13 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface QueryLoyaltyImportsResponse {
+interface QueryLoyaltyImportsResponse {
     /** List of loyalty imports matching the query. */
     loyaltyImports?: LoyaltyImport[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
-export interface CursorPagingMetadata {
+interface CursorPagingMetadata {
     /** Number of items returned in current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -298,7 +303,7 @@ export interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -310,7 +315,7 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface DeleteLoyaltyImportRequest {
+interface DeleteLoyaltyImportRequest {
     /**
      * Loyalty import ID.
      * @format GUID
@@ -322,9 +327,9 @@ export interface DeleteLoyaltyImportRequest {
      */
     revision?: string;
 }
-export interface DeleteLoyaltyImportResponse {
+interface DeleteLoyaltyImportResponse {
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -359,19 +364,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.
@@ -379,20 +384,20 @@ 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 Empty {
+interface Empty {
 }
-export interface ImportFinished {
+interface ImportFinished {
     /** Completed loyalty import. */
     loyaltyImport?: LoyaltyImport;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -408,7 +413,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
@@ -430,10 +435,10 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
      */
     appId?: string;
     /** @readonly */
-    identityType?: WebhookIdentityType;
+    identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -455,14 +460,16 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-export interface BaseEventMetadata {
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -476,7 +483,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;
     /**
@@ -506,137 +513,20 @@ export interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-export interface LoyaltyImportCreatedEnvelope {
+interface LoyaltyImportCreatedEnvelope {
     entity: LoyaltyImport;
     metadata: EventMetadata;
 }
-/**
- * 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` | `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 {
+interface CreateLoyaltyImportOptions {
     /** Name of the file to import. */
     fileName?: string | null;
     /** Size of the file to import, in bytes. */
     fileSize?: number | null;
 }
-/**
- * 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 {
+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;
@@ -644,13 +534,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-export interface LoyaltyImportsQueryResult extends QueryCursorResult {
+interface LoyaltyImportsQueryResult extends QueryCursorResult {
     items: LoyaltyImport[];
     query: LoyaltyImportsQueryBuilder;
     next: () => Promise<LoyaltyImportsQueryResult>;
     prev: () => Promise<LoyaltyImportsQueryResult>;
 }
-export interface LoyaltyImportsQueryBuilder {
+interface LoyaltyImportsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
@@ -691,4 +581,5 @@ export interface LoyaltyImportsQueryBuilder {
     skipTo: (cursor: string) => LoyaltyImportsQueryBuilder;
     find: () => Promise<LoyaltyImportsQueryResult>;
 }
-export {};
+
+export { type EntityCreatedEvent as A, type EntityUpdatedEvent 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 EntityDeletedEvent as J, type ActionEvent as K, type LoyaltyImport as L, type Empty as M, type ImportFinished as N, type MessageEnvelope as O, type ParseResult as P, type QueryLoyaltyImportsRequest as Q, type RestoreInfo as R, SortOrder as S, type IdentificationData as T, type IdentificationDataIdOneOf as U, type BaseEventMetadata as V, WebhookIdentityType as W, type EventMetadata as X, type LoyaltyImportsQueryResult as Y, type CreateLoyaltyImportResponse as a, type ExecuteLoyaltyImportResponse as b, type CreateLoyaltyImportFileUrlResponse as c, type LoyaltyImportsQueryBuilder as d, type LoyaltyImportCreatedEnvelope as e, ColumnName as f, type FileHeader as g, type HeaderMapping as h, type SampleDataRow as i, type ImportResult as j, type CreateLoyaltyImportRequest as k, type GetLoyaltyImportRequest as l, type GetLoyaltyImportResponse as m, type GetErrorFileDownloadUrlRequest as n, type ExecuteLoyaltyImportRequest as o, type CreateLoyaltyImportFileUrlRequest as p, type CursorQuery as q, type CursorQueryPagingMethodOneOf as r, type Sorting as s, type CursorPaging as t, type QueryLoyaltyImportsResponse as u, type CursorPagingMetadata as v, type Cursors as w, type DeleteLoyaltyImportResponse as x, type DomainEvent as y, type DomainEventBodyOneOf as z };