@snagsolutions/sdk 0.1.0-alpha.181 → 0.1.0-alpha.183

package/src/resources/loyalty/badges.ts

@@ -789,329 +789,340 @@ export namespace BadgeUpdateResponse {
   }
 }
 
-/**
- * Response returned upon successful fetching of the badges.
- */
 export interface BadgeListResponse {
-  /**
-   * 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<BadgeListResponse.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<BadgeListResponse.DataJob>;
+  data: Array<BadgeListResponse.Data>;
 
   /**
-   * Array of user badges
+   * Indicates if there is a next page of results
    */
-  loyaltyBadgeUsers?: Array<BadgeListResponse.LoyaltyBadgeUser>;
-
-  /**
-   * Array of loyalty rules associated with the badge
-   */
-  loyaltyRules?: Array<BadgeListResponse.LoyaltyRule>;
+  hasNextPage: boolean;
 }
 
 export namespace BadgeListResponse {
   /**
-   * Schema for a loyalty condition rule.
+   * Response returned upon successful fetching of the badges.
    */
-  export interface LoyaltyCondition {
+  export interface Data {
     /**
-     * UUID of the condition (converted to lowercase)
+     * UUID of the badge (converted to lowercase)
      */
     id: string;
 
     /**
-     * The amount of the condition
+     * The date and time the badge was created
      */
-    amount: number | null;
-
-    association: Array<LoyaltyCondition.Association>;
+    createdAt: string;
 
     /**
-     * URL of the CSV file
+     * The description of the badge
      */
-    csvUrl: string | null;
+    description: string | null;
 
     /**
-     * The description of the condition
+     * The URL of the badge image
      */
-    description: string | null;
+    imageUrl: string | null;
 
     /**
-     * UUID of the currency (converted to lowercase)
+     * Array of conditions of the badge
      */
-    loyaltyCurrencyId: string | null;
+    loyaltyConditions: Array<Data.LoyaltyCondition>;
 
     /**
-     * UUID of the rule group (converted to lowercase)
+     * The name of the badge
      */
-    loyaltyRuleGroupId: string | null;
+    name: string;
 
     /**
-     * The repeat count of the condition
+     * The date and time the badge was updated
      */
-    repeatCount: number | null;
+    updatedAt: string;
 
     /**
-     * The required count of the condition
+     * Array of data jobs associated with the badge
      */
-    requiredCount: number | null;
+    dataJobs?: Array<Data.DataJob>;
 
     /**
-     * The type of the condition
+     * Array of user badges
      */
-    type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
+    loyaltyBadgeUsers?: Array<Data.LoyaltyBadgeUser>;
 
     /**
-     * Array of CSV files associated with the condition
+     * Array of loyalty rules associated with the badge
      */
-    csvFiles?: Array<LoyaltyCondition.CsvFile>;
+    loyaltyRules?: Array<Data.LoyaltyRule>;
   }
 
-  export namespace LoyaltyCondition {
-    export interface Association {
-      loyaltyBadge: Association.LoyaltyBadge | null;
+  export namespace Data {
+    /**
+     * Schema for a loyalty condition rule.
+     */
+    export interface LoyaltyCondition {
+      /**
+       * UUID of the condition (converted to lowercase)
+       */
+      id: string;
 
-      loyaltyCurrency: Association.LoyaltyCurrency | null;
+      /**
+       * The amount of the condition
+       */
+      amount: number | null;
 
-      loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
+      association: Array<LoyaltyCondition.Association>;
 
-      loyaltyRule: Association.LoyaltyRule | null;
+      /**
+       * URL of the CSV file
+       */
+      csvUrl: string | null;
 
-      loyaltyRuleGroup: Association.LoyaltyRuleGroup | 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>;
     }
 
-    export namespace Association {
-      export interface LoyaltyBadge {
-        /**
-         * UUID of the association (converted to lowercase)
-         */
-        id: string;
+    export namespace LoyaltyCondition {
+      export interface Association {
+        loyaltyBadge: Association.LoyaltyBadge | null;
 
-        /**
-         * The name of the association
-         */
-        name: string;
-      }
+        loyaltyCurrency: Association.LoyaltyCurrency | null;
 
-      export interface LoyaltyCurrency {
-        /**
-         * UUID of the association (converted to lowercase)
-         */
-        id: string;
+        loyaltyLeaderboardView: Association.LoyaltyLeaderboardView | null;
 
-        /**
-         * The name of the association
-         */
-        name: string;
-      }
+        loyaltyRule: Association.LoyaltyRule | null;
 
-      export interface LoyaltyLeaderboardView {
-        /**
-         * UUID of the association (converted to lowercase)
-         */
-        id: string;
+        loyaltyRuleGroup: Association.LoyaltyRuleGroup | null;
+      }
 
-        /**
-         * The name of the association
-         */
-        name: string;
+      export namespace Association {
+        export interface LoyaltyBadge {
+          /**
+           * UUID of the association (converted to lowercase)
+           */
+          id: string;
+
+          /**
+           * The name of the association
+           */
+          name: string;
+        }
+
+        export interface LoyaltyCurrency {
+          /**
+           * UUID of the association (converted to lowercase)
+           */
+          id: string;
+
+          /**
+           * The name of the association
+           */
+          name: string;
+        }
+
+        export interface LoyaltyLeaderboardView {
+          /**
+           * UUID of the association (converted to lowercase)
+           */
+          id: string;
+
+          /**
+           * The name of the association
+           */
+          name: string;
+        }
+
+        export interface LoyaltyRule {
+          /**
+           * UUID of the association (converted to lowercase)
+           */
+          id: string;
+
+          /**
+           * The name of the association
+           */
+          name: string;
+        }
+
+        export interface LoyaltyRuleGroup {
+          /**
+           * UUID of the association (converted to lowercase)
+           */
+          id: string;
+
+          /**
+           * The name of the association
+           */
+          name: string;
+        }
       }
 
-      export interface LoyaltyRule {
+      export interface CsvFile {
         /**
-         * UUID of the association (converted to lowercase)
+         * UUID of the CSV file (converted to lowercase)
          */
         id: string;
 
         /**
-         * The name of the association
+         * The description of the CSV file
          */
-        name: string;
-      }
+        description: string | null;
 
-      export interface LoyaltyRuleGroup {
         /**
-         * UUID of the association (converted to lowercase)
+         * The name of the CSV file
          */
-        id: string;
+        name: string | null;
 
         /**
-         * The name of the association
+         * The URL of the CSV file
          */
-        name: string;
+        url: string | null;
       }
     }
 
-    export interface CsvFile {
+    export interface DataJob {
       /**
-       * UUID of the CSV file (converted to lowercase)
+       * UUID of the data job (converted to lowercase)
        */
       id: string;
 
       /**
-       * The description of the CSV file
+       * The date and time the data job was created
        */
-      description: string | null;
+      createdAt: string;
 
       /**
-       * The name of the CSV file
+       * The status of the data job
        */
-      name: string | null;
+      status: 'pending' | 'complete' | 'failed';
 
       /**
-       * The URL of the CSV file
+       * The date and time the data job was updated
        */
-      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;
+      updatedAt: string;
 
-    /**
-     * The status of the data job
-     */
-    status: 'pending' | 'complete' | 'failed';
+      /**
+       * The message associated with the data job
+       */
+      message?: string | null;
+    }
 
-    /**
-     * The date and time the data job was updated
-     */
-    updatedAt: string;
+    export interface LoyaltyBadgeUser {
+      /**
+       * UUID of the user badge (converted to lowercase)
+       */
+      id: string;
 
-    /**
-     * The message associated with the data job
-     */
-    message?: string | null;
-  }
+      /**
+       * The date and time the user badge was created
+       */
+      createdAt: string;
 
-  export interface LoyaltyBadgeUser {
-    /**
-     * UUID of the user badge (converted to lowercase)
-     */
-    id: string;
+      /**
+       * UUID of the badge (converted to lowercase)
+       */
+      loyaltyBadgeId: string;
 
-    /**
-     * The date and time the user badge was created
-     */
-    createdAt: string;
+      /**
+       * UUID of the organization (converted to lowercase)
+       */
+      organizationId: string;
 
-    /**
-     * UUID of the badge (converted to lowercase)
-     */
-    loyaltyBadgeId: string;
+      /**
+       * The status of the badge
+       */
+      status: 'active' | 'inactive' | 'revoked';
 
-    /**
-     * UUID of the organization (converted to lowercase)
-     */
-    organizationId: string;
+      /**
+       * The date and time the user badge was updated
+       */
+      updatedAt: string;
 
-    /**
-     * The status of the badge
-     */
-    status: 'active' | 'inactive' | 'revoked';
+      /**
+       * UUID of the user (converted to lowercase)
+       */
+      userId: string;
 
-    /**
-     * The date and time the user badge was updated
-     */
-    updatedAt: string;
+      /**
+       * UUID of the website (converted to lowercase)
+       */
+      websiteId: string;
 
-    /**
-     * UUID of the user (converted to lowercase)
-     */
-    userId: string;
+      /**
+       * Whether the user has dismissed the badge in the UI
+       */
+      dismissedInUi?: boolean;
 
-    /**
-     * UUID of the website (converted to lowercase)
-     */
-    websiteId: string;
+      /**
+       * Array of progress for the badge
+       */
+      progress?: unknown;
 
-    /**
-     * Whether the user has dismissed the badge in the UI
-     */
-    dismissedInUi?: boolean;
+      /**
+       * User associated with the user badge
+       */
+      user?: LoyaltyBadgeUser.User;
+    }
 
-    /**
-     * Array of progress for the badge
-     */
-    progress?: unknown;
+    export namespace LoyaltyBadgeUser {
+      /**
+       * User associated with the user badge
+       */
+      export interface User {
+        /**
+         * UUID of the user (converted to lowercase)
+         */
+        id: string;
 
-    /**
-     * User associated with the user badge
-     */
-    user?: LoyaltyBadgeUser.User;
-  }
+        /**
+         * Wallet address of the user
+         */
+        walletAddress: string;
+      }
+    }
 
-  export namespace LoyaltyBadgeUser {
-    /**
-     * User associated with the user badge
-     */
-    export interface User {
+    export interface LoyaltyRule {
       /**
-       * UUID of the user (converted to lowercase)
+       * UUID of the loyalty rule (converted to lowercase)
        */
       id: string;
 
       /**
-       * Wallet address of the user
+       * The name of the loyalty rule
        */
-      walletAddress: string;
+      name: string;
     }
   }
-
-  export interface LoyaltyRule {
-    /**
-     * UUID of the loyalty rule (converted to lowercase)
-     */
-    id: string;
-
-    /**
-     * The name of the loyalty rule
-     */
-    name: string;
-  }
 }
 
 /**

package/src/resources/loyalty/questions-responses.ts

@@ -54,14 +54,19 @@ export class QuestionsResponses extends APIResource {
  * List of question responses with details
  */
 export interface QuestionsResponseListResponse {
-  responses: Array<QuestionsResponseListResponse.Response>;
+  data: Array<QuestionsResponseListResponse.Data>;
+
+  /**
+   * Indicates if there are more pages of results available
+   */
+  hasNextPage: boolean;
 }
 
 export namespace QuestionsResponseListResponse {
   /**
    * Response details including the question and choice information
    */
-  export interface Response {
+  export interface Data {
     id: string;
 
     createdAt: string;
@@ -72,12 +77,12 @@ export namespace QuestionsResponseListResponse {
 
     loyaltyQuestionId: string;
 
-    question: Response.Question;
+    question: Data.Question;
 
     userId: string;
   }
 
-  export namespace Response {
+  export namespace Data {
     export interface Question {
       loyaltyQuestionChoices: Array<Question.LoyaltyQuestionChoice>;
 
@@ -138,6 +143,11 @@ export namespace QuestionsResponseSubmitResponse {
 }
 
 export interface QuestionsResponseListParams {
+  /**
+   * Maximum number of records to return (max 100)
+   */
+  limit?: number;
+
   /**
    * UUID of the organization to filter responses
    */
@@ -148,6 +158,11 @@ export interface QuestionsResponseListParams {
    */
   questionsId?: string | Array<string>;
 
+  /**
+   * Pagination cursor to start after a specific resource ID
+   */
+  startingAfter?: string;
+
   /**
    * UUID of the user to filter responses
    */

package/src/resources/loyalty/questions.ts

@@ -103,21 +103,25 @@ export namespace QuestionUpdateResponse {
   }
 }
 
-export type QuestionListResponse = Array<QuestionListResponse.QuestionListResponseItem>;
+export interface QuestionListResponse {
+  data: Array<QuestionListResponse.Data>;
+
+  hasNextPage: boolean;
+}
 
 export namespace QuestionListResponse {
   /**
    * Response returned for a question
    */
-  export interface QuestionListResponseItem {
+  export interface Data {
     id: string;
 
-    loyaltyQuestionChoices: Array<QuestionListResponseItem.LoyaltyQuestionChoice>;
+    loyaltyQuestionChoices: Array<Data.LoyaltyQuestionChoice>;
 
     text: string;
   }
 
-  export namespace QuestionListResponseItem {
+  export namespace Data {
     export interface LoyaltyQuestionChoice {
       id: string;
 
@@ -216,11 +220,21 @@ export interface QuestionListParams {
    */
   loyaltyRuleIds: string | Array<string>;
 
+  /**
+   * Maximum number of records to return (max 100)
+   */
+  limit?: number;
+
   /**
    * UUID of the organization to fetch questions for
    */
   organizationId?: string;
 
+  /**
+   * Pagination cursor to start after a specific resource ID
+   */
+  startingAfter?: string;
+
   /**
    * UUID of the user to fetch questions for
    */

package/src/resources/loyalty/rule-groups.ts

@@ -254,7 +254,8 @@ export namespace RuleGroupGetRuleGroupsResponse {
           | 'discord_join'
           | 'connected_youtube'
           | 'stratus_function'
-          | 'connected_tiktok';
+          | 'connected_tiktok'
+          | 'tiktok_follow';
       }
 
       export namespace LoyaltyRule {