@wix/auto_sdk_loyalty_earning-rules 1.0.0

package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.js

@@ -0,0 +1,78 @@
+import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';
+import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
+import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
+import { EventDefinition } from '@wix/sdk-types';
+import { bulkCreateLoyaltyEarningRules as universalBulkCreateLoyaltyEarningRules, createCustomLoyaltyEarningRule as universalCreateCustomLoyaltyEarningRule, createLoyaltyEarningRule as universalCreateLoyaltyEarningRule, deleteAutomationEarningRule as universalDeleteAutomationEarningRule, deleteLoyaltyEarningRule as universalDeleteLoyaltyEarningRule, getLoyaltyEarningRule as universalGetLoyaltyEarningRule, listEarningRules as universalListEarningRules, updateLoyaltyEarningRule as universalUpdateLoyaltyEarningRule, } from './loyalty-v1-loyalty-earning-rule-earning-rules.universal.js';
+export const __metadata = { PACKAGE_NAME: '@wix/loyalty' };
+export function createLoyaltyEarningRule(httpClient) {
+    return (earningRule) => universalCreateLoyaltyEarningRule(earningRule, 
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkCreateLoyaltyEarningRules(httpClient) {
+    return (earningRules) => universalBulkCreateLoyaltyEarningRules(earningRules, 
+    // @ts-ignore
+    { httpClient });
+}
+export function createCustomLoyaltyEarningRule(httpClient) {
+    return (type, options) => universalCreateCustomLoyaltyEarningRule(type, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getLoyaltyEarningRule(httpClient) {
+    return (_id) => universalGetLoyaltyEarningRule(_id, 
+    // @ts-ignore
+    { httpClient });
+}
+export function updateLoyaltyEarningRule(httpClient) {
+    return (_id, earningRule) => universalUpdateLoyaltyEarningRule(_id, earningRule, 
+    // @ts-ignore
+    { httpClient });
+}
+export function deleteLoyaltyEarningRule(httpClient) {
+    return (_id, options) => universalDeleteLoyaltyEarningRule(_id, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function deleteAutomationEarningRule(httpClient) {
+    return (_id) => universalDeleteAutomationEarningRule(_id, 
+    // @ts-ignore
+    { httpClient });
+}
+export function listEarningRules(httpClient) {
+    return (options) => universalListEarningRules(options, 
+    // @ts-ignore
+    { httpClient });
+}
+export const onLoyaltyEarningRuleCreated = EventDefinition('wix.loyalty.v1.loyalty_earning_rule_created', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'entity.createdDate' },
+            { path: 'entity.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+])))();
+export const onLoyaltyEarningRuleDeleted = EventDefinition('wix.loyalty.v1.loyalty_earning_rule_deleted', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'undefined.createdDate' },
+            { path: 'undefined.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+])))();
+export const onLoyaltyEarningRuleUpdated = EventDefinition('wix.loyalty.v1.loyalty_earning_rule_updated', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'entity.createdDate' },
+            { path: 'entity.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+])))();
+export { LoyaltyEarningRuleTypeTagType, Status, Type, WebhookIdentityType, } from './loyalty-v1-loyalty-earning-rule-earning-rules.universal.js';
+//# sourceMappingURL=loyalty-v1-loyalty-earning-rule-earning-rules.public.js.map

package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loyalty-v1-loyalty-earning-rule-earning-rules.public.js","sourceRoot":"","sources":["../../../src/loyalty-v1-loyalty-earning-rule-earning-rules.public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,yCAAyC,CAAC;AAClG,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,eAAe,EAAc,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAmBL,6BAA6B,IAAI,sCAAsC,EACvE,8BAA8B,IAAI,uCAAuC,EACzE,wBAAwB,IAAI,iCAAiC,EAC7D,2BAA2B,IAAI,oCAAoC,EACnE,wBAAwB,IAAI,iCAAiC,EAC7D,qBAAqB,IAAI,8BAA8B,EACvD,gBAAgB,IAAI,yBAAyB,EAC7C,wBAAwB,IAAI,iCAAiC,GAC9D,MAAM,8DAA8D,CAAC;AAEtE,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAE3D,MAAM,UAAU,wBAAwB,CACtC,UAAsB;IAEtB,OAAO,CAAC,WAA+B,EAAE,EAAE,CACzC,iCAAiC,CAC/B,WAAW;IACX,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAgBD,MAAM,UAAU,6BAA6B,CAC3C,UAAsB;IAEtB,OAAO,CAAC,YAAkC,EAAE,EAAE,CAC5C,sCAAsC,CACpC,YAAY;IACZ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAgBD,MAAM,UAAU,8BAA8B,CAC5C,UAAsB;IAEtB,OAAO,CAAC,IAAU,EAAE,OAA+C,EAAE,EAAE,CACrE,uCAAuC,CACrC,IAAI,EACJ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAkBD,MAAM,UAAU,qBAAqB,CACnC,UAAsB;IAEtB,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,8BAA8B,CAC5B,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAaD,MAAM,UAAU,wBAAwB,CACtC,UAAsB;IAEtB,OAAO,CAAC,GAAkB,EAAE,WAAqC,EAAE,EAAE,CACnE,iCAAiC,CAC/B,GAAG,EACH,WAAW;IACX,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAkBD,MAAM,UAAU,wBAAwB,CACtC,UAAsB;IAEtB,OAAO,CAAC,GAAW,EAAE,OAAyC,EAAE,EAAE,CAChE,iCAAiC,CAC/B,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAaD,MAAM,UAAU,2BAA2B,CACzC,UAAsB;IAEtB,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,oCAAoC,CAClC,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAYD,MAAM,UAAU,gBAAgB,CAC9B,UAAsB;IAEtB,OAAO,CAAC,OAAiC,EAAE,EAAE,CAC3C,yBAAyB,CACvB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAeD,MAAM,CAAC,MAAM,2BAA2B,GAAG,eAAe,CACxD,6CAA6C,EAC7C,IAAI,EACJ,CAAC,KAAwC,EAAE,EAAE,CAC3C,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAAqC,CAAC;AACvC,MAAM,CAAC,MAAM,2BAA2B,GAAG,eAAe,CACxD,6CAA6C,EAC7C,IAAI,EACJ,CAAC,KAAwC,EAAE,EAAE,CAC3C,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAAqC,CAAC;AACvC,MAAM,CAAC,MAAM,2BAA2B,GAAG,eAAe,CACxD,6CAA6C,EAC7C,IAAI,EACJ,CAAC,KAAwC,EAAE,EAAE,CAC3C,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAAqC,CAAC;AAEvC,OAAO,EAuDL,6BAA6B,EAM7B,MAAM,EACN,IAAI,EAKJ,mBAAmB,GACpB,MAAM,8DAA8D,CAAC"}

package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.d.ts

@@ -0,0 +1,483 @@
+/**
+ * A loyalty earning rule defines how customers earn points in a loyalty program.
+ * You can create rules for different activities, such as making purchases.
+ */
+export interface LoyaltyEarningRule extends LoyaltyEarningRuleTypeOneOf {
+    /** Fixed amount of points awarded for each qualifying activity. */
+    fixedAmount?: FixedAmount;
+    /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
+    conversionRate?: ConversionRate;
+    /**
+     * Loyalty earning rule ID.
+     * @readonly
+     */
+    id?: string | null;
+    /** ID of the app managing the earning rule. Can be a loyalty app ID or a Wix automations app ID. */
+    sourceAppId?: string;
+    /** ID of the app that triggers point assignment. Examples: Wix Stores, Wix Bookings, Wix Events. */
+    triggerAppId?: string;
+    /** Type of activity that triggers point assignment. For example, `wix-restaurants/orderSubmitted` or `birthday`. */
+    triggerActivityType?: string;
+    /** Name of the earning rule. */
+    title?: string;
+    /** Current status of the earning rule. */
+    status?: Status;
+    /**
+     * Revision number, incremented by 1 each time the earning rule is updated.
+     * Pass the latest revision when updating to prevent conflicting changes.
+     */
+    revision?: string | null;
+    /**
+     * Date and time the earning rule was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the earning rule was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Additional metadata about the earning rule.
+     * @readonly
+     */
+    metadata?: Metadata;
+}
+/** @oneof */
+export interface LoyaltyEarningRuleTypeOneOf {
+    /** Fixed amount of points awarded for each qualifying activity. */
+    fixedAmount?: FixedAmount;
+    /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
+    conversionRate?: ConversionRate;
+}
+/** Fixed amount type of earning rule. */
+export interface FixedAmount {
+    /** Fixed amount configurations for each tier. */
+    configs?: FixedAmountConfig[];
+}
+export interface FixedAmountConfig {
+    /**
+     * Tier ID. If empty, the [base tier](https://dev.wix.com/docs/rest/crm/loyalty-program/tiers/introduction#terminology) is used.
+     * @readonly
+     */
+    tierId?: string | null;
+    /** Number of points to award. */
+    points?: number;
+}
+/**
+ * Conversion rate type of earning rule.
+ * Customers earn points based on the amount spent.
+ * For example, for every $10 spent, a customer might earn 1 point.
+ */
+export interface ConversionRate {
+    /**
+     * Conversion rate configurations for each tier.
+     *
+     * Points are awarded proportionally to the amount spent.
+     *
+     * Formula: `(amount spent) / (money_amount * points)`.
+     */
+    configs?: ConversionRateConfig[];
+    /**
+     * Specifies which field in the Wix automations trigger payload [REST](https://dev.wix.com/docs/rest/business-management/automations/introduction#how-do-automations-work)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/automations/triggered-events/reporting-and-canceling-events) to use for calculating points in conversion rate rules.
+     * For example, if set to "priceSummary.totalAmount", the rule uses the total order amount to calculate loyalty points to be awarded.
+     * This field is only applicable for automated earning rules.
+     */
+    field?: string | null;
+}
+export interface ConversionRateConfig {
+    /**
+     * Tier ID. If empty, the [base tier](https://dev.wix.com/docs/rest/crm/loyalty-program/tiers/introduction) is used.
+     * @readonly
+     */
+    tierId?: string | null;
+    /**
+     * The amount of money used as a reference for point calculation.
+     * Points are awarded proportionally to the amount spent.
+     *
+     * For example, if set to 10, 1 point is awarded for every 10 units of currency spent (assuming `points` is set to 1).
+     *
+     * Formula for points is: `(amount spent) / (money_amount * points)`.
+     */
+    moneyAmount?: number;
+    /**
+     * Points given for the specified `money_amount`.
+     * Works in conjunction with `money_amount` to define the earning rule.
+     *
+     * For example: If `money_amount` is 20 and `points` is 10:
+     * - Spending 10 units of currency earns 5 points
+     * - Spending 20 units of currency earns 10 points
+     * - Spending 30 units of currency earns 15 points
+     */
+    points?: number;
+}
+export declare enum Status {
+    /** Status is unknown or not specified. */
+    UNKNOWN = "UNKNOWN",
+    /** Earning rule is active and can assign points. */
+    ACTIVE = "ACTIVE",
+    /** Earning rule is paused and can't assign points. */
+    PAUSED = "PAUSED"
+}
+export interface Metadata {
+    /** Whether the earning rule can be deleted. */
+    canBeDeleted?: boolean;
+}
+export interface LoyaltyEarningRuleTypeTag {
+    /** Type of custom earning rule. */
+    ruleType?: LoyaltyEarningRuleTypeTagType;
+}
+export declare enum LoyaltyEarningRuleTypeTagType {
+    /** Type is unknown or not specified. */
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /** Earning rule for a customer's birthday. */
+    BIRTHDAY = "BIRTHDAY"
+}
+export interface EarningRuleDisabled {
+}
+export interface CreateLoyaltyEarningRuleRequest {
+    /** Earning rule to create. */
+    earningRule: LoyaltyEarningRule;
+}
+export interface CreateLoyaltyEarningRuleResponse {
+    /** Created earning rule. */
+    earningRule?: LoyaltyEarningRule;
+}
+export interface BulkCreateLoyaltyEarningRulesRequest {
+    /** Earning rules to create. */
+    earningRules: LoyaltyEarningRule[];
+}
+export interface BulkCreateLoyaltyEarningRulesResponse {
+    /** Created earning rules. */
+    results?: BulkLoyaltyEarningRuleResult[];
+    /** Additional metadata for the created earning rules. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkLoyaltyEarningRuleResult {
+    /** Additional metadata for the created earning rules. */
+    itemMetadata?: ItemMetadata;
+    /** Created earning rule. */
+    item?: LoyaltyEarningRule;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface CreateCustomLoyaltyEarningRuleRequest {
+    /** Type of the custom earning rule. */
+    type: Type;
+    /** Custom earning rule to create. */
+    earningRule?: CustomLoyaltyEarningRule;
+}
+export declare enum Type {
+    /** Unknown type. This value is not used. */
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /** Earning rule for social media. */
+    SOCIAL_MEDIA = "SOCIAL_MEDIA",
+    /** Earning rule for birthdays. */
+    BIRTHDAY = "BIRTHDAY"
+}
+/** Used in CreateCustomLoyaltyEarningRuleRequest */
+export interface CustomLoyaltyEarningRule extends CustomLoyaltyEarningRuleTypeOneOf {
+    /** Fixed amount of points awarded for each qualifying activity. */
+    fixedAmount?: FixedAmount;
+    /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
+    conversionRate?: ConversionRate;
+    /** Name of the earning rule. */
+    title?: string;
+}
+/** @oneof */
+export interface CustomLoyaltyEarningRuleTypeOneOf {
+    /** Fixed amount of points awarded for each qualifying activity. */
+    fixedAmount?: FixedAmount;
+    /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
+    conversionRate?: ConversionRate;
+}
+export interface CreateCustomLoyaltyEarningRuleResponse {
+    /** Created earning rule. */
+    earningRule?: LoyaltyEarningRule;
+}
+export interface GetLoyaltyEarningRuleRequest {
+    /** ID of the earning rule to retrieve. */
+    id: string;
+}
+export interface GetLoyaltyEarningRuleResponse {
+    /** Retrieved earning rule. */
+    earningRule?: LoyaltyEarningRule;
+}
+export interface UpdateLoyaltyEarningRuleRequest {
+    /** Earning rule to update. */
+    earningRule: LoyaltyEarningRule;
+}
+export interface UpdateLoyaltyEarningRuleResponse {
+    /** The updated earning rule. */
+    earningRule?: LoyaltyEarningRule;
+}
+export interface DeleteLoyaltyEarningRuleRequest {
+    /** ID of the earning rule to delete. */
+    id: string;
+    /**
+     * Revision of the earning rule. Incremented by 1 each time the earning rule is updated.
+     * Pass the latest revision when updating to prevent conflicting changes.
+     */
+    revision?: string;
+}
+export interface DeleteLoyaltyEarningRuleResponse {
+}
+export interface DeleteAutomationEarningRuleRequest {
+    /** ID of the earning rule to delete. */
+    id: string;
+}
+export interface DeleteAutomationEarningRuleResponse {
+}
+export interface ListEarningRulesRequest {
+    /** App ID that triggers the point assignment. For example, `9a5d83fd-8570-482e-81ab-cfa88942ee60`. */
+    triggerAppId?: string | null;
+    /** Type of activity that triggers the point assignment. For example, `restaurants-order-is-pending`. */
+    triggerActivityType?: string | null;
+}
+export interface ListEarningRulesResponse {
+    /** Retrieved earning rules. */
+    earningRules?: LoyaltyEarningRule[];
+}
+export interface ListEarningRulesInTierRequest {
+    /** ID of the tier for which the earning rules will be returned. */
+    tierId?: string | null;
+    /** Pagination options. */
+    paging?: CursorPaging;
+}
+export interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    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.
+     */
+    cursor?: string | null;
+}
+export interface ListEarningRulesInTierResponse {
+    /** Retrieved earning rules. */
+    earningRules?: LoyaltyEarningRule[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * 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 defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    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 MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    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. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface FixedAmountConfigNonNullableFields {
+    points: number;
+}
+interface FixedAmountNonNullableFields {
+    configs: FixedAmountConfigNonNullableFields[];
+}
+interface ConversionRateConfigNonNullableFields {
+    moneyAmount: number;
+    points: number;
+}
+interface ConversionRateNonNullableFields {
+    configs: ConversionRateConfigNonNullableFields[];
+}
+interface MetadataNonNullableFields {
+    canBeDeleted: boolean;
+}
+interface LoyaltyEarningRuleNonNullableFields {
+    fixedAmount?: FixedAmountNonNullableFields;
+    conversionRate?: ConversionRateNonNullableFields;
+    sourceAppId: string;
+    triggerAppId: string;
+    triggerActivityType: string;
+    title: string;
+    status: Status;
+    metadata?: MetadataNonNullableFields;
+}
+export interface CreateLoyaltyEarningRuleResponseNonNullableFields {
+    earningRule?: LoyaltyEarningRuleNonNullableFields;
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkLoyaltyEarningRuleResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    item?: LoyaltyEarningRuleNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkCreateLoyaltyEarningRulesResponseNonNullableFields {
+    results: BulkLoyaltyEarningRuleResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface CreateCustomLoyaltyEarningRuleResponseNonNullableFields {
+    earningRule?: LoyaltyEarningRuleNonNullableFields;
+}
+export interface GetLoyaltyEarningRuleResponseNonNullableFields {
+    earningRule?: LoyaltyEarningRuleNonNullableFields;
+}
+export interface UpdateLoyaltyEarningRuleResponseNonNullableFields {
+    earningRule?: LoyaltyEarningRuleNonNullableFields;
+}
+export interface ListEarningRulesResponseNonNullableFields {
+    earningRules: LoyaltyEarningRuleNonNullableFields[];
+}
+export {};

package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.js

@@ -0,0 +1,34 @@
+export var Status;
+(function (Status) {
+    /** Status is unknown or not specified. */
+    Status["UNKNOWN"] = "UNKNOWN";
+    /** Earning rule is active and can assign points. */
+    Status["ACTIVE"] = "ACTIVE";
+    /** Earning rule is paused and can't assign points. */
+    Status["PAUSED"] = "PAUSED";
+})(Status || (Status = {}));
+export var LoyaltyEarningRuleTypeTagType;
+(function (LoyaltyEarningRuleTypeTagType) {
+    /** Type is unknown or not specified. */
+    LoyaltyEarningRuleTypeTagType["UNKNOWN_TYPE"] = "UNKNOWN_TYPE";
+    /** Earning rule for a customer's birthday. */
+    LoyaltyEarningRuleTypeTagType["BIRTHDAY"] = "BIRTHDAY";
+})(LoyaltyEarningRuleTypeTagType || (LoyaltyEarningRuleTypeTagType = {}));
+export var Type;
+(function (Type) {
+    /** Unknown type. This value is not used. */
+    Type["UNKNOWN_TYPE"] = "UNKNOWN_TYPE";
+    /** Earning rule for social media. */
+    Type["SOCIAL_MEDIA"] = "SOCIAL_MEDIA";
+    /** Earning rule for birthdays. */
+    Type["BIRTHDAY"] = "BIRTHDAY";
+})(Type || (Type = {}));
+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-v1-loyalty-earning-rule-earning-rules.types.js.map

package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loyalty-v1-loyalty-earning-rule-earning-rules.types.js","sourceRoot":"","sources":["../../../src/loyalty-v1-loyalty-earning-rule-earning-rules.types.ts"],"names":[],"mappings":"AAuHA,MAAM,CAAN,IAAY,MAOX;AAPD,WAAY,MAAM;IAChB,0CAA0C;IAC1C,6BAAmB,CAAA;IACnB,oDAAoD;IACpD,2BAAiB,CAAA;IACjB,sDAAsD;IACtD,2BAAiB,CAAA;AACnB,CAAC,EAPW,MAAM,KAAN,MAAM,QAOjB;AAYD,MAAM,CAAN,IAAY,6BAKX;AALD,WAAY,6BAA6B;IACvC,wCAAwC;IACxC,8DAA6B,CAAA;IAC7B,8CAA8C;IAC9C,sDAAqB,CAAA;AACvB,CAAC,EALW,6BAA6B,KAA7B,6BAA6B,QAKxC;AAqED,MAAM,CAAN,IAAY,IAOX;AAPD,WAAY,IAAI;IACd,4CAA4C;IAC5C,qCAA6B,CAAA;IAC7B,qCAAqC;IACrC,qCAA6B,CAAA;IAC7B,kCAAkC;IAClC,6BAAqB,CAAA;AACvB,CAAC,EAPW,IAAI,KAAJ,IAAI,QAOf;AAgPD,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"}