@wix/auto_sdk_loyalty_rewards 1.0.6 → 1.0.8

package/build/meta.d.ts

@@ -0,0 +1,476 @@
+import { t as CreateRewardRequest$1, u as CreateRewardResponse$1, v as BulkCreateRewardsRequest$1, B as BulkCreateRewardsResponse$1, y as GetRewardRequest$1, z as GetRewardResponse$1, E as BulkGetRewardsRequest$1, a as BulkGetRewardsResponse$1, J as QueryRewardsRequest$1, Q as QueryRewardsResponse$1, V as UpdateRewardRequest$1, b as UpdateRewardResponse$1, X as DeleteRewardRequest$1, Y as DeleteRewardResponse$1, Z as ListRewardsRequest$1, c as ListRewardsResponse$1 } from './loyalty-v1-reward-rewards.universal-BFnbQRqi.js';
+
+/**
+ * A loyalty reward is an object a customer can redeem with loyalty points.
+ * Redeeming a reward then creates a loyalty coupon that the customer can use.
+ */
+interface Reward extends RewardTypeDetailsOneOf {
+    /** Discount details. */
+    discountAmount?: DiscountAmount;
+    /** Coupon details. */
+    couponReward?: CouponReward;
+    /**
+     * Reward ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Reward name.
+     * @minLength 1
+     * @maxLength 50
+     */
+    name?: string;
+    /** Whether the reward is active. Default: `FALSE` */
+    active?: boolean;
+    /** Reward type. */
+    type?: RewardTypeWithLiterals;
+    /**
+     * Revision number, which increments by 1 each time the loyalty reward is updated.
+     *
+     * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty reward.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the reward was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the reward was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+}
+/** @oneof */
+interface RewardTypeDetailsOneOf {
+    /** Discount details. */
+    discountAmount?: DiscountAmount;
+    /** Coupon details. */
+    couponReward?: CouponReward;
+}
+/** Available reward types. */
+declare enum RewardType {
+    /** Undefined reward type. */
+    UNDEFINED = "UNDEFINED",
+    /** Discount reward. Special flexible reward type used in checkout. */
+    DISCOUNT_AMOUNT = "DISCOUNT_AMOUNT",
+    /** Coupon reward. [Learn more about coupons.](https://support.wix.com/en/article/using-coupons-as-loyalty-rewards) */
+    COUPON_REWARD = "COUPON_REWARD",
+    /** For internal use. */
+    SPI_DISCOUNT_AMOUNT = "SPI_DISCOUNT_AMOUNT"
+}
+/** @enumType */
+type RewardTypeWithLiterals = RewardType | 'UNDEFINED' | 'DISCOUNT_AMOUNT' | 'COUPON_REWARD' | 'SPI_DISCOUNT_AMOUNT';
+interface DiscountAmount {
+    /**
+     * Discount details for each tier.
+     * @maxSize 21
+     */
+    configsByTier?: DiscountAmountConfig[];
+}
+interface DiscountAmountConfig {
+    /**
+     * Discount amount. Must be a positive value.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gt:0, maxScale:2 }
+     */
+    amount?: string;
+    /**
+     * Tier ID, or empty if config applies to the base tier.
+     * @format GUID
+     */
+    tierId?: string | null;
+    /**
+     * Amount of points required to redeem the reward.
+     * @min 1
+     * @max 9999999
+     */
+    costInPoints?: number;
+}
+interface CouponReward extends CouponRewardDiscountTypeOneOf, CouponRewardScopeOrMinSubtotalOneOf {
+    /** Discount as a fixed amount. */
+    fixedAmount?: FixedAmountDiscount;
+    /** Discount as a percentage. */
+    percentage?: PercentageDiscount;
+    /** Free shipping. */
+    freeShipping?: FreeShippingDiscount;
+    /** Limit the coupon to carts with a subtotal greater than this number. */
+    minimumSubtotal?: number;
+    /**
+     * Specifies the type of line items this coupon will apply to.
+     * For more information, see [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).
+     */
+    scope?: CouponScope;
+    /** Whether the coupon is limited to one item. */
+    limitedToOneItem?: boolean | null;
+    /** Whether the coupon also applies to subscriptions. */
+    appliesToSubscriptions?: boolean | null;
+    /**
+     * Specifies the amount of discounted cycles for a subscription item.
+     *
+     * Can only be set when `appliesToSubscriptions` is `true` and `scope.namespace` is `pricingPlans`.
+     * If `discountedCycleCount` is empty, the coupon applies to all available cycles.
+     * @min 1
+     * @max 999
+     */
+    discountedCycleCount?: number | null;
+}
+/** @oneof */
+interface CouponRewardDiscountTypeOneOf {
+    /** Discount as a fixed amount. */
+    fixedAmount?: FixedAmountDiscount;
+    /** Discount as a percentage. */
+    percentage?: PercentageDiscount;
+    /** Free shipping. */
+    freeShipping?: FreeShippingDiscount;
+}
+/** @oneof */
+interface CouponRewardScopeOrMinSubtotalOneOf {
+    /** Limit the coupon to carts with a subtotal greater than this number. */
+    minimumSubtotal?: number;
+    /**
+     * Specifies the type of line items this coupon will apply to.
+     * For more information, see [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).
+     */
+    scope?: CouponScope;
+}
+interface FixedAmountDiscount {
+    /**
+     * Discount details for each tier.
+     * @minSize 1
+     * @maxSize 21
+     */
+    configsByTier?: FixedAmountDiscountConfig[];
+}
+interface FixedAmountDiscountConfig {
+    /**
+     * Tier ID, or empty if config applies to the base tier.
+     * @format GUID
+     */
+    tierId?: string | null;
+    /**
+     * Amount of points required to redeem the reward.
+     * @min 1
+     * @max 9999999
+     */
+    costInPoints?: number;
+    /** Discount amount. */
+    amount?: number;
+}
+interface PercentageDiscount {
+    /**
+     * Discount details for each tier.
+     * @minSize 1
+     * @maxSize 21
+     */
+    configsByTier?: PercentageDiscountConfig[];
+}
+interface PercentageDiscountConfig {
+    /**
+     * Tier ID, or empty if config applies to the base tier.
+     * @format GUID
+     */
+    tierId?: string | null;
+    /**
+     * Amount of points required to redeem the reward.
+     * @min 1
+     * @max 9999999
+     */
+    costInPoints?: number;
+    /** Percentage discount. */
+    percentage?: number;
+}
+interface FreeShippingDiscount {
+    /**
+     * Discount details for each tier.
+     * @minSize 1
+     * @maxSize 21
+     */
+    configsByTier?: FreeShippingDiscountConfig[];
+}
+interface FreeShippingDiscountConfig {
+    /**
+     * Tier ID, or empty if config applies to the base tier.
+     * @format GUID
+     */
+    tierId?: string | null;
+    /**
+     * Amount of points required to redeem the reward.
+     * @min 1
+     * @max 9999999
+     */
+    costInPoints?: number;
+}
+interface CouponScope {
+    /**
+     * Scope namespace.
+     *
+     * See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values) for valid namespaces.
+     */
+    namespace?: string;
+    /**
+     * Coupon scope's applied group.
+     *
+     * See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values) for valid groups.
+     */
+    group?: Group;
+}
+interface Group {
+    /**
+     * Name of coupon scope's group.
+     *
+     * See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values) for valid groups.
+     */
+    name?: string;
+    /** Entity ID, if the coupon scope is limited to just one item. */
+    entityId?: string | null;
+}
+interface CreateRewardRequest {
+    /** Reward to create. */
+    reward: Reward;
+}
+interface CreateRewardResponse {
+    /** Created reward. */
+    reward?: Reward;
+}
+interface BulkCreateRewardsRequest {
+    /**
+     * Rewards to create.
+     * @minSize 1
+     * @maxSize 10
+     */
+    rewards: Reward[];
+}
+interface BulkCreateRewardsResponse {
+    /** Created rewards. */
+    results?: BulkRewardResult[];
+    /** Total successes and failures of the bulk create rewards action. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkRewardResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
+    /** Created reward. */
+    item?: Reward;
+}
+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;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+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;
+}
+interface GetRewardRequest {
+    /**
+     * ID of the reward to retrieve.
+     * @format GUID
+     */
+    id: string;
+}
+interface GetRewardResponse {
+    /** Retrieved reward. */
+    reward?: Reward;
+}
+interface BulkGetRewardsRequest {
+}
+interface BulkGetRewardsResponse {
+    /** Found rewards per site. */
+    rewardsInSite?: RewardsInSite[];
+}
+interface RewardsInSite {
+    /**
+     * Metasite id.
+     * @format GUID
+     */
+    metaSiteId?: string;
+    /** Rewards. */
+    rewards?: Reward[];
+}
+interface QueryRewardsRequest {
+    /** Query parameters. */
+    query: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    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.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryRewardsResponse {
+    /** Retrieved loyalty rewards. */
+    rewards?: Reward[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface UpdateRewardRequest {
+    /** Reward information to update. */
+    reward: Reward;
+}
+interface UpdateRewardResponse {
+    /** Updated reward. */
+    reward?: Reward;
+}
+interface DeleteRewardRequest {
+    /**
+     * ID of the reward to delete.
+     * @format GUID
+     */
+    id: string;
+    /**
+     * Revision number, which increments by 1 each time the reward is updated.
+     *
+     * To prevent conflicting changes, the current `revision` must be passed when deleting the reward.
+     */
+    revision?: string;
+}
+interface DeleteRewardResponse {
+}
+interface ListRewardsRequest {
+    /** Pagination options. */
+    cursorPaging?: CursorPaging;
+}
+interface ListRewardsResponse {
+    /** Retrieved loyalty rewards. */
+    rewards?: Reward[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: PagingMetadataV2;
+}
+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;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createReward(): __PublicMethodMetaInfo<'POST', {}, CreateRewardRequest$1, CreateRewardRequest, CreateRewardResponse$1, CreateRewardResponse>;
+declare function bulkCreateRewards(): __PublicMethodMetaInfo<'POST', {}, BulkCreateRewardsRequest$1, BulkCreateRewardsRequest, BulkCreateRewardsResponse$1, BulkCreateRewardsResponse>;
+declare function getReward(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, GetRewardRequest$1, GetRewardRequest, GetRewardResponse$1, GetRewardResponse>;
+declare function bulkGetRewards(): __PublicMethodMetaInfo<'GET', {}, BulkGetRewardsRequest$1, BulkGetRewardsRequest, BulkGetRewardsResponse$1, BulkGetRewardsResponse>;
+declare function queryRewards(): __PublicMethodMetaInfo<'POST', {}, QueryRewardsRequest$1, QueryRewardsRequest, QueryRewardsResponse$1, QueryRewardsResponse>;
+declare function updateReward(): __PublicMethodMetaInfo<'PUT', {
+    rewardId: string;
+}, UpdateRewardRequest$1, UpdateRewardRequest, UpdateRewardResponse$1, UpdateRewardResponse>;
+declare function deleteReward(): __PublicMethodMetaInfo<'DELETE', {
+    id: string;
+}, DeleteRewardRequest$1, DeleteRewardRequest, DeleteRewardResponse$1, DeleteRewardResponse>;
+declare function listRewards(): __PublicMethodMetaInfo<'GET', {}, ListRewardsRequest$1, ListRewardsRequest, ListRewardsResponse$1, ListRewardsResponse>;
+
+export { type __PublicMethodMetaInfo, bulkCreateRewards, bulkGetRewards, createReward, deleteReward, getReward, listRewards, queryRewards, updateReward };