@snagsolutions/sdk 0.1.0-alpha.18 → 0.1.0-alpha.180

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,25 @@ 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>;
+
   /**
    * Array of user badges
    */
-  LoyaltyBadgeUser?: Array<BadgeCreateResponse.LoyaltyBadgeUser>;
+  loyaltyBadgeUsers?: Array<BadgeCreateResponse.LoyaltyBadgeUser>;
+
+  /**
+   * Array of loyalty rules associated with the badge
+   */
+  loyaltyRules?: Array<BadgeCreateResponse.LoyaltyRule>;
 }
 
 export namespace BadgeCreateResponse {
@@ -148,7 +212,7 @@ export namespace BadgeCreateResponse {
     association: Array<LoyaltyCondition.Association>;
 
     /**
-     * The URL of the CSV file
+     * URL of the CSV file
      */
     csvUrl: string | null;
 
@@ -181,6 +245,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 +326,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' | '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 {
@@ -265,6 +383,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 +403,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 +418,49 @@ export namespace BadgeCreateResponse {
      */
     websiteId: string;
 
+    /**
+     * Whether the user has dismissed the badge in the UI
+     */
+    dismissedInUi?: 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;
   }
 }
 
@@ -306,6 +473,11 @@ export interface BadgeUpdateResponse {
    */
   id: string;
 
+  /**
+   * The date and time the badge was created
+   */
+  createdAt: string;
+
   /**
    * The description of the badge
    */
@@ -326,10 +498,25 @@ 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>;
+
   /**
    * Array of user badges
    */
-  LoyaltyBadgeUser?: Array<BadgeUpdateResponse.LoyaltyBadgeUser>;
+  loyaltyBadgeUsers?: Array<BadgeUpdateResponse.LoyaltyBadgeUser>;
+
+  /**
+   * Array of loyalty rules associated with the badge
+   */
+  loyaltyRules?: Array<BadgeUpdateResponse.LoyaltyRule>;
 }
 
 export namespace BadgeUpdateResponse {
@@ -350,7 +537,7 @@ export namespace BadgeUpdateResponse {
     association: Array<LoyaltyCondition.Association>;
 
     /**
-     * The URL of the CSV file
+     * URL of the CSV file
      */
     csvUrl: string | null;
 
@@ -383,6 +570,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 +651,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' | '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 {
@@ -467,6 +708,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 +728,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,10 +743,49 @@ export namespace BadgeUpdateResponse {
      */
     websiteId: string;
 
+    /**
+     * Whether the user has dismissed the badge in the UI
+     */
+    dismissedInUi?: 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;
   }
 }
 
@@ -508,6 +798,11 @@ export interface BadgeListResponse {
    */
   id: string;
 
+  /**
+   * The date and time the badge was created
+   */
+  createdAt: string;
+
   /**
    * The description of the badge
    */
@@ -528,10 +823,25 @@ export interface BadgeListResponse {
    */
   name: string;
 
+  /**
+   * The date and time the badge was updated
+   */
+  updatedAt: string;
+
+  /**
+   * Array of data jobs associated with the badge
+   */
+  dataJobs?: Array<BadgeListResponse.DataJob>;
+
   /**
    * Array of user badges
    */
-  LoyaltyBadgeUser?: Array<BadgeListResponse.LoyaltyBadgeUser>;
+  loyaltyBadgeUsers?: Array<BadgeListResponse.LoyaltyBadgeUser>;
+
+  /**
+   * Array of loyalty rules associated with the badge
+   */
+  loyaltyRules?: Array<BadgeListResponse.LoyaltyRule>;
 }
 
 export namespace BadgeListResponse {
@@ -552,7 +862,7 @@ export namespace BadgeListResponse {
     association: Array<LoyaltyCondition.Association>;
 
     /**
-     * The URL of the CSV file
+     * URL of the CSV file
      */
     csvUrl: string | null;
 
@@ -585,6 +895,11 @@ export namespace BadgeListResponse {
      * 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 {
@@ -661,6 +976,55 @@ export namespace BadgeListResponse {
         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' | '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 {
@@ -669,6 +1033,11 @@ export namespace BadgeListResponse {
      */
     id: string;
 
+    /**
+     * The date and time the user badge was created
+     */
+    createdAt: string;
+
     /**
      * UUID of the badge (converted to lowercase)
      */
@@ -684,6 +1053,11 @@ export namespace BadgeListResponse {
      */
     status: 'active' | 'inactive' | 'revoked';
 
+    /**
+     * The date and time the user badge was updated
+     */
+    updatedAt: string;
+
     /**
      * UUID of the user (converted to lowercase)
      */
@@ -694,10 +1068,49 @@ export namespace BadgeListResponse {
      */
     websiteId: string;
 
+    /**
+     * Whether the user has dismissed the badge in the UI
+     */
+    dismissedInUi?: 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;
   }
 }
 
@@ -710,6 +1123,11 @@ export interface BadgeDeleteResponse {
    */
   id: string;
 
+  /**
+   * The date and time the badge was created
+   */
+  createdAt: string;
+
   /**
    * The description of the badge
    */
@@ -730,10 +1148,25 @@ 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>;
+
   /**
    * Array of user badges
    */
-  LoyaltyBadgeUser?: Array<BadgeDeleteResponse.LoyaltyBadgeUser>;
+  loyaltyBadgeUsers?: Array<BadgeDeleteResponse.LoyaltyBadgeUser>;
+
+  /**
+   * Array of loyalty rules associated with the badge
+   */
+  loyaltyRules?: Array<BadgeDeleteResponse.LoyaltyRule>;
 }
 
 export namespace BadgeDeleteResponse {
@@ -754,7 +1187,7 @@ export namespace BadgeDeleteResponse {
     association: Array<LoyaltyCondition.Association>;
 
     /**
-     * The URL of the CSV file
+     * URL of the CSV file
      */
     csvUrl: string | null;
 
@@ -787,6 +1220,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 +1301,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' | '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 {
@@ -871,6 +1358,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 +1378,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 +1393,49 @@ export namespace BadgeDeleteResponse {
      */
     websiteId: string;
 
+    /**
+     * Whether the user has dismissed the badge in the UI
+     */
+    dismissedInUi?: 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;
   }
 }
 
@@ -952,6 +1488,11 @@ export namespace BadgeRewardResponse {
 }
 
 export interface BadgeCreateParams {
+  /**
+   * Array of conditions for the badge
+   */
+  conditions: Array<BadgeCreateParams.Condition>;
+
   /**
    * The URL of the badge image
    */
@@ -967,16 +1508,13 @@ 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
    */
@@ -984,12 +1522,7 @@ export interface BadgeCreateParams {
 }
 
 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 +1556,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,10 +1577,25 @@ 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 BadgeUpdateParams {
+  csvFiles?: Array<BadgeUpdateParams.CsvFile>;
+
   /**
    * The description of the badge
    */
@@ -1064,11 +1612,21 @@ export interface BadgeUpdateParams {
   name?: string;
 }
 
+export namespace BadgeUpdateParams {
+  export interface CsvFile {
+    src: string;
+
+    description?: string;
+
+    name?: string;
+  }
+}
+
 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
@@ -1091,9 +1649,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 +1675,11 @@ export interface BadgeListParams {
 }
 
 export interface BadgeRevokeParams {
+  /**
+   * Status of the badge
+   */
+  status?: 'active' | 'inactive' | 'revoked';
+
   /**
    * UUID of the user (converted to lowercase)
    */
@@ -1114,6 +1692,11 @@ export interface BadgeRevokeParams {
 }
 
 export interface BadgeRewardParams {
+  /**
+   * Status of the badge
+   */
+  status?: 'active' | 'inactive' | 'revoked';
+
   /**
    * UUID of the user (converted to lowercase)
    */