@wix/auto_sdk_loyalty_imports 1.0.12 → 1.0.14

package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.types.d.ts

@@ -1,473 +0,0 @@
-/**
- * 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 {
-    /**
-     * The ID of the import.
-     * @format GUID
-     * @readonly
-     */
-    id?: string | null;
-    /**
-     * ID of the asynchronous import job associated with this import.
-     * @format GUID
-     * @readonly
-     */
-    asyncImportJobId?: string | null;
-    /**
-     * Revision number, which increments by 1 each time the Loyalty Import is updated.
-     * To prevent conflicting changes, the current revision must be passed when updating the Loyalty Import.
-     *
-     * Ignored when creating a Loyalty Import.
-     * @readonly
-     */
-    revision?: string | null;
-    /**
-     * Date and time the Loyalty Import was created.
-     * @readonly
-     */
-    createdDate?: Date | null;
-    /**
-     * Date and time the Loyalty Import was last updated.
-     * @readonly
-     */
-    updatedDate?: Date | null;
-    /**
-     * Current status of the import process.
-     * @readonly
-     */
-    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. */
-    parseResult?: ParseResult;
-    /** Results of the import process, including success and failure counts. */
-    importResult?: ImportResult;
-}
-export declare enum ImportStatus {
-    /** Status is unknown or not specified. */
-    UNKNOWN = "UNKNOWN",
-    /** The import has been initiated but processing has not yet begun. */
-    INITIATED = "INITIATED",
-    /** The system is currently parsing the import file. */
-    PARSING = "PARSING",
-    /** The import file has been successfully parsed and is ready for importing. */
-    PARSED = "PARSED",
-    /** The system is currently importing the parsed data. */
-    IMPORTING = "IMPORTING",
-    /** The import process is complete. This status indicates the process finished, but doesn't guarantee all data imported successfully. */
-    IMPORTED = "IMPORTED",
-    /** The import process has failed. */
-    FAILED = "FAILED"
-}
-/** @enumType */
-export type ImportStatusWithLiterals = ImportStatus | 'UNKNOWN' | 'INITIATED' | 'PARSING' | 'PARSED' | 'IMPORTING' | 'IMPORTED' | 'FAILED';
-export interface FileMetadata {
-    /**
-     * Size of the uploaded file in bytes. Max: `10 MB`.
-     * @max 104857600
-     * @readonly
-     */
-    size?: number | null;
-    /**
-     * Name of the uploaded file.
-     * @format GUID
-     * @readonly
-     */
-    name?: string | null;
-    /**
-     * URL of the uploaded file.
-     * @minLength 3
-     * @maxLength 10000
-     */
-    url?: string;
-    /** Column headings from the first row of the uploaded CSV file. */
-    header?: FileHeader;
-    /**
-     * Mapping between loyalty data fields and the corresponding columns in the uploaded file.
-     *
-     * Must include mappings for both `EMAIL` and `POINTS` to be valid.
-     */
-    headerMappingInfo?: HeaderMappingInfo;
-    /**
-     * Up to 5 sample rows from the import file, providing a preview of the data to be imported.
-     * @maxSize 5
-     */
-    sampleDataRows?: SampleDataRow[];
-}
-export interface FileHeader {
-    /**
-     * Column headings from the first row of the uploaded file.
-     * @maxSize 100
-     * @maxLength 1000
-     */
-    values?: string[];
-}
-export interface HeaderMappingInfo {
-    /**
-     * Mappings between required loyalty data fields and file columns.
-     * Must contain exactly 2 mappings: one for `EMAIL` and one for `POINTS`.
-     * @minSize 2
-     * @maxSize 2
-     */
-    headerMappings?: HeaderMapping[];
-}
-export interface HeaderMapping {
-    /** The required loyalty data field that this mapping corresponds to. Must be either `EMAIL` or `POINTS`. */
-    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 {
-    /** Column containing the customer's email address. */
-    EMAIL = "EMAIL",
-    /** Column containing the customer's loyalty point balance to be imported or updated. */
-    POINTS = "POINTS"
-}
-/** @enumType */
-export type ColumnNameWithLiterals = ColumnName | 'EMAIL' | 'POINTS';
-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.
-     * @maxSize 20
-     * @maxLength 1000
-     */
-    values?: string[];
-}
-export interface ParseResult {
-    /**
-     * Number of rows parsed from the uploaded import file.
-     * @readonly
-     */
-    parsedRowCount?: number | null;
-    /**
-     * Reason code explaining why parsing failed, if applicable.
-     * @readonly
-     * @maxLength 1000
-     */
-    parseErrorReason?: string | null;
-}
-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;
-    /**
-     * Number of rows successfully imported.
-     * @readonly
-     */
-    successCount?: number | null;
-    /**
-     * Number of rows that failed to import due to errors.
-     * @readonly
-     */
-    failureCount?: number | null;
-}
-export interface CreateLoyaltyImportRequest {
-    /** URL of the file to import. */
-    fileUrl: string | null;
-    /** Name of the file to import. */
-    fileName?: string | null;
-    /** Size of the file to import, in bytes. */
-    fileSize?: number | null;
-}
-export interface CreateLoyaltyImportResponse {
-    /** Created loyalty import. */
-    loyaltyImport?: LoyaltyImport;
-}
-export interface GetLoyaltyImportRequest {
-    /** Loyalty import ID. */
-    loyaltyImportId: string;
-}
-export interface GetLoyaltyImportResponse {
-    /** Retrieved loyalty import. */
-    loyaltyImport?: LoyaltyImport;
-}
-export interface GetErrorFileDownloadUrlRequest {
-    /** Loyalty import ID. */
-    loyaltyImportId: string;
-}
-export interface GetErrorFileDownloadUrlResponse {
-    /** URL for downloading the error file. */
-    url?: string | null;
-}
-export interface ExecuteLoyaltyImportRequest {
-    /** Loyalty import ID. */
-    loyaltyImportId: string;
-    /** Header mapping information for the import file. */
-    headerMappingInfo?: HeaderMappingInfo;
-}
-export interface ExecuteLoyaltyImportResponse {
-    /** Executed loyalty import. */
-    loyaltyImport?: LoyaltyImport;
-}
-export interface CreateLoyaltyImportFileUrlRequest {
-}
-export 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 {
-    /**
-     * Filter object.
-     * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
-     * for more information.
-     *
-     * For a detailed list of supported filters, see
-     * [Supported Filters](https://dev.wix.com/api/rest/wix-loyalty-program/loyalty-imports/supported-filters).
-     */
-    query: CursorQuery;
-}
-export interface CursorQuery extends CursorQueryPagingMethodOneOf {
-    /**
-     * Cursor paging options.
-     *
-     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
-     */
-    cursorPaging?: CursorPaging;
-    /**
-     * Filter object.
-     *
-     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object.
-     *
-     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
-     * @maxSize 5
-     */
-    sort?: Sorting[];
-}
-/** @oneof */
-export interface CursorQueryPagingMethodOneOf {
-    /**
-     * Cursor paging options.
-     *
-     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
-     */
-    cursorPaging?: CursorPaging;
-}
-export interface Sorting {
-    /**
-     * Name of the field to sort by.
-     * @maxLength 512
-     */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrderWithLiterals;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-/** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface CursorPaging {
-    /**
-     * Maximum number of items to return in the results.
-     * @max 100
-     */
-    limit?: number | null;
-    /**
-     * Pointer to the next or previous page in the list of results.
-     *
-     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
-     * Not relevant for the first request.
-     * @maxLength 16000
-     */
-    cursor?: string | null;
-}
-export interface QueryLoyaltyImportsResponse {
-    /** List of loyalty imports matching the query. */
-    loyaltyImports?: LoyaltyImport[];
-    /** Paging metadata. */
-    pagingMetadata?: 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. */
-    cursors?: Cursors;
-    /**
-     * Whether there are more pages to retrieve following the current page.
-     *
-     * + `true`: Another page of results can be retrieved.
-     * + `false`: This is the last page.
-     */
-    hasNext?: boolean | null;
-}
-export interface Cursors {
-    /**
-     * Cursor string pointing to the next page in the list of results.
-     * @maxLength 16000
-     */
-    next?: string | null;
-    /**
-     * Cursor pointing to the previous page in the list of results.
-     * @maxLength 16000
-     */
-    prev?: string | null;
-}
-export interface DeleteLoyaltyImportRequest {
-    /**
-     * Loyalty import ID.
-     * @format GUID
-     */
-    loyaltyImportId?: string;
-    /**
-     * Revision number, which increments by 1 each time the loyalty import is updated.
-     * To prevent conflicting changes, the current revision must be passed when updating the loyalty import.
-     */
-    revision?: string;
-}
-export interface DeleteLoyaltyImportResponse {
-}
-export interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
-    id?: string;
-    /**
-     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
-     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
-     */
-    entityFqdn?: string;
-    /**
-     * Event action name, placed at the top level to make it easier for users to dispatch messages.
-     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
-    eventTime?: Date | null;
-    /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
-     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
-     */
-    entityEventSequence?: string | null;
-}
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
-}
-export interface RestoreInfo {
-    deletedDate?: Date | null;
-}
-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.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
-     */
-    currentEntityAsJson?: string;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
-}
-export interface ActionEvent {
-    bodyAsJson?: string;
-}
-export interface Empty {
-}
-export interface ImportFinished {
-    /** Completed loyalty import. */
-    loyaltyImport?: LoyaltyImport;
-}
-export interface MessageEnvelope {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-}
-export interface IdentificationData extends IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityTypeWithLiterals;
-}
-/** @oneof */
-export interface IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-}
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-/** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';

package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.types.js

@@ -1,38 +0,0 @@
-export var ImportStatus;
-(function (ImportStatus) {
-    /** Status is unknown or not specified. */
-    ImportStatus["UNKNOWN"] = "UNKNOWN";
-    /** The import has been initiated but processing has not yet begun. */
-    ImportStatus["INITIATED"] = "INITIATED";
-    /** The system is currently parsing the import file. */
-    ImportStatus["PARSING"] = "PARSING";
-    /** The import file has been successfully parsed and is ready for importing. */
-    ImportStatus["PARSED"] = "PARSED";
-    /** The system is currently importing the parsed data. */
-    ImportStatus["IMPORTING"] = "IMPORTING";
-    /** The import process is complete. This status indicates the process finished, but doesn't guarantee all data imported successfully. */
-    ImportStatus["IMPORTED"] = "IMPORTED";
-    /** The import process has failed. */
-    ImportStatus["FAILED"] = "FAILED";
-})(ImportStatus || (ImportStatus = {}));
-export var ColumnName;
-(function (ColumnName) {
-    /** Column containing the customer's email address. */
-    ColumnName["EMAIL"] = "EMAIL";
-    /** Column containing the customer's loyalty point balance to be imported or updated. */
-    ColumnName["POINTS"] = "POINTS";
-})(ColumnName || (ColumnName = {}));
-export var SortOrder;
-(function (SortOrder) {
-    SortOrder["ASC"] = "ASC";
-    SortOrder["DESC"] = "DESC";
-})(SortOrder || (SortOrder = {}));
-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 = {}));
-//# sourceMappingURL=loyalty-imports-v1-loyalty-import-imports.types.js.map

package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"loyalty-imports-v1-loyalty-import-imports.types.js","sourceRoot":"","sources":["../../../../src/loyalty-imports-v1-loyalty-import-imports.types.ts"],"names":[],"mappings":"AAiDA,MAAM,CAAN,IAAY,YAeX;AAfD,WAAY,YAAY;IACtB,0CAA0C;IAC1C,mCAAmB,CAAA;IACnB,sEAAsE;IACtE,uCAAuB,CAAA;IACvB,uDAAuD;IACvD,mCAAmB,CAAA;IACnB,+EAA+E;IAC/E,iCAAiB,CAAA;IACjB,yDAAyD;IACzD,uCAAuB,CAAA;IACvB,wIAAwI;IACxI,qCAAqB,CAAA;IACrB,qCAAqC;IACrC,iCAAiB,CAAA;AACnB,CAAC,EAfW,YAAY,KAAZ,YAAY,QAevB;AA4ED,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,sDAAsD;IACtD,6BAAe,CAAA;IACf,wFAAwF;IACxF,+BAAiB,CAAA;AACnB,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB;AAyJD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAsND,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"}