@wix/auto_sdk_loyalty_earning-rules 1.0.16 → 1.0.18

package/build/cjs/index.d.ts

@@ -1,18 +1,19 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { LoyaltyEarningRule, BulkCreateLoyaltyEarningRulesResponse, TypeWithLiterals, CreateCustomLoyaltyEarningRuleOptions, CreateCustomLoyaltyEarningRuleResponse, UpdateLoyaltyEarningRule, UpdateLoyaltyEarningRuleResponse, DeleteLoyaltyEarningRuleOptions, ListEarningRulesOptions, ListEarningRulesResponse, LoyaltyEarningRuleCreatedEnvelope, LoyaltyEarningRuleDeletedEnvelope, LoyaltyEarningRuleUpdatedEnvelope } from './index.typings.js';
 export { ActionEvent, ApplicationError, Asset, BaseEventMetadata, BulkActionMetadata, BulkCreateLoyaltyEarningRulesRequest, BulkLoyaltyEarningRuleResult, CacheInvalidated, ConversionRate, ConversionRateConfig, CreateCustomLoyaltyEarningRuleRequest, CreateLoyaltyEarningRuleRequest, CreateLoyaltyEarningRuleResponse, CursorPaging, Cursors, CustomLoyaltyEarningRule, CustomLoyaltyEarningRuleTypeOneOf, DeleteAutomationEarningRuleRequest, DeleteAutomationEarningRuleResponse, DeleteContext, DeleteLoyaltyEarningRuleRequest, DeleteLoyaltyEarningRuleResponse, DeleteStatus, DomainEvent, DomainEventBodyOneOf, EarningRuleDisabled, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, FixedAmount, FixedAmountConfig, GetLoyaltyEarningRuleRequest, GetLoyaltyEarningRuleResponse, IdentificationData, IdentificationDataIdOneOf, InvalidateEarningRuleCacheRequest, InvalidateEarningRuleCacheResponse, ItemMetadata, ListEarningRulesInTierRequest, ListEarningRulesInTierResponse, ListEarningRulesRequest, LoyaltyEarningRuleTypeOneOf, LoyaltyEarningRuleTypeTag, LoyaltyEarningRuleTypeTagType, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Metadata, Namespace, NamespaceChanged, OdeditorAssigned, OdeditorUnassigned, PagingMetadataV2, PicassoAssigned, PicassoUnassigned, RestoreInfo, ServiceProvisioned, ServiceRemoved, SiteCreated, SiteCreatedContext, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, State, Status, StudioAssigned, StudioUnassigned, Type, UpdateLoyaltyEarningRuleRequest, WebhookIdentityType } from './index.typings.js';
 
+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`;
 declare function createLoyaltyEarningRule$1(httpClient: HttpClient): CreateLoyaltyEarningRuleSignature;
 interface CreateLoyaltyEarningRuleSignature {
     /**
      * 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.
+     * For the supported list of services, see the Introduction.
      * @param - Earning rule to create.
      * @returns Created earning rule.
      */
-    (earningRule: LoyaltyEarningRule): Promise<LoyaltyEarningRule>;
+    (earningRule: NonNullablePaths<LoyaltyEarningRule, `sourceAppId` | `status` | `title` | `triggerActivityType` | `triggerAppId`>): Promise<NonNullablePaths<LoyaltyEarningRule, LoyaltyEarningRuleNonNullablePaths>>;
 }
 declare function bulkCreateLoyaltyEarningRules$1(httpClient: HttpClient): BulkCreateLoyaltyEarningRulesSignature;
 interface BulkCreateLoyaltyEarningRulesSignature {
@@ -20,29 +21,35 @@ interface BulkCreateLoyaltyEarningRulesSignature {
      * 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.
+     * For the supported list of services, see the Introduction.
      * @param - Earning rules to create.
      */
-    (earningRules: LoyaltyEarningRule[]): Promise<BulkCreateLoyaltyEarningRulesResponse>;
+    (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`>>;
 }
 declare function createCustomLoyaltyEarningRule$1(httpClient: HttpClient): CreateCustomLoyaltyEarningRuleSignature;
 interface CreateCustomLoyaltyEarningRuleSignature {
     /**
      * Creates a custom automated earning rule.
      *
-     * To learn more about the automated rules, read the introduction.
+     * To learn more about the automated rules, see the Introduction.
      * @param - Type of the custom earning rule.
      */
-    (type: TypeWithLiterals, options?: CreateCustomLoyaltyEarningRuleOptions | undefined): Promise<CreateCustomLoyaltyEarningRuleResponse>;
+    (type: TypeWithLiterals, options?: CreateCustomLoyaltyEarningRuleOptions): Promise<NonNullablePaths<CreateCustomLoyaltyEarningRuleResponse, {
+        [P in LoyaltyEarningRuleNonNullablePaths]: `earningRule.${P}`;
+    }[LoyaltyEarningRuleNonNullablePaths]>>;
 }
 declare function getLoyaltyEarningRule$1(httpClient: HttpClient): GetLoyaltyEarningRuleSignature;
 interface GetLoyaltyEarningRuleSignature {
     /**
      * Retrieves a specified non-automated earning rule.
+     *
+     * To retrieve both automated and non-automated earning rules, call List Earning Rules.
      * @param - ID of the earning rule to retrieve.
      * @returns Retrieved earning rule.
      */
-    (_id: string): Promise<LoyaltyEarningRule>;
+    (_id: string): Promise<NonNullablePaths<LoyaltyEarningRule, LoyaltyEarningRuleNonNullablePaths>>;
 }
 declare function updateLoyaltyEarningRule$1(httpClient: HttpClient): UpdateLoyaltyEarningRuleSignature;
 interface UpdateLoyaltyEarningRuleSignature {
@@ -52,25 +59,38 @@ interface UpdateLoyaltyEarningRuleSignature {
      * 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.
+     * the current `revision` must be passed when updating the earning rule.
      * @param - Loyalty earning rule ID.
      */
-    (_id: string, earningRule: UpdateLoyaltyEarningRule): Promise<UpdateLoyaltyEarningRuleResponse>;
+    (_id: string, earningRule: UpdateLoyaltyEarningRule): Promise<NonNullablePaths<UpdateLoyaltyEarningRuleResponse, {
+        [P in LoyaltyEarningRuleNonNullablePaths]: `earningRule.${P}`;
+    }[LoyaltyEarningRuleNonNullablePaths]>>;
 }
 declare function deleteLoyaltyEarningRule$1(httpClient: HttpClient): DeleteLoyaltyEarningRuleSignature;
 interface DeleteLoyaltyEarningRuleSignature {
     /**
      * Deletes a non-automated earning rule.
+     *
+     * To delete an automated earning rule, call
+     * Delete Automation Earning Rule.
+     *
+     * To update an earning rule's status instead of deleting it, call
+     * Update Loyalty Earning Rule.
      * @param - ID of the earning rule to delete.
      */
-    (_id: string, options?: DeleteLoyaltyEarningRuleOptions | undefined): Promise<void>;
+    (_id: string, options?: DeleteLoyaltyEarningRuleOptions): Promise<void>;
 }
 declare function deleteAutomationEarningRule$1(httpClient: HttpClient): DeleteAutomationEarningRuleSignature;
 interface DeleteAutomationEarningRuleSignature {
     /**
      * Deletes a custom automated earning rule.
+     * Pre-installed automated rules can only be paused, not deleted.
+     *
+     * To update an earning rule's status instead of deleting it, call
+     * Update Loyalty Earning Rule.
      *
-     * > **Note:** Pre-installed automated rules can only be paused, not deleted.
+     * To delete a non-automated earning rule, call
+     * Delete Loyalty Earning Rule.
      * @param - ID of the earning rule to delete.
      */
     (_id: string): Promise<void>;
@@ -84,7 +104,9 @@ interface ListEarningRulesSignature {
      *
      * You can filter the results by `triggerAppId` or `triggerActivityType`.
      */
-    (options?: ListEarningRulesOptions | undefined): Promise<ListEarningRulesResponse>;
+    (options?: ListEarningRulesOptions): Promise<NonNullablePaths<ListEarningRulesResponse, {
+        [P in LoyaltyEarningRuleNonNullablePaths]: `earningRules.${number}.${P}`;
+    }[LoyaltyEarningRuleNonNullablePaths]>>;
 }
 declare const onLoyaltyEarningRuleCreated$1: EventDefinition<LoyaltyEarningRuleCreatedEnvelope, "wix.loyalty.v1.loyalty_earning_rule_created">;
 declare const onLoyaltyEarningRuleDeleted$1: EventDefinition<LoyaltyEarningRuleDeletedEnvelope, "wix.loyalty.v1.loyalty_earning_rule_deleted">;