@snagsolutions/sdk 0.1.0-alpha.19 → 0.1.0-alpha.191

package/src/resources/users/metadatas.ts

@@ -7,6 +7,11 @@ import * as Core from '../../core';
 export class Metadatas extends APIResource {
   /**
    * This endpoint is used to create user metadata
+   *
+   * @example
+   * ```ts
+   * const metadata = await client.users.metadatas.create();
+   * ```
    */
   create(body?: MetadataCreateParams, options?: Core.RequestOptions): Core.APIPromise<MetadataCreateResponse>;
   create(options?: Core.RequestOptions): Core.APIPromise<MetadataCreateResponse>;
@@ -22,6 +27,11 @@ export class Metadatas extends APIResource {
 
   /**
    * This endpoint is used to get user metadata
+   *
+   * @example
+   * ```ts
+   * const metadatas = await client.users.metadatas.list();
+   * ```
    */
   list(query?: MetadataListParams, options?: Core.RequestOptions): Core.APIPromise<MetadataListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<MetadataListResponse>;
@@ -57,7 +67,10 @@ export interface MetadataCreateResponse {
 
   user: MetadataCreateResponse.User;
 
-  userGroup: MetadataCreateResponse.UserGroup;
+  /**
+   * User group associated with the user
+   */
+  userGroup: MetadataCreateResponse.UserGroup | null;
 
   /**
    * Identifier for the user group set via api
@@ -88,6 +101,9 @@ export namespace MetadataCreateResponse {
     walletAddress: string;
   }
 
+  /**
+   * User group associated with the user
+   */
   export interface UserGroup {
     /**
      * id for the user group
@@ -123,6 +139,18 @@ export namespace MetadataListResponse {
 }
 
 export interface MetadataCreateParams {
+  bio?: string | null;
+
+  blockStatusReason?:
+    | 'sybil_and_multi_account'
+    | 'account_migration'
+    | 'abuse_manipulation'
+    | 'not_sybil'
+    | 'issue_resolved'
+    | 'twitter_suspended'
+    | 'other'
+    | null;
+
   discordUser?: string | null;
 
   discordUserId?: string | null;
@@ -135,22 +163,44 @@ export interface MetadataCreateParams {
 
   externalIdentifier?: string | null;
 
+  externalLoyaltyScore?: string | null;
+
+  googleUser?: string | null;
+
+  googleUserId?: string | null;
+
+  internalNotes?: string | null;
+
   isBlocked?: boolean;
 
+  isBlockExempt?: boolean;
+
+  location?: string | null;
+
   logoUrl?: string | null;
 
   organizationId?: string;
 
-  stardustProfileIdentifier?: string | null;
+  portfolioUrl?: string | null;
+
+  steamUserId?: string | null;
 
-  stardustWalletIdentifier?: string | null;
+  steamUsername?: string | null;
+
+  sybilScore?: number | null;
 
   telegramUserId?: string | null;
 
   telegramUsername?: string | null;
 
+  tiktokUser?: string | null;
+
+  tiktokUserId?: string | null;
+
   twitterUser?: string | null;
 
+  twitterUserFollowersCount?: number | null;
+
   twitterUserId?: string | null;
 
   userGroupExternalIdentifier?: string | null;
@@ -164,6 +214,8 @@ export interface MetadataCreateParams {
   walletGroupIdentifier?: string | null;
 
   websiteId?: string;
+
+  YTChannelId?: string | null;
 }
 
 export interface MetadataListParams {
@@ -192,6 +244,8 @@ export interface MetadataListParams {
    */
   userId?: string;
 
+  userSearch?: string;
+
   /**
    * Wallet address of the user
    */

package/src/resources/users/users.ts

@@ -17,6 +17,11 @@ export class Users extends APIResource {
 
   /**
    * This endpoint allows you to get users
+   *
+   * @example
+   * ```ts
+   * const users = await client.users.list();
+   * ```
    */
   list(query?: UserListParams, options?: Core.RequestOptions): Core.APIPromise<UserListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<UserListResponse>;
@@ -31,7 +36,18 @@ export class Users extends APIResource {
   }
 
   /**
-   * This endpoint allows you to create a user
+   * This endpoint allows you to connect a user to a user group
+   *
+   * @example
+   * ```ts
+   * const response = await client.users.connect({
+   *   organizationId: '123e4567-e89b-12d3-a456-426614174001',
+   *   walletAddress:
+   *     '0x1234567890abcdef1234567890abcdef12345678',
+   *   walletType: 'evm',
+   *   websiteId: '123e4567-e89b-12d3-a456-426614174000',
+   * });
+   * ```
    */
   connect(body: UserConnectParams, options?: Core.RequestOptions): Core.APIPromise<UserConnectResponse> {
     return this._client.post('/api/users/connect', { body, ...options });
@@ -39,17 +55,71 @@ export class Users extends APIResource {
 
   /**
    * This endpoint returns the total user count
+   *
+   * @example
+   * ```ts
+   * const response = await client.users.count({
+   *   organizationId: '123e4567-e89b-12d3-a456-426614174001',
+   *   websiteId: '123e4567-e89b-12d3-a456-426614174000',
+   * });
+   * ```
    */
   count(query: UserCountParams, options?: Core.RequestOptions): Core.APIPromise<UserCountResponse> {
     return this._client.get('/api/users/count', { query, ...options });
   }
 
   /**
-   * This endpoint allows you to disconnect a user from another user
+   * This endpoint is used to create user devices for fraud tracking
+   *
+   * @example
+   * ```ts
+   * const response = await client.users.createDevice({
+   *   ipAddress: '123.456.789.012',
+   * });
+   * ```
    */
-  disconnect(body: UserDisconnectParams, options?: Core.RequestOptions): Core.APIPromise<unknown> {
+  createDevice(
+    body: UserCreateDeviceParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<UserCreateDeviceResponse> {
+    return this._client.post('/api/users/devices', { body, ...options });
+  }
+
+  /**
+   * This endpoint allows you to disconnect a user from another user
+   *
+   * @example
+   * ```ts
+   * const response = await client.users.disconnect({
+   *   organizationId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   userId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   websiteId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * });
+   * ```
+   */
+  disconnect(
+    body: UserDisconnectParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<UserDisconnectResponse> {
     return this._client.post('/api/users/disconnect', { body, ...options });
   }
+
+  /**
+   * Transfers a social account from one user to another when a conflict is detected.
+   * Disconnects the account from the previous user and connects it to the current
+   * user's profile. Used when a social account is already linked to a different user
+   * (MAXIMUM_ACCOUNT_LINKED error).
+   *
+   * @example
+   * ```ts
+   * const response = await client.users.verify({
+   *   accountLinkData: 'accountLinkData',
+   * });
+   * ```
+   */
+  verify(body: UserVerifyParams, options?: Core.RequestOptions): Core.APIPromise<UserVerifyResponse> {
+    return this._client.post('/api/users/verify', { body, ...options });
+  }
 }
 
 export interface UserListResponse {
@@ -57,6 +127,11 @@ export interface UserListResponse {
    * Schema for users response
    */
   data: Array<UserListResponse.Data>;
+
+  /**
+   * Indicates if there is a next page of results
+   */
+  hasNextPage: boolean;
 }
 
 export namespace UserListResponse {
@@ -70,64 +145,72 @@ export namespace UserListResponse {
 
     walletAddress: string;
 
-    /**
-     * The followers of the user, only returned if includeFollow is true
-     */
-    _count?: Data._Count | null;
-
     /**
      * The delegations from the user, only returned if includeDelegation is true
      */
     delegationsFrom?: Array<Data.DelegationsFrom> | null;
 
-    /**
-     * The followers of the user, only returned if includeFollow is true and the user
-     * is querying their own user
-     */
-    followers?: Array<Data.Follower> | null;
-
     /**
      * Whether the user has notifications enabled, only returned if
      * includeNotifications is true
      */
-    notifications?: boolean;
+    notifications?: boolean | null;
 
     privyUserId?: string | null;
 
-    stardustProfileId?: string | null;
+    referrers?: Array<Data.Referrer> | null;
 
     temporaryLoyaltyUser?: boolean | null;
 
     userMetadata?: Array<Data.UserMetadata> | null;
+
+    websiteUserAttributes?: Array<Data.WebsiteUserAttribute> | null;
   }
 
   export namespace Data {
-    /**
-     * The followers of the user, only returned if includeFollow is true
-     */
-    export interface _Count {
-      select: _Count.Select;
+    export interface DelegationsFrom {
+      walletAddress: string;
     }
 
-    export namespace _Count {
-      export interface Select {
-        followers: number;
+    export interface Referrer {
+      eligible: boolean;
 
-        follows: number;
-      }
-    }
+      referralCode: Referrer.ReferralCode;
 
-    export interface DelegationsFrom {
-      walletAddress: string;
+      user: Referrer.User;
     }
 
-    export interface Follower {
-      userId: string;
+    export namespace Referrer {
+      export interface ReferralCode {
+        /**
+         * Use who referred the user
+         */
+        user: ReferralCode.User;
+      }
+
+      export namespace ReferralCode {
+        /**
+         * Use who referred the user
+         */
+        export interface User {
+          id: string;
+
+          walletAddress: string;
+        }
+      }
+
+      export interface User {
+        id: string;
+
+        walletAddress: string;
+      }
     }
 
     export interface UserMetadata {
       bio?: string | null;
 
+      createdAt?: string | null;
+
       discordUser?: string | null;
 
       discordVerifiedAt?: string | null;
@@ -146,6 +229,12 @@ export namespace UserListResponse {
 
       epicUsername?: string | null;
 
+      externalLoyaltyScore?: string | null;
+
+      googleUser?: string | null;
+
+      googleUserId?: string | null;
+
       instagramUser?: string | null;
 
       instagramVerifiedAt?: string | null;
@@ -170,15 +259,43 @@ export namespace UserListResponse {
 
       telegramVerifiedAt?: string | null;
 
+      tiktokUser?: string | null;
+
+      tiktokUserId?: string | null;
+
       twitterUser?: string | null;
 
       twitterUserFollowersCount?: number | null;
 
       twitterVerifiedAt?: string | null;
 
+      updatedAt?: string | null;
+
       userGroupId?: string | null;
 
       walletGroupIdentifier?: string | null;
+
+      YTChannelId?: string | null;
+    }
+
+    export interface WebsiteUserAttribute {
+      id: string;
+
+      label: string;
+
+      websiteUserAttributeValues: Array<WebsiteUserAttribute.WebsiteUserAttributeValue>;
+    }
+
+    export namespace WebsiteUserAttribute {
+      export interface WebsiteUserAttributeValue {
+        id: string;
+
+        userId: string;
+
+        value: string;
+
+        websiteUserAttributeId: string;
+      }
     }
   }
 }
@@ -218,7 +335,56 @@ export interface UserCountResponse {
   totalCount: number;
 }
 
-export type UserDisconnectResponse = unknown;
+/**
+ * Schema for a user device
+ */
+export interface UserCreateDeviceResponse {
+  /**
+   * Unique identifier for the user device
+   */
+  id: string;
+
+  /**
+   * Timestamp when the wallet was created
+   */
+  createdAt: string;
+
+  /**
+   * IP address of the user device
+   */
+  ipAddress: string;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId: string;
+
+  /**
+   * Source of the user device
+   */
+  source: string;
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId: string;
+
+  /**
+   * Device identifier of the user device
+   */
+  deviceIdentifier?: string;
+}
+
+export interface UserDisconnectResponse {
+  /**
+   * The message of the disconnect user response
+   */
+  message: 'Success';
+}
+
+export interface UserVerifyResponse {
+  message: string;
+}
 
 export interface UserListParams {
   /**
@@ -231,6 +397,11 @@ export interface UserListParams {
    */
   discordUser?: string;
 
+  /**
+   * Email address of the user
+   */
+  emailAddress?: string;
+
   /**
    * External identifier for the user
    */
@@ -241,11 +412,6 @@ export interface UserListParams {
    */
   includeDelegation?: boolean | null;
 
-  /**
-   * Whether to include followers in the response
-   */
-  includeFollow?: boolean | null;
-
   /**
    * Number of users to return
    */
@@ -281,6 +447,11 @@ export interface UserListParams {
    */
   telegramUsername?: string;
 
+  /**
+   * TikTok username of the user
+   */
+  tiktokUser?: string;
+
   /**
    * Twitter username of the user
    */
@@ -323,7 +494,17 @@ export interface UserConnectParams {
    */
   walletAddress: string;
 
-  walletType: 'evm' | 'solana' | 'imx' | 'sui' | 'ton';
+  walletType:
+    | 'evm'
+    | 'solana'
+    | 'imx'
+    | 'sui'
+    | 'ton'
+    | 'cosmos'
+    | 'ultra'
+    | 'agw'
+    | 'flow_cadence'
+    | 'substrate';
 
   /**
    * The ID of the website
@@ -415,6 +596,22 @@ export interface UserCountParams {
   websiteId: string;
 }
 
+export interface UserCreateDeviceParams {
+  /**
+   * IP address of the user device
+   */
+  ipAddress: string;
+
+  /**
+   * Device identifier of the user device
+   */
+  deviceIdentifier?: string;
+
+  userId?: string;
+
+  walletAddress?: string;
+}
+
 export interface UserDisconnectParams {
   organizationId: string;
 
@@ -423,6 +620,16 @@ export interface UserDisconnectParams {
   websiteId: string;
 }
 
+export interface UserVerifyParams {
+  accountLinkData: string;
+
+  organizationId?: string;
+
+  userId?: string;
+
+  websiteId?: string;
+}
+
 Users.Metadatas = Metadatas;
 
 export declare namespace Users {
@@ -430,11 +637,15 @@ export declare namespace Users {
     type UserListResponse as UserListResponse,
     type UserConnectResponse as UserConnectResponse,
     type UserCountResponse as UserCountResponse,
+    type UserCreateDeviceResponse as UserCreateDeviceResponse,
     type UserDisconnectResponse as UserDisconnectResponse,
+    type UserVerifyResponse as UserVerifyResponse,
     type UserListParams as UserListParams,
     type UserConnectParams as UserConnectParams,
     type UserCountParams as UserCountParams,
+    type UserCreateDeviceParams as UserCreateDeviceParams,
     type UserDisconnectParams as UserDisconnectParams,
+    type UserVerifyParams as UserVerifyParams,
   };
 
   export {

package/src/resources/websites/website-collections.ts

@@ -6,6 +6,19 @@ import * as Core from '../../core';
 export class WebsiteCollections extends APIResource {
   /**
    * Creates a new collection under a website
+   *
+   * @example
+   * ```ts
+   * await client.websites.websiteCollections.create({
+   *   collectionAddress:
+   *     '0x2c02efDd09B3BA1AEaDd3dCAa7aC7A37C1CBDA8A',
+   *   name: 'x',
+   *   network: 'abstract',
+   *   organizationId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   sortId: 99999,
+   *   websiteId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * });
+   * ```
    */
   create(body: WebsiteCollectionCreateParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/api/website_collections', {
@@ -17,6 +30,14 @@ export class WebsiteCollections extends APIResource {
 
   /**
    * Retrieves collections for a specific website.
+   *
+   * @example
+   * ```ts
+   * const websiteCollections =
+   *   await client.websites.websiteCollections.list({
+   *     websiteId: '123e4567-e89b-12d3-a456-426614174000',
+   *   });
+   * ```
    */
   list(
     query: WebsiteCollectionListParams,
@@ -56,13 +77,17 @@ export interface WebsiteCollectionCreateParams {
   name: string;
 
   network:
+    | 'abstract'
+    | 'abstractTestnet'
     | 'apechain'
     | 'arbitrum'
     | 'avalanche'
     | 'avalancheFuji'
     | 'base'
     | 'baseSepolia'
+    | 'berachain'
     | 'berachainArtio'
+    | 'berachainBepolia'
     | 'binance'
     | 'bscTestnet'
     | 'campTestnet'
@@ -70,18 +95,30 @@ export interface WebsiteCollectionCreateParams {
     | 'fantomTestnet'
     | 'flowMainnet'
     | 'mainnet'
+    | 'nexusTestnet'
     | 'optimism'
     | 'polygon'
     | 'polygon_mumbai'
     | 'skaleNebula'
+    | 'skaleEuropa'
+    | 'skaleCalypso'
     | 'solana'
     | 'sophon'
+    | 'sophonTestnet'
     | 'sui'
     | 'superseed'
     | 'superseedSepolia'
     | 'vanar'
     | 'xai'
     | 'zksync'
+    | 'coti'
+    | 'cotiTestnet'
+    | 'morph'
+    | 'morphTestnet'
+    | 'morphHolesky'
+    | 'ultra'
+    | 'ultraTestnet'
+    | 'nitrograph'
     | 'sepolia'
     | 'optimism_sepolia'
     | 'arbitrumSepolia'
@@ -89,7 +126,11 @@ export interface WebsiteCollectionCreateParams {
     | 'optimism_goerli'
     | 'arbitrumGoerli'
     | 'basecamp'
-    | 'abstract';
+    | 'somnia'
+    | 'zkverify'
+    | 'polkadot'
+    | 'kusama'
+    | 'flow_cadence';
 
   organizationId: string;
 

package/src/resources/websites/website-user-roles.ts

@@ -7,6 +7,14 @@ export class WebsiteUserRoles extends APIResource {
   /**
    * Retrieves roles of users for a specific website. If userId is provided,
    * retrieves the role of that specific user for the website.
+   *
+   * @example
+   * ```ts
+   * const websiteUserRoles =
+   *   await client.websites.websiteUserRoles.list({
+   *     websiteId: '123e4567-e89b-12d3-a456-426614174000',
+   *   });
+   * ```
    */
   list(
     query: WebsiteUserRoleListParams,
@@ -17,6 +25,21 @@ export class WebsiteUserRoles extends APIResource {
 
   /**
    * Assign roles to users for a specific website
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.websites.websiteUserRoles.assign({
+   *     websiteId: '123e4567-e89b-12d3-a456-426614174000',
+   *     websiteUserRoles: [
+   *       {
+   *         roleType: 'WEBSITE_SUPER_ADMIN',
+   *         walletAddress:
+   *           '0x1234567890abcdef1234567890abcdef12345678',
+   *       },
+   *     ],
+   *   });
+   * ```
    */
   assign(
     body: WebsiteUserRoleAssignParams,
@@ -83,7 +106,8 @@ export namespace WebsiteUserRoleAssignParams {
       | 'WEBSITE_ADMIN'
       | 'WEBSITE_MODERATOR'
       | 'WEBSITE_API_KEY'
-      | 'STRATUS_API_KEY';
+      | 'STRATUS_API_KEY'
+      | 'WEBSITE_READ_ONLY_API_KEY';
 
     /**
      * Wallet address of the user