@snagsolutions/sdk 0.1.0-alpha.14 → 0.1.0-alpha.140

package/resources/loyalty/accounts.d.ts

@@ -1,4 +1,204 @@
 import { APIResource } from "../../resource.js";
+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>;
+    /**
+     * 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>;
+}
+/**
+ * Schema for the response of getting loyalty accounts
+ */
+export interface AccountListResponse {
+    /**
+     * Array of loyalty accounts
+     */
+    data: Array<AccountListResponse.Data>;
+    /**
+     * Indicates if there is a next page of results
+     */
+    hasNextPage: boolean;
+    /**
+     * Optional message
+     */
+    message?: string;
+}
+export declare namespace AccountListResponse {
+    /**
+     * Schema for a loyalty account
+     */
+    interface Data {
+        /**
+         * Unique identifier for the loyalty account
+         */
+        id: string;
+        /**
+         * Unique identifier for the loyalty currency
+         */
+        loyaltyCurrencyId: string;
+        /**
+         * User associated with the loyalty account
+         */
+        user: Data.User | null;
+        /**
+         * Unique identifier for the user
+         */
+        userId: string | null;
+        /**
+         * Balance amount in the loyalty account
+         */
+        amount?: unknown;
+        /**
+         * Version number used for optimistic locking
+         */
+        lockVersion?: unknown;
+    }
+    namespace Data {
+        /**
+         * Schema for a user
+         */
+        interface User {
+            /**
+             * Unique identifier for the user
+             */
+            id: string;
+            /**
+             * Array of metadata associated with the user
+             */
+            userMetadata: Array<User.UserMetadata>;
+            /**
+             * Ethereum wallet address of the user
+             */
+            walletAddress: string | null;
+        }
+        namespace User {
+            /**
+             * Schema for user metadata
+             */
+            interface UserMetadata {
+                /**
+                 * Discord username associated with the user
+                 */
+                discordUser: string | null;
+                /**
+                 * Display name of the user
+                 */
+                displayName: string | null;
+                /**
+                 * URL of the user's logo
+                 */
+                logoUrl: string | null;
+                /**
+                 * Twitter username associated with the user
+                 */
+                twitterUser: string | null;
+                /**
+                 * Identifier for the wallet group
+                 */
+                walletGroupIdentifier: string | null;
+            }
+        }
+    }
+}
+/**
+ * Schema for a get account rank response
+ */
+export interface AccountRetrieveRankResponse {
+    /**
+     * Rank of the user. null means the user has no amount.
+     */
+    rank: number | null;
+}
+export interface AccountListParams {
+    /**
+     * External identifier for the user
+     */
+    externalIdentifier?: string;
+    /**
+     * Maximum number of accounts to return
+     */
+    limit?: number;
+    /**
+     * Unique identifier for the loyalty currency
+     */
+    loyaltyCurrencyId?: string;
+    /**
+     * Unique identifier for the organization to filter by
+     */
+    organizationId?: string;
+    /**
+     * Order the accounts in ascending or descending order, sorted by amount
+     */
+    sortDir?: 'asc' | 'desc';
+    /**
+     * Pagination cursor to start after a specific account ID
+     */
+    startingAfter?: string;
+    /**
+     * External identifier for the user group controlled by you
+     */
+    userGroupExternalIdentifier?: string;
+    /**
+     * Unique identifier for the user group
+     */
+    userGroupId?: string;
+    /**
+     * User ID(s) to filter accounts by. Pass in null to get a currencys main accounts.
+     */
+    userId?: string | 'null' | Array<string>;
+    /**
+     * Wallet address(es) to filter accounts by
+     */
+    walletAddress?: string | Array<string>;
+    /**
+     * Wallet group identifier to filter accounts by
+     */
+    walletGroupIdentifier?: string;
+    /**
+     * Unique identifier for the website to filter by
+     */
+    websiteId?: string;
+}
+export interface AccountRetrieveRankParams {
+    /**
+     * UUID of the loyalty currency
+     */
+    loyaltyCurrencyId: string;
+    /**
+     * UUID of the organization
+     */
+    organizationId: string;
+    /**
+     * UUID of the website
+     */
+    websiteId: string;
+}
+export declare namespace Accounts {
+    export { type AccountListResponse as AccountListResponse, type AccountRetrieveRankResponse as AccountRetrieveRankResponse, type AccountListParams as AccountListParams, type AccountRetrieveRankParams as AccountRetrieveRankParams, };
 }
 //# sourceMappingURL=accounts.d.ts.map

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,qBAAa,QAAS,SAAQ,WAAW;CAAG"}
+{"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;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,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

@@ -3,7 +3,35 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Accounts = void 0;
 const resource_1 = require("../../resource.js");
+const core_1 = require("../../core.js");
 class Accounts extends resource_1.APIResource {
+    list(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.list({}, query);
+        }
+        return this._client.get('/api/loyalty/accounts', { query, ...options });
+    }
+    /**
+     * 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 });
+    }
 }
 exports.Accounts = Accounts;
 //# sourceMappingURL=accounts.js.map

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;AAE7C,MAAa,QAAS,SAAQ,sBAAW;CAAG;AAA5C,4BAA4C"}
+{"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

@@ -1,5 +1,33 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../../resource.mjs";
+import { isRequestOptions } from "../../core.mjs";
 export class Accounts extends APIResource {
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this._client.get('/api/loyalty/accounts', { query, ...options });
+    }
+    /**
+     * 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 });
+    }
 }
 //# sourceMappingURL=accounts.mjs.map

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;AAEtB,MAAM,OAAO,QAAS,SAAQ,WAAW;CAAG"}
+{"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"}