@wix/auto_sdk_loyalty_earning-rules 1.0.3 → 1.0.5

package/build/index.d.mts

@@ -0,0 +1,112 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { L as LoyaltyEarningRule, B as BulkCreateLoyaltyEarningRulesResponse, T as Type, C as CreateCustomLoyaltyEarningRuleOptions, a as CreateCustomLoyaltyEarningRuleResponse, U as UpdateLoyaltyEarningRule, b as UpdateLoyaltyEarningRuleResponse, D as DeleteLoyaltyEarningRuleOptions, c as ListEarningRulesOptions, d as ListEarningRulesResponse } from './loyalty-v1-loyalty-earning-rule-earning-rules.universal-ByA9SEhi.mjs';
+export { Y as ActionEvent, A as ApplicationError, a1 as BaseEventMetadata, o as BulkActionMetadata, m as BulkCreateLoyaltyEarningRulesRequest, n as BulkLoyaltyEarningRuleResult, h as ConversionRate, i as ConversionRateConfig, p as CreateCustomLoyaltyEarningRuleRequest, k as CreateLoyaltyEarningRuleRequest, l as CreateLoyaltyEarningRuleResponse, H as CursorPaging, K as Cursors, q as CustomLoyaltyEarningRule, r as CustomLoyaltyEarningRuleTypeOneOf, w as DeleteAutomationEarningRuleRequest, x as DeleteAutomationEarningRuleResponse, u as DeleteLoyaltyEarningRuleRequest, v as DeleteLoyaltyEarningRuleResponse, N as DomainEvent, O as DomainEventBodyOneOf, E as EarningRuleDisabled, Z as Empty, Q as EntityCreatedEvent, X as EntityDeletedEvent, V as EntityUpdatedEvent, a2 as EventMetadata, F as FixedAmount, g as FixedAmountConfig, G as GetLoyaltyEarningRuleRequest, s as GetLoyaltyEarningRuleResponse, $ as IdentificationData, a0 as IdentificationDataIdOneOf, I as ItemMetadata, z as ListEarningRulesInTierRequest, J as ListEarningRulesInTierResponse, y as ListEarningRulesRequest, a3 as LoyaltyEarningRuleCreatedEnvelope, a4 as LoyaltyEarningRuleDeletedEnvelope, f as LoyaltyEarningRuleTypeOneOf, j as LoyaltyEarningRuleTypeTag, e as LoyaltyEarningRuleTypeTagType, a5 as LoyaltyEarningRuleUpdatedEnvelope, _ as MessageEnvelope, M as Metadata, P as PagingMetadataV2, R as RestoreInfo, S as Status, t as UpdateLoyaltyEarningRuleRequest, W as WebhookIdentityType } from './loyalty-v1-loyalty-earning-rule-earning-rules.universal-ByA9SEhi.mjs';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+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.
+     * @param - Earning rule to create.
+     * @returns Created earning rule.
+     */
+    (earningRule: LoyaltyEarningRule): Promise<LoyaltyEarningRule>;
+}
+declare function bulkCreateLoyaltyEarningRules$1(httpClient: HttpClient): BulkCreateLoyaltyEarningRulesSignature;
+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.
+     * @param - Earning rules to create.
+     */
+    (earningRules: LoyaltyEarningRule[]): Promise<BulkCreateLoyaltyEarningRulesResponse>;
+}
+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.
+     * @param - Type of the custom earning rule.
+     */
+    (type: Type, options?: CreateCustomLoyaltyEarningRuleOptions | undefined): Promise<CreateCustomLoyaltyEarningRuleResponse>;
+}
+declare function getLoyaltyEarningRule$1(httpClient: HttpClient): GetLoyaltyEarningRuleSignature;
+interface GetLoyaltyEarningRuleSignature {
+    /**
+     * Retrieves a specified non-automated earning rule.
+     * @param - ID of the earning rule to retrieve.
+     * @returns Retrieved earning rule.
+     */
+    (_id: string): Promise<LoyaltyEarningRule>;
+}
+declare function updateLoyaltyEarningRule$1(httpClient: HttpClient): UpdateLoyaltyEarningRuleSignature;
+interface UpdateLoyaltyEarningRuleSignature {
+    /**
+     * 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 - Loyalty earning rule ID.
+     */
+    (_id: string, earningRule: UpdateLoyaltyEarningRule): Promise<UpdateLoyaltyEarningRuleResponse>;
+}
+declare function deleteLoyaltyEarningRule$1(httpClient: HttpClient): DeleteLoyaltyEarningRuleSignature;
+interface DeleteLoyaltyEarningRuleSignature {
+    /**
+     * Deletes a non-automated earning rule.
+     * @param - ID of the earning rule to delete.
+     */
+    (_id: string, options?: DeleteLoyaltyEarningRuleOptions | undefined): Promise<void>;
+}
+declare function deleteAutomationEarningRule$1(httpClient: HttpClient): DeleteAutomationEarningRuleSignature;
+interface DeleteAutomationEarningRuleSignature {
+    /**
+     * Deletes a custom automated earning rule.
+     *
+     * > **Note:** Pre-installed automated rules can only be paused, not deleted.
+     * @param - ID of the earning rule to delete.
+     */
+    (_id: string): Promise<void>;
+}
+declare function listEarningRules$1(httpClient: HttpClient): ListEarningRulesSignature;
+interface ListEarningRulesSignature {
+    /**
+     * Retrieves a list of earning rules.
+     *
+     * Returns both automated and non-automated earning rules.
+     *
+     * You can filter the results by `triggerAppId` or `triggerActivityType`.
+     */
+    (options?: ListEarningRulesOptions | undefined): Promise<ListEarningRulesResponse>;
+}
+
+declare const createLoyaltyEarningRule: MaybeContext<BuildRESTFunction<typeof createLoyaltyEarningRule$1> & typeof createLoyaltyEarningRule$1>;
+declare const bulkCreateLoyaltyEarningRules: MaybeContext<BuildRESTFunction<typeof bulkCreateLoyaltyEarningRules$1> & typeof bulkCreateLoyaltyEarningRules$1>;
+declare const createCustomLoyaltyEarningRule: MaybeContext<BuildRESTFunction<typeof createCustomLoyaltyEarningRule$1> & typeof createCustomLoyaltyEarningRule$1>;
+declare const getLoyaltyEarningRule: MaybeContext<BuildRESTFunction<typeof getLoyaltyEarningRule$1> & typeof getLoyaltyEarningRule$1>;
+declare const updateLoyaltyEarningRule: MaybeContext<BuildRESTFunction<typeof updateLoyaltyEarningRule$1> & typeof updateLoyaltyEarningRule$1>;
+declare const deleteLoyaltyEarningRule: MaybeContext<BuildRESTFunction<typeof deleteLoyaltyEarningRule$1> & typeof deleteLoyaltyEarningRule$1>;
+declare const deleteAutomationEarningRule: MaybeContext<BuildRESTFunction<typeof deleteAutomationEarningRule$1> & typeof deleteAutomationEarningRule$1>;
+declare const listEarningRules: MaybeContext<BuildRESTFunction<typeof listEarningRules$1> & typeof listEarningRules$1>;
+/**
+ * Triggered when an earning rule is created.
+ */
+declare const onLoyaltyEarningRuleCreated: ReturnType<typeof createEventModule<typeof publicOnLoyaltyEarningRuleCreated>>;
+/**
+ * Triggered when an earning rule is deleted.
+ */
+declare const onLoyaltyEarningRuleDeleted: ReturnType<typeof createEventModule<typeof publicOnLoyaltyEarningRuleDeleted>>;
+/**
+ * Triggered when an earning rule is updated.
+ */
+declare const onLoyaltyEarningRuleUpdated: ReturnType<typeof createEventModule<typeof publicOnLoyaltyEarningRuleUpdated>>;
+
+export { BulkCreateLoyaltyEarningRulesResponse, CreateCustomLoyaltyEarningRuleOptions, CreateCustomLoyaltyEarningRuleResponse, DeleteLoyaltyEarningRuleOptions, ListEarningRulesOptions, ListEarningRulesResponse, LoyaltyEarningRule, Type, UpdateLoyaltyEarningRule, UpdateLoyaltyEarningRuleResponse, bulkCreateLoyaltyEarningRules, createCustomLoyaltyEarningRule, createLoyaltyEarningRule, deleteAutomationEarningRule, deleteLoyaltyEarningRule, getLoyaltyEarningRule, listEarningRules, onLoyaltyEarningRuleCreated, onLoyaltyEarningRuleDeleted, onLoyaltyEarningRuleUpdated, updateLoyaltyEarningRule };

package/build/index.d.ts

@@ -0,0 +1,112 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { L as LoyaltyEarningRule, B as BulkCreateLoyaltyEarningRulesResponse, T as Type, C as CreateCustomLoyaltyEarningRuleOptions, a as CreateCustomLoyaltyEarningRuleResponse, U as UpdateLoyaltyEarningRule, b as UpdateLoyaltyEarningRuleResponse, D as DeleteLoyaltyEarningRuleOptions, c as ListEarningRulesOptions, d as ListEarningRulesResponse } from './loyalty-v1-loyalty-earning-rule-earning-rules.universal-ByA9SEhi.js';
+export { Y as ActionEvent, A as ApplicationError, a1 as BaseEventMetadata, o as BulkActionMetadata, m as BulkCreateLoyaltyEarningRulesRequest, n as BulkLoyaltyEarningRuleResult, h as ConversionRate, i as ConversionRateConfig, p as CreateCustomLoyaltyEarningRuleRequest, k as CreateLoyaltyEarningRuleRequest, l as CreateLoyaltyEarningRuleResponse, H as CursorPaging, K as Cursors, q as CustomLoyaltyEarningRule, r as CustomLoyaltyEarningRuleTypeOneOf, w as DeleteAutomationEarningRuleRequest, x as DeleteAutomationEarningRuleResponse, u as DeleteLoyaltyEarningRuleRequest, v as DeleteLoyaltyEarningRuleResponse, N as DomainEvent, O as DomainEventBodyOneOf, E as EarningRuleDisabled, Z as Empty, Q as EntityCreatedEvent, X as EntityDeletedEvent, V as EntityUpdatedEvent, a2 as EventMetadata, F as FixedAmount, g as FixedAmountConfig, G as GetLoyaltyEarningRuleRequest, s as GetLoyaltyEarningRuleResponse, $ as IdentificationData, a0 as IdentificationDataIdOneOf, I as ItemMetadata, z as ListEarningRulesInTierRequest, J as ListEarningRulesInTierResponse, y as ListEarningRulesRequest, a3 as LoyaltyEarningRuleCreatedEnvelope, a4 as LoyaltyEarningRuleDeletedEnvelope, f as LoyaltyEarningRuleTypeOneOf, j as LoyaltyEarningRuleTypeTag, e as LoyaltyEarningRuleTypeTagType, a5 as LoyaltyEarningRuleUpdatedEnvelope, _ as MessageEnvelope, M as Metadata, P as PagingMetadataV2, R as RestoreInfo, S as Status, t as UpdateLoyaltyEarningRuleRequest, W as WebhookIdentityType } from './loyalty-v1-loyalty-earning-rule-earning-rules.universal-ByA9SEhi.js';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+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.
+     * @param - Earning rule to create.
+     * @returns Created earning rule.
+     */
+    (earningRule: LoyaltyEarningRule): Promise<LoyaltyEarningRule>;
+}
+declare function bulkCreateLoyaltyEarningRules$1(httpClient: HttpClient): BulkCreateLoyaltyEarningRulesSignature;
+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.
+     * @param - Earning rules to create.
+     */
+    (earningRules: LoyaltyEarningRule[]): Promise<BulkCreateLoyaltyEarningRulesResponse>;
+}
+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.
+     * @param - Type of the custom earning rule.
+     */
+    (type: Type, options?: CreateCustomLoyaltyEarningRuleOptions | undefined): Promise<CreateCustomLoyaltyEarningRuleResponse>;
+}
+declare function getLoyaltyEarningRule$1(httpClient: HttpClient): GetLoyaltyEarningRuleSignature;
+interface GetLoyaltyEarningRuleSignature {
+    /**
+     * Retrieves a specified non-automated earning rule.
+     * @param - ID of the earning rule to retrieve.
+     * @returns Retrieved earning rule.
+     */
+    (_id: string): Promise<LoyaltyEarningRule>;
+}
+declare function updateLoyaltyEarningRule$1(httpClient: HttpClient): UpdateLoyaltyEarningRuleSignature;
+interface UpdateLoyaltyEarningRuleSignature {
+    /**
+     * 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 - Loyalty earning rule ID.
+     */
+    (_id: string, earningRule: UpdateLoyaltyEarningRule): Promise<UpdateLoyaltyEarningRuleResponse>;
+}
+declare function deleteLoyaltyEarningRule$1(httpClient: HttpClient): DeleteLoyaltyEarningRuleSignature;
+interface DeleteLoyaltyEarningRuleSignature {
+    /**
+     * Deletes a non-automated earning rule.
+     * @param - ID of the earning rule to delete.
+     */
+    (_id: string, options?: DeleteLoyaltyEarningRuleOptions | undefined): Promise<void>;
+}
+declare function deleteAutomationEarningRule$1(httpClient: HttpClient): DeleteAutomationEarningRuleSignature;
+interface DeleteAutomationEarningRuleSignature {
+    /**
+     * Deletes a custom automated earning rule.
+     *
+     * > **Note:** Pre-installed automated rules can only be paused, not deleted.
+     * @param - ID of the earning rule to delete.
+     */
+    (_id: string): Promise<void>;
+}
+declare function listEarningRules$1(httpClient: HttpClient): ListEarningRulesSignature;
+interface ListEarningRulesSignature {
+    /**
+     * Retrieves a list of earning rules.
+     *
+     * Returns both automated and non-automated earning rules.
+     *
+     * You can filter the results by `triggerAppId` or `triggerActivityType`.
+     */
+    (options?: ListEarningRulesOptions | undefined): Promise<ListEarningRulesResponse>;
+}
+
+declare const createLoyaltyEarningRule: MaybeContext<BuildRESTFunction<typeof createLoyaltyEarningRule$1> & typeof createLoyaltyEarningRule$1>;
+declare const bulkCreateLoyaltyEarningRules: MaybeContext<BuildRESTFunction<typeof bulkCreateLoyaltyEarningRules$1> & typeof bulkCreateLoyaltyEarningRules$1>;
+declare const createCustomLoyaltyEarningRule: MaybeContext<BuildRESTFunction<typeof createCustomLoyaltyEarningRule$1> & typeof createCustomLoyaltyEarningRule$1>;
+declare const getLoyaltyEarningRule: MaybeContext<BuildRESTFunction<typeof getLoyaltyEarningRule$1> & typeof getLoyaltyEarningRule$1>;
+declare const updateLoyaltyEarningRule: MaybeContext<BuildRESTFunction<typeof updateLoyaltyEarningRule$1> & typeof updateLoyaltyEarningRule$1>;
+declare const deleteLoyaltyEarningRule: MaybeContext<BuildRESTFunction<typeof deleteLoyaltyEarningRule$1> & typeof deleteLoyaltyEarningRule$1>;
+declare const deleteAutomationEarningRule: MaybeContext<BuildRESTFunction<typeof deleteAutomationEarningRule$1> & typeof deleteAutomationEarningRule$1>;
+declare const listEarningRules: MaybeContext<BuildRESTFunction<typeof listEarningRules$1> & typeof listEarningRules$1>;
+/**
+ * Triggered when an earning rule is created.
+ */
+declare const onLoyaltyEarningRuleCreated: ReturnType<typeof createEventModule<typeof publicOnLoyaltyEarningRuleCreated>>;
+/**
+ * Triggered when an earning rule is deleted.
+ */
+declare const onLoyaltyEarningRuleDeleted: ReturnType<typeof createEventModule<typeof publicOnLoyaltyEarningRuleDeleted>>;
+/**
+ * Triggered when an earning rule is updated.
+ */
+declare const onLoyaltyEarningRuleUpdated: ReturnType<typeof createEventModule<typeof publicOnLoyaltyEarningRuleUpdated>>;
+
+export { BulkCreateLoyaltyEarningRulesResponse, CreateCustomLoyaltyEarningRuleOptions, CreateCustomLoyaltyEarningRuleResponse, DeleteLoyaltyEarningRuleOptions, ListEarningRulesOptions, ListEarningRulesResponse, LoyaltyEarningRule, Type, UpdateLoyaltyEarningRule, UpdateLoyaltyEarningRuleResponse, bulkCreateLoyaltyEarningRules, createCustomLoyaltyEarningRule, createLoyaltyEarningRule, deleteAutomationEarningRule, deleteLoyaltyEarningRule, getLoyaltyEarningRule, listEarningRules, onLoyaltyEarningRuleCreated, onLoyaltyEarningRuleDeleted, onLoyaltyEarningRuleUpdated, updateLoyaltyEarningRule };