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

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,66 @@ 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 });
   }
+
+  /**
+   * @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 {
@@ -94,11 +159,15 @@ export namespace UserListResponse {
 
     privyUserId?: string | null;
 
+    referrers?: Array<Data.Referrer> | null;
+
     stardustProfileId?: string | null;
 
     temporaryLoyaltyUser?: boolean | null;
 
     userMetadata?: Array<Data.UserMetadata> | null;
+
+    websiteUserAttributes?: Array<Data.WebsiteUserAttribute> | null;
   }
 
   export namespace Data {
@@ -125,9 +194,25 @@ export namespace UserListResponse {
       userId: string;
     }
 
+    export interface Referrer {
+      eligible: boolean;
+
+      user: Referrer.User;
+    }
+
+    export namespace Referrer {
+      export interface User {
+        id: string;
+
+        walletAddress: string;
+      }
+    }
+
     export interface UserMetadata {
       bio?: string | null;
 
+      createdAt?: string | null;
+
       discordUser?: string | null;
 
       discordVerifiedAt?: string | null;
@@ -146,6 +231,12 @@ export namespace UserListResponse {
 
       epicUsername?: string | null;
 
+      externalLoyaltyScore?: string | null;
+
+      googleUser?: string | null;
+
+      googleUserId?: string | null;
+
       instagramUser?: string | null;
 
       instagramVerifiedAt?: string | null;
@@ -170,15 +261,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 +337,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 +399,11 @@ export interface UserListParams {
    */
   discordUser?: string;
 
+  /**
+   * Email address of the user
+   */
+  emailAddress?: string;
+
   /**
    * External identifier for the user
    */
@@ -281,6 +454,11 @@ export interface UserListParams {
    */
   telegramUsername?: string;
 
+  /**
+   * TikTok username of the user
+   */
+  tiktokUser?: string;
+
   /**
    * Twitter username of the user
    */
@@ -323,7 +501,7 @@ export interface UserConnectParams {
    */
   walletAddress: string;
 
-  walletType: 'evm' | 'solana' | 'imx' | 'sui' | 'ton';
+  walletType: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | 'flow_cadence';
 
   /**
    * The ID of the website
@@ -415,6 +593,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 +617,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 +634,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/index.ts

@@ -1,11 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export {
-  WebsiteCollections,
-  type WebsiteCollectionListResponse,
-  type WebsiteCollectionCreateParams,
-  type WebsiteCollectionListParams,
-} from './website-collections';
+export { WebsiteCollections } from './website-collections';
 export {
   WebsiteUserRoles,
   type WebsiteUserRoleListResponse,
@@ -13,10 +8,4 @@ export {
   type WebsiteUserRoleListParams,
   type WebsiteUserRoleAssignParams,
 } from './website-user-roles';
-export {
-  Websites,
-  type WebsiteCreateResponse,
-  type WebsiteListResponse,
-  type WebsiteCreateParams,
-  type WebsiteListParams,
-} from './websites';
+export { Websites, type WebsiteListResponse, type WebsiteListParams } from './websites';

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

@@ -1,149 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
-import * as Core from '../../core';
 
-export class WebsiteCollections extends APIResource {
-  /**
-   * Creates a new collection under a website
-   */
-  create(body: WebsiteCollectionCreateParams, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.post('/api/website_collections', {
-      body,
-      ...options,
-      headers: { Accept: '*/*', ...options?.headers },
-    });
-  }
-
-  /**
-   * Retrieves collections for a specific website.
-   */
-  list(
-    query: WebsiteCollectionListParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<WebsiteCollectionListResponse> {
-    return this._client.get('/api/website_collections', { query, ...options });
-  }
-}
-
-/**
- * Response schema for fetching website collections
- */
-export interface WebsiteCollectionListResponse {
-  /**
-   * Array of websites
-   */
-  data: Array<WebsiteCollectionListResponse.Data>;
-
-  /**
-   * Indicates if more pages are available
-   */
-  hasNextPage: boolean;
-}
-
-export namespace WebsiteCollectionListResponse {
-  export interface Data {
-    /**
-     * Website Collection ID
-     */
-    id: string;
-  }
-}
-
-export interface WebsiteCollectionCreateParams {
-  collectionAddress: string;
-
-  name: string;
-
-  network:
-    | 'apechain'
-    | 'arbitrum'
-    | 'avalanche'
-    | 'avalancheFuji'
-    | 'base'
-    | 'baseSepolia'
-    | 'berachainArtio'
-    | 'binance'
-    | 'bscTestnet'
-    | 'campTestnet'
-    | 'fantom'
-    | 'fantomTestnet'
-    | 'flowMainnet'
-    | 'mainnet'
-    | 'optimism'
-    | 'polygon'
-    | 'polygon_mumbai'
-    | 'skaleNebula'
-    | 'solana'
-    | 'sophon'
-    | 'sui'
-    | 'superseed'
-    | 'superseedSepolia'
-    | 'vanar'
-    | 'xai'
-    | 'zksync'
-    | 'sepolia'
-    | 'optimism_sepolia'
-    | 'arbitrumSepolia'
-    | 'goerli'
-    | 'optimism_goerli'
-    | 'arbitrumGoerli'
-    | 'basecamp'
-    | 'abstract';
-
-  organizationId: string;
-
-  sortId: number;
-
-  websiteId: string;
-
-  discordUrl?: string;
-
-  homeUrl?: string;
-
-  imageUrl?: string | null;
-
-  instagramUsername?: string;
-
-  royaltyFee?: number | null;
-
-  royaltyFeeAddress?: string | null;
-
-  stakingAddress?: string;
-
-  telegramUrl?: string;
-
-  themeId?: string;
-
-  twitterUsername?: string;
-}
-
-export interface WebsiteCollectionListParams {
-  /**
-   * Filter by website ID
-   */
-  websiteId: string;
-
-  /**
-   * Number of items to return
-   */
-  limit?: number;
-
-  /**
-   * Filter by organization ID
-   */
-  organizationId?: string;
-
-  /**
-   * Pagination cursor, start after this ID
-   */
-  startingAfter?: string;
-}
-
-export declare namespace WebsiteCollections {
-  export {
-    type WebsiteCollectionListResponse as WebsiteCollectionListResponse,
-    type WebsiteCollectionCreateParams as WebsiteCollectionCreateParams,
-    type WebsiteCollectionListParams as WebsiteCollectionListParams,
-  };
-}
+export class WebsiteCollections extends APIResource {}

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,