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

package/src/resources/loyalty/accounts.ts

@@ -7,6 +7,11 @@ import * as Core from '../../core';
 export class Accounts extends APIResource {
   /**
    * Get loyalty accounts
+   *
+   * @example
+   * ```ts
+   * const accounts = await client.loyalty.accounts.list();
+   * ```
    */
   list(query?: AccountListParams, options?: Core.RequestOptions): Core.APIPromise<AccountListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<AccountListResponse>;
@@ -21,9 +26,23 @@ export class Accounts extends APIResource {
   }
 
   /**
+   * This api can only return the rank upto 5000, after that it will return '5000+'.
    * Returns the user's rank determined by their loyalty points for the specified
    * loyalty currency. This can be a slow operation for large organizations. We
    * recommend caching when possible.
+   *
+   * @example
+   * ```ts
+   * const response = await client.loyalty.accounts.retrieveRank(
+   *   '123e4567-e89b-12d3-a456-426614174333',
+   *   {
+   *     loyaltyCurrencyId:
+   *       '123e4567-e89b-12d3-a456-426614174333',
+   *     organizationId: '123e4567-e89b-12d3-a456-426614174333',
+   *     websiteId: '123e4567-e89b-12d3-a456-426614174333',
+   *   },
+   * );
+   * ```
    */
   retrieveRank(
     id: string,
@@ -109,6 +128,11 @@ export namespace AccountListResponse {
        * Ethereum wallet address of the user
        */
       walletAddress: string | null;
+
+      /**
+       * Array of website user attribute values for the user
+       */
+      websiteUserAttributeValues: Array<User.WebsiteUserAttributeValue>;
     }
 
     export namespace User {
@@ -141,6 +165,38 @@ export namespace AccountListResponse {
          */
         walletGroupIdentifier: string | null;
       }
+
+      /**
+       * Schema for a website user attribute value
+       */
+      export interface WebsiteUserAttributeValue {
+        /**
+         * Value for the website user attribute
+         */
+        value: string;
+
+        /**
+         * Website user attribute details
+         */
+        websiteUserAttribute: WebsiteUserAttributeValue.WebsiteUserAttribute;
+      }
+
+      export namespace WebsiteUserAttributeValue {
+        /**
+         * Website user attribute details
+         */
+        export interface WebsiteUserAttribute {
+          /**
+           * Unique identifier for the website user attribute
+           */
+          id: string;
+
+          /**
+           * Label for the website user attribute
+           */
+          label: string;
+        }
+      }
     }
   }
 }
@@ -150,17 +206,13 @@ export namespace AccountListResponse {
  */
 export interface AccountRetrieveRankResponse {
   /**
-   * Rank of the user
+   * Rank of the user. null means the user has no amount. This api can only return
+   * the rank upto 5000, after that it will return "5000+"
    */
-  rank: number;
+  rank: number | null;
 }
 
 export interface AccountListParams {
-  /**
-   * Discord username to filter accounts by
-   */
-  discordUser?: string;
-
   /**
    * External identifier for the user
    */
@@ -176,25 +228,20 @@ export interface AccountListParams {
    */
   loyaltyCurrencyId?: string;
 
-  /**
-   * Order the accounts by amount in ascending or descending order
-   */
-  'orderBy[amount]'?: 'asc' | 'desc';
-
   /**
    * Unique identifier for the organization to filter by
    */
   organizationId?: string;
 
   /**
-   * Pagination cursor to start after a specific account ID
+   * Order the accounts in ascending or descending order, sorted by amount
    */
-  startingAfter?: string;
+  sortDir?: 'asc' | 'desc';
 
   /**
-   * Twitter username to filter accounts by
+   * Pagination cursor to start after a specific account ID
    */
-  twitterUser?: string;
+  startingAfter?: string;
 
   /**
    * External identifier for the user group controlled by you
@@ -207,9 +254,9 @@ export interface AccountListParams {
   userGroupId?: string;
 
   /**
-   * User ID(s) to filter accounts by
+   * User ID(s) to filter accounts by. Pass in null to get a currencys main accounts.
    */
-  userId?: string | Array<string>;
+  userId?: string | 'null' | Array<string>;
 
   /**
    * Wallet address(es) to filter accounts by