@snagsolutions/sdk 0.1.0-alpha.16 → 0.1.0-alpha.161

package/resources/loyalty/badges.d.ts

@@ -2,30 +2,74 @@ import { APIResource } from "../../resource.js";
 import * as Core from "../../core.js";
 export declare 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>;
     /**
      * 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, body?: BadgeUpdateParams, options?: Core.RequestOptions): Core.APIPromise<BadgeUpdateResponse>;
     update(id: string, options?: Core.RequestOptions): Core.APIPromise<BadgeUpdateResponse>;
     /**
      * 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>;
     /**
      * 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>;
     /**
      * 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, body?: BadgeRevokeParams, options?: Core.RequestOptions): Core.APIPromise<BadgeRevokeResponse>;
     revoke(id: string, options?: Core.RequestOptions): Core.APIPromise<BadgeRevokeResponse>;
     /**
      * 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, body?: BadgeRewardParams, options?: Core.RequestOptions): Core.APIPromise<BadgeRewardResponse>;
     reward(id: string, options?: Core.RequestOptions): Core.APIPromise<BadgeRewardResponse>;
@@ -54,10 +98,18 @@ export interface BadgeCreateResponse {
      * The name of the badge
      */
     name: 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 declare namespace BadgeCreateResponse {
     /**
@@ -74,7 +126,7 @@ export declare namespace BadgeCreateResponse {
         amount: number | null;
         association: Array<LoyaltyCondition.Association>;
         /**
-         * The URL of the CSV file
+         * URL of the CSV file
          */
         csvUrl: string | null;
         /**
@@ -101,6 +153,10 @@ export declare 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>;
     }
     namespace LoyaltyCondition {
         interface Association {
@@ -162,12 +218,56 @@ export declare namespace BadgeCreateResponse {
                 name: string;
             }
         }
+        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;
+        }
+    }
+    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;
     }
     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)
          */
@@ -180,6 +280,10 @@ export declare namespace BadgeCreateResponse {
          * 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)
          */
@@ -188,10 +292,43 @@ export declare namespace BadgeCreateResponse {
          * UUID of the website (converted to lowercase)
          */
         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;
+    }
+    namespace LoyaltyBadgeUser {
+        /**
+         * User associated with the user badge
+         */
+        interface User {
+            /**
+             * UUID of the user (converted to lowercase)
+             */
+            id: string;
+            /**
+             * Wallet address of the user
+             */
+            walletAddress: string;
+        }
+    }
+    interface LoyaltyRule {
+        /**
+         * UUID of the loyalty rule (converted to lowercase)
+         */
+        id: string;
+        /**
+         * The name of the loyalty rule
+         */
+        name: string;
     }
 }
 /**
@@ -218,10 +355,18 @@ export interface BadgeUpdateResponse {
      * The name of the badge
      */
     name: 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 declare namespace BadgeUpdateResponse {
     /**
@@ -238,7 +383,7 @@ export declare namespace BadgeUpdateResponse {
         amount: number | null;
         association: Array<LoyaltyCondition.Association>;
         /**
-         * The URL of the CSV file
+         * URL of the CSV file
          */
         csvUrl: string | null;
         /**
@@ -265,6 +410,10 @@ export declare 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>;
     }
     namespace LoyaltyCondition {
         interface Association {
@@ -326,12 +475,56 @@ export declare namespace BadgeUpdateResponse {
                 name: string;
             }
         }
+        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;
+        }
+    }
+    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;
     }
     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)
          */
@@ -344,6 +537,10 @@ export declare namespace BadgeUpdateResponse {
          * 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)
          */
@@ -352,10 +549,43 @@ export declare namespace BadgeUpdateResponse {
          * UUID of the website (converted to lowercase)
          */
         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;
+    }
+    namespace LoyaltyBadgeUser {
+        /**
+         * User associated with the user badge
+         */
+        interface User {
+            /**
+             * UUID of the user (converted to lowercase)
+             */
+            id: string;
+            /**
+             * Wallet address of the user
+             */
+            walletAddress: string;
+        }
+    }
+    interface LoyaltyRule {
+        /**
+         * UUID of the loyalty rule (converted to lowercase)
+         */
+        id: string;
+        /**
+         * The name of the loyalty rule
+         */
+        name: string;
     }
 }
 /**
@@ -382,10 +612,18 @@ export interface BadgeListResponse {
      * The name of the badge
      */
     name: 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 declare namespace BadgeListResponse {
     /**
@@ -402,7 +640,7 @@ export declare namespace BadgeListResponse {
         amount: number | null;
         association: Array<LoyaltyCondition.Association>;
         /**
-         * The URL of the CSV file
+         * URL of the CSV file
          */
         csvUrl: string | null;
         /**
@@ -429,6 +667,10 @@ export declare 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>;
     }
     namespace LoyaltyCondition {
         interface Association {
@@ -490,12 +732,56 @@ export declare namespace BadgeListResponse {
                 name: string;
             }
         }
+        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;
+        }
+    }
+    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;
     }
     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)
          */
@@ -508,6 +794,10 @@ export declare namespace BadgeListResponse {
          * 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)
          */
@@ -516,10 +806,43 @@ export declare namespace BadgeListResponse {
          * UUID of the website (converted to lowercase)
          */
         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;
+    }
+    namespace LoyaltyBadgeUser {
+        /**
+         * User associated with the user badge
+         */
+        interface User {
+            /**
+             * UUID of the user (converted to lowercase)
+             */
+            id: string;
+            /**
+             * Wallet address of the user
+             */
+            walletAddress: string;
+        }
+    }
+    interface LoyaltyRule {
+        /**
+         * UUID of the loyalty rule (converted to lowercase)
+         */
+        id: string;
+        /**
+         * The name of the loyalty rule
+         */
+        name: string;
     }
 }
 /**
@@ -546,10 +869,18 @@ export interface BadgeDeleteResponse {
      * The name of the badge
      */
     name: 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 declare namespace BadgeDeleteResponse {
     /**
@@ -566,7 +897,7 @@ export declare namespace BadgeDeleteResponse {
         amount: number | null;
         association: Array<LoyaltyCondition.Association>;
         /**
-         * The URL of the CSV file
+         * URL of the CSV file
          */
         csvUrl: string | null;
         /**
@@ -593,6 +924,10 @@ export declare 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>;
     }
     namespace LoyaltyCondition {
         interface Association {
@@ -654,12 +989,56 @@ export declare namespace BadgeDeleteResponse {
                 name: string;
             }
         }
+        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;
+        }
+    }
+    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;
     }
     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)
          */
@@ -672,6 +1051,10 @@ export declare namespace BadgeDeleteResponse {
          * 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)
          */
@@ -680,10 +1063,43 @@ export declare namespace BadgeDeleteResponse {
          * UUID of the website (converted to lowercase)
          */
         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;
+    }
+    namespace LoyaltyBadgeUser {
+        /**
+         * User associated with the user badge
+         */
+        interface User {
+            /**
+             * UUID of the user (converted to lowercase)
+             */
+            id: string;
+            /**
+             * Wallet address of the user
+             */
+            walletAddress: string;
+        }
+    }
+    interface LoyaltyRule {
+        /**
+         * UUID of the loyalty rule (converted to lowercase)
+         */
+        id: string;
+        /**
+         * The name of the loyalty rule
+         */
+        name: string;
     }
 }
 /**
@@ -723,6 +1139,10 @@ export declare namespace BadgeRewardResponse {
     }
 }
 export interface BadgeCreateParams {
+    /**
+     * Array of conditions for the badge
+     */
+    conditions: Array<BadgeCreateParams.Condition>;
     /**
      * The URL of the badge image
      */
@@ -735,25 +1155,18 @@ export interface BadgeCreateParams {
      * UUID of the organization (optional, converted to lowercase)
      */
     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;
 }
 export declare namespace BadgeCreateParams {
-    interface Rule {
-        /**
-         * The type of rule
-         */
-        type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
+    interface Condition {
         /**
          * The amount of the rule
          */
@@ -781,7 +1194,7 @@ export declare 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)
          */
@@ -798,9 +1211,19 @@ export declare 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';
+    }
+    interface CsvFile {
+        src: string;
+        description?: string;
+        name?: string;
     }
 }
 export interface BadgeUpdateParams {
+    csvFiles?: Array<BadgeUpdateParams.CsvFile>;
     /**
      * The description of the badge
      */
@@ -814,11 +1237,18 @@ export interface BadgeUpdateParams {
      */
     name?: string;
 }
+export declare namespace BadgeUpdateParams {
+    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
      */
@@ -836,15 +1266,31 @@ 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)
      */
     websiteId?: string;
 }
 export interface BadgeRevokeParams {
+    /**
+     * Status of the badge
+     */
+    status?: 'active' | 'inactive' | 'revoked';
     /**
      * UUID of the user (converted to lowercase)
      */
@@ -855,6 +1301,10 @@ export interface BadgeRevokeParams {
     walletAddress?: string;
 }
 export interface BadgeRewardParams {
+    /**
+     * Status of the badge
+     */
+    status?: 'active' | 'inactive' | 'revoked';
     /**
      * UUID of the user (converted to lowercase)
      */