@snagsolutions/sdk 0.1.0-alpha.13 → 0.1.0-alpha.14

package/src/resources/assets/users.ts

@@ -0,0 +1,415 @@
+// 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';
+
+export class Users extends APIResource {
+  /**
+   * This endpoint allows you to create a user
+   */
+  connectUser(
+    body: UserConnectUserParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<UserConnectUserResponse> {
+    return this._client.post('/api/users/connect', { body, ...options });
+  }
+
+  /**
+   * This endpoint allows you to disconnect a user from another user
+   */
+  disconnectUser(body: UserDisconnectUserParams, options?: Core.RequestOptions): Core.APIPromise<unknown> {
+    return this._client.post('/api/users/disconnect', { body, ...options });
+  }
+
+  /**
+   * This endpoint returns the total user count
+   */
+  getUserCount(
+    query: UserGetUserCountParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<UserGetUserCountResponse> {
+    return this._client.get('/api/users/count', { query, ...options });
+  }
+
+  /**
+   * This endpoint allows you to get users
+   */
+  getUsers(query?: UserGetUsersParams, options?: Core.RequestOptions): Core.APIPromise<UserGetUsersResponse>;
+  getUsers(options?: Core.RequestOptions): Core.APIPromise<UserGetUsersResponse>;
+  getUsers(
+    query: UserGetUsersParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<UserGetUsersResponse> {
+    if (isRequestOptions(query)) {
+      return this.getUsers({}, query);
+    }
+    return this._client.get('/api/users', { query, ...options });
+  }
+}
+
+export interface UserConnectUserResponse {
+  /**
+   * 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;
+}
+
+export type UserDisconnectUserResponse = unknown;
+
+/**
+ * Schema for counting users response
+ */
+export interface UserGetUserCountResponse {
+  /**
+   * Total count of users
+   */
+  totalCount: number;
+}
+
+export interface UserGetUsersResponse {
+  /**
+   * Schema for users response
+   */
+  data: Array<UserGetUsersResponse.Data>;
+}
+
+export namespace UserGetUsersResponse {
+  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;
+
+      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;
+
+      twitterUser?: string | null;
+
+      twitterUserFollowersCount?: number | null;
+
+      twitterVerifiedAt?: string | null;
+
+      userGroupId?: string | null;
+
+      walletGroupIdentifier?: string | null;
+    }
+  }
+}
+
+export interface UserConnectUserParams {
+  /**
+   * The ID of the organization
+   */
+  organizationId: string;
+
+  /**
+   * The wallet address of the user
+   */
+  walletAddress: string;
+
+  walletType: 'evm' | 'solana' | 'imx' | 'sui' | 'ton';
+
+  /**
+   * 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?: UserConnectUserParams.VerificationData;
+}
+
+export namespace UserConnectUserParams {
+  /**
+   * The verification data of the user walletAddress
+   */
+  export interface VerificationData {
+    accessToken?: 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 UserDisconnectUserParams {
+  organizationId: string;
+
+  userId: string;
+
+  websiteId: string;
+}
+
+export interface UserGetUserCountParams {
+  /**
+   * The ID of the organization
+   */
+  organizationId: string;
+
+  /**
+   * The ID of the website
+   */
+  websiteId: string;
+}
+
+export interface UserGetUsersParams {
+  /**
+   * The address of the user
+   */
+  address?: string;
+
+  /**
+   * Discord username of the user
+   */
+  discordUser?: 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 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 declare namespace Users {
+  export {
+    type UserConnectUserResponse as UserConnectUserResponse,
+    type UserDisconnectUserResponse as UserDisconnectUserResponse,
+    type UserGetUserCountResponse as UserGetUserCountResponse,
+    type UserGetUsersResponse as UserGetUsersResponse,
+    type UserConnectUserParams as UserConnectUserParams,
+    type UserDisconnectUserParams as UserDisconnectUserParams,
+    type UserGetUserCountParams as UserGetUserCountParams,
+    type UserGetUsersParams as UserGetUsersParams,
+  };
+}

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

@@ -0,0 +1,147 @@
+// 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
+   */
+  createWebsiteCollection(
+    body: WebsiteCollectionCreateWebsiteCollectionParams,
+    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.
+   */
+  getWebsiteCollections(
+    query: WebsiteCollectionGetWebsiteCollectionsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WebsiteCollectionGetWebsiteCollectionsResponse> {
+    return this._client.get('/api/website_collections', { query, ...options });
+  }
+}
+
+/**
+ * Response schema for fetching website collections
+ */
+export interface WebsiteCollectionGetWebsiteCollectionsResponse {
+  /**
+   * Array of websites
+   */
+  data: Array<WebsiteCollectionGetWebsiteCollectionsResponse.Data>;
+
+  /**
+   * Indicates if more pages are available
+   */
+  hasNextPage: boolean;
+}
+
+export namespace WebsiteCollectionGetWebsiteCollectionsResponse {
+  export interface Data {
+    /**
+     * Website Collection ID
+     */
+    id: string;
+  }
+}
+
+export interface WebsiteCollectionCreateWebsiteCollectionParams {
+  collectionAddress: string;
+
+  name: string;
+
+  network:
+    | 'mainnet'
+    | 'polygon'
+    | 'polygon_mumbai'
+    | 'optimism'
+    | 'arbitrum'
+    | 'binance'
+    | 'bscTestnet'
+    | 'avalanche'
+    | 'avalancheFuji'
+    | 'zksync'
+    | 'fantom'
+    | 'fantomTestnet'
+    | 'base'
+    | 'baseSepolia'
+    | 'skaleNebula'
+    | 'xai'
+    | 'berachainArtio'
+    | 'solana'
+    | 'apechain'
+    | 'flowMainnet'
+    | 'campTestnet'
+    | 'sui'
+    | 'vanar'
+    | 'sepolia'
+    | 'optimism_sepolia'
+    | 'arbitrumSepolia'
+    | 'goerli'
+    | 'optimism_goerli'
+    | 'arbitrumGoerli';
+
+  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 WebsiteCollectionGetWebsiteCollectionsParams {
+  /**
+   * 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 WebsiteCollectionGetWebsiteCollectionsResponse as WebsiteCollectionGetWebsiteCollectionsResponse,
+    type WebsiteCollectionCreateWebsiteCollectionParams as WebsiteCollectionCreateWebsiteCollectionParams,
+    type WebsiteCollectionGetWebsiteCollectionsParams as WebsiteCollectionGetWebsiteCollectionsParams,
+  };
+}

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

@@ -0,0 +1,107 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class WebsiteUserRoles extends APIResource {
+  /**
+   * Assign roles to users for a specific website
+   */
+  assignRolesToUsers(
+    body: WebsiteUserRoleAssignRolesToUsersParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WebsiteUserRoleAssignRolesToUsersResponse> {
+    return this._client.post('/api/website_user_roles', { body, ...options });
+  }
+
+  /**
+   * Retrieves roles of users for a specific website. If userId is provided,
+   * retrieves the role of that specific user for the website.
+   */
+  getWebsiteUserRoles(
+    query: WebsiteUserRoleGetWebsiteUserRolesParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WebsiteUserRoleGetWebsiteUserRolesResponse> {
+    return this._client.get('/api/website_user_roles', { query, ...options });
+  }
+}
+
+/**
+ * Schema for postWebsiteUserRoles response
+ */
+export interface WebsiteUserRoleAssignRolesToUsersResponse {
+  data?: unknown;
+}
+
+/**
+ * Schema for getWebsiteUserRoles response
+ */
+export interface WebsiteUserRoleGetWebsiteUserRolesResponse {
+  data: Array<WebsiteUserRoleGetWebsiteUserRolesResponse.Data>;
+}
+
+export namespace WebsiteUserRoleGetWebsiteUserRolesResponse {
+  export interface Data {
+    /**
+     * UUID of the website user role
+     */
+    id: string;
+  }
+}
+
+export interface WebsiteUserRoleAssignRolesToUsersParams {
+  /**
+   * UUID of the website
+   */
+  websiteId: string;
+
+  /**
+   * Array of website user roles
+   */
+  websiteUserRoles: Array<WebsiteUserRoleAssignRolesToUsersParams.WebsiteUserRole>;
+}
+
+export namespace WebsiteUserRoleAssignRolesToUsersParams {
+  export interface WebsiteUserRole {
+    /**
+     * Role type of the user
+     */
+    roleType:
+      | 'WEBSITE_SUPER_ADMIN'
+      | 'WEBSITE_ADMIN'
+      | 'WEBSITE_MODERATOR'
+      | 'WEBSITE_API_KEY'
+      | 'STRATUS_API_KEY';
+
+    /**
+     * Wallet address of the user
+     */
+    walletAddress: string;
+
+    /**
+     * Deletion date of the user role
+     */
+    deletedAt?: string;
+  }
+}
+
+export interface WebsiteUserRoleGetWebsiteUserRolesParams {
+  /**
+   * UUID of the website
+   */
+  websiteId: string;
+
+  /**
+   * UUID of the user
+   */
+  userId?: string;
+}
+
+export declare namespace WebsiteUserRoles {
+  export {
+    type WebsiteUserRoleAssignRolesToUsersResponse as WebsiteUserRoleAssignRolesToUsersResponse,
+    type WebsiteUserRoleGetWebsiteUserRolesResponse as WebsiteUserRoleGetWebsiteUserRolesResponse,
+    type WebsiteUserRoleAssignRolesToUsersParams as WebsiteUserRoleAssignRolesToUsersParams,
+    type WebsiteUserRoleGetWebsiteUserRolesParams as WebsiteUserRoleGetWebsiteUserRolesParams,
+  };
+}