@snagsolutions/sdk 0.1.0-alpha.55 → 0.1.0-alpha.57

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>;
@@ -32,6 +37,17 @@ export class Users extends APIResource {
 
   /**
    * This endpoint allows you to create a user
+   *
+   * @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,6 +55,14 @@ 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 });
@@ -46,6 +70,13 @@ export class Users extends APIResource {
 
   /**
    * 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,
@@ -56,6 +87,15 @@ export class Users extends APIResource {
 
   /**
    * 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,
@@ -64,6 +104,14 @@ export class Users extends APIResource {
     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 });
   }

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: 0,
+   *   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,
@@ -78,6 +99,7 @@ export interface WebsiteCollectionCreateParams {
     | 'skaleNebula'
     | 'solana'
     | 'sophon'
+    | 'sophonTestnet'
     | 'sui'
     | 'superseed'
     | 'superseedSepolia'

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_ADMIN',
+   *         walletAddress:
+   *           '0x1234567890abcdef1234567890abcdef12345678',
+   *       },
+   *     ],
+   *   });
+   * ```
    */
   assign(
     body: WebsiteUserRoleAssignParams,

package/src/resources/websites/websites.ts

@@ -29,6 +29,13 @@ export class Websites extends APIResource {
 
   /**
    * Creates a new website
+   *
+   * @example
+   * ```ts
+   * const website = await client.websites.create({
+   *   name: 'My New Website',
+   * });
+   * ```
    */
   create(body: WebsiteCreateParams, options?: Core.RequestOptions): Core.APIPromise<WebsiteCreateResponse> {
     return this._client.post('/api/websites', { body, ...options });
@@ -37,6 +44,11 @@ export class Websites extends APIResource {
   /**
    * Returns a list of websites. Includes optional query parameters for filtering and
    * pagination.
+   *
+   * @example
+   * ```ts
+   * const websites = await client.websites.list();
+   * ```
    */
   list(query?: WebsiteListParams, options?: Core.RequestOptions): Core.APIPromise<WebsiteListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<WebsiteListResponse>;

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-alpha.55'; // x-release-please-version
+export const VERSION = '0.1.0-alpha.57'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-alpha.55";
+export declare const VERSION = "0.1.0-alpha.57";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.1.0-alpha.55'; // x-release-please-version
+exports.VERSION = '0.1.0-alpha.57'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.1.0-alpha.55'; // x-release-please-version
+export const VERSION = '0.1.0-alpha.57'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map