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

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,
@@ -99,118 +143,1132 @@ export 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 data jobs associated with the badge
+   */
+  dataJobs?: Array<BadgeCreateResponse.DataJob>;
+
+  /**
+   * Array of user badges
+   */
+  loyaltyBadgeUsers?: Array<BadgeCreateResponse.LoyaltyBadgeUser>;
+
+  /**
+   * Array of loyalty rules associated with the badge
+   */
+  loyaltyRules?: Array<BadgeCreateResponse.LoyaltyRule>;
 }
 
-/**
- * Response returned upon successful update of the badge.
- */
-export interface BadgeUpdateResponse {
-  id: string;
-}
+export namespace BadgeCreateResponse {
+  /**
+   * 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>;
+
+    /**
+     * 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';
+  }
+
+  export namespace LoyaltyCondition {
+    export interface Association {
+      loyaltyBadge: Association.LoyaltyBadge | null;
+
+      loyaltyCurrency: Association.LoyaltyCurrency | null;
+
+      loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
+
+      loyaltyRule: Association.LoyaltyRule | null;
+
+      loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
+    }
+
+    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 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' | 'complete' | 'failed';
+
+    /**
+     * The date and time the data job was updated
+     */
+    updatedAt: string;
+
+    /**
+     * The message associated with the data job
+     */
+    message?: string | null;
+  }
+
+  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;
+
+    /**
+     * 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;
+  }
+}
+
+/**
+ * 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 data jobs associated with the badge
+   */
+  dataJobs?: Array<BadgeUpdateResponse.DataJob>;
+
+  /**
+   * Array of user badges
+   */
+  loyaltyBadgeUsers?: Array<BadgeUpdateResponse.LoyaltyBadgeUser>;
+
+  /**
+   * Array of loyalty rules associated with the badge
+   */
+  loyaltyRules?: Array<BadgeUpdateResponse.LoyaltyRule>;
+}
+
+export namespace BadgeUpdateResponse {
+  /**
+   * 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>;
+
+    /**
+     * 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';
+  }
+
+  export namespace LoyaltyCondition {
+    export interface Association {
+      loyaltyBadge: Association.LoyaltyBadge | null;
+
+      loyaltyCurrency: Association.LoyaltyCurrency | null;
+
+      loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
+
+      loyaltyRule: Association.LoyaltyRule | null;
+
+      loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
+    }
+
+    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 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' | 'complete' | 'failed';
+
+    /**
+     * The date and time the data job was updated
+     */
+    updatedAt: string;
+
+    /**
+     * The message associated with the data job
+     */
+    message?: string | null;
+  }
+
+  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;
+
+    /**
+     * 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;
+  }
+}
+
+/**
+ * Response returned upon successful fetching of the badges.
+ */
+export interface BadgeListResponse {
+  /**
+   * 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 data jobs associated with the badge
+   */
+  dataJobs?: Array<BadgeListResponse.DataJob>;
+
+  /**
+   * Array of user badges
+   */
+  loyaltyBadgeUsers?: Array<BadgeListResponse.LoyaltyBadgeUser>;
+
+  /**
+   * Array of loyalty rules associated with the badge
+   */
+  loyaltyRules?: Array<BadgeListResponse.LoyaltyRule>;
+}
+
+export namespace BadgeListResponse {
+  /**
+   * 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>;
+
+    /**
+     * 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';
+  }
+
+  export namespace LoyaltyCondition {
+    export interface Association {
+      loyaltyBadge: Association.LoyaltyBadge | null;
+
+      loyaltyCurrency: Association.LoyaltyCurrency | null;
+
+      loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
+
+      loyaltyRule: Association.LoyaltyRule | null;
+
+      loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
+    }
 
-/**
- * Response returned upon successful fetching of the badges.
- */
-export interface BadgeListResponse {
-  badges: Array<BadgeListResponse.Badge>;
-}
+    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 namespace BadgeListResponse {
-  export interface Badge {
+  export interface DataJob {
     /**
-     * UUID of the badge (converted to lowercase)
+     * UUID of the data job (converted to lowercase)
      */
     id: string;
 
     /**
-     * Count of rules and accounts with the badge
+     * The date and time the data job was created
      */
-    _count: Badge._Count;
+    createdAt: string;
 
     /**
-     * The URL of the badge image
+     * The status of the data job
      */
-    imageUrl: string;
+    status: 'pending' | 'complete' | 'failed';
 
     /**
-     * Array of rules for the badge
+     * The date and time the data job was updated
      */
-    loyaltyConditions: Array<Badge.LoyaltyCondition>;
+    updatedAt: string;
 
     /**
-     * The name of the badge
+     * The message associated with the data job
      */
-    name: string;
+    message?: string | null;
+  }
 
+  export interface LoyaltyBadgeUser {
     /**
-     * The description of the badge
+     * UUID of the user badge (converted to lowercase)
      */
-    description?: string;
-  }
+    id: string;
 
-  export namespace Badge {
     /**
-     * Count of rules and accounts with the badge
+     * The date and time the user badge was created
      */
-    export interface _Count {
-      /**
-       * The number of accounts with the badge
-       */
-      LoyaltyBadgeUser: number;
+    createdAt: string;
 
-      /**
-       * The number of rules
-       */
-      loyaltyConditions: number;
-    }
+    /**
+     * UUID of the badge (converted to lowercase)
+     */
+    loyaltyBadgeId: string;
 
-    export interface LoyaltyCondition {
-      /**
-       * UUID of the rule (converted to lowercase)
-       */
-      id: string;
+    /**
+     * UUID of the organization (converted to lowercase)
+     */
+    organizationId: string;
 
-      /**
-       * The type of rule
-       */
-      type: 'rule' | 'section' | 'level' | 'points' | 'api' | 'badge';
+    /**
+     * The status of the badge
+     */
+    status: 'active' | 'inactive' | 'revoked';
 
-      /**
-       * The amount of the rule
-       */
-      amount?: number;
+    /**
+     * The date and time the user badge was updated
+     */
+    updatedAt: string;
 
-      /**
-       * The description of the rule
-       */
-      description?: string;
+    /**
+     * UUID of the user (converted to lowercase)
+     */
+    userId: string;
 
-      /**
-       * UUID of the currency (optional, converted to lowercase)
-       */
-      loyaltyCurrencyId?: string;
+    /**
+     * UUID of the website (converted to lowercase)
+     */
+    websiteId: string;
+
+    /**
+     * 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 rule group (optional, converted to lowercase)
+       * UUID of the user (converted to lowercase)
        */
-      loyaltyRuleGroupId?: string;
+      id: string;
 
       /**
-       * UUID of the rule (optional, converted to lowercase)
+       * Wallet address of the user
        */
-      loyaltyRuleId?: string;
+      walletAddress: string;
     }
   }
+
+  export interface LoyaltyRule {
+    /**
+     * UUID of the loyalty rule (converted to lowercase)
+     */
+    id: string;
+
+    /**
+     * The name of the loyalty rule
+     */
+    name: string;
+  }
 }
 
 /**
  * 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 data jobs associated with the badge
+   */
+  dataJobs?: Array<BadgeDeleteResponse.DataJob>;
+
+  /**
+   * Array of user badges
+   */
+  loyaltyBadgeUsers?: Array<BadgeDeleteResponse.LoyaltyBadgeUser>;
+
+  /**
+   * Array of loyalty rules associated with the badge
+   */
+  loyaltyRules?: Array<BadgeDeleteResponse.LoyaltyRule>;
+}
+
+export namespace BadgeDeleteResponse {
+  /**
+   * 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>;
+
+    /**
+     * 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';
+  }
+
+  export namespace LoyaltyCondition {
+    export interface Association {
+      loyaltyBadge: Association.LoyaltyBadge | null;
+
+      loyaltyCurrency: Association.LoyaltyCurrency | null;
+
+      loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
+
+      loyaltyRule: Association.LoyaltyRule | null;
+
+      loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
+    }
+
+    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 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' | 'complete' | 'failed';
+
+    /**
+     * The date and time the data job was updated
+     */
+    updatedAt: string;
+
+    /**
+     * The message associated with the data job
+     */
+    message?: string | null;
+  }
+
+  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;
+
+    /**
+     * 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;
+  }
 }
 
 /**
@@ -262,6 +1320,11 @@ export namespace BadgeRewardResponse {
 }
 
 export interface BadgeCreateParams {
+  /**
+   * Array of conditions for the badge
+   */
+  conditions: Array<BadgeCreateParams.Condition>;
+
   /**
    * The URL of the badge image
    */
@@ -277,11 +1340,6 @@ export interface BadgeCreateParams {
    */
   organizationId: string;
 
-  /**
-   * Array of rules for the badge
-   */
-  rules: Array<BadgeCreateParams.Rule>;
-
   /**
    * UUID of the website (optional, converted to lowercase)
    */
@@ -294,49 +1352,66 @@ export interface BadgeCreateParams {
 }
 
 export namespace BadgeCreateParams {
-  /**
-   * Schema for a loyalty condition rule.
-   */
-  export interface Rule {
+  export interface Condition {
     /**
-     * The type of rule
+     * The amount of the rule
      */
-    type: 'rule' | 'section' | 'level' | 'points' | 'api' | 'badge';
+    amount?: number | null;
 
     /**
-     * The amount of the rule
+     * URL of the CSV file (optional)
      */
-    amount?: number | null;
+    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>;
+
+    /**
+     * Array of UUIDs of the Loyalty Leaderboard (optional, converted to lowercase)
+     */
+    loyaltyLeaderboardViewIds?: Array<string>;
 
     /**
-     * UUID of the badge (optional, converted to lowercase)
+     * UUID of the loyalty rule chain (optional, converted to lowercase)
      */
-    loyaltyBadgeId?: string | null;
+    loyaltyRuleChainId?: 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
+     */
+    requiredCount?: number | null;
+
+    /**
+     * The type of rule
      */
-    loyaltyRuleId?: string | null;
+    type?: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
   }
 }
 
@@ -371,7 +1446,7 @@ export interface BadgeListParams {
   /**
    * Number of badges to fetch
    */
-  limit?: number | null;
+  limit?: number;
 
   /**
    * UUID of the organization (optional, converted to lowercase)
@@ -384,9 +1459,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)
@@ -395,6 +1485,11 @@ export interface BadgeListParams {
 }
 
 export interface BadgeRevokeParams {
+  /**
+   * Status of the badge
+   */
+  status?: 'active' | 'inactive' | 'revoked';
+
   /**
    * UUID of the user (converted to lowercase)
    */
@@ -407,6 +1502,11 @@ export interface BadgeRevokeParams {
 }
 
 export interface BadgeRewardParams {
+  /**
+   * Status of the badge
+   */
+  status?: 'active' | 'inactive' | 'revoked';
+
   /**
    * UUID of the user (converted to lowercase)
    */