@snagsolutions/sdk 0.1.0-alpha.15 → 0.1.0-alpha.151

package/src/resources/users/users.ts

@@ -0,0 +1,603 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as MetadatasAPI from './metadatas';
+import {
+  MetadataCreateParams,
+  MetadataCreateResponse,
+  MetadataListParams,
+  MetadataListResponse,
+  Metadatas,
+} from './metadatas';
+
+export class Users extends APIResource {
+  metadatas: MetadatasAPI.Metadatas = new MetadatasAPI.Metadatas(this._client);
+
+  /**
+   * 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>;
+  list(
+    query: UserListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<UserListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/api/users', { query, ...options });
+  }
+
+  /**
+   * 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 });
+  }
+
+  /**
+   * 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 is used to create user devices for fraud tracking
+   *
+   * @example
+   * ```ts
+   * const response = await client.users.createDevice({
+   *   ipAddress: '123.456.789.012',
+   * });
+   * ```
+   */
+  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 {
+  /**
+   * Schema for users response
+   */
+  data: Array<UserListResponse.Data>;
+}
+
+export namespace UserListResponse {
+  /**
+   * Schema for a user response
+   */
+  export interface Data {
+    id: string;
+
+    isSnagSuperAdmin: boolean;
+
+    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;
+
+    privyUserId?: string | null;
+
+    stardustProfileId?: string | null;
+
+    temporaryLoyaltyUser?: boolean | null;
+
+    userMetadata?: Array<Data.UserMetadata> | null;
+  }
+
+  export namespace Data {
+    /**
+     * The followers of the user, only returned if includeFollow is true
+     */
+    export interface _Count {
+      select: _Count.Select;
+    }
+
+    export namespace _Count {
+      export interface Select {
+        followers: number;
+
+        follows: number;
+      }
+    }
+
+    export interface DelegationsFrom {
+      walletAddress: string;
+    }
+
+    export interface Follower {
+      userId: string;
+    }
+
+    export interface UserMetadata {
+      bio?: string | null;
+
+      discordUser?: string | null;
+
+      discordVerifiedAt?: string | null;
+
+      displayName?: string | null;
+
+      /**
+       * The email address of the user, only returned if the user is querying their own
+       * user
+       */
+      emailAddress?: string | null;
+
+      emailVerifiedAt?: string | null;
+
+      epicAccountIdentifier?: string | null;
+
+      epicUsername?: string | null;
+
+      externalLoyaltyScore?: string | null;
+
+      googleUser?: string | null;
+
+      googleUserId?: string | null;
+
+      instagramUser?: string | null;
+
+      instagramVerifiedAt?: string | null;
+
+      isBlocked?: boolean | null;
+
+      location?: string | null;
+
+      logoUrl?: string | null;
+
+      meta?: string | null;
+
+      portfolioUrl?: string | null;
+
+      steamUserId?: string | null;
+
+      steamUsername?: string | null;
+
+      telegramUserId?: string | null;
+
+      telegramUsername?: string | null;
+
+      telegramVerifiedAt?: string | null;
+
+      tiktokUser?: string | null;
+
+      tiktokUserId?: string | null;
+
+      twitterUser?: string | null;
+
+      twitterUserFollowersCount?: number | null;
+
+      twitterVerifiedAt?: string | null;
+
+      userGroupId?: string | null;
+
+      walletGroupIdentifier?: string | null;
+
+      YTChannelId?: string | null;
+    }
+  }
+}
+
+/**
+ * Schema for a connect users response
+ */
+export interface UserConnectResponse {
+  /**
+   * The ID of the user
+   */
+  id: string;
+
+  /**
+   * Timestamp when the user was created
+   */
+  createdAt: string;
+
+  /**
+   * Timestamp when the user was last updated
+   */
+  updatedAt: string;
+
+  /**
+   * The wallet address of the user
+   */
+  walletAddress: string;
+}
+
+/**
+ * Schema for counting users response
+ */
+export interface UserCountResponse {
+  /**
+   * Total count of users
+   */
+  totalCount: number;
+}
+
+/**
+ * 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 {
+  /**
+   * The address of the user
+   */
+  address?: string;
+
+  /**
+   * Discord username of the user
+   */
+  discordUser?: string;
+
+  /**
+   * External identifier for the user
+   */
+  externalIdentifier?: string;
+
+  /**
+   * Whether to include delegations in the response
+   */
+  includeDelegation?: boolean | null;
+
+  /**
+   * Whether to include followers in the response
+   */
+  includeFollow?: boolean | null;
+
+  /**
+   * Number of users to return
+   */
+  limit?: number;
+
+  /**
+   * The ID of the organization
+   */
+  organizationId?: string;
+
+  /**
+   * Pagination cursor to start after a specific user ID
+   */
+  startingAfter?: string;
+
+  /**
+   * Steam ID of the user
+   */
+  steamUserId?: string;
+
+  /**
+   * Steam username of the user
+   */
+  steamUsername?: string;
+
+  /**
+   * Telegram ID of the user
+   */
+  telegramUserId?: string;
+
+  /**
+   * Telegram username of the user
+   */
+  telegramUsername?: string;
+
+  /**
+   * Twitter username of the user
+   */
+  twitterUser?: string;
+
+  /**
+   * External identifier for the user group controlled by you
+   */
+  userGroupExternalIdentifier?: string;
+
+  /**
+   * The ID of the user group
+   */
+  userGroupId?: string;
+
+  /**
+   * The ID of the user
+   */
+  userId?: string | Array<string>;
+
+  /**
+   * The wallet address of the user
+   */
+  walletAddress?: string;
+
+  /**
+   * The ID of the website
+   */
+  websiteId?: string;
+}
+
+export interface UserConnectParams {
+  /**
+   * The ID of the organization
+   */
+  organizationId: string;
+
+  /**
+   * The wallet address of the user
+   */
+  walletAddress: string;
+
+  walletType: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw';
+
+  /**
+   * The ID of the website
+   */
+  websiteId: string;
+
+  /**
+   * Whether to confirm the disconnect
+   */
+  confirmDisconnect?: boolean;
+
+  /**
+   * The ID of the user to whome this wallet is being connected
+   */
+  userId?: string;
+
+  /**
+   * The verification data of the user walletAddress
+   */
+  verificationData?: UserConnectParams.VerificationData;
+}
+
+export namespace UserConnectParams {
+  /**
+   * The verification data of the user walletAddress
+   */
+  export interface VerificationData {
+    accessToken?: string;
+
+    dynamicAuthToken?: string;
+
+    message?: string;
+
+    signature?: string;
+
+    tonVerification?: VerificationData.TonVerification;
+  }
+
+  export namespace VerificationData {
+    export interface TonVerification {
+      account: TonVerification.Account;
+
+      proof: TonVerification.Proof;
+    }
+
+    export namespace TonVerification {
+      export interface Account {
+        address: string;
+
+        chain: '-239' | '-3';
+
+        publicKey: string;
+
+        walletStateInit?: string;
+      }
+
+      export interface Proof {
+        domain: Proof.Domain;
+
+        payload: string;
+
+        signature: string;
+
+        timestamp: number;
+
+        state_init?: string;
+      }
+
+      export namespace Proof {
+        export interface Domain {
+          lengthBytes: number;
+
+          value: string;
+        }
+      }
+    }
+  }
+}
+
+export interface UserCountParams {
+  /**
+   * The ID of the organization
+   */
+  organizationId: string;
+
+  /**
+   * The ID of the website
+   */
+  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;
+
+  userId: string;
+
+  websiteId: string;
+}
+
+export interface UserVerifyParams {
+  accountLinkData: string;
+
+  organizationId?: string;
+
+  userId?: string;
+
+  websiteId?: string;
+}
+
+Users.Metadatas = Metadatas;
+
+export declare namespace Users {
+  export {
+    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 {
+    Metadatas as Metadatas,
+    type MetadataCreateResponse as MetadataCreateResponse,
+    type MetadataListResponse as MetadataListResponse,
+    type MetadataCreateParams as MetadataCreateParams,
+    type MetadataListParams as MetadataListParams,
+  };
+}

package/src/resources/websites/index.ts

@@ -0,0 +1,22 @@
+// 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 {
+  WebsiteUserRoles,
+  type WebsiteUserRoleListResponse,
+  type WebsiteUserRoleAssignResponse,
+  type WebsiteUserRoleListParams,
+  type WebsiteUserRoleAssignParams,
+} from './website-user-roles';
+export {
+  Websites,
+  type WebsiteCreateResponse,
+  type WebsiteListResponse,
+  type WebsiteCreateParams,
+  type WebsiteListParams,
+} from './websites';

package/src/resources/{api → 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,39 +77,53 @@ export interface WebsiteCollectionCreateParams {
   name: string;
 
   network:
-    | 'mainnet'
-    | 'polygon'
-    | 'polygon_mumbai'
-    | 'optimism'
+    | 'abstract'
+    | 'abstractTestnet'
+    | 'apechain'
     | 'arbitrum'
-    | 'binance'
-    | 'bscTestnet'
     | 'avalanche'
     | 'avalancheFuji'
-    | 'zksync'
-    | 'fantom'
-    | 'fantomTestnet'
     | 'base'
     | 'baseSepolia'
-    | 'skaleNebula'
-    | 'xai'
+    | 'berachain'
     | 'berachainArtio'
-    | 'solana'
-    | 'apechain'
-    | 'flowMainnet'
+    | 'berachainBepolia'
+    | 'binance'
+    | 'bscTestnet'
     | 'campTestnet'
+    | 'fantom'
+    | 'fantomTestnet'
+    | 'flowMainnet'
+    | 'mainnet'
+    | 'nexusTestnet'
+    | 'optimism'
+    | 'polygon'
+    | 'polygon_mumbai'
+    | 'skaleNebula'
+    | 'solana'
+    | 'sophon'
+    | 'sophonTestnet'
     | 'sui'
-    | 'vanar'
     | 'superseed'
     | 'superseedSepolia'
+    | 'vanar'
+    | 'xai'
+    | 'zksync'
+    | 'coti'
+    | 'cotiTestnet'
+    | 'morph'
+    | 'morphTestnet'
+    | 'morphHolesky'
+    | 'ultra'
+    | 'ultraTestnet'
+    | 'nitrograph'
     | 'sepolia'
     | 'optimism_sepolia'
     | 'arbitrumSepolia'
     | 'goerli'
     | 'optimism_goerli'
     | 'arbitrumGoerli'
-    | 'basecamp'
-    | 'abstract';
+    | 'basecamp';
 
   organizationId: string;