@wix/auto_sdk_loyalty_programs 1.0.20 → 1.0.21

package/build/meta.d.mts

@@ -0,0 +1,230 @@
+import { m as GetLoyaltyProgramRequest$1, G as GetLoyaltyProgramResponse$1, n as BulkGetLoyaltyProgramRequest$1, B as BulkGetLoyaltyProgramResponse$1, p as UpdateLoyaltyProgramRequest$1, U as UpdateLoyaltyProgramResponse$1, s as ActivateLoyaltyProgramRequest$1, A as ActivateLoyaltyProgramResponse$1, u as PauseLoyaltyProgramRequest$1, P as PauseLoyaltyProgramResponse$1, C as GetLoyaltyProgramPremiumFeaturesRequest$1, a as GetLoyaltyProgramPremiumFeaturesResponse$1, H as EnablePointsExpirationRequest$1, E as EnablePointsExpirationResponse$1, J as DisablePointsExpirationRequest$1, D as DisablePointsExpirationResponse$1 } from './loyalty-v1-program-programs.universal-CEkDSoxz.mjs';
+
+/**
+ * A loyalty program allows sites to maintain customer reward accounts. Site owners can create a
+ * loyalty program to increase customer retention. Read more about the loyalty program in
+ * [this overview](https://support.wix.com/en/article/wix-loyalty-program-an-overview).
+ */
+interface LoyaltyProgram {
+    /**
+     * Program name.
+     * @minLength 2
+     * @maxLength 50
+     */
+    name?: string | null;
+    /** Details about the program's collectible unit. */
+    pointDefinition?: PointDefinition;
+    /**
+     * Program status. Customers can only earn or redeem points while the program is `ACTIVE`.
+     *
+     * Default: `"DRAFT"`
+     * @readonly
+     */
+    status?: ProgramStatusWithLiterals;
+    /**
+     * Date and time the program was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the program was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /** Configuration for the points expiration feature. */
+    pointsExpiration?: PointsExpiration;
+    /**
+     * Information about the available program premium features.
+     * @readonly
+     */
+    premiumFeatures?: PremiumFeatures;
+}
+interface PointDefinition {
+    /**
+     * Display name for the program's collectible unit.
+     *
+     * It's recommended to use a plural, for example `Stars`.
+     *
+     * In contrast to a custom name, the default `"Points"` name is translated and adjusted to singular based on circumstances.
+     *
+     * Default: `Points`.
+     * @maxLength 20
+     */
+    customName?: string | null;
+    /** Details about the points icon. */
+    icon?: Image;
+}
+interface Image {
+    /** WixMedia image ID. */
+    id?: string;
+    /** Image URL. */
+    url?: string;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /**
+     * Image filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+declare enum ProgramStatus {
+    /** Unknown program status. */
+    UNKNOWN = "UNKNOWN",
+    /** Program was created but is not enabled yet. */
+    DRAFT = "DRAFT",
+    /** Program is active. */
+    ACTIVE = "ACTIVE",
+    /** Program was manually disabled by the user. This action can be reverted, meaning the user can set it to be active again. */
+    PAUSED = "PAUSED"
+}
+/** @enumType */
+type ProgramStatusWithLiterals = ProgramStatus | 'UNKNOWN' | 'DRAFT' | 'ACTIVE' | 'PAUSED';
+interface PointsExpiration {
+    /**
+     * Status of the points expiration feature.
+     * @readonly
+     */
+    status?: StatusWithLiterals;
+    /**
+     * How many months a member should be inactive to lose the collected points.
+     * @min 1
+     * @max 12
+     */
+    monthsOfInactivity?: number;
+    /**
+     * Percentage of points that a member loses after being inactive.
+     * @min 1
+     * @max 100
+     */
+    expiringPointsPercentage?: number;
+}
+declare enum Status {
+    /** Unknown points expiration status. This value is not used. */
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** Points expiration feature is disabled. */
+    DISABLED = "DISABLED",
+    /** Points expiration feature is enabled. */
+    ENABLED = "ENABLED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'DISABLED' | 'ENABLED';
+interface PremiumFeatures {
+    /**
+     * Whether there are any loyalty program premium features.
+     * @readonly
+     */
+    loyaltyProgram?: boolean;
+    /**
+     * Whether this loyalty program includes tiers.
+     * @readonly
+     */
+    tiers?: boolean;
+    /**
+     * Whether this loyalty program includes point expiration.
+     * @readonly
+     */
+    pointsExpiration?: boolean;
+}
+interface GetLoyaltyProgramRequest {
+}
+interface GetLoyaltyProgramResponse {
+    /** Retrieved loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+interface BulkGetLoyaltyProgramRequest {
+}
+interface BulkGetLoyaltyProgramResponse {
+    /** Retrieved loyalty programs. */
+    programInSites?: ProgramInSite[];
+}
+interface ProgramInSite {
+    /**
+     * Metasite ID.
+     * @format GUID
+     */
+    metaSiteId?: string;
+    /** Loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+interface UpdateLoyaltyProgramRequest {
+    /** Loyalty program fields to update. */
+    loyaltyProgram: LoyaltyProgram;
+}
+interface UpdateLoyaltyProgramResponse {
+    /** Updated loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+interface ActivateLoyaltyProgramRequest {
+}
+interface ActivateLoyaltyProgramResponse {
+    /** Activated loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+interface PauseLoyaltyProgramRequest {
+}
+interface PauseLoyaltyProgramResponse {
+    /** Paused loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+interface GetLoyaltyProgramPremiumFeaturesRequest {
+}
+interface GetLoyaltyProgramPremiumFeaturesResponse {
+    /**
+     * Whether there are any loyalty program premium features.
+     * @readonly
+     */
+    loyaltyProgram?: boolean;
+    /**
+     * Whether this loyalty program includes tiers.
+     * @readonly
+     */
+    tiers?: boolean;
+    /**
+     * Whether this loyalty program includes point expiration.
+     * @readonly
+     */
+    pointsExpiration?: boolean;
+}
+interface EnablePointsExpirationRequest {
+}
+interface EnablePointsExpirationResponse {
+    /** Loyalty program with enabled points expiration feature. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+interface DisablePointsExpirationRequest {
+}
+interface DisablePointsExpirationResponse {
+    /** Loyalty program with disabled points expiration feature. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+
+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 getLoyaltyProgram(): __PublicMethodMetaInfo<'GET', {}, GetLoyaltyProgramRequest$1, GetLoyaltyProgramRequest, GetLoyaltyProgramResponse$1, GetLoyaltyProgramResponse>;
+declare function bulkGetLoyaltyProgram(): __PublicMethodMetaInfo<'GET', {}, BulkGetLoyaltyProgramRequest$1, BulkGetLoyaltyProgramRequest, BulkGetLoyaltyProgramResponse$1, BulkGetLoyaltyProgramResponse>;
+declare function updateLoyaltyProgram(): __PublicMethodMetaInfo<'PATCH', {}, UpdateLoyaltyProgramRequest$1, UpdateLoyaltyProgramRequest, UpdateLoyaltyProgramResponse$1, UpdateLoyaltyProgramResponse>;
+declare function activateLoyaltyProgram(): __PublicMethodMetaInfo<'POST', {}, ActivateLoyaltyProgramRequest$1, ActivateLoyaltyProgramRequest, ActivateLoyaltyProgramResponse$1, ActivateLoyaltyProgramResponse>;
+declare function pauseLoyaltyProgram(): __PublicMethodMetaInfo<'POST', {}, PauseLoyaltyProgramRequest$1, PauseLoyaltyProgramRequest, PauseLoyaltyProgramResponse$1, PauseLoyaltyProgramResponse>;
+declare function getLoyaltyProgramPremiumFeatures(): __PublicMethodMetaInfo<'GET', {}, GetLoyaltyProgramPremiumFeaturesRequest$1, GetLoyaltyProgramPremiumFeaturesRequest, GetLoyaltyProgramPremiumFeaturesResponse$1, GetLoyaltyProgramPremiumFeaturesResponse>;
+declare function enablePointsExpiration(): __PublicMethodMetaInfo<'POST', {}, EnablePointsExpirationRequest$1, EnablePointsExpirationRequest, EnablePointsExpirationResponse$1, EnablePointsExpirationResponse>;
+declare function disablePointsExpiration(): __PublicMethodMetaInfo<'POST', {}, DisablePointsExpirationRequest$1, DisablePointsExpirationRequest, DisablePointsExpirationResponse$1, DisablePointsExpirationResponse>;
+
+export { type __PublicMethodMetaInfo, activateLoyaltyProgram, bulkGetLoyaltyProgram, disablePointsExpiration, enablePointsExpiration, getLoyaltyProgram, getLoyaltyProgramPremiumFeatures, pauseLoyaltyProgram, updateLoyaltyProgram };

package/build/meta.d.ts

@@ -0,0 +1,230 @@
+import { m as GetLoyaltyProgramRequest$1, G as GetLoyaltyProgramResponse$1, n as BulkGetLoyaltyProgramRequest$1, B as BulkGetLoyaltyProgramResponse$1, p as UpdateLoyaltyProgramRequest$1, U as UpdateLoyaltyProgramResponse$1, s as ActivateLoyaltyProgramRequest$1, A as ActivateLoyaltyProgramResponse$1, u as PauseLoyaltyProgramRequest$1, P as PauseLoyaltyProgramResponse$1, C as GetLoyaltyProgramPremiumFeaturesRequest$1, a as GetLoyaltyProgramPremiumFeaturesResponse$1, H as EnablePointsExpirationRequest$1, E as EnablePointsExpirationResponse$1, J as DisablePointsExpirationRequest$1, D as DisablePointsExpirationResponse$1 } from './loyalty-v1-program-programs.universal-CEkDSoxz.js';
+
+/**
+ * A loyalty program allows sites to maintain customer reward accounts. Site owners can create a
+ * loyalty program to increase customer retention. Read more about the loyalty program in
+ * [this overview](https://support.wix.com/en/article/wix-loyalty-program-an-overview).
+ */
+interface LoyaltyProgram {
+    /**
+     * Program name.
+     * @minLength 2
+     * @maxLength 50
+     */
+    name?: string | null;
+    /** Details about the program's collectible unit. */
+    pointDefinition?: PointDefinition;
+    /**
+     * Program status. Customers can only earn or redeem points while the program is `ACTIVE`.
+     *
+     * Default: `"DRAFT"`
+     * @readonly
+     */
+    status?: ProgramStatusWithLiterals;
+    /**
+     * Date and time the program was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the program was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /** Configuration for the points expiration feature. */
+    pointsExpiration?: PointsExpiration;
+    /**
+     * Information about the available program premium features.
+     * @readonly
+     */
+    premiumFeatures?: PremiumFeatures;
+}
+interface PointDefinition {
+    /**
+     * Display name for the program's collectible unit.
+     *
+     * It's recommended to use a plural, for example `Stars`.
+     *
+     * In contrast to a custom name, the default `"Points"` name is translated and adjusted to singular based on circumstances.
+     *
+     * Default: `Points`.
+     * @maxLength 20
+     */
+    customName?: string | null;
+    /** Details about the points icon. */
+    icon?: Image;
+}
+interface Image {
+    /** WixMedia image ID. */
+    id?: string;
+    /** Image URL. */
+    url?: string;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /**
+     * Image filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+declare enum ProgramStatus {
+    /** Unknown program status. */
+    UNKNOWN = "UNKNOWN",
+    /** Program was created but is not enabled yet. */
+    DRAFT = "DRAFT",
+    /** Program is active. */
+    ACTIVE = "ACTIVE",
+    /** Program was manually disabled by the user. This action can be reverted, meaning the user can set it to be active again. */
+    PAUSED = "PAUSED"
+}
+/** @enumType */
+type ProgramStatusWithLiterals = ProgramStatus | 'UNKNOWN' | 'DRAFT' | 'ACTIVE' | 'PAUSED';
+interface PointsExpiration {
+    /**
+     * Status of the points expiration feature.
+     * @readonly
+     */
+    status?: StatusWithLiterals;
+    /**
+     * How many months a member should be inactive to lose the collected points.
+     * @min 1
+     * @max 12
+     */
+    monthsOfInactivity?: number;
+    /**
+     * Percentage of points that a member loses after being inactive.
+     * @min 1
+     * @max 100
+     */
+    expiringPointsPercentage?: number;
+}
+declare enum Status {
+    /** Unknown points expiration status. This value is not used. */
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** Points expiration feature is disabled. */
+    DISABLED = "DISABLED",
+    /** Points expiration feature is enabled. */
+    ENABLED = "ENABLED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'DISABLED' | 'ENABLED';
+interface PremiumFeatures {
+    /**
+     * Whether there are any loyalty program premium features.
+     * @readonly
+     */
+    loyaltyProgram?: boolean;
+    /**
+     * Whether this loyalty program includes tiers.
+     * @readonly
+     */
+    tiers?: boolean;
+    /**
+     * Whether this loyalty program includes point expiration.
+     * @readonly
+     */
+    pointsExpiration?: boolean;
+}
+interface GetLoyaltyProgramRequest {
+}
+interface GetLoyaltyProgramResponse {
+    /** Retrieved loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+interface BulkGetLoyaltyProgramRequest {
+}
+interface BulkGetLoyaltyProgramResponse {
+    /** Retrieved loyalty programs. */
+    programInSites?: ProgramInSite[];
+}
+interface ProgramInSite {
+    /**
+     * Metasite ID.
+     * @format GUID
+     */
+    metaSiteId?: string;
+    /** Loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+interface UpdateLoyaltyProgramRequest {
+    /** Loyalty program fields to update. */
+    loyaltyProgram: LoyaltyProgram;
+}
+interface UpdateLoyaltyProgramResponse {
+    /** Updated loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+interface ActivateLoyaltyProgramRequest {
+}
+interface ActivateLoyaltyProgramResponse {
+    /** Activated loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+interface PauseLoyaltyProgramRequest {
+}
+interface PauseLoyaltyProgramResponse {
+    /** Paused loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+interface GetLoyaltyProgramPremiumFeaturesRequest {
+}
+interface GetLoyaltyProgramPremiumFeaturesResponse {
+    /**
+     * Whether there are any loyalty program premium features.
+     * @readonly
+     */
+    loyaltyProgram?: boolean;
+    /**
+     * Whether this loyalty program includes tiers.
+     * @readonly
+     */
+    tiers?: boolean;
+    /**
+     * Whether this loyalty program includes point expiration.
+     * @readonly
+     */
+    pointsExpiration?: boolean;
+}
+interface EnablePointsExpirationRequest {
+}
+interface EnablePointsExpirationResponse {
+    /** Loyalty program with enabled points expiration feature. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+interface DisablePointsExpirationRequest {
+}
+interface DisablePointsExpirationResponse {
+    /** Loyalty program with disabled points expiration feature. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+
+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 getLoyaltyProgram(): __PublicMethodMetaInfo<'GET', {}, GetLoyaltyProgramRequest$1, GetLoyaltyProgramRequest, GetLoyaltyProgramResponse$1, GetLoyaltyProgramResponse>;
+declare function bulkGetLoyaltyProgram(): __PublicMethodMetaInfo<'GET', {}, BulkGetLoyaltyProgramRequest$1, BulkGetLoyaltyProgramRequest, BulkGetLoyaltyProgramResponse$1, BulkGetLoyaltyProgramResponse>;
+declare function updateLoyaltyProgram(): __PublicMethodMetaInfo<'PATCH', {}, UpdateLoyaltyProgramRequest$1, UpdateLoyaltyProgramRequest, UpdateLoyaltyProgramResponse$1, UpdateLoyaltyProgramResponse>;
+declare function activateLoyaltyProgram(): __PublicMethodMetaInfo<'POST', {}, ActivateLoyaltyProgramRequest$1, ActivateLoyaltyProgramRequest, ActivateLoyaltyProgramResponse$1, ActivateLoyaltyProgramResponse>;
+declare function pauseLoyaltyProgram(): __PublicMethodMetaInfo<'POST', {}, PauseLoyaltyProgramRequest$1, PauseLoyaltyProgramRequest, PauseLoyaltyProgramResponse$1, PauseLoyaltyProgramResponse>;
+declare function getLoyaltyProgramPremiumFeatures(): __PublicMethodMetaInfo<'GET', {}, GetLoyaltyProgramPremiumFeaturesRequest$1, GetLoyaltyProgramPremiumFeaturesRequest, GetLoyaltyProgramPremiumFeaturesResponse$1, GetLoyaltyProgramPremiumFeaturesResponse>;
+declare function enablePointsExpiration(): __PublicMethodMetaInfo<'POST', {}, EnablePointsExpirationRequest$1, EnablePointsExpirationRequest, EnablePointsExpirationResponse$1, EnablePointsExpirationResponse>;
+declare function disablePointsExpiration(): __PublicMethodMetaInfo<'POST', {}, DisablePointsExpirationRequest$1, DisablePointsExpirationRequest, DisablePointsExpirationResponse$1, DisablePointsExpirationResponse>;
+
+export { type __PublicMethodMetaInfo, activateLoyaltyProgram, bulkGetLoyaltyProgram, disablePointsExpiration, enablePointsExpiration, getLoyaltyProgram, getLoyaltyProgramPremiumFeatures, pauseLoyaltyProgram, updateLoyaltyProgram };