@snagsolutions/sdk 0.1.0-alpha.13 → 0.1.0-alpha.14

package/resources/loyalty/badges.d.ts

@@ -34,99 +34,657 @@ export declare class Badges extends APIResource {
  * Response returned upon successful creation of the badge.
  */
 export interface BadgeCreateResponse {
+    /**
+     * UUID of the badge (converted to lowercase)
+     */
     id: string;
+    /**
+     * The description of the badge
+     */
+    description: string | null;
+    /**
+     * The URL of the badge image
+     */
+    imageUrl: string | null;
+    /**
+     * Array of conditions of the badge
+     */
+    loyaltyConditions: Array<BadgeCreateResponse.LoyaltyCondition>;
+    /**
+     * The name of the badge
+     */
+    name: string;
+    /**
+     * Array of user badges
+     */
+    LoyaltyBadgeUser?: Array<BadgeCreateResponse.LoyaltyBadgeUser>;
+}
+export declare namespace BadgeCreateResponse {
+    /**
+     * Schema for a loyalty condition rule.
+     */
+    interface LoyaltyCondition {
+        /**
+         * UUID of the condition (converted to lowercase)
+         */
+        id: string;
+        /**
+         * The amount of the condition
+         */
+        amount: number | null;
+        association: Array<LoyaltyCondition.Association>;
+        /**
+         * The URL of the CSV file
+         */
+        csvUrl: string | null;
+        /**
+         * The description of the condition
+         */
+        description: string | null;
+        /**
+         * UUID of the currency (converted to lowercase)
+         */
+        loyaltyCurrencyId: string | null;
+        /**
+         * UUID of the rule group (converted to lowercase)
+         */
+        loyaltyRuleGroupId: string | null;
+        /**
+         * The repeat count of the condition
+         */
+        repeatCount: number | null;
+        /**
+         * The required count of the condition
+         */
+        requiredCount: number | null;
+        /**
+         * The type of the condition
+         */
+        type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
+    }
+    namespace LoyaltyCondition {
+        interface Association {
+            loyaltyBadge: Association.LoyaltyBadge | null;
+            loyaltyCurrency: Association.LoyaltyCurrency | null;
+            loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
+            loyaltyRule: Association.LoyaltyRule | null;
+            loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
+        }
+        namespace Association {
+            interface LoyaltyBadge {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyCurrency {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyLeaderboardView {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyRule {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyRuleGroup {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+        }
+    }
+    interface LoyaltyBadgeUser {
+        /**
+         * UUID of the user badge (converted to lowercase)
+         */
+        id: string;
+        /**
+         * UUID of the badge (converted to lowercase)
+         */
+        loyaltyBadgeId: string;
+        /**
+         * UUID of the organization (converted to lowercase)
+         */
+        organizationId: string;
+        /**
+         * The status of the badge
+         */
+        status: 'active' | 'inactive' | 'revoked';
+        /**
+         * UUID of the user (converted to lowercase)
+         */
+        userId: string;
+        /**
+         * UUID of the website (converted to lowercase)
+         */
+        websiteId: string;
+        /**
+         * Array of progress for the badge
+         */
+        progress?: unknown;
+    }
 }
 /**
  * Response returned upon successful update of the badge.
  */
 export interface BadgeUpdateResponse {
+    /**
+     * UUID of the badge (converted to lowercase)
+     */
     id: string;
+    /**
+     * The description of the badge
+     */
+    description: string | null;
+    /**
+     * The URL of the badge image
+     */
+    imageUrl: string | null;
+    /**
+     * Array of conditions of the badge
+     */
+    loyaltyConditions: Array<BadgeUpdateResponse.LoyaltyCondition>;
+    /**
+     * The name of the badge
+     */
+    name: string;
+    /**
+     * Array of user badges
+     */
+    LoyaltyBadgeUser?: Array<BadgeUpdateResponse.LoyaltyBadgeUser>;
+}
+export declare namespace BadgeUpdateResponse {
+    /**
+     * Schema for a loyalty condition rule.
+     */
+    interface LoyaltyCondition {
+        /**
+         * UUID of the condition (converted to lowercase)
+         */
+        id: string;
+        /**
+         * The amount of the condition
+         */
+        amount: number | null;
+        association: Array<LoyaltyCondition.Association>;
+        /**
+         * The URL of the CSV file
+         */
+        csvUrl: string | null;
+        /**
+         * The description of the condition
+         */
+        description: string | null;
+        /**
+         * UUID of the currency (converted to lowercase)
+         */
+        loyaltyCurrencyId: string | null;
+        /**
+         * UUID of the rule group (converted to lowercase)
+         */
+        loyaltyRuleGroupId: string | null;
+        /**
+         * The repeat count of the condition
+         */
+        repeatCount: number | null;
+        /**
+         * The required count of the condition
+         */
+        requiredCount: number | null;
+        /**
+         * The type of the condition
+         */
+        type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
+    }
+    namespace LoyaltyCondition {
+        interface Association {
+            loyaltyBadge: Association.LoyaltyBadge | null;
+            loyaltyCurrency: Association.LoyaltyCurrency | null;
+            loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
+            loyaltyRule: Association.LoyaltyRule | null;
+            loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
+        }
+        namespace Association {
+            interface LoyaltyBadge {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyCurrency {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyLeaderboardView {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyRule {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyRuleGroup {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+        }
+    }
+    interface LoyaltyBadgeUser {
+        /**
+         * UUID of the user badge (converted to lowercase)
+         */
+        id: string;
+        /**
+         * UUID of the badge (converted to lowercase)
+         */
+        loyaltyBadgeId: string;
+        /**
+         * UUID of the organization (converted to lowercase)
+         */
+        organizationId: string;
+        /**
+         * The status of the badge
+         */
+        status: 'active' | 'inactive' | 'revoked';
+        /**
+         * UUID of the user (converted to lowercase)
+         */
+        userId: string;
+        /**
+         * UUID of the website (converted to lowercase)
+         */
+        websiteId: string;
+        /**
+         * Array of progress for the badge
+         */
+        progress?: unknown;
+    }
 }
 /**
  * Response returned upon successful fetching of the badges.
  */
 export interface BadgeListResponse {
-    badges: Array<BadgeListResponse.Badge>;
+    /**
+     * UUID of the badge (converted to lowercase)
+     */
+    id: string;
+    /**
+     * The description of the badge
+     */
+    description: string | null;
+    /**
+     * The URL of the badge image
+     */
+    imageUrl: string | null;
+    /**
+     * Array of conditions of the badge
+     */
+    loyaltyConditions: Array<BadgeListResponse.LoyaltyCondition>;
+    /**
+     * The name of the badge
+     */
+    name: string;
+    /**
+     * Array of user badges
+     */
+    LoyaltyBadgeUser?: Array<BadgeListResponse.LoyaltyBadgeUser>;
 }
 export declare namespace BadgeListResponse {
-    interface Badge {
+    /**
+     * Schema for a loyalty condition rule.
+     */
+    interface LoyaltyCondition {
         /**
-         * UUID of the badge (converted to lowercase)
+         * UUID of the condition (converted to lowercase)
          */
         id: string;
         /**
-         * Count of rules and accounts with the badge
+         * The amount of the condition
          */
-        _count: Badge._Count;
+        amount: number | null;
+        association: Array<LoyaltyCondition.Association>;
         /**
-         * The URL of the badge image
+         * The URL of the CSV file
          */
-        imageUrl: string;
+        csvUrl: string | null;
         /**
-         * Array of rules for the badge
+         * The description of the condition
          */
-        loyaltyConditions: Array<Badge.LoyaltyCondition>;
+        description: string | null;
         /**
-         * The name of the badge
+         * UUID of the currency (converted to lowercase)
          */
-        name: string;
+        loyaltyCurrencyId: string | null;
         /**
-         * The description of the badge
+         * UUID of the rule group (converted to lowercase)
          */
-        description?: string;
+        loyaltyRuleGroupId: string | null;
+        /**
+         * The repeat count of the condition
+         */
+        repeatCount: number | null;
+        /**
+         * The required count of the condition
+         */
+        requiredCount: number | null;
+        /**
+         * The type of the condition
+         */
+        type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
     }
-    namespace Badge {
-        /**
-         * Count of rules and accounts with the badge
-         */
-        interface _Count {
-            /**
-             * The number of accounts with the badge
-             */
-            LoyaltyBadgeUser: number;
-            /**
-             * The number of rules
-             */
-            loyaltyConditions: number;
+    namespace LoyaltyCondition {
+        interface Association {
+            loyaltyBadge: Association.LoyaltyBadge | null;
+            loyaltyCurrency: Association.LoyaltyCurrency | null;
+            loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
+            loyaltyRule: Association.LoyaltyRule | null;
+            loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
         }
-        interface LoyaltyCondition {
-            /**
-             * UUID of the rule (converted to lowercase)
-             */
-            id: string;
-            /**
-             * The type of rule
-             */
-            type: 'rule' | 'section' | 'level' | 'points' | 'api' | 'badge';
-            /**
-             * The amount of the rule
-             */
-            amount?: number;
-            /**
-             * The description of the rule
-             */
-            description?: string;
-            /**
-             * UUID of the currency (optional, converted to lowercase)
-             */
-            loyaltyCurrencyId?: string;
-            /**
-             * UUID of the rule group (optional, converted to lowercase)
-             */
-            loyaltyRuleGroupId?: string;
-            /**
-             * UUID of the rule (optional, converted to lowercase)
-             */
-            loyaltyRuleId?: string;
+        namespace Association {
+            interface LoyaltyBadge {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyCurrency {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyLeaderboardView {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyRule {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyRuleGroup {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
         }
     }
+    interface LoyaltyBadgeUser {
+        /**
+         * UUID of the user badge (converted to lowercase)
+         */
+        id: string;
+        /**
+         * UUID of the badge (converted to lowercase)
+         */
+        loyaltyBadgeId: string;
+        /**
+         * UUID of the organization (converted to lowercase)
+         */
+        organizationId: string;
+        /**
+         * The status of the badge
+         */
+        status: 'active' | 'inactive' | 'revoked';
+        /**
+         * UUID of the user (converted to lowercase)
+         */
+        userId: string;
+        /**
+         * UUID of the website (converted to lowercase)
+         */
+        websiteId: string;
+        /**
+         * Array of progress for the badge
+         */
+        progress?: unknown;
+    }
 }
 /**
  * Response returned upon successful deletion of the badge.
  */
 export interface BadgeDeleteResponse {
+    /**
+     * UUID of the badge (converted to lowercase)
+     */
     id: string;
-    deletedAt: string;
+    /**
+     * The description of the badge
+     */
+    description: string | null;
+    /**
+     * The URL of the badge image
+     */
+    imageUrl: string | null;
+    /**
+     * Array of conditions of the badge
+     */
+    loyaltyConditions: Array<BadgeDeleteResponse.LoyaltyCondition>;
+    /**
+     * The name of the badge
+     */
+    name: string;
+    /**
+     * Array of user badges
+     */
+    LoyaltyBadgeUser?: Array<BadgeDeleteResponse.LoyaltyBadgeUser>;
+}
+export declare namespace BadgeDeleteResponse {
+    /**
+     * Schema for a loyalty condition rule.
+     */
+    interface LoyaltyCondition {
+        /**
+         * UUID of the condition (converted to lowercase)
+         */
+        id: string;
+        /**
+         * The amount of the condition
+         */
+        amount: number | null;
+        association: Array<LoyaltyCondition.Association>;
+        /**
+         * The URL of the CSV file
+         */
+        csvUrl: string | null;
+        /**
+         * The description of the condition
+         */
+        description: string | null;
+        /**
+         * UUID of the currency (converted to lowercase)
+         */
+        loyaltyCurrencyId: string | null;
+        /**
+         * UUID of the rule group (converted to lowercase)
+         */
+        loyaltyRuleGroupId: string | null;
+        /**
+         * The repeat count of the condition
+         */
+        repeatCount: number | null;
+        /**
+         * The required count of the condition
+         */
+        requiredCount: number | null;
+        /**
+         * The type of the condition
+         */
+        type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
+    }
+    namespace LoyaltyCondition {
+        interface Association {
+            loyaltyBadge: Association.LoyaltyBadge | null;
+            loyaltyCurrency: Association.LoyaltyCurrency | null;
+            loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
+            loyaltyRule: Association.LoyaltyRule | null;
+            loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
+        }
+        namespace Association {
+            interface LoyaltyBadge {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyCurrency {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyLeaderboardView {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyRule {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+            interface LoyaltyRuleGroup {
+                /**
+                 * UUID of the association (converted to lowercase)
+                 */
+                id: string;
+                /**
+                 * The name of the association
+                 */
+                name: string;
+            }
+        }
+    }
+    interface LoyaltyBadgeUser {
+        /**
+         * UUID of the user badge (converted to lowercase)
+         */
+        id: string;
+        /**
+         * UUID of the badge (converted to lowercase)
+         */
+        loyaltyBadgeId: string;
+        /**
+         * UUID of the organization (converted to lowercase)
+         */
+        organizationId: string;
+        /**
+         * The status of the badge
+         */
+        status: 'active' | 'inactive' | 'revoked';
+        /**
+         * UUID of the user (converted to lowercase)
+         */
+        userId: string;
+        /**
+         * UUID of the website (converted to lowercase)
+         */
+        websiteId: string;
+        /**
+         * Array of progress for the badge
+         */
+        progress?: unknown;
+    }
 }
 /**
  * Response returned upon successful update of the user badge
@@ -191,42 +749,51 @@ export interface BadgeCreateParams {
     description?: string;
 }
 export declare namespace BadgeCreateParams {
-    /**
-     * Schema for a loyalty condition rule.
-     */
     interface Rule {
         /**
          * The type of rule
          */
-        type: 'rule' | 'section' | 'level' | 'points' | 'api' | 'badge';
+        type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
         /**
          * The amount of the rule
          */
         amount?: number | null;
+        /**
+         * URL of the CSV file (optional)
+         */
+        csvUrl?: string | null;
         /**
          * The description of the rule
          */
-        description?: string;
+        description?: string | null;
+        /**
+         * Array of UUIDs of the badge (optional, converted to lowercase)
+         */
+        loyaltyBadgeIds?: Array<string>;
+        /**
+         * Array of UUIDs of the currency (optional, converted to lowercase)
+         */
+        loyaltyCurrencyIds?: Array<string>;
         /**
-         * UUID of the badge (optional, converted to lowercase)
+         * Array of UUIDs of the Loyalty Leaderboard (optional, converted to lowercase)
          */
-        loyaltyBadgeId?: string | null;
+        loyaltyLeaderboardViewIds?: Array<string>;
         /**
-         * UUID of the currency (optional, converted to lowercase)
+         * Array of UUIDs of the rule group (optional, converted to lowercase)
          */
-        loyaltyCurrencyId?: string | null;
+        loyaltyRuleGroupIds?: Array<string>;
         /**
-         * UUID of the Loyalty Leaderboard (optional, converted to lowercase)
+         * Array of UUIDs of the rules (optional, converted to lowercase)
          */
-        loyaltyLeaderboardViewId?: string | null;
+        loyaltyRuleIds?: Array<string>;
         /**
-         * UUID of the rule group (optional, converted to lowercase)
+         * The number of times the rule should be repeated to fulfill the condition
          */
-        loyaltyRuleGroupId?: string | null;
+        repeatCount?: number | null;
         /**
-         * UUID of the rule (optional, converted to lowercase)
+         * The number of rules that need to be fulfilled to satisfy the condition
          */
-        loyaltyRuleId?: string | null;
+        requiredCount?: number | null;
     }
 }
 export interface BadgeUpdateParams {
@@ -255,7 +822,7 @@ export interface BadgeListParams {
     /**
      * Number of badges to fetch
      */
-    limit?: number | null;
+    limit?: number;
     /**
      * UUID of the organization (optional, converted to lowercase)
      */