@snagsolutions/sdk 0.1.0-alpha.230 → 0.1.0-alpha.232

package/resources/loyalty/badges.d.mts

@@ -1,1398 +0,0 @@
-import { APIResource } from "../../core/resource.mjs";
-import { APIPromise } from "../../core/api-promise.mjs";
-import { RequestOptions } from "../../internal/request-options.mjs";
-export declare class Badges extends APIResource {
-    /**
-     * 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?: RequestOptions): 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 | null | undefined, options?: RequestOptions): APIPromise<BadgeUpdateResponse>;
-    /**
-     * This endpoint allows you to fetch badge(s) data.
-     *
-     * @example
-     * ```ts
-     * const badges = await client.loyalty.badges.list();
-     * ```
-     */
-    list(query?: BadgeListParams | null | undefined, options?: RequestOptions): 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?: RequestOptions): 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 | null | undefined, options?: RequestOptions): 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 | null | undefined, options?: RequestOptions): APIPromise<BadgeRewardResponse>;
-}
-/**
- * Response returned upon successful creation of the badge.
- */
-export interface BadgeCreateResponse {
-    /**
-     * UUID of the badge (converted to lowercase)
-     */
-    id: string;
-    /**
-     * The date and time the badge was created
-     */
-    createdAt: 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;
-    /**
-     * 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
-     */
-    loyaltyBadgeUsers?: Array<BadgeCreateResponse.LoyaltyBadgeUser>;
-    /**
-     * Array of loyalty rules associated with the badge
-     */
-    loyaltyRules?: Array<BadgeCreateResponse.LoyaltyRule>;
-}
-export declare namespace BadgeCreateResponse {
-    /**
-     * Schema for a loyalty condition rule.
-     */
-    interface LoyaltyCondition {
-        /**
-         * UUID of the condition (converted to lowercase)
-         */
-        id: string;
-        /**
-         * The amount of the condition
-         */
-        amount: number | null;
-        association: Array<LoyaltyCondition.Association>;
-        /**
-         * 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>;
-    }
-    namespace LoyaltyCondition {
-        interface Association {
-            loyaltyBadge: Association.LoyaltyBadge | null;
-            loyaltyCurrency: Association.LoyaltyCurrency | null;
-            loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
-            loyaltyRule: Association.LoyaltyRule | null;
-            loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
-        }
-        namespace Association {
-            interface LoyaltyBadge {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-            interface LoyaltyCurrency {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-            interface LoyaltyLeaderboardView {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-            interface LoyaltyRule {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-            interface LoyaltyRuleGroup {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-        }
-        interface 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' | '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;
-    }
-    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;
-        /**
-         * 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;
-    }
-    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;
-    }
-}
-/**
- * Response returned upon successful update of the badge.
- */
-export interface BadgeUpdateResponse {
-    /**
-     * UUID of the badge (converted to lowercase)
-     */
-    id: string;
-    /**
-     * The date and time the badge was created
-     */
-    createdAt: 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;
-    /**
-     * 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
-     */
-    loyaltyBadgeUsers?: Array<BadgeUpdateResponse.LoyaltyBadgeUser>;
-    /**
-     * Array of loyalty rules associated with the badge
-     */
-    loyaltyRules?: Array<BadgeUpdateResponse.LoyaltyRule>;
-}
-export declare namespace BadgeUpdateResponse {
-    /**
-     * Schema for a loyalty condition rule.
-     */
-    interface LoyaltyCondition {
-        /**
-         * UUID of the condition (converted to lowercase)
-         */
-        id: string;
-        /**
-         * The amount of the condition
-         */
-        amount: number | null;
-        association: Array<LoyaltyCondition.Association>;
-        /**
-         * 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>;
-    }
-    namespace LoyaltyCondition {
-        interface Association {
-            loyaltyBadge: Association.LoyaltyBadge | null;
-            loyaltyCurrency: Association.LoyaltyCurrency | null;
-            loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
-            loyaltyRule: Association.LoyaltyRule | null;
-            loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
-        }
-        namespace Association {
-            interface LoyaltyBadge {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-            interface LoyaltyCurrency {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-            interface LoyaltyLeaderboardView {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-            interface LoyaltyRule {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-            interface LoyaltyRuleGroup {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-        }
-        interface 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' | '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;
-    }
-    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;
-        /**
-         * 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;
-    }
-    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;
-    }
-}
-export interface BadgeListResponse {
-    data: Array<BadgeListResponse.Data>;
-    /**
-     * Indicates if there is a next page of results
-     */
-    hasNextPage: boolean;
-}
-export declare namespace BadgeListResponse {
-    /**
-     * Response returned upon successful fetching of the badges.
-     */
-    interface Data {
-        /**
-         * UUID of the badge (converted to lowercase)
-         */
-        id: string;
-        /**
-         * The date and time the badge was created
-         */
-        createdAt: 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<Data.LoyaltyCondition>;
-        /**
-         * The name of the badge
-         */
-        name: string;
-        /**
-         * The date and time the badge was updated
-         */
-        updatedAt: string;
-        /**
-         * Array of data jobs associated with the badge
-         */
-        dataJobs?: Array<Data.DataJob>;
-        /**
-         * Whether to hide this badge in the user interface
-         */
-        hideInUi?: boolean;
-        /**
-         * Array of user badges
-         */
-        loyaltyBadgeUsers?: Array<Data.LoyaltyBadgeUser>;
-        /**
-         * Array of loyalty rules associated with the badge
-         */
-        loyaltyRules?: Array<Data.LoyaltyRule>;
-    }
-    namespace Data {
-        /**
-         * Schema for a loyalty condition rule.
-         */
-        interface LoyaltyCondition {
-            /**
-             * UUID of the condition (converted to lowercase)
-             */
-            id: string;
-            /**
-             * The amount of the condition
-             */
-            amount: number | null;
-            association: Array<LoyaltyCondition.Association>;
-            /**
-             * 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>;
-        }
-        namespace LoyaltyCondition {
-            interface Association {
-                loyaltyBadge: Association.LoyaltyBadge | null;
-                loyaltyCurrency: Association.LoyaltyCurrency | null;
-                loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
-                loyaltyRule: Association.LoyaltyRule | null;
-                loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
-            }
-            namespace Association {
-                interface LoyaltyBadge {
-                    /**
-                     * UUID of the association (converted to lowercase)
-                     */
-                    id: string;
-                    /**
-                     * The name of the association
-                     */
-                    name: string;
-                }
-                interface LoyaltyCurrency {
-                    /**
-                     * UUID of the association (converted to lowercase)
-                     */
-                    id: string;
-                    /**
-                     * The name of the association
-                     */
-                    name: string;
-                }
-                interface LoyaltyLeaderboardView {
-                    /**
-                     * UUID of the association (converted to lowercase)
-                     */
-                    id: string;
-                    /**
-                     * The name of the association
-                     */
-                    name: string;
-                }
-                interface LoyaltyRule {
-                    /**
-                     * UUID of the association (converted to lowercase)
-                     */
-                    id: string;
-                    /**
-                     * The name of the association
-                     */
-                    name: string;
-                }
-                interface LoyaltyRuleGroup {
-                    /**
-                     * UUID of the association (converted to lowercase)
-                     */
-                    id: string;
-                    /**
-                     * The name of the association
-                     */
-                    name: string;
-                }
-            }
-            interface 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' | '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;
-        }
-        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;
-            /**
-             * 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;
-        }
-        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;
-        }
-    }
-}
-/**
- * Response returned upon successful deletion of the badge.
- */
-export interface BadgeDeleteResponse {
-    /**
-     * UUID of the badge (converted to lowercase)
-     */
-    id: string;
-    /**
-     * The date and time the badge was created
-     */
-    createdAt: 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;
-    /**
-     * 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
-     */
-    loyaltyBadgeUsers?: Array<BadgeDeleteResponse.LoyaltyBadgeUser>;
-    /**
-     * Array of loyalty rules associated with the badge
-     */
-    loyaltyRules?: Array<BadgeDeleteResponse.LoyaltyRule>;
-}
-export declare namespace BadgeDeleteResponse {
-    /**
-     * Schema for a loyalty condition rule.
-     */
-    interface LoyaltyCondition {
-        /**
-         * UUID of the condition (converted to lowercase)
-         */
-        id: string;
-        /**
-         * The amount of the condition
-         */
-        amount: number | null;
-        association: Array<LoyaltyCondition.Association>;
-        /**
-         * 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>;
-    }
-    namespace LoyaltyCondition {
-        interface Association {
-            loyaltyBadge: Association.LoyaltyBadge | null;
-            loyaltyCurrency: Association.LoyaltyCurrency | null;
-            loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
-            loyaltyRule: Association.LoyaltyRule | null;
-            loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
-        }
-        namespace Association {
-            interface LoyaltyBadge {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-            interface LoyaltyCurrency {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-            interface LoyaltyLeaderboardView {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-            interface LoyaltyRule {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-            interface LoyaltyRuleGroup {
-                /**
-                 * UUID of the association (converted to lowercase)
-                 */
-                id: string;
-                /**
-                 * The name of the association
-                 */
-                name: string;
-            }
-        }
-        interface 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' | '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;
-    }
-    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;
-        /**
-         * 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;
-    }
-    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;
-    }
-}
-/**
- * Response returned upon successful update of the user badge
- */
-export interface BadgeRevokeResponse {
-    data: BadgeRevokeResponse.Data;
-    /**
-     * The message returned upon update of the badge
-     */
-    message: string;
-}
-export declare namespace BadgeRevokeResponse {
-    interface Data {
-        id: string;
-        loyaltyBadgeId: string;
-        status: 'active' | 'inactive' | 'revoked';
-        userId: string;
-    }
-}
-/**
- * Response returned upon successful update of the user badge
- */
-export interface BadgeRewardResponse {
-    data: BadgeRewardResponse.Data;
-    /**
-     * The message returned upon update of the badge
-     */
-    message: string;
-}
-export declare namespace BadgeRewardResponse {
-    interface Data {
-        id: string;
-        loyaltyBadgeId: string;
-        status: 'active' | 'inactive' | 'revoked';
-        userId: string;
-    }
-}
-export interface BadgeCreateParams {
-    /**
-     * Array of conditions for the badge
-     */
-    conditions: Array<BadgeCreateParams.Condition>;
-    /**
-     * The URL of the badge image
-     */
-    imageUrl: string;
-    /**
-     * The name of the badge
-     */
-    name: string;
-    /**
-     * UUID of the organization (optional, converted to lowercase)
-     */
-    organizationId: string;
-    /**
-     * 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;
-}
-export declare namespace BadgeCreateParams {
-    interface Condition {
-        /**
-         * The amount of the rule
-         */
-        amount?: number | null;
-        /**
-         * URL of the CSV file (optional)
-         */
-        csvUrl?: string | null;
-        /**
-         * The description of the rule
-         */
-        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 loyalty rule chain (optional, converted to lowercase)
-         */
-        loyaltyRuleChainId?: string | null;
-        /**
-         * Array of UUIDs of the rule group (optional, converted to lowercase)
-         */
-        loyaltyRuleGroupIds?: Array<string>;
-        /**
-         * Array of UUIDs of the rules (optional, converted to lowercase)
-         */
-        loyaltyRuleIds?: Array<string>;
-        /**
-         * The number of times the rule should be repeated to fulfill the condition
-         */
-        repeatCount?: number | null;
-        /**
-         * 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
-     */
-    description?: string;
-    /**
-     * Whether to hide this badge in the user interface
-     */
-    hideInUi?: boolean;
-    /**
-     * The URL of the badge image
-     */
-    imageUrl?: string;
-    /**
-     * The name of the badge
-     */
-    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?: string | Array<string>;
-    /**
-     * Include deleted badges in the response
-     */
-    includeDeleted?: boolean | null;
-    /**
-     * Number of badges to fetch
-     */
-    limit?: number;
-    /**
-     * UUID of the organization (optional, converted to lowercase)
-     */
-    organizationId?: string;
-    /**
-     * UUID of the badge to start after (converted to lowercase)
-     */
-    startingAfter?: string;
-    /**
-     * External identifier of the user group
-     */
-    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)
-     */
-    userId?: string;
-    /**
-     * Validated and formatted wallet address
-     */
-    walletAddress?: string;
-}
-export interface BadgeRewardParams {
-    /**
-     * Status of the badge
-     */
-    status?: 'active' | 'inactive' | 'revoked';
-    /**
-     * UUID of the user (converted to lowercase)
-     */
-    userId?: string;
-    /**
-     * Validated and formatted wallet address
-     */
-    walletAddress?: string;
-}
-export declare namespace Badges {
-    export { type BadgeCreateResponse as BadgeCreateResponse, type BadgeUpdateResponse as BadgeUpdateResponse, type BadgeListResponse as BadgeListResponse, type BadgeDeleteResponse as BadgeDeleteResponse, type BadgeRevokeResponse as BadgeRevokeResponse, type BadgeRewardResponse as BadgeRewardResponse, type BadgeCreateParams as BadgeCreateParams, type BadgeUpdateParams as BadgeUpdateParams, type BadgeListParams as BadgeListParams, type BadgeRevokeParams as BadgeRevokeParams, type BadgeRewardParams as BadgeRewardParams, };
-}
-//# sourceMappingURL=badges.d.mts.map