@snagsolutions/sdk 0.1.0-alpha.23 → 0.1.0-alpha.231

package/src/resources/auth.ts

@@ -6,19 +6,52 @@ import * as Core from '../core';
 
 export class Auth extends APIResource {
   /**
-   * This endpoint allows you to connect your Twitter account to a Snag account
+   * This endpoint allows you to connect your auth account to a Snag account
    */
   connectAuth(
-    authType: 'twitter' | 'discord' | 'telegram' | 'epic' | 'steam',
+    authType:
+      | 'twitter'
+      | 'discord'
+      | 'telegram'
+      | 'epic'
+      | 'steam'
+      | 'ultra'
+      | 'google'
+      | 'tiktok'
+      | 'email'
+      | 'reddit'
+      | 'instagram',
     query?: AuthConnectAuthParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<AuthConnectAuthResponse>;
   connectAuth(
-    authType: 'twitter' | 'discord' | 'telegram' | 'epic' | 'steam',
+    authType:
+      | 'twitter'
+      | 'discord'
+      | 'telegram'
+      | 'epic'
+      | 'steam'
+      | 'ultra'
+      | 'google'
+      | 'tiktok'
+      | 'email'
+      | 'reddit'
+      | 'instagram',
     options?: Core.RequestOptions,
   ): Core.APIPromise<AuthConnectAuthResponse>;
   connectAuth(
-    authType: 'twitter' | 'discord' | 'telegram' | 'epic' | 'steam',
+    authType:
+      | 'twitter'
+      | 'discord'
+      | 'telegram'
+      | 'epic'
+      | 'steam'
+      | 'ultra'
+      | 'google'
+      | 'tiktok'
+      | 'email'
+      | 'reddit'
+      | 'instagram',
     query: AuthConnectAuthParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<AuthConnectAuthResponse> {
@@ -27,6 +60,17 @@ export class Auth extends APIResource {
     }
     return this._client.get(`/api/${authType}/auth`, { query, ...options });
   }
+
+  /**
+   * endpoint to verify and complete connecting an auth account to a Snag account
+   */
+  connectAuthVerify(
+    authType: 'tiktok' | 'reddit' | 'instagram',
+    query: AuthConnectAuthVerifyParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AuthConnectAuthVerifyResponse> {
+    return this._client.get(`/api/${authType}/auth/connect`, { query, ...options });
+  }
 }
 
 /**
@@ -34,36 +78,107 @@ export class Auth extends APIResource {
  */
 export interface AuthConnectAuthResponse {
   /**
-   * The URL to redirect to
+   * The URL to redirect to.
    */
   url: string;
 }
 
+/**
+ * 200 response for GET /api/{authType}/auth/connect. Success, conflict (account
+ * already linked), or verification error.
+ */
+export interface AuthConnectAuthVerifyResponse {
+  /**
+   * Whether the account was linked successfully
+   */
+  success: boolean;
+
+  /**
+   * The error message if the account was not linked successfully
+   */
+  error?: string;
+
+  /**
+   * The JWT state
+   */
+  jwtState?: string;
+
+  /**
+   * The message of the response
+   */
+  message?: string;
+}
+
 export interface AuthConnectAuthParams {
+  /**
+   * The email address of the user, this is only required for email auth
+   */
+  emailAddress?: string;
+
   /**
    * The redirect URL where the user will land after completing the auth
    */
   redirect?: string;
 
   /**
-   * The type of response to return
+   * The type of response to return, this is not valid for email auth, email auth
+   * only supports the redirect flow via verification link.
    */
   responseType?: 'redirect' | 'json';
 
+  /**
+   * Whether to skip the YouTube channel check, this is only value for google auth
+   */
+  skipYTChannelCheck?: string;
+
   /**
    * The ID of the user
    */
   userId?: string;
 
+  /**
+   * The wallet address of the user
+   */
+  walletAddress?: string;
+
   /**
    * The ID of the website
    */
   websiteId?: string;
 }
 
+export interface AuthConnectAuthVerifyParams {
+  state: string;
+
+  code?: string;
+
+  /**
+   * The username or URL of the Instagram profile
+   */
+  instagramUsernameOrUrl?: string;
+
+  /**
+   * The URL of the Reddit profile
+   */
+  redditProfileUrl?: string;
+
+  /**
+   * The type of response to return, this is not valid for email auth, email auth
+   * only supports the redirect flow via verification link.
+   */
+  responseType?: 'redirect' | 'json';
+
+  /**
+   * The URL of the TikTok profile
+   */
+  tiktokProfileUrl?: string;
+}
+
 export declare namespace Auth {
   export {
     type AuthConnectAuthResponse as AuthConnectAuthResponse,
+    type AuthConnectAuthVerifyResponse as AuthConnectAuthVerifyResponse,
     type AuthConnectAuthParams as AuthConnectAuthParams,
+    type AuthConnectAuthVerifyParams as AuthConnectAuthVerifyParams,
   };
 }

package/src/resources/index.ts

@@ -1,25 +1,63 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Assets, type AssetCreateAssetResponse, type AssetCreateAssetParams } from './assets';
-export { Auctions, type AuctionListAuctionsResponse, type AuctionListAuctionBidsParams } from './auctions';
-export { Auth, type AuthConnectAuthResponse, type AuthConnectAuthParams } from './auth';
+export {
+  Auctions,
+  type AuctionGetPageSectionsResponse,
+  type AuctionListAuctionBidsResponse,
+  type AuctionListAuctionsResponse,
+  type AuctionGetPageSectionsParams,
+  type AuctionListAuctionBidsParams,
+} from './auctions/auctions';
+export {
+  Auth,
+  type AuthConnectAuthResponse,
+  type AuthConnectAuthVerifyResponse,
+  type AuthConnectAuthParams,
+  type AuthConnectAuthVerifyParams,
+} from './auth';
 export { Loyalty } from './loyalty/loyalty';
-export { Minting, type MintingGetAssetsResponse, type MintingGetAssetsParams } from './minting';
+export {
+  Minting,
+  type MintingGetAssetsResponse,
+  type MintingGetTokenGateStatusResponse,
+  type MintingGetAssetsParams,
+  type MintingGetTokenGateStatusParams,
+} from './minting/minting';
 export {
   Referral,
   type ReferralCreateCodeResponse,
   type ReferralCreateCodeParams,
 } from './referral/referral';
+export {
+  TokenClaims,
+  type TokenClaimRetrieveResponse,
+  type TokenClaimListResponse,
+  type TokenClaimCheckEligibilityResponse,
+  type TokenClaimGetProofResponse,
+  type TokenClaimListUsersResponse,
+  type TokenClaimUpdateClaimResponse,
+  type TokenClaimRetrieveParams,
+  type TokenClaimListParams,
+  type TokenClaimCheckEligibilityParams,
+  type TokenClaimGetProofParams,
+  type TokenClaimListUsersParams,
+  type TokenClaimUpdateClaimParams,
+} from './token-claims';
 export {
   Users,
   type UserListResponse,
   type UserConnectResponse,
   type UserCountResponse,
+  type UserCreateDeviceResponse,
   type UserDisconnectResponse,
+  type UserVerifyResponse,
   type UserListParams,
   type UserConnectParams,
   type UserCountParams,
+  type UserCreateDeviceParams,
   type UserDisconnectParams,
+  type UserVerifyParams,
 } from './users/users';
 export {
   Websites,

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

@@ -0,0 +1,128 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+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: AccountStreakGetStreaksParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AccountStreakGetStreaksResponse> {
+    return this._client.get('/api/loyalty/account_streaks', { query, ...options });
+  }
+}
+
+/**
+ * Response schema for getting loyalty account streaks, null if no streak
+ */
+export type AccountStreakGetStreaksResponse =
+  Array<AccountStreakGetStreaksResponse.AccountStreakGetStreaksResponseItem>;
+
+export namespace AccountStreakGetStreaksResponse {
+  /**
+   * Response schema for getting loyalty account streaks, null if no streak
+   */
+  export interface AccountStreakGetStreaksResponseItem {
+    /**
+     * 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;
+
+    /**
+     * ID of the loyalty account streak, null if no streak yet
+     */
+    id?: string;
+  }
+
+  export namespace AccountStreakGetStreaksResponseItem {
+    export 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;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId?: string;
+
+  /**
+   * Pagination cursor to start after a specific resource ID
+   */
+  startingAfter?: string;
+
+  /**
+   * Unique identifier for the user group
+   */
+  userGroupId?: string;
+
+  /**
+   * User id to filter by
+   */
+  userId?: string;
+
+  /**
+   * Wallet address to filter by
+   */
+  walletAddress?: string;
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId?: string;
+}
+
+export declare namespace AccountStreaks {
+  export {
+    type AccountStreakGetStreaksResponse as AccountStreakGetStreaksResponse,
+    type AccountStreakGetStreaksParams as AccountStreakGetStreaksParams,
+  };
+}

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