@snagsolutions/sdk 0.1.0-alpha.17 → 0.1.0-alpha.171

package/resources/loyalty/account-streaks.d.ts

@@ -0,0 +1,81 @@
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+export declare class AccountStreaks extends APIResource {
+    /**
+     * Get loyalty account streaks
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.loyalty.accountStreaks.getStreaks({
+     *     loyaltyRuleId:
+     *       'loyaltyRuleId=123e4567-e89b-12d3-a456-426614174001&loyaltyRuleId=123e4567-e89b-12d3-a456-426614174002',
+     *   });
+     * ```
+     */
+    getStreaks(query: AccountStreakGetStreaksParams, options?: Core.RequestOptions): Core.APIPromise<AccountStreakGetStreaksResponse>;
+}
+/**
+ * Response schema for getting loyalty account streaks, null if no streak
+ */
+export type AccountStreakGetStreaksResponse = Array<AccountStreakGetStreaksResponse.AccountStreakGetStreaksResponseItem>;
+export declare namespace AccountStreakGetStreaksResponse {
+    interface AccountStreakGetStreaksResponseItem {
+        /**
+         * ID of the loyalty account streak, null if no streak yet
+         */
+        id: string | null;
+        /**
+         * Date and time the streak was created, null if no streak yet
+         */
+        createdAt: string | null;
+        /**
+         * Date and time the streak expires, null if no streak yet
+         */
+        expiresAt: string | null;
+        loyaltyRuleId: string;
+        milestone: Array<AccountStreakGetStreaksResponseItem.Milestone>;
+        /**
+         * Number of days in the streak, 0 if no streak
+         */
+        streakCount: number;
+        /**
+         * Date and time the streak was last updated, null if no streak yet
+         */
+        updatedAt: string | null;
+        userId: string;
+        walletAddress: string;
+    }
+    namespace AccountStreakGetStreaksResponseItem {
+        interface Milestone {
+            streakAmount: number;
+            streakMilestone: number;
+        }
+    }
+}
+export interface AccountStreakGetStreaksParams {
+    /**
+     * Loyalty rule id(s) to filter by, array or single id
+     */
+    loyaltyRuleId: string | Array<string>;
+    /**
+     * Maximum number of records to return (max 1000)
+     */
+    limit?: number;
+    /**
+     * Pagination cursor to start after a specific resource ID
+     */
+    startingAfter?: string;
+    /**
+     * User id to filter by
+     */
+    userId?: string;
+    /**
+     * Wallet address to filter by
+     */
+    walletAddress?: string;
+}
+export declare namespace AccountStreaks {
+    export { type AccountStreakGetStreaksResponse as AccountStreakGetStreaksResponse, type AccountStreakGetStreaksParams as AccountStreakGetStreaksParams, };
+}
+//# sourceMappingURL=account-streaks.d.ts.map

package/resources/loyalty/account-streaks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-streaks.d.ts","sourceRoot":"","sources":["../../src/resources/loyalty/account-streaks.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;OAWG;IACH,UAAU,CACR,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC;CAGpD;AAED;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,KAAK,CAAC,+BAA+B,CAAC,mCAAmC,CAAC,CAAC;AAE7E,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,mCAAmC;QAClD;;WAEG;QACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,CAAC;QAEtB,SAAS,EAAE,KAAK,CAAC,mCAAmC,CAAC,SAAS,CAAC,CAAC;QAEhE;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,MAAM,EAAE,MAAM,CAAC;QAEf,aAAa,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,mCAAmC,CAAC;QACnD,UAAiB,SAAS;YACxB,YAAY,EAAE,MAAM,CAAC;YAErB,eAAe,EAAE,MAAM,CAAC;SACzB;KACF;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/resources/loyalty/account-streaks.js

@@ -0,0 +1,24 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountStreaks = void 0;
+const resource_1 = require("../../resource.js");
+class AccountStreaks extends resource_1.APIResource {
+    /**
+     * Get loyalty account streaks
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.loyalty.accountStreaks.getStreaks({
+     *     loyaltyRuleId:
+     *       'loyaltyRuleId=123e4567-e89b-12d3-a456-426614174001&loyaltyRuleId=123e4567-e89b-12d3-a456-426614174002',
+     *   });
+     * ```
+     */
+    getStreaks(query, options) {
+        return this._client.get('/api/loyalty/account_streaks', { query, ...options });
+    }
+}
+exports.AccountStreaks = AccountStreaks;
+//# sourceMappingURL=account-streaks.js.map

package/resources/loyalty/account-streaks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-streaks.js","sourceRoot":"","sources":["../../src/resources/loyalty/account-streaks.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;;;;;;OAWG;IACH,UAAU,CACR,KAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AAnBD,wCAmBC"}

package/resources/loyalty/account-streaks.mjs

@@ -0,0 +1,20 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../resource.mjs";
+export class AccountStreaks extends APIResource {
+    /**
+     * Get loyalty account streaks
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.loyalty.accountStreaks.getStreaks({
+     *     loyaltyRuleId:
+     *       'loyaltyRuleId=123e4567-e89b-12d3-a456-426614174001&loyaltyRuleId=123e4567-e89b-12d3-a456-426614174002',
+     *   });
+     * ```
+     */
+    getStreaks(query, options) {
+        return this._client.get('/api/loyalty/account_streaks', { query, ...options });
+    }
+}
+//# sourceMappingURL=account-streaks.mjs.map

package/resources/loyalty/account-streaks.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-streaks.mjs","sourceRoot":"","sources":["../../src/resources/loyalty/account-streaks.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;OAWG;IACH,UAAU,CACR,KAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF"}

package/resources/loyalty/accounts.d.ts

@@ -3,6 +3,11 @@ import * as Core from "../../core.js";
 export declare 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>;
@@ -10,6 +15,19 @@ export declare class Accounts extends APIResource {
      * 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, query: AccountRetrieveRankParams, options?: Core.RequestOptions): Core.APIPromise<AccountRetrieveRankResponse>;
 }
@@ -77,6 +95,10 @@ export declare namespace AccountListResponse {
              * Ethereum wallet address of the user
              */
             walletAddress: string | null;
+            /**
+             * Array of website user attribute values for the user
+             */
+            websiteUserAttributeValues: Array<User.WebsiteUserAttributeValue>;
         }
         namespace User {
             /**
@@ -104,6 +126,34 @@ export declare namespace AccountListResponse {
                  */
                 walletGroupIdentifier: string | null;
             }
+            /**
+             * Schema for a website user attribute value
+             */
+            interface WebsiteUserAttributeValue {
+                /**
+                 * Value for the website user attribute
+                 */
+                value: string;
+                /**
+                 * Website user attribute details
+                 */
+                websiteUserAttribute: WebsiteUserAttributeValue.WebsiteUserAttribute;
+            }
+            namespace WebsiteUserAttributeValue {
+                /**
+                 * Website user attribute details
+                 */
+                interface WebsiteUserAttribute {
+                    /**
+                     * Unique identifier for the website user attribute
+                     */
+                    id: string;
+                    /**
+                     * Label for the website user attribute
+                     */
+                    label: string;
+                }
+            }
         }
     }
 }
@@ -112,15 +162,11 @@ export declare namespace AccountListResponse {
  */
 export interface AccountRetrieveRankResponse {
     /**
-     * Rank of the user
+     * Rank of the user. null means the user has no amount.
      */
-    rank: number;
+    rank: number | null;
 }
 export interface AccountListParams {
-    /**
-     * Discord username to filter accounts by
-     */
-    discordUser?: string;
     /**
      * External identifier for the user
      */
@@ -133,22 +179,18 @@ export interface AccountListParams {
      * Unique identifier for the loyalty currency
      */
     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
      */
@@ -158,9 +200,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
      */

package/resources/loyalty/accounts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../../src/resources/loyalty/accounts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IACpG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAWzE;;;;OAIG;IACH,YAAY,CACV,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;CAGhD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,IAAI,EAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAEvC;;eAEG;YACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;SAC9B;QAED,UAAiB,IAAI,CAAC;YACpB;;eAEG;YACH,UAAiB,YAAY;gBAC3B;;mBAEG;gBACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE3B;;mBAEG;gBACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE3B;;mBAEG;gBACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEvB;;mBAEG;gBACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE3B;;mBAEG;gBACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;aACtC;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEnC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
+{"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../../src/resources/loyalty/accounts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IACpG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAWzE;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CACV,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;CAGhD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,IAAI,EAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAEvC;;eAEG;YACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,0BAA0B,EAAE,KAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;SACnE;QAED,UAAiB,IAAI,CAAC;YACpB;;eAEG;YACH,UAAiB,YAAY;gBAC3B;;mBAEG;gBACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE3B;;mBAEG;gBACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE3B;;mBAEG;gBACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEvB;;mBAEG;gBACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE3B;;mBAEG;gBACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;aACtC;YAED;;eAEG;YACH,UAAiB,yBAAyB;gBACxC;;mBAEG;gBACH,KAAK,EAAE,MAAM,CAAC;gBAEd;;mBAEG;gBACH,oBAAoB,EAAE,yBAAyB,CAAC,oBAAoB,CAAC;aACtE;YAED,UAAiB,yBAAyB,CAAC;gBACzC;;mBAEG;gBACH,UAAiB,oBAAoB;oBACnC;;uBAEG;oBACH,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,KAAK,EAAE,MAAM,CAAC;iBACf;aACF;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/loyalty/accounts.js

@@ -15,6 +15,19 @@ class Accounts extends resource_1.APIResource {
      * 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, query, options) {
         return this._client.get(`/api/loyalty/accounts/${id}/rank`, { query, ...options });

package/resources/loyalty/accounts.js.map

@@ -1 +1 @@
-{"version":3,"file":"accounts.js","sourceRoot":"","sources":["../../src/resources/loyalty/accounts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,MAAa,QAAS,SAAQ,sBAAW;IAMvC,IAAI,CACF,QAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,EAAU,EACV,KAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF;AA5BD,4BA4BC"}
+{"version":3,"file":"accounts.js","sourceRoot":"","sources":["../../src/resources/loyalty/accounts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,MAAa,QAAS,SAAQ,sBAAW;IAWvC,IAAI,CACF,QAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CACV,EAAU,EACV,KAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF;AA9CD,4BA8CC"}

package/resources/loyalty/accounts.mjs

@@ -12,6 +12,19 @@ export class Accounts extends APIResource {
      * 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, query, options) {
         return this._client.get(`/api/loyalty/accounts/${id}/rank`, { query, ...options });

package/resources/loyalty/accounts.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"accounts.mjs","sourceRoot":"","sources":["../../src/resources/loyalty/accounts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAG3B,MAAM,OAAO,QAAS,SAAQ,WAAW;IAMvC,IAAI,CACF,QAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,EAAU,EACV,KAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF"}
+{"version":3,"file":"accounts.mjs","sourceRoot":"","sources":["../../src/resources/loyalty/accounts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAG3B,MAAM,OAAO,QAAS,SAAQ,WAAW;IAWvC,IAAI,CACF,QAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CACV,EAAU,EACV,KAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF"}