@wix/auto_sdk_loyalty_earning-rules 1.0.15 → 1.0.17

package/build/internal/es/{loyalty-v1-loyalty-earning-rule-earning-rules.universal-B7haYXGy.d.mts → index.typings.d.mts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 /**
  * A loyalty earning rule defines how customers earn points in a loyalty program.
  * You can create rules for different activities, such as making purchases.
@@ -1013,17 +1015,143 @@ interface LoyaltyEarningRuleCreatedEnvelope {
     entity: LoyaltyEarningRule;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when an earning rule is created.
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId LOYALTY.READ_EARNING_RULES
+ * @webhook
+ * @eventType wix.loyalty.v1.loyalty_earning_rule_created
+ * @slug created
+ */
+declare function onLoyaltyEarningRuleCreated(handler: (event: LoyaltyEarningRuleCreatedEnvelope) => void | Promise<void>): void;
 interface LoyaltyEarningRuleDeletedEnvelope {
     metadata: EventMetadata;
 }
+/**
+ * Triggered when an earning rule is deleted.
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId LOYALTY.READ_EARNING_RULES
+ * @webhook
+ * @eventType wix.loyalty.v1.loyalty_earning_rule_deleted
+ * @slug deleted
+ */
+declare function onLoyaltyEarningRuleDeleted(handler: (event: LoyaltyEarningRuleDeletedEnvelope) => void | Promise<void>): void;
 interface LoyaltyEarningRuleUpdatedEnvelope {
     entity: LoyaltyEarningRule;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when an earning rule is updated.
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId LOYALTY.READ_EARNING_RULES
+ * @webhook
+ * @eventType wix.loyalty.v1.loyalty_earning_rule_updated
+ * @slug updated
+ */
+declare function onLoyaltyEarningRuleUpdated(handler: (event: LoyaltyEarningRuleUpdatedEnvelope) => void | Promise<void>): void;
+type LoyaltyEarningRuleNonNullablePaths = `fixedAmount.configs` | `fixedAmount.configs.${number}.points` | `conversionRate.configs` | `conversionRate.configs.${number}.moneyAmount` | `conversionRate.configs.${number}.points` | `sourceAppId` | `triggerAppId` | `triggerActivityType` | `title` | `status` | `metadata.canBeDeleted`;
+/**
+ * Creates a non-automated earning rule.
+ *
+ * >**Note**: You can only create non-automated earning rules from a supported list.
+ * For the supported list of services, see the introduction.
+ * @param earningRule - Earning rule to create.
+ * @public
+ * @requiredField earningRule
+ * @requiredField earningRule.sourceAppId
+ * @requiredField earningRule.status
+ * @requiredField earningRule.title
+ * @requiredField earningRule.triggerActivityType
+ * @requiredField earningRule.triggerAppId
+ * @permissionId LOYALTY.MANAGE_EARNING_RULES
+ * @applicableIdentity APP
+ * @returns Created earning rule.
+ * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.CreateLoyaltyEarningRule
+ */
+declare function createLoyaltyEarningRule(earningRule: NonNullablePaths<LoyaltyEarningRule, `sourceAppId` | `status` | `title` | `triggerActivityType` | `triggerAppId`>): Promise<NonNullablePaths<LoyaltyEarningRule, LoyaltyEarningRuleNonNullablePaths>>;
+/**
+ * Creates multiple non-automated earning rules.
+ *
+ * >**Note**: You can only create non-automated earning rules from a supported list.
+ * For the supported list of services, see the introduction.
+ * @param earningRules - Earning rules to create.
+ * @public
+ * @requiredField earningRules
+ * @requiredField earningRules.sourceAppId
+ * @requiredField earningRules.status
+ * @requiredField earningRules.title
+ * @requiredField earningRules.triggerActivityType
+ * @requiredField earningRules.triggerAppId
+ * @permissionId LOYALTY.MANAGE_EARNING_RULES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.BulkCreateLoyaltyEarningRules
+ */
+declare function bulkCreateLoyaltyEarningRules(earningRules: NonNullablePaths<LoyaltyEarningRule, `sourceAppId` | `status` | `title` | `triggerActivityType` | `triggerAppId`>[]): Promise<NonNullablePaths<BulkCreateLoyaltyEarningRulesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+    [P in LoyaltyEarningRuleNonNullablePaths]: `results.${number}.item.${P}`;
+}[LoyaltyEarningRuleNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+/**
+ * Creates a custom automated earning rule.
+ *
+ * To learn more about the automated rules, read the introduction.
+ * @param type - Type of the custom earning rule.
+ * @public
+ * @requiredField type
+ * @permissionId LOYALTY.MANAGE_EARNING_RULES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.CreateCustomLoyaltyEarningRule
+ */
+declare function createCustomLoyaltyEarningRule(type: TypeWithLiterals, options?: CreateCustomLoyaltyEarningRuleOptions): Promise<NonNullablePaths<CreateCustomLoyaltyEarningRuleResponse, {
+    [P in LoyaltyEarningRuleNonNullablePaths]: `earningRule.${P}`;
+}[LoyaltyEarningRuleNonNullablePaths]>>;
 interface CreateCustomLoyaltyEarningRuleOptions {
     /** Custom earning rule to create. */
     earningRule?: CustomLoyaltyEarningRule;
 }
+/**
+ * Retrieves a specified non-automated earning rule.
+ * @param _id - ID of the earning rule to retrieve.
+ * @public
+ * @requiredField _id
+ * @permissionId LOYALTY.READ_EARNING_RULES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns Retrieved earning rule.
+ * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.GetLoyaltyEarningRule
+ */
+declare function getLoyaltyEarningRule(_id: string): Promise<NonNullablePaths<LoyaltyEarningRule, LoyaltyEarningRuleNonNullablePaths>>;
+/**
+ * Updates an earning rule.
+ *
+ * Supports partial updates.
+ *
+ * Revision number, which increments by 1 each time the earning rule is updated. To prevent conflicting changes,
+ * the current revision must be passed when updating the earning rule.
+ * @param _id - Loyalty earning rule ID.
+ * @public
+ * @requiredField _id
+ * @requiredField earningRule
+ * @permissionId LOYALTY.MANAGE_EARNING_RULES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.UpdateLoyaltyEarningRule
+ */
+declare function updateLoyaltyEarningRule(_id: string, earningRule: UpdateLoyaltyEarningRule): Promise<NonNullablePaths<UpdateLoyaltyEarningRuleResponse, {
+    [P in LoyaltyEarningRuleNonNullablePaths]: `earningRule.${P}`;
+}[LoyaltyEarningRuleNonNullablePaths]>>;
 interface UpdateLoyaltyEarningRule {
     /** Fixed amount of points awarded for each qualifying activity. */
     fixedAmount?: FixedAmount;
@@ -1081,6 +1209,16 @@ interface UpdateLoyaltyEarningRule {
      */
     metadata?: Metadata;
 }
+/**
+ * Deletes a non-automated earning rule.
+ * @param _id - ID of the earning rule to delete.
+ * @public
+ * @requiredField _id
+ * @permissionId LOYALTY.MANAGE_EARNING_RULES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.DeleteLoyaltyEarningRule
+ */
+declare function deleteLoyaltyEarningRule(_id: string, options?: DeleteLoyaltyEarningRuleOptions): Promise<void>;
 interface DeleteLoyaltyEarningRuleOptions {
     /**
      * Revision of the earning rule. Incremented by 1 each time the earning rule is updated.
@@ -1088,6 +1226,33 @@ interface DeleteLoyaltyEarningRuleOptions {
      */
     revision?: string;
 }
+/**
+ * Deletes a custom automated earning rule.
+ *
+ * > **Note:** Pre-installed automated rules can only be paused, not deleted.
+ * @param _id - ID of the earning rule to delete.
+ * @public
+ * @requiredField _id
+ * @permissionId LOYALTY.MANAGE_EARNING_RULES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.DeleteAutomationEarningRule
+ */
+declare function deleteAutomationEarningRule(_id: string): Promise<void>;
+/**
+ * Retrieves a list of earning rules.
+ *
+ * Returns both automated and non-automated earning rules.
+ *
+ * You can filter the results by `triggerAppId` or `triggerActivityType`.
+ * @public
+ * @permissionId LOYALTY.READ_EARNING_RULES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.ListEarningRules
+ */
+declare function listEarningRules(options?: ListEarningRulesOptions): Promise<NonNullablePaths<ListEarningRulesResponse, {
+    [P in LoyaltyEarningRuleNonNullablePaths]: `earningRules.${number}.${P}`;
+}[LoyaltyEarningRuleNonNullablePaths]>>;
 interface ListEarningRulesOptions {
     /** App ID that triggers the point assignment. For example, `9a5d83fd-8570-482e-81ab-cfa88942ee60`. */
     triggerAppId?: string | null;
@@ -1095,4 +1260,4 @@ interface ListEarningRulesOptions {
     triggerActivityType?: string | null;
 }
 
-export { type DomainEvent as $, type ApplicationError as A, type BulkCreateLoyaltyEarningRulesResponse as B, type CreateCustomLoyaltyEarningRuleOptions as C, type DeleteLoyaltyEarningRuleOptions as D, type EarningRuleDisabled as E, type FixedAmount as F, type GetLoyaltyEarningRuleRequest as G, type GetLoyaltyEarningRuleResponse as H, type ItemMetadata as I, type UpdateLoyaltyEarningRuleRequest as J, type DeleteLoyaltyEarningRuleRequest as K, type LoyaltyEarningRule as L, type Metadata as M, Namespace as N, type DeleteLoyaltyEarningRuleResponse as O, type DeleteAutomationEarningRuleRequest as P, type DeleteAutomationEarningRuleResponse as Q, type ListEarningRulesRequest as R, Status as S, type TypeWithLiterals as T, type UpdateLoyaltyEarningRule as U, type ListEarningRulesInTierRequest as V, WebhookIdentityType as W, type CursorPaging as X, type ListEarningRulesInTierResponse as Y, type PagingMetadataV2 as Z, type Cursors as _, type CreateCustomLoyaltyEarningRuleResponse as a, type DomainEventBodyOneOf as a0, type EntityCreatedEvent as a1, type RestoreInfo as a2, type EntityUpdatedEvent as a3, type EntityDeletedEvent as a4, type ActionEvent as a5, type Empty as a6, type InvalidateEarningRuleCacheRequest as a7, type InvalidateEarningRuleCacheResponse as a8, type MetaSiteSpecialEvent as a9, type IdentificationDataIdOneOf as aA, type BaseEventMetadata as aB, type EventMetadata as aC, type MetaSiteSpecialEventPayloadOneOf as aa, type Asset as ab, type SiteCreated as ac, type SiteTransferred as ad, type SiteDeleted as ae, type DeleteContext as af, type SiteUndeleted as ag, type SitePublished as ah, type SiteUnpublished as ai, type SiteMarkedAsTemplate as aj, type SiteMarkedAsWixSite as ak, type ServiceProvisioned as al, type ServiceRemoved as am, type SiteRenamed as an, type SiteHardDeleted as ao, type NamespaceChanged as ap, type StudioAssigned as aq, type StudioUnassigned as ar, type SiteUrlChanged as as, type SitePurgedExternally as at, type OdeditorAssigned as au, type OdeditorUnassigned as av, type PicassoAssigned as aw, type PicassoUnassigned as ax, type MessageEnvelope as ay, type IdentificationData as az, type UpdateLoyaltyEarningRuleResponse as b, type ListEarningRulesOptions as c, type ListEarningRulesResponse as d, type LoyaltyEarningRuleCreatedEnvelope as e, type LoyaltyEarningRuleDeletedEnvelope as f, type LoyaltyEarningRuleUpdatedEnvelope as g, LoyaltyEarningRuleTypeTagType as h, Type as i, State as j, SiteCreatedContext as k, DeleteStatus as l, type LoyaltyEarningRuleTypeOneOf as m, type FixedAmountConfig as n, type ConversionRate as o, type ConversionRateConfig as p, type LoyaltyEarningRuleTypeTag as q, type CacheInvalidated as r, type CreateLoyaltyEarningRuleRequest as s, type CreateLoyaltyEarningRuleResponse as t, type BulkCreateLoyaltyEarningRulesRequest as u, type BulkLoyaltyEarningRuleResult as v, type BulkActionMetadata as w, type CreateCustomLoyaltyEarningRuleRequest as x, type CustomLoyaltyEarningRule as y, type CustomLoyaltyEarningRuleTypeOneOf as z };
+export { type ActionEvent, type ApplicationError, type Asset, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateLoyaltyEarningRulesRequest, type BulkCreateLoyaltyEarningRulesResponse, type BulkLoyaltyEarningRuleResult, type CacheInvalidated, type ConversionRate, type ConversionRateConfig, type CreateCustomLoyaltyEarningRuleOptions, type CreateCustomLoyaltyEarningRuleRequest, type CreateCustomLoyaltyEarningRuleResponse, type CreateLoyaltyEarningRuleRequest, type CreateLoyaltyEarningRuleResponse, type CursorPaging, type Cursors, type CustomLoyaltyEarningRule, type CustomLoyaltyEarningRuleTypeOneOf, type DeleteAutomationEarningRuleRequest, type DeleteAutomationEarningRuleResponse, type DeleteContext, type DeleteLoyaltyEarningRuleOptions, type DeleteLoyaltyEarningRuleRequest, type DeleteLoyaltyEarningRuleResponse, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type EarningRuleDisabled, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type FixedAmount, type FixedAmountConfig, type GetLoyaltyEarningRuleRequest, type GetLoyaltyEarningRuleResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidateEarningRuleCacheRequest, type InvalidateEarningRuleCacheResponse, type ItemMetadata, type ListEarningRulesInTierRequest, type ListEarningRulesInTierResponse, type ListEarningRulesOptions, type ListEarningRulesRequest, type ListEarningRulesResponse, type LoyaltyEarningRule, type LoyaltyEarningRuleCreatedEnvelope, type LoyaltyEarningRuleDeletedEnvelope, type LoyaltyEarningRuleTypeOneOf, type LoyaltyEarningRuleTypeTag, LoyaltyEarningRuleTypeTagType, type LoyaltyEarningRuleTypeTagTypeWithLiterals, type LoyaltyEarningRuleUpdatedEnvelope, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type Metadata, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type PagingMetadataV2, type PicassoAssigned, type PicassoUnassigned, type RestoreInfo, type ServiceProvisioned, type ServiceRemoved, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, State, type StateWithLiterals, Status, type StatusWithLiterals, type StudioAssigned, type StudioUnassigned, Type, type TypeWithLiterals, type UpdateLoyaltyEarningRule, type UpdateLoyaltyEarningRuleRequest, type UpdateLoyaltyEarningRuleResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateLoyaltyEarningRules, createCustomLoyaltyEarningRule, createLoyaltyEarningRule, deleteAutomationEarningRule, deleteLoyaltyEarningRule, getLoyaltyEarningRule, listEarningRules, onLoyaltyEarningRuleCreated, onLoyaltyEarningRuleDeleted, onLoyaltyEarningRuleUpdated, updateLoyaltyEarningRule };