@wix/auto_sdk_ecom_discount-rules 1.0.14 → 1.0.16

package/build/index.d.mts

@@ -0,0 +1,98 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { D as DiscountRule, U as UpdateDiscountRule, a as DiscountRulesQueryBuilder, b as DiscountRuleCreatedEnvelope, c as DiscountRuleDeletedEnvelope, d as DiscountRuleUpdatedEnvelope } from './ecom-discounts-v1-discount-rule-discount-rules.universal-CAqXQEc1.mjs';
+export { ad as ActionEvent, q as ActiveTimeInfo, n as And, a3 as AppliedDiscount, a4 as AppliedDiscountRule, A as AppliedSubjectType, aj as BaseEventMetadata, B as BuyXGetYInfo, C as CatalogItemFilter, a1 as CatalogReference, z as CreateDiscountRuleRequest, F as CreateDiscountRuleResponse, X as CursorPaging, _ as Cursors, o as Custom, m as CustomFilter, v as CustomerBuy, w as CustomerBuyConditionOneOf, x as CustomerGet, L as DeleteDiscountRuleRequest, M as DeleteDiscountRuleResponse, s as Discount, t as DiscountDiscountOneOf, a5 as DiscountRuleName, af as DiscountRuleUsageLimitReached, al as DiscountRulesQueryResult, y as DiscountSettings, i as DiscountTrigger, j as DiscountTriggerTriggerOneOf, f as DiscountType, r as Discounts, a7 as DomainEvent, a8 as DomainEventBodyOneOf, ae as Empty, a9 as EntityCreatedEvent, ac as EntityDeletedEvent, ab as EntityUpdatedEvent, ak as EventMetadata, E as ExtendedFields, $ as GetAppliedDiscountsRequest, a2 as GetAppliedDiscountsResponse, G as GetDiscountRuleRequest, H as GetDiscountRuleResponse, ah as IdentificationData, ai as IdentificationDataIdOneOf, I as ItemQuantityRange, a0 as LineItem, ag as MessageEnvelope, a6 as MultiCurrencyPrice, O as Or, V as PlatformPaging, Z as PlatformPagingMetadata, P as PlatformQuery, N as PlatformQueryPagingMethodOneOf, Q as QueryDiscountRulesRequest, Y as QueryDiscountRulesResponse, aa as RestoreInfo, k as Scope, l as ScopeScopeItemsOneOf, S as ScopeType, h as SortOrder, R as Sorting, u as SpecificItemsInfo, g as Status, p as SubtotalRange, T as TriggerType, e as Type, J as UpdateDiscountRuleRequest, K as UpdateDiscountRuleResponse, W as WebhookIdentityType } from './ecom-discounts-v1-discount-rule-discount-rules.universal-CAqXQEc1.mjs';
+
+declare function createDiscountRule$1(httpClient: HttpClient): CreateDiscountRuleSignature;
+interface CreateDiscountRuleSignature {
+    /**
+     * Creates a new discount rule.
+     *
+     *
+     * The `createDiscountRule()` function returns a Promise that resolves to the new discount rule when it's created.
+     * @param - Discount rule info.
+     * @returns Discount rule.
+     */
+    (discountRule: DiscountRule): Promise<DiscountRule>;
+}
+declare function getDiscountRule$1(httpClient: HttpClient): GetDiscountRuleSignature;
+interface GetDiscountRuleSignature {
+    /**
+     * Retrieves a discount rule.
+     *
+     *
+     * The `getDiscountRule()` function returns a Promise that resolves when the specified discount rule is retrieved.
+     * @param - ID of the discount rule to retrieve.
+     * @returns The requested discount rule.
+     */
+    (discountRuleId: string): Promise<DiscountRule>;
+}
+declare function updateDiscountRule$1(httpClient: HttpClient): UpdateDiscountRuleSignature;
+interface UpdateDiscountRuleSignature {
+    /**
+     * Updates a discount rule's properties.
+     *
+     *
+     * The `updateDiscountRule()` function returns a Promise that resolves when the specified discount rule's properties are updated.
+     *
+     * Each time the discount rule is updated, `revision` increments by 1. The existing `revision` must be included when updating the discount rule. This ensures you're working with the latest discount rule information, and it prevents unintended overwrites.
+     * @param - Discount rule ID.
+     * @param - Discount rule info.
+     * @param - Discount rule info.
+     * @returns Updated discount rule.
+     */
+    (_id: string, discountRule: UpdateDiscountRule): Promise<DiscountRule>;
+}
+declare function deleteDiscountRule$1(httpClient: HttpClient): DeleteDiscountRuleSignature;
+interface DeleteDiscountRuleSignature {
+    /**
+     * Deletes a discount rule.
+     *
+     *
+     * The `deleteDiscountRule()` function returns a Promise that resolves when the specified discount rule is deleted.
+     * @param - ID of the discount rule to delete.
+     */
+    (discountRuleId: string): Promise<void>;
+}
+declare function queryDiscountRules$1(httpClient: HttpClient): QueryDiscountRulesSignature;
+interface QueryDiscountRulesSignature {
+    /**
+     * Creates a query to retrieve a list of discount rules.
+     *
+     *
+     * The `queryDiscountRules()` function builds a query to retrieve a list of up to 100 discount rules, and returns a [`DiscountRulesQueryBuilder`](#discountrulesquerybuilder) object.
+     *
+     * The returned object contains the query definition which is typically used to run the query using the [`find()`](/discount-rules/discount-rules-query-builder/find) function.
+     *
+     * You can refine the query by chaining `DiscountRulesQueryBuilder` functions onto the query. `DiscountRulesQueryBuilder` functions enable you to sort, filter, and control the results queryDiscountRules() returns.
+     *
+     * By default, `queryDiscountRules()` sorts results by [`ascending("_id")`](/discount-rules/discount-rules-query-builder/ascending) by default. This can be overridden.
+     *
+     * To learn how to query posts, refer to the table below.
+     *
+     * The following `DiscountRulesQueryBuilder` functions are supported for the `queryDiscountRules()` function. For a full description of the discount rule object, see the object returned for the [`items`](/discount-rules/discount-rules-query-result/items) property in the `DiscountRulesQueryResult`.
+     */
+    (): DiscountRulesQueryBuilder;
+}
+declare const onDiscountRuleCreated$1: EventDefinition<DiscountRuleCreatedEnvelope, "wix.ecom.discounts.v1.discount_rule_created">;
+declare const onDiscountRuleDeleted$1: EventDefinition<DiscountRuleDeletedEnvelope, "wix.ecom.discounts.v1.discount_rule_deleted">;
+declare const onDiscountRuleUpdated$1: EventDefinition<DiscountRuleUpdatedEnvelope, "wix.ecom.discounts.v1.discount_rule_updated">;
+
+declare const createDiscountRule: MaybeContext<BuildRESTFunction<typeof createDiscountRule$1> & typeof createDiscountRule$1>;
+declare const getDiscountRule: MaybeContext<BuildRESTFunction<typeof getDiscountRule$1> & typeof getDiscountRule$1>;
+declare const updateDiscountRule: MaybeContext<BuildRESTFunction<typeof updateDiscountRule$1> & typeof updateDiscountRule$1>;
+declare const deleteDiscountRule: MaybeContext<BuildRESTFunction<typeof deleteDiscountRule$1> & typeof deleteDiscountRule$1>;
+declare const queryDiscountRules: MaybeContext<BuildRESTFunction<typeof queryDiscountRules$1> & typeof queryDiscountRules$1>;
+/**
+ * Triggered when a discount rule is created.
+ */
+declare const onDiscountRuleCreated: BuildEventDefinition<typeof onDiscountRuleCreated$1>;
+/**
+ * Triggered when a discount rule is deleted.
+ */
+declare const onDiscountRuleDeleted: BuildEventDefinition<typeof onDiscountRuleDeleted$1>;
+/**
+ * Triggered when a discount rule is updated.
+ */
+declare const onDiscountRuleUpdated: BuildEventDefinition<typeof onDiscountRuleUpdated$1>;
+
+export { DiscountRule, DiscountRuleCreatedEnvelope, DiscountRuleDeletedEnvelope, DiscountRuleUpdatedEnvelope, DiscountRulesQueryBuilder, UpdateDiscountRule, createDiscountRule, deleteDiscountRule, getDiscountRule, onDiscountRuleCreated, onDiscountRuleDeleted, onDiscountRuleUpdated, queryDiscountRules, updateDiscountRule };

package/build/index.d.ts

@@ -0,0 +1,98 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { D as DiscountRule, U as UpdateDiscountRule, a as DiscountRulesQueryBuilder, b as DiscountRuleCreatedEnvelope, c as DiscountRuleDeletedEnvelope, d as DiscountRuleUpdatedEnvelope } from './ecom-discounts-v1-discount-rule-discount-rules.universal-CAqXQEc1.js';
+export { ad as ActionEvent, q as ActiveTimeInfo, n as And, a3 as AppliedDiscount, a4 as AppliedDiscountRule, A as AppliedSubjectType, aj as BaseEventMetadata, B as BuyXGetYInfo, C as CatalogItemFilter, a1 as CatalogReference, z as CreateDiscountRuleRequest, F as CreateDiscountRuleResponse, X as CursorPaging, _ as Cursors, o as Custom, m as CustomFilter, v as CustomerBuy, w as CustomerBuyConditionOneOf, x as CustomerGet, L as DeleteDiscountRuleRequest, M as DeleteDiscountRuleResponse, s as Discount, t as DiscountDiscountOneOf, a5 as DiscountRuleName, af as DiscountRuleUsageLimitReached, al as DiscountRulesQueryResult, y as DiscountSettings, i as DiscountTrigger, j as DiscountTriggerTriggerOneOf, f as DiscountType, r as Discounts, a7 as DomainEvent, a8 as DomainEventBodyOneOf, ae as Empty, a9 as EntityCreatedEvent, ac as EntityDeletedEvent, ab as EntityUpdatedEvent, ak as EventMetadata, E as ExtendedFields, $ as GetAppliedDiscountsRequest, a2 as GetAppliedDiscountsResponse, G as GetDiscountRuleRequest, H as GetDiscountRuleResponse, ah as IdentificationData, ai as IdentificationDataIdOneOf, I as ItemQuantityRange, a0 as LineItem, ag as MessageEnvelope, a6 as MultiCurrencyPrice, O as Or, V as PlatformPaging, Z as PlatformPagingMetadata, P as PlatformQuery, N as PlatformQueryPagingMethodOneOf, Q as QueryDiscountRulesRequest, Y as QueryDiscountRulesResponse, aa as RestoreInfo, k as Scope, l as ScopeScopeItemsOneOf, S as ScopeType, h as SortOrder, R as Sorting, u as SpecificItemsInfo, g as Status, p as SubtotalRange, T as TriggerType, e as Type, J as UpdateDiscountRuleRequest, K as UpdateDiscountRuleResponse, W as WebhookIdentityType } from './ecom-discounts-v1-discount-rule-discount-rules.universal-CAqXQEc1.js';
+
+declare function createDiscountRule$1(httpClient: HttpClient): CreateDiscountRuleSignature;
+interface CreateDiscountRuleSignature {
+    /**
+     * Creates a new discount rule.
+     *
+     *
+     * The `createDiscountRule()` function returns a Promise that resolves to the new discount rule when it's created.
+     * @param - Discount rule info.
+     * @returns Discount rule.
+     */
+    (discountRule: DiscountRule): Promise<DiscountRule>;
+}
+declare function getDiscountRule$1(httpClient: HttpClient): GetDiscountRuleSignature;
+interface GetDiscountRuleSignature {
+    /**
+     * Retrieves a discount rule.
+     *
+     *
+     * The `getDiscountRule()` function returns a Promise that resolves when the specified discount rule is retrieved.
+     * @param - ID of the discount rule to retrieve.
+     * @returns The requested discount rule.
+     */
+    (discountRuleId: string): Promise<DiscountRule>;
+}
+declare function updateDiscountRule$1(httpClient: HttpClient): UpdateDiscountRuleSignature;
+interface UpdateDiscountRuleSignature {
+    /**
+     * Updates a discount rule's properties.
+     *
+     *
+     * The `updateDiscountRule()` function returns a Promise that resolves when the specified discount rule's properties are updated.
+     *
+     * Each time the discount rule is updated, `revision` increments by 1. The existing `revision` must be included when updating the discount rule. This ensures you're working with the latest discount rule information, and it prevents unintended overwrites.
+     * @param - Discount rule ID.
+     * @param - Discount rule info.
+     * @param - Discount rule info.
+     * @returns Updated discount rule.
+     */
+    (_id: string, discountRule: UpdateDiscountRule): Promise<DiscountRule>;
+}
+declare function deleteDiscountRule$1(httpClient: HttpClient): DeleteDiscountRuleSignature;
+interface DeleteDiscountRuleSignature {
+    /**
+     * Deletes a discount rule.
+     *
+     *
+     * The `deleteDiscountRule()` function returns a Promise that resolves when the specified discount rule is deleted.
+     * @param - ID of the discount rule to delete.
+     */
+    (discountRuleId: string): Promise<void>;
+}
+declare function queryDiscountRules$1(httpClient: HttpClient): QueryDiscountRulesSignature;
+interface QueryDiscountRulesSignature {
+    /**
+     * Creates a query to retrieve a list of discount rules.
+     *
+     *
+     * The `queryDiscountRules()` function builds a query to retrieve a list of up to 100 discount rules, and returns a [`DiscountRulesQueryBuilder`](#discountrulesquerybuilder) object.
+     *
+     * The returned object contains the query definition which is typically used to run the query using the [`find()`](/discount-rules/discount-rules-query-builder/find) function.
+     *
+     * You can refine the query by chaining `DiscountRulesQueryBuilder` functions onto the query. `DiscountRulesQueryBuilder` functions enable you to sort, filter, and control the results queryDiscountRules() returns.
+     *
+     * By default, `queryDiscountRules()` sorts results by [`ascending("_id")`](/discount-rules/discount-rules-query-builder/ascending) by default. This can be overridden.
+     *
+     * To learn how to query posts, refer to the table below.
+     *
+     * The following `DiscountRulesQueryBuilder` functions are supported for the `queryDiscountRules()` function. For a full description of the discount rule object, see the object returned for the [`items`](/discount-rules/discount-rules-query-result/items) property in the `DiscountRulesQueryResult`.
+     */
+    (): DiscountRulesQueryBuilder;
+}
+declare const onDiscountRuleCreated$1: EventDefinition<DiscountRuleCreatedEnvelope, "wix.ecom.discounts.v1.discount_rule_created">;
+declare const onDiscountRuleDeleted$1: EventDefinition<DiscountRuleDeletedEnvelope, "wix.ecom.discounts.v1.discount_rule_deleted">;
+declare const onDiscountRuleUpdated$1: EventDefinition<DiscountRuleUpdatedEnvelope, "wix.ecom.discounts.v1.discount_rule_updated">;
+
+declare const createDiscountRule: MaybeContext<BuildRESTFunction<typeof createDiscountRule$1> & typeof createDiscountRule$1>;
+declare const getDiscountRule: MaybeContext<BuildRESTFunction<typeof getDiscountRule$1> & typeof getDiscountRule$1>;
+declare const updateDiscountRule: MaybeContext<BuildRESTFunction<typeof updateDiscountRule$1> & typeof updateDiscountRule$1>;
+declare const deleteDiscountRule: MaybeContext<BuildRESTFunction<typeof deleteDiscountRule$1> & typeof deleteDiscountRule$1>;
+declare const queryDiscountRules: MaybeContext<BuildRESTFunction<typeof queryDiscountRules$1> & typeof queryDiscountRules$1>;
+/**
+ * Triggered when a discount rule is created.
+ */
+declare const onDiscountRuleCreated: BuildEventDefinition<typeof onDiscountRuleCreated$1>;
+/**
+ * Triggered when a discount rule is deleted.
+ */
+declare const onDiscountRuleDeleted: BuildEventDefinition<typeof onDiscountRuleDeleted$1>;
+/**
+ * Triggered when a discount rule is updated.
+ */
+declare const onDiscountRuleUpdated: BuildEventDefinition<typeof onDiscountRuleUpdated$1>;
+
+export { DiscountRule, DiscountRuleCreatedEnvelope, DiscountRuleDeletedEnvelope, DiscountRuleUpdatedEnvelope, DiscountRulesQueryBuilder, UpdateDiscountRule, createDiscountRule, deleteDiscountRule, getDiscountRule, onDiscountRuleCreated, onDiscountRuleDeleted, onDiscountRuleUpdated, queryDiscountRules, updateDiscountRule };