@snagsolutions/sdk 0.1.0-alpha.26 → 0.1.0-alpha.260

package/src/resources/loyalty/badges.ts

@@ -6,7 +6,18 @@ import * as Core from '../../core';
 
 export class Badges extends APIResource {
   /**
-   * This endpoint allows you to configure a new badge.
+   * This endpoint allows you to configure a new badge
+   *
+   * @example
+   * ```ts
+   * const badge = await client.loyalty.badges.create({
+   *   conditions: [{}],
+   *   imageUrl: 'https://example.com/image.png',
+   *   name: 'Example Badge',
+   *   organizationId: '123e4567-e89b-12d3-a456-426614174222',
+   *   websiteId: '123e4567-e89b-12d3-a456-426614174111',
+   * });
+   * ```
    */
   create(body: BadgeCreateParams, options?: Core.RequestOptions): Core.APIPromise<BadgeCreateResponse> {
     return this._client.post('/api/loyalty/badges', { body, ...options });
@@ -14,6 +25,13 @@ export class Badges extends APIResource {
 
   /**
    * This endpoint allows you to update an existing badge.
+   *
+   * @example
+   * ```ts
+   * const badge = await client.loyalty.badges.update(
+   *   '123e4567-e89b-12d3-a456-426614174333',
+   * );
+   * ```
    */
   update(
     id: string,
@@ -34,6 +52,11 @@ export class Badges extends APIResource {
 
   /**
    * This endpoint allows you to fetch badge(s) data.
+   *
+   * @example
+   * ```ts
+   * const badges = await client.loyalty.badges.list();
+   * ```
    */
   list(query?: BadgeListParams, options?: Core.RequestOptions): Core.APIPromise<BadgeListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<BadgeListResponse>;
@@ -49,6 +72,13 @@ export class Badges extends APIResource {
 
   /**
    * This endpoint allows you to delete a badge.
+   *
+   * @example
+   * ```ts
+   * const badge = await client.loyalty.badges.delete(
+   *   '123e4567-e89b-12d3-a456-426614174333',
+   * );
+   * ```
    */
   delete(id: string, options?: Core.RequestOptions): Core.APIPromise<BadgeDeleteResponse> {
     return this._client.delete(`/api/loyalty/badges/${id}`, options);
@@ -56,6 +86,13 @@ export class Badges extends APIResource {
 
   /**
    * This endpoint allows you to revoke a badge from an account
+   *
+   * @example
+   * ```ts
+   * const response = await client.loyalty.badges.revoke(
+   *   '123e4567-e89b-12d3-a456-426614174333',
+   * );
+   * ```
    */
   revoke(
     id: string,
@@ -76,6 +113,13 @@ export class Badges extends APIResource {
 
   /**
    * This endpoint allows you to reward a badge for an account
+   *
+   * @example
+   * ```ts
+   * const response = await client.loyalty.badges.reward(
+   *   '123e4567-e89b-12d3-a456-426614174333',
+   * );
+   * ```
    */
   reward(
     id: string,
@@ -104,6 +148,11 @@ export interface BadgeCreateResponse {
    */
   id: string;
 
+  /**
+   * The date and time the badge was created
+   */
+  createdAt: string;
+
   /**
    * The description of the badge
    */
@@ -124,10 +173,35 @@ export interface BadgeCreateResponse {
    */
   name: string;
 
+  /**
+   * The date and time the badge was updated
+   */
+  updatedAt: string;
+
+  /**
+   * Array of data jobs associated with the badge
+   */
+  dataJobs?: Array<BadgeCreateResponse.DataJob>;
+
+  /**
+   * Whether to hide this badge in the user interface
+   */
+  hideInUi?: boolean;
+
   /**
    * Array of user badges
    */
-  LoyaltyBadgeUser?: Array<BadgeCreateResponse.LoyaltyBadgeUser>;
+  loyaltyBadgeUsers?: Array<BadgeCreateResponse.LoyaltyBadgeUser>;
+
+  /**
+   * Array of loyalty rules associated with the badge
+   */
+  loyaltyRules?: Array<BadgeCreateResponse.LoyaltyRule>;
+
+  /**
+   * Array of rewards granted when the badge is achieved
+   */
+  rewards?: Array<BadgeCreateResponse.Reward>;
 }
 
 export namespace BadgeCreateResponse {
@@ -148,7 +222,7 @@ export namespace BadgeCreateResponse {
     association: Array<LoyaltyCondition.Association>;
 
     /**
-     * The URL of the CSV file
+     * URL of the CSV file
      */
     csvUrl: string | null;
 
@@ -181,6 +255,11 @@ export namespace BadgeCreateResponse {
      * The type of the condition
      */
     type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
+
+    /**
+     * Array of CSV files associated with the condition
+     */
+    csvFiles?: Array<LoyaltyCondition.CsvFile>;
   }
 
   export namespace LoyaltyCondition {
@@ -257,6 +336,55 @@ export namespace BadgeCreateResponse {
         name: string;
       }
     }
+
+    export interface CsvFile {
+      /**
+       * UUID of the CSV file (converted to lowercase)
+       */
+      id: string;
+
+      /**
+       * The description of the CSV file
+       */
+      description: string | null;
+
+      /**
+       * The name of the CSV file
+       */
+      name: string | null;
+
+      /**
+       * The URL of the CSV file
+       */
+      url: string | null;
+    }
+  }
+
+  export interface DataJob {
+    /**
+     * UUID of the data job (converted to lowercase)
+     */
+    id: string;
+
+    /**
+     * The date and time the data job was created
+     */
+    createdAt: string;
+
+    /**
+     * The status of the data job
+     */
+    status: 'pending' | 'processing' | 'complete' | 'failed' | 'cancelled';
+
+    /**
+     * The date and time the data job was updated
+     */
+    updatedAt: string;
+
+    /**
+     * The message associated with the data job
+     */
+    message?: string | null;
   }
 
   export interface LoyaltyBadgeUser {
@@ -265,6 +393,11 @@ export namespace BadgeCreateResponse {
      */
     id: string;
 
+    /**
+     * The date and time the user badge was created
+     */
+    createdAt: string;
+
     /**
      * UUID of the badge (converted to lowercase)
      */
@@ -280,6 +413,11 @@ export namespace BadgeCreateResponse {
      */
     status: 'active' | 'inactive' | 'revoked';
 
+    /**
+     * The date and time the user badge was updated
+     */
+    updatedAt: string;
+
     /**
      * UUID of the user (converted to lowercase)
      */
@@ -290,10 +428,97 @@ export namespace BadgeCreateResponse {
      */
     websiteId: string;
 
+    /**
+     * The date and time the user badge was granted
+     */
+    completedAt?: string | null;
+
+    /**
+     * Whether the user has dismissed the badge in the UI
+     */
+    dismissedInUi?: boolean;
+
+    /**
+     * Whether to hide this badge in the user interface
+     */
+    hideInUi?: boolean;
+
     /**
      * Array of progress for the badge
      */
     progress?: unknown;
+
+    /**
+     * User associated with the user badge
+     */
+    user?: LoyaltyBadgeUser.User;
+  }
+
+  export namespace LoyaltyBadgeUser {
+    /**
+     * User associated with the user badge
+     */
+    export interface User {
+      /**
+       * UUID of the user (converted to lowercase)
+       */
+      id: string;
+
+      /**
+       * Wallet address of the user
+       */
+      walletAddress: string;
+    }
+  }
+
+  export interface LoyaltyRule {
+    /**
+     * UUID of the loyalty rule (converted to lowercase)
+     */
+    id: string;
+
+    /**
+     * The name of the loyalty rule
+     */
+    name: string;
+  }
+
+  export interface Reward {
+    /**
+     * UUID of the badge reward
+     */
+    id: string;
+
+    /**
+     * Points amount to reward (for points reward type)
+     */
+    amount: number | null;
+
+    /**
+     * Whether the multiplier should be applied to the user's existing balance
+     */
+    isRetroactive: boolean;
+
+    /**
+     * UUID of the loyalty currency for this reward
+     */
+    loyaltyCurrencyId: string | null;
+
+    /**
+     * Multiplier to reward (for multiplier reward type)
+     */
+    multiplier: number | null;
+
+    /**
+     * Type of reward (points or multiplier)
+     */
+    rewardType: 'points' | 'multiplier' | 'badge';
+
+    /**
+     * Array of loyalty currency IDs for multiplier rewards (empty means all
+     * currencies)
+     */
+    loyaltyCurrencyIds?: Array<string>;
   }
 }
 
@@ -306,6 +531,11 @@ export interface BadgeUpdateResponse {
    */
   id: string;
 
+  /**
+   * The date and time the badge was created
+   */
+  createdAt: string;
+
   /**
    * The description of the badge
    */
@@ -326,10 +556,35 @@ export interface BadgeUpdateResponse {
    */
   name: string;
 
+  /**
+   * The date and time the badge was updated
+   */
+  updatedAt: string;
+
+  /**
+   * Array of data jobs associated with the badge
+   */
+  dataJobs?: Array<BadgeUpdateResponse.DataJob>;
+
+  /**
+   * Whether to hide this badge in the user interface
+   */
+  hideInUi?: boolean;
+
   /**
    * Array of user badges
    */
-  LoyaltyBadgeUser?: Array<BadgeUpdateResponse.LoyaltyBadgeUser>;
+  loyaltyBadgeUsers?: Array<BadgeUpdateResponse.LoyaltyBadgeUser>;
+
+  /**
+   * Array of loyalty rules associated with the badge
+   */
+  loyaltyRules?: Array<BadgeUpdateResponse.LoyaltyRule>;
+
+  /**
+   * Array of rewards granted when the badge is achieved
+   */
+  rewards?: Array<BadgeUpdateResponse.Reward>;
 }
 
 export namespace BadgeUpdateResponse {
@@ -350,7 +605,7 @@ export namespace BadgeUpdateResponse {
     association: Array<LoyaltyCondition.Association>;
 
     /**
-     * The URL of the CSV file
+     * URL of the CSV file
      */
     csvUrl: string | null;
 
@@ -383,6 +638,11 @@ export namespace BadgeUpdateResponse {
      * The type of the condition
      */
     type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
+
+    /**
+     * Array of CSV files associated with the condition
+     */
+    csvFiles?: Array<LoyaltyCondition.CsvFile>;
   }
 
   export namespace LoyaltyCondition {
@@ -459,6 +719,55 @@ export namespace BadgeUpdateResponse {
         name: string;
       }
     }
+
+    export interface CsvFile {
+      /**
+       * UUID of the CSV file (converted to lowercase)
+       */
+      id: string;
+
+      /**
+       * The description of the CSV file
+       */
+      description: string | null;
+
+      /**
+       * The name of the CSV file
+       */
+      name: string | null;
+
+      /**
+       * The URL of the CSV file
+       */
+      url: string | null;
+    }
+  }
+
+  export interface DataJob {
+    /**
+     * UUID of the data job (converted to lowercase)
+     */
+    id: string;
+
+    /**
+     * The date and time the data job was created
+     */
+    createdAt: string;
+
+    /**
+     * The status of the data job
+     */
+    status: 'pending' | 'processing' | 'complete' | 'failed' | 'cancelled';
+
+    /**
+     * The date and time the data job was updated
+     */
+    updatedAt: string;
+
+    /**
+     * The message associated with the data job
+     */
+    message?: string | null;
   }
 
   export interface LoyaltyBadgeUser {
@@ -467,6 +776,11 @@ export namespace BadgeUpdateResponse {
      */
     id: string;
 
+    /**
+     * The date and time the user badge was created
+     */
+    createdAt: string;
+
     /**
      * UUID of the badge (converted to lowercase)
      */
@@ -482,6 +796,11 @@ export namespace BadgeUpdateResponse {
      */
     status: 'active' | 'inactive' | 'revoked';
 
+    /**
+     * The date and time the user badge was updated
+     */
+    updatedAt: string;
+
     /**
      * UUID of the user (converted to lowercase)
      */
@@ -492,212 +811,491 @@ export namespace BadgeUpdateResponse {
      */
     websiteId: string;
 
+    /**
+     * The date and time the user badge was granted
+     */
+    completedAt?: string | null;
+
+    /**
+     * Whether the user has dismissed the badge in the UI
+     */
+    dismissedInUi?: boolean;
+
+    /**
+     * Whether to hide this badge in the user interface
+     */
+    hideInUi?: boolean;
+
     /**
      * Array of progress for the badge
      */
     progress?: unknown;
+
+    /**
+     * User associated with the user badge
+     */
+    user?: LoyaltyBadgeUser.User;
   }
-}
 
-/**
- * Response returned upon successful fetching of the badges.
- */
-export interface BadgeListResponse {
-  /**
-   * UUID of the badge (converted to lowercase)
-   */
-  id: string;
+  export namespace LoyaltyBadgeUser {
+    /**
+     * User associated with the user badge
+     */
+    export interface User {
+      /**
+       * UUID of the user (converted to lowercase)
+       */
+      id: string;
 
-  /**
-   * The description of the badge
-   */
-  description: string | null;
+      /**
+       * Wallet address of the user
+       */
+      walletAddress: string;
+    }
+  }
 
-  /**
-   * The URL of the badge image
-   */
-  imageUrl: string | null;
+  export interface LoyaltyRule {
+    /**
+     * UUID of the loyalty rule (converted to lowercase)
+     */
+    id: string;
 
-  /**
-   * Array of conditions of the badge
-   */
-  loyaltyConditions: Array<BadgeListResponse.LoyaltyCondition>;
+    /**
+     * The name of the loyalty rule
+     */
+    name: string;
+  }
 
-  /**
-   * The name of the badge
-   */
-  name: string;
+  export interface Reward {
+    /**
+     * UUID of the badge reward
+     */
+    id: string;
+
+    /**
+     * Points amount to reward (for points reward type)
+     */
+    amount: number | null;
+
+    /**
+     * Whether the multiplier should be applied to the user's existing balance
+     */
+    isRetroactive: boolean;
+
+    /**
+     * UUID of the loyalty currency for this reward
+     */
+    loyaltyCurrencyId: string | null;
+
+    /**
+     * Multiplier to reward (for multiplier reward type)
+     */
+    multiplier: number | null;
+
+    /**
+     * Type of reward (points or multiplier)
+     */
+    rewardType: 'points' | 'multiplier' | 'badge';
+
+    /**
+     * Array of loyalty currency IDs for multiplier rewards (empty means all
+     * currencies)
+     */
+    loyaltyCurrencyIds?: Array<string>;
+  }
+}
+
+export interface BadgeListResponse {
+  data: Array<BadgeListResponse.Data>;
 
   /**
-   * Array of user badges
+   * Indicates if there is a next page of results
    */
-  LoyaltyBadgeUser?: Array<BadgeListResponse.LoyaltyBadgeUser>;
+  hasNextPage: boolean;
 }
 
 export namespace BadgeListResponse {
   /**
-   * Schema for a loyalty condition rule.
+   * Response returned upon successful fetching of the badges.
    */
-  export interface LoyaltyCondition {
+  export interface Data {
     /**
-     * UUID of the condition (converted to lowercase)
+     * UUID of the badge (converted to lowercase)
      */
     id: string;
 
     /**
-     * The amount of the condition
+     * The date and time the badge was created
      */
-    amount: number | null;
+    createdAt: string;
 
-    association: Array<LoyaltyCondition.Association>;
+    /**
+     * The description of the badge
+     */
+    description: string | null;
 
     /**
-     * The URL of the CSV file
+     * The URL of the badge image
      */
-    csvUrl: string | null;
+    imageUrl: string | null;
 
     /**
-     * The description of the condition
+     * Array of conditions of the badge
      */
-    description: string | null;
+    loyaltyConditions: Array<Data.LoyaltyCondition>;
 
     /**
-     * UUID of the currency (converted to lowercase)
+     * The name of the badge
      */
-    loyaltyCurrencyId: string | null;
+    name: string;
 
     /**
-     * UUID of the rule group (converted to lowercase)
+     * The date and time the badge was updated
      */
-    loyaltyRuleGroupId: string | null;
+    updatedAt: string;
 
     /**
-     * The repeat count of the condition
+     * Array of data jobs associated with the badge
      */
-    repeatCount: number | null;
+    dataJobs?: Array<Data.DataJob>;
 
     /**
-     * The required count of the condition
+     * Whether to hide this badge in the user interface
      */
-    requiredCount: number | null;
+    hideInUi?: boolean;
 
     /**
-     * The type of the condition
+     * Array of user badges
      */
-    type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
+    loyaltyBadgeUsers?: Array<Data.LoyaltyBadgeUser>;
+
+    /**
+     * Array of loyalty rules associated with the badge
+     */
+    loyaltyRules?: Array<Data.LoyaltyRule>;
+
+    /**
+     * Array of rewards granted when the badge is achieved
+     */
+    rewards?: Array<Data.Reward>;
   }
 
-  export namespace LoyaltyCondition {
-    export interface Association {
-      loyaltyBadge: Association.LoyaltyBadge | null;
+  export namespace Data {
+    /**
+     * Schema for a loyalty condition rule.
+     */
+    export interface LoyaltyCondition {
+      /**
+       * UUID of the condition (converted to lowercase)
+       */
+      id: string;
+
+      /**
+       * The amount of the condition
+       */
+      amount: number | null;
+
+      association: Array<LoyaltyCondition.Association>;
+
+      /**
+       * 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';
+
+      /**
+       * Array of CSV files associated with the condition
+       */
+      csvFiles?: Array<LoyaltyCondition.CsvFile>;
+    }
 
-      loyaltyCurrency: Association.LoyaltyCurrency | null;
+    export namespace LoyaltyCondition {
+      export interface Association {
+        loyaltyBadge: Association.LoyaltyBadge | null;
 
-      loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
+        loyaltyCurrency: Association.LoyaltyCurrency | null;
 
-      loyaltyRule: Association.LoyaltyRule | null;
+        loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
 
-      loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
-    }
+        loyaltyRule: Association.LoyaltyRule | null;
 
-    export namespace Association {
-      export interface LoyaltyBadge {
-        /**
-         * UUID of the association (converted to lowercase)
-         */
-        id: string;
+        loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
+      }
 
-        /**
-         * The name of the association
-         */
-        name: string;
+      export namespace Association {
+        export interface LoyaltyBadge {
+          /**
+           * UUID of the association (converted to lowercase)
+           */
+          id: string;
+
+          /**
+           * The name of the association
+           */
+          name: string;
+        }
+
+        export interface LoyaltyCurrency {
+          /**
+           * UUID of the association (converted to lowercase)
+           */
+          id: string;
+
+          /**
+           * The name of the association
+           */
+          name: string;
+        }
+
+        export interface LoyaltyLeaderboardView {
+          /**
+           * UUID of the association (converted to lowercase)
+           */
+          id: string;
+
+          /**
+           * The name of the association
+           */
+          name: string;
+        }
+
+        export interface LoyaltyRule {
+          /**
+           * UUID of the association (converted to lowercase)
+           */
+          id: string;
+
+          /**
+           * The name of the association
+           */
+          name: string;
+        }
+
+        export interface LoyaltyRuleGroup {
+          /**
+           * UUID of the association (converted to lowercase)
+           */
+          id: string;
+
+          /**
+           * The name of the association
+           */
+          name: string;
+        }
       }
 
-      export interface LoyaltyCurrency {
+      export interface CsvFile {
         /**
-         * UUID of the association (converted to lowercase)
+         * UUID of the CSV file (converted to lowercase)
          */
         id: string;
 
         /**
-         * The name of the association
+         * The description of the CSV file
          */
-        name: string;
-      }
+        description: string | null;
 
-      export interface LoyaltyLeaderboardView {
         /**
-         * UUID of the association (converted to lowercase)
+         * The name of the CSV file
          */
-        id: string;
+        name: string | null;
 
         /**
-         * The name of the association
+         * The URL of the CSV file
          */
-        name: string;
+        url: string | null;
       }
+    }
 
-      export interface LoyaltyRule {
-        /**
-         * UUID of the association (converted to lowercase)
-         */
-        id: string;
+    export interface DataJob {
+      /**
+       * UUID of the data job (converted to lowercase)
+       */
+      id: string;
+
+      /**
+       * The date and time the data job was created
+       */
+      createdAt: string;
+
+      /**
+       * The status of the data job
+       */
+      status: 'pending' | 'processing' | 'complete' | 'failed' | 'cancelled';
+
+      /**
+       * The date and time the data job was updated
+       */
+      updatedAt: string;
+
+      /**
+       * The message associated with the data job
+       */
+      message?: string | null;
+    }
 
-        /**
-         * The name of the association
-         */
-        name: string;
-      }
+    export interface LoyaltyBadgeUser {
+      /**
+       * UUID of the user badge (converted to lowercase)
+       */
+      id: string;
+
+      /**
+       * The date and time the user badge was created
+       */
+      createdAt: 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';
+
+      /**
+       * The date and time the user badge was updated
+       */
+      updatedAt: string;
+
+      /**
+       * UUID of the user (converted to lowercase)
+       */
+      userId: string;
+
+      /**
+       * UUID of the website (converted to lowercase)
+       */
+      websiteId: string;
+
+      /**
+       * The date and time the user badge was granted
+       */
+      completedAt?: string | null;
+
+      /**
+       * Whether the user has dismissed the badge in the UI
+       */
+      dismissedInUi?: boolean;
+
+      /**
+       * Whether to hide this badge in the user interface
+       */
+      hideInUi?: boolean;
+
+      /**
+       * Array of progress for the badge
+       */
+      progress?: unknown;
+
+      /**
+       * User associated with the user badge
+       */
+      user?: LoyaltyBadgeUser.User;
+    }
 
-      export interface LoyaltyRuleGroup {
+    export namespace LoyaltyBadgeUser {
+      /**
+       * User associated with the user badge
+       */
+      export interface User {
         /**
-         * UUID of the association (converted to lowercase)
+         * UUID of the user (converted to lowercase)
          */
         id: string;
 
         /**
-         * The name of the association
+         * Wallet address of the user
          */
-        name: string;
+        walletAddress: string;
       }
     }
-  }
 
-  export interface LoyaltyBadgeUser {
-    /**
-     * UUID of the user badge (converted to lowercase)
-     */
-    id: string;
-
-    /**
-     * UUID of the badge (converted to lowercase)
-     */
-    loyaltyBadgeId: string;
+    export interface LoyaltyRule {
+      /**
+       * UUID of the loyalty rule (converted to lowercase)
+       */
+      id: 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;
+      /**
+       * The name of the loyalty rule
+       */
+      name: string;
+    }
 
-    /**
-     * Array of progress for the badge
-     */
-    progress?: unknown;
+    export interface Reward {
+      /**
+       * UUID of the badge reward
+       */
+      id: string;
+
+      /**
+       * Points amount to reward (for points reward type)
+       */
+      amount: number | null;
+
+      /**
+       * Whether the multiplier should be applied to the user's existing balance
+       */
+      isRetroactive: boolean;
+
+      /**
+       * UUID of the loyalty currency for this reward
+       */
+      loyaltyCurrencyId: string | null;
+
+      /**
+       * Multiplier to reward (for multiplier reward type)
+       */
+      multiplier: number | null;
+
+      /**
+       * Type of reward (points or multiplier)
+       */
+      rewardType: 'points' | 'multiplier' | 'badge';
+
+      /**
+       * Array of loyalty currency IDs for multiplier rewards (empty means all
+       * currencies)
+       */
+      loyaltyCurrencyIds?: Array<string>;
+    }
   }
 }
 
@@ -710,6 +1308,11 @@ export interface BadgeDeleteResponse {
    */
   id: string;
 
+  /**
+   * The date and time the badge was created
+   */
+  createdAt: string;
+
   /**
    * The description of the badge
    */
@@ -730,10 +1333,35 @@ export interface BadgeDeleteResponse {
    */
   name: string;
 
+  /**
+   * The date and time the badge was updated
+   */
+  updatedAt: string;
+
+  /**
+   * Array of data jobs associated with the badge
+   */
+  dataJobs?: Array<BadgeDeleteResponse.DataJob>;
+
+  /**
+   * Whether to hide this badge in the user interface
+   */
+  hideInUi?: boolean;
+
   /**
    * Array of user badges
    */
-  LoyaltyBadgeUser?: Array<BadgeDeleteResponse.LoyaltyBadgeUser>;
+  loyaltyBadgeUsers?: Array<BadgeDeleteResponse.LoyaltyBadgeUser>;
+
+  /**
+   * Array of loyalty rules associated with the badge
+   */
+  loyaltyRules?: Array<BadgeDeleteResponse.LoyaltyRule>;
+
+  /**
+   * Array of rewards granted when the badge is achieved
+   */
+  rewards?: Array<BadgeDeleteResponse.Reward>;
 }
 
 export namespace BadgeDeleteResponse {
@@ -754,7 +1382,7 @@ export namespace BadgeDeleteResponse {
     association: Array<LoyaltyCondition.Association>;
 
     /**
-     * The URL of the CSV file
+     * URL of the CSV file
      */
     csvUrl: string | null;
 
@@ -787,6 +1415,11 @@ export namespace BadgeDeleteResponse {
      * The type of the condition
      */
     type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
+
+    /**
+     * Array of CSV files associated with the condition
+     */
+    csvFiles?: Array<LoyaltyCondition.CsvFile>;
   }
 
   export namespace LoyaltyCondition {
@@ -863,6 +1496,55 @@ export namespace BadgeDeleteResponse {
         name: string;
       }
     }
+
+    export interface CsvFile {
+      /**
+       * UUID of the CSV file (converted to lowercase)
+       */
+      id: string;
+
+      /**
+       * The description of the CSV file
+       */
+      description: string | null;
+
+      /**
+       * The name of the CSV file
+       */
+      name: string | null;
+
+      /**
+       * The URL of the CSV file
+       */
+      url: string | null;
+    }
+  }
+
+  export interface DataJob {
+    /**
+     * UUID of the data job (converted to lowercase)
+     */
+    id: string;
+
+    /**
+     * The date and time the data job was created
+     */
+    createdAt: string;
+
+    /**
+     * The status of the data job
+     */
+    status: 'pending' | 'processing' | 'complete' | 'failed' | 'cancelled';
+
+    /**
+     * The date and time the data job was updated
+     */
+    updatedAt: string;
+
+    /**
+     * The message associated with the data job
+     */
+    message?: string | null;
   }
 
   export interface LoyaltyBadgeUser {
@@ -871,6 +1553,11 @@ export namespace BadgeDeleteResponse {
      */
     id: string;
 
+    /**
+     * The date and time the user badge was created
+     */
+    createdAt: string;
+
     /**
      * UUID of the badge (converted to lowercase)
      */
@@ -886,6 +1573,11 @@ export namespace BadgeDeleteResponse {
      */
     status: 'active' | 'inactive' | 'revoked';
 
+    /**
+     * The date and time the user badge was updated
+     */
+    updatedAt: string;
+
     /**
      * UUID of the user (converted to lowercase)
      */
@@ -896,10 +1588,97 @@ export namespace BadgeDeleteResponse {
      */
     websiteId: string;
 
+    /**
+     * The date and time the user badge was granted
+     */
+    completedAt?: string | null;
+
+    /**
+     * Whether the user has dismissed the badge in the UI
+     */
+    dismissedInUi?: boolean;
+
+    /**
+     * Whether to hide this badge in the user interface
+     */
+    hideInUi?: boolean;
+
     /**
      * Array of progress for the badge
      */
     progress?: unknown;
+
+    /**
+     * User associated with the user badge
+     */
+    user?: LoyaltyBadgeUser.User;
+  }
+
+  export namespace LoyaltyBadgeUser {
+    /**
+     * User associated with the user badge
+     */
+    export interface User {
+      /**
+       * UUID of the user (converted to lowercase)
+       */
+      id: string;
+
+      /**
+       * Wallet address of the user
+       */
+      walletAddress: string;
+    }
+  }
+
+  export interface LoyaltyRule {
+    /**
+     * UUID of the loyalty rule (converted to lowercase)
+     */
+    id: string;
+
+    /**
+     * The name of the loyalty rule
+     */
+    name: string;
+  }
+
+  export interface Reward {
+    /**
+     * UUID of the badge reward
+     */
+    id: string;
+
+    /**
+     * Points amount to reward (for points reward type)
+     */
+    amount: number | null;
+
+    /**
+     * Whether the multiplier should be applied to the user's existing balance
+     */
+    isRetroactive: boolean;
+
+    /**
+     * UUID of the loyalty currency for this reward
+     */
+    loyaltyCurrencyId: string | null;
+
+    /**
+     * Multiplier to reward (for multiplier reward type)
+     */
+    multiplier: number | null;
+
+    /**
+     * Type of reward (points or multiplier)
+     */
+    rewardType: 'points' | 'multiplier' | 'badge';
+
+    /**
+     * Array of loyalty currency IDs for multiplier rewards (empty means all
+     * currencies)
+     */
+    loyaltyCurrencyIds?: Array<string>;
   }
 }
 
@@ -952,6 +1731,11 @@ export namespace BadgeRewardResponse {
 }
 
 export interface BadgeCreateParams {
+  /**
+   * Array of conditions for the badge
+   */
+  conditions: Array<BadgeCreateParams.Condition>;
+
   /**
    * The URL of the badge image
    */
@@ -967,29 +1751,31 @@ export interface BadgeCreateParams {
    */
   organizationId: string;
 
-  /**
-   * Array of rules for the badge
-   */
-  rules: Array<BadgeCreateParams.Rule>;
-
   /**
    * UUID of the website (optional, converted to lowercase)
    */
   websiteId: string;
 
+  csvFiles?: Array<BadgeCreateParams.CsvFile>;
+
   /**
    * The description of the badge
    */
   description?: string;
+
+  /**
+   * Whether to hide this badge in the user interface
+   */
+  hideInUi?: boolean;
+
+  /**
+   * Array of rewards granted when the badge is achieved
+   */
+  rewards?: Array<BadgeCreateParams.Reward>;
 }
 
 export namespace BadgeCreateParams {
-  export interface Rule {
-    /**
-     * The type of rule
-     */
-    type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
-
+  export interface Condition {
     /**
      * The amount of the rule
      */
@@ -1023,7 +1809,7 @@ export namespace BadgeCreateParams {
     /**
      * UUID of the loyalty rule chain (optional, converted to lowercase)
      */
-    loyaltyRuleChainId?: string;
+    loyaltyRuleChainId?: string | null;
 
     /**
      * Array of UUIDs of the rule group (optional, converted to lowercase)
@@ -1044,15 +1830,68 @@ export namespace BadgeCreateParams {
      * The number of rules that need to be fulfilled to satisfy the condition
      */
     requiredCount?: number | null;
+
+    /**
+     * The type of rule
+     */
+    type?: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
+  }
+
+  export interface CsvFile {
+    src: string;
+
+    description?: string;
+
+    name?: string;
+  }
+
+  export interface Reward {
+    /**
+     * Type of reward (points or multiplier)
+     */
+    rewardType: 'points' | 'multiplier' | 'badge';
+
+    /**
+     * Points amount to reward (for points reward type)
+     */
+    amount?: number;
+
+    /**
+     * Whether the multiplier should be applied to the user's existing balance
+     */
+    isRetroactive?: boolean;
+
+    /**
+     * UUID of the loyalty currency for this reward
+     */
+    loyaltyCurrencyId?: string;
+
+    /**
+     * Array of loyalty currency IDs for multiplier rewards (empty means all
+     * currencies)
+     */
+    loyaltyCurrencyIds?: Array<string>;
+
+    /**
+     * Multiplier to reward (for multiplier reward type)
+     */
+    multiplier?: number;
   }
 }
 
 export interface BadgeUpdateParams {
+  csvFiles?: Array<BadgeUpdateParams.CsvFile>;
+
   /**
    * The description of the badge
    */
   description?: string;
 
+  /**
+   * Whether to hide this badge in the user interface
+   */
+  hideInUi?: boolean;
+
   /**
    * The URL of the badge image
    */
@@ -1062,18 +1901,66 @@ export interface BadgeUpdateParams {
    * The name of the badge
    */
   name?: string;
+
+  /**
+   * Array of rewards granted when the badge is achieved
+   */
+  rewards?: Array<BadgeUpdateParams.Reward>;
+}
+
+export namespace BadgeUpdateParams {
+  export interface CsvFile {
+    src: string;
+
+    description?: string;
+
+    name?: string;
+  }
+
+  export interface Reward {
+    /**
+     * Type of reward (points or multiplier)
+     */
+    rewardType: 'points' | 'multiplier' | 'badge';
+
+    /**
+     * Points amount to reward (for points reward type)
+     */
+    amount?: number;
+
+    /**
+     * Whether the multiplier should be applied to the user's existing balance
+     */
+    isRetroactive?: boolean;
+
+    /**
+     * UUID of the loyalty currency for this reward
+     */
+    loyaltyCurrencyId?: string;
+
+    /**
+     * Array of loyalty currency IDs for multiplier rewards (empty means all
+     * currencies)
+     */
+    loyaltyCurrencyIds?: Array<string>;
+
+    /**
+     * Multiplier to reward (for multiplier reward type)
+     */
+    multiplier?: number;
+  }
 }
 
 export interface BadgeListParams {
   /**
    * Array of badge IDs (converted to lowercase) to fetch
    */
-  badgeIds?: Array<string>;
+  badgeIds?: string | Array<string>;
 
   /**
    * Include deleted badges in the response
    */
-  includeDeleted?: boolean | null;
+  includeDeleted?: boolean;
 
   /**
    * Number of badges to fetch
@@ -1091,9 +1978,24 @@ export interface BadgeListParams {
   startingAfter?: string;
 
   /**
-   * UUID of the user (optional, converted to lowercase)
+   * External identifier of the user group
    */
-  userId?: string;
+  userGroupExternalIdentifier?: string;
+
+  /**
+   * UUID of the user group
+   */
+  userGroupId?: string;
+
+  /**
+   * UUID of the user, or array of UUID.
+   */
+  userId?: string | Array<string>;
+
+  /**
+   * Wallet Address of the user, or array of wallet addresses.
+   */
+  walletAddress?: string | Array<string>;
 
   /**
    * UUID of the website (optional, converted to lowercase)
@@ -1102,6 +2004,11 @@ export interface BadgeListParams {
 }
 
 export interface BadgeRevokeParams {
+  /**
+   * Status of the badge
+   */
+  status?: 'active' | 'inactive' | 'revoked';
+
   /**
    * UUID of the user (converted to lowercase)
    */
@@ -1114,6 +2021,11 @@ export interface BadgeRevokeParams {
 }
 
 export interface BadgeRewardParams {
+  /**
+   * Status of the badge
+   */
+  status?: 'active' | 'inactive' | 'revoked';
+
   /**
    * UUID of the user (converted to lowercase)
    */