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

package/src/resources/assets/assets.ts

@@ -0,0 +1,294 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as MintingAPI from './minting';
+import { Minting, MintingGetMintingAssetsParams, MintingGetMintingAssetsResponse } from './minting';
+import * as UsersAPI from './users';
+import {
+  UserConnectUserParams,
+  UserConnectUserResponse,
+  UserDisconnectUserParams,
+  UserDisconnectUserResponse,
+  UserGetUserCountParams,
+  UserGetUserCountResponse,
+  UserGetUsersParams,
+  UserGetUsersResponse,
+  Users,
+} from './users';
+import * as WebsiteCollectionsAPI from './website-collections';
+import {
+  WebsiteCollectionCreateWebsiteCollectionParams,
+  WebsiteCollectionGetWebsiteCollectionsParams,
+  WebsiteCollectionGetWebsiteCollectionsResponse,
+  WebsiteCollections,
+} from './website-collections';
+import * as WebsiteUserRolesAPI from './website-user-roles';
+import {
+  WebsiteUserRoleAssignRolesToUsersParams,
+  WebsiteUserRoleAssignRolesToUsersResponse,
+  WebsiteUserRoleGetWebsiteUserRolesParams,
+  WebsiteUserRoleGetWebsiteUserRolesResponse,
+  WebsiteUserRoles,
+} from './website-user-roles';
+import * as ReferralAPI from './referral/referral';
+import {
+  Referral,
+  ReferralCreateReferralCodeParams,
+  ReferralCreateReferralCodeResponse,
+} from './referral/referral';
+
+export class Assets extends APIResource {
+  users: UsersAPI.Users = new UsersAPI.Users(this._client);
+  minting: MintingAPI.Minting = new MintingAPI.Minting(this._client);
+  referral: ReferralAPI.Referral = new ReferralAPI.Referral(this._client);
+  websiteCollections: WebsiteCollectionsAPI.WebsiteCollections = new WebsiteCollectionsAPI.WebsiteCollections(
+    this._client,
+  );
+  websiteUserRoles: WebsiteUserRolesAPI.WebsiteUserRoles = new WebsiteUserRolesAPI.WebsiteUserRoles(
+    this._client,
+  );
+
+  /**
+   * This endpoint enables you to upload a file to the resource. Returns a presigned
+   * URL and the asset's public URL. Call PUT with the file as the body to upload the
+   * asset using the presigned URL.
+   */
+  create(body: AssetCreateParams, options?: Core.RequestOptions): Core.APIPromise<AssetCreateResponse> {
+    return this._client.post('/api/assets', { body, ...options });
+  }
+
+  /**
+   * Returns a list of auctions with optional filtering and pagination.
+   */
+  getAuctions(options?: Core.RequestOptions): Core.APIPromise<AssetGetAuctionsResponse> {
+    return this._client.get('/api/auctions', options);
+  }
+}
+
+/**
+ * Response returned upon successful generation of the signed URL for uploading the
+ * file.
+ */
+export interface AssetCreateResponse {
+  /**
+   * The pre-signed URL to be used for uploading the file.
+   */
+  signedUrl: string;
+
+  /**
+   * The URL of the uploaded file.
+   */
+  url: string;
+}
+
+/**
+ * Schema for the response when fetching auctions
+ */
+export interface AssetGetAuctionsResponse {
+  data: Array<AssetGetAuctionsResponse.Data>;
+
+  hasNextPage: boolean;
+}
+
+export namespace AssetGetAuctionsResponse {
+  export interface Data {
+    id: string;
+
+    auctionBids: Array<Data.AuctionBid>;
+
+    auctionItems: Array<Data.AuctionItem>;
+
+    biddersOwnCollectionAddresses: Array<string>;
+
+    createdAt: string;
+
+    currencyAddress: string | null;
+
+    currencyDecimals: number;
+
+    deletedAt: string | null;
+
+    description: string;
+
+    endsAt: string;
+
+    extendedDurationInSeconds: number | null;
+
+    hideBids: boolean;
+
+    /**
+     * Schema representing a loyalty currency
+     */
+    loyaltyCurrency: Data.LoyaltyCurrency | null;
+
+    loyaltyCurrencyId: string | null;
+
+    minBidAmount: string;
+
+    minBidIncrement: string | null;
+
+    mintingContractId: string;
+
+    name: string;
+
+    network: 'ethereum' | 'zksync';
+
+    organizationId: string;
+
+    reservePrice: string | null;
+
+    signature: string;
+
+    startsAt: string;
+
+    status: 'in_progress' | 'completed' | 'cancelled';
+
+    type: 'first_price' | 'second_price' | 'english';
+
+    updatedAt: string;
+
+    userId: string;
+
+    websiteId: string;
+  }
+
+  export namespace Data {
+    /**
+     * Schema representing an auction bid
+     */
+    export interface AuctionBid {
+      id: string;
+
+      amount: string;
+
+      createdAt: string;
+    }
+
+    export interface AuctionItem {
+      id: string;
+
+      /**
+       * Schema representing a minting contract asset
+       */
+      mintingContractAsset: AuctionItem.MintingContractAsset;
+
+      quantity: number;
+
+      sortId: number;
+    }
+
+    export namespace AuctionItem {
+      /**
+       * Schema representing a minting contract asset
+       */
+      export interface MintingContractAsset {
+        id: string;
+      }
+    }
+
+    /**
+     * Schema representing a loyalty currency
+     */
+    export interface LoyaltyCurrency {
+      id: string;
+
+      decimals: number;
+
+      imageUrl: string | null;
+
+      name: string;
+
+      symbol: string;
+    }
+  }
+}
+
+export interface AssetCreateParams {
+  /**
+   * The name of the file, must match the regex pattern (converted to lowercase)
+   */
+  fileName: string;
+
+  /**
+   * The file path, must be a valid enum value.
+   */
+  filePath?:
+    | 'announcements'
+    | 'images'
+    | 'videos'
+    | 'banners'
+    | 'fonts'
+    | 'posts'
+    | 'profiles'
+    | 'minting'
+    | 'loyalty';
+
+  /**
+   * UUID of the organization (optional, converted to lowercase)
+   */
+  organizationId?: string;
+
+  /**
+   * UUID of the user (optional, converted to lowercase)
+   */
+  userId?: string;
+
+  /**
+   * UUID of the website (optional, converted to lowercase)
+   */
+  websiteId?: string;
+}
+
+Assets.Users = Users;
+Assets.Minting = Minting;
+Assets.Referral = Referral;
+Assets.WebsiteCollections = WebsiteCollections;
+Assets.WebsiteUserRoles = WebsiteUserRoles;
+
+export declare namespace Assets {
+  export {
+    type AssetCreateResponse as AssetCreateResponse,
+    type AssetGetAuctionsResponse as AssetGetAuctionsResponse,
+    type AssetCreateParams as AssetCreateParams,
+  };
+
+  export {
+    Users as Users,
+    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,
+  };
+
+  export {
+    Minting as Minting,
+    type MintingGetMintingAssetsResponse as MintingGetMintingAssetsResponse,
+    type MintingGetMintingAssetsParams as MintingGetMintingAssetsParams,
+  };
+
+  export {
+    Referral as Referral,
+    type ReferralCreateReferralCodeResponse as ReferralCreateReferralCodeResponse,
+    type ReferralCreateReferralCodeParams as ReferralCreateReferralCodeParams,
+  };
+
+  export {
+    WebsiteCollections as WebsiteCollections,
+    type WebsiteCollectionGetWebsiteCollectionsResponse as WebsiteCollectionGetWebsiteCollectionsResponse,
+    type WebsiteCollectionCreateWebsiteCollectionParams as WebsiteCollectionCreateWebsiteCollectionParams,
+    type WebsiteCollectionGetWebsiteCollectionsParams as WebsiteCollectionGetWebsiteCollectionsParams,
+  };
+
+  export {
+    WebsiteUserRoles as WebsiteUserRoles,
+    type WebsiteUserRoleAssignRolesToUsersResponse as WebsiteUserRoleAssignRolesToUsersResponse,
+    type WebsiteUserRoleGetWebsiteUserRolesResponse as WebsiteUserRoleGetWebsiteUserRolesResponse,
+    type WebsiteUserRoleAssignRolesToUsersParams as WebsiteUserRoleAssignRolesToUsersParams,
+    type WebsiteUserRoleGetWebsiteUserRolesParams as WebsiteUserRoleGetWebsiteUserRolesParams,
+  };
+}

package/src/resources/assets/index.ts

@@ -0,0 +1,38 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Assets,
+  type AssetCreateResponse,
+  type AssetGetAuctionsResponse,
+  type AssetCreateParams,
+} from './assets';
+export { Minting, type MintingGetMintingAssetsResponse, type MintingGetMintingAssetsParams } from './minting';
+export {
+  Referral,
+  type ReferralCreateReferralCodeResponse,
+  type ReferralCreateReferralCodeParams,
+} from './referral/index';
+export {
+  Users,
+  type UserConnectUserResponse,
+  type UserDisconnectUserResponse,
+  type UserGetUserCountResponse,
+  type UserGetUsersResponse,
+  type UserConnectUserParams,
+  type UserDisconnectUserParams,
+  type UserGetUserCountParams,
+  type UserGetUsersParams,
+} from './users';
+export {
+  WebsiteCollections,
+  type WebsiteCollectionGetWebsiteCollectionsResponse,
+  type WebsiteCollectionCreateWebsiteCollectionParams,
+  type WebsiteCollectionGetWebsiteCollectionsParams,
+} from './website-collections';
+export {
+  WebsiteUserRoles,
+  type WebsiteUserRoleAssignRolesToUsersResponse,
+  type WebsiteUserRoleGetWebsiteUserRolesResponse,
+  type WebsiteUserRoleAssignRolesToUsersParams,
+  type WebsiteUserRoleGetWebsiteUserRolesParams,
+} from './website-user-roles';

package/src/resources/assets/minting.ts

@@ -0,0 +1,153 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class Minting extends APIResource {
+  /**
+   * Returns minting assets and any relevant context
+   */
+  getMintingAssets(
+    query: MintingGetMintingAssetsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MintingGetMintingAssetsResponse> {
+    return this._client.get('/api/minting/assets', { query, ...options });
+  }
+}
+
+/**
+ * Schema for getting minting assets response
+ */
+export interface MintingGetMintingAssetsResponse {
+  /**
+   * Array of minting assets
+   */
+  data: Array<MintingGetMintingAssetsResponse.Data>;
+
+  /**
+   * Indicates if more pages are available
+   */
+  hasNextPage: boolean;
+}
+
+export namespace MintingGetMintingAssetsResponse {
+  export interface Data {
+    /**
+     * UUID of the minting asset
+     */
+    id: string;
+  }
+}
+
+export interface MintingGetMintingAssetsParams {
+  /**
+   * Organization ID
+   */
+  organizationId: string;
+
+  /**
+   * Website ID
+   */
+  websiteId: string;
+
+  /**
+   * Contract Address
+   */
+  contractAddress?: string;
+
+  /**
+   * Currency Type
+   */
+  currencyType?: 'loyalty' | 'native' | null;
+
+  /**
+   * Whether to include deleted assets in the response
+   */
+  includeDeleted?: boolean | null;
+
+  /**
+   * Whether to include metadata in the response
+   */
+  includeMetadata?: boolean | null;
+
+  /**
+   * Whether to include listed assets in the response
+   */
+  isListed?: boolean | null;
+
+  /**
+   * Minting Contract Asset ID
+   */
+  mintingContractAssetId?: string | null;
+
+  /**
+   * Minting Contract IDs
+   */
+  mintingContractIds?: string | null;
+
+  /**
+   * Network
+   */
+  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';
+
+  /**
+   * Sort Dir
+   */
+  sortDir?: 'asc' | 'desc' | null;
+
+  /**
+   * Sort Key
+   */
+  sortKey?: 'price' | 'startsAt' | 'assetNr' | null;
+
+  /**
+   * Status
+   */
+  status?: 'active' | 'past' | null;
+
+  /**
+   * Token ID
+   */
+  tokenId?: string | Array<number> | null;
+
+  /**
+   * Wallet Address
+   */
+  walletAddress?: string | Array<string>;
+}
+
+export declare namespace Minting {
+  export {
+    type MintingGetMintingAssetsResponse as MintingGetMintingAssetsResponse,
+    type MintingGetMintingAssetsParams as MintingGetMintingAssetsParams,
+  };
+}

package/src/resources/assets/referral/index.ts

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Referral,
+  type ReferralCreateReferralCodeResponse,
+  type ReferralCreateReferralCodeParams,
+} from './referral';
+export {
+  Users,
+  type UserCreateReferralUserResponse,
+  type UserGetReferralsResponse,
+  type UserCreateReferralUserParams,
+  type UserGetReferralsParams,
+} from './users';

package/src/resources/assets/referral/referral.ts

@@ -0,0 +1,74 @@
+// 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 UsersAPI from './users';
+import {
+  UserCreateReferralUserParams,
+  UserCreateReferralUserResponse,
+  UserGetReferralsParams,
+  UserGetReferralsResponse,
+  Users,
+} from './users';
+
+export class Referral extends APIResource {
+  users: UsersAPI.Users = new UsersAPI.Users(this._client);
+
+  /**
+   * This endpoint allows you to create a referral code
+   */
+  createReferralCode(
+    body?: ReferralCreateReferralCodeParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ReferralCreateReferralCodeResponse>;
+  createReferralCode(options?: Core.RequestOptions): Core.APIPromise<ReferralCreateReferralCodeResponse>;
+  createReferralCode(
+    body: ReferralCreateReferralCodeParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ReferralCreateReferralCodeResponse> {
+    if (isRequestOptions(body)) {
+      return this.createReferralCode({}, body);
+    }
+    return this._client.post('/api/referral/codes', { body, ...options });
+  }
+}
+
+export interface ReferralCreateReferralCodeResponse {
+  id: string;
+
+  createdAt: string;
+
+  deletedAt: string | null;
+
+  organizationId: string;
+
+  referralCode: string;
+
+  updatedAt: string;
+
+  userId: string;
+
+  websiteId: string;
+}
+
+export interface ReferralCreateReferralCodeParams {
+  userId?: string;
+}
+
+Referral.Users = Users;
+
+export declare namespace Referral {
+  export {
+    type ReferralCreateReferralCodeResponse as ReferralCreateReferralCodeResponse,
+    type ReferralCreateReferralCodeParams as ReferralCreateReferralCodeParams,
+  };
+
+  export {
+    Users as Users,
+    type UserCreateReferralUserResponse as UserCreateReferralUserResponse,
+    type UserGetReferralsResponse as UserGetReferralsResponse,
+    type UserCreateReferralUserParams as UserCreateReferralUserParams,
+    type UserGetReferralsParams as UserGetReferralsParams,
+  };
+}

package/src/resources/assets/referral/users.ts

@@ -0,0 +1,99 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import * as Core from '../../../core';
+
+export class Users extends APIResource {
+  /**
+   * This endpoint allows you to create a referral user
+   */
+  createReferralUser(
+    body: UserCreateReferralUserParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<UserCreateReferralUserResponse> {
+    return this._client.post('/api/referral/users', { body, ...options });
+  }
+
+  /**
+   * This endpoint allows you to get referrals
+   */
+  getReferrals(
+    query: UserGetReferralsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<UserGetReferralsResponse> {
+    return this._client.get('/api/referral/users', { query, ...options });
+  }
+}
+
+export interface UserCreateReferralUserResponse {
+  message: string;
+}
+
+export interface UserGetReferralsResponse {
+  data: Array<UserGetReferralsResponse.Data>;
+
+  hasNextPage: boolean;
+}
+
+export namespace UserGetReferralsResponse {
+  export interface Data {
+    id: string;
+
+    referralCode: Data.ReferralCode;
+
+    user: Data.User;
+  }
+
+  export namespace Data {
+    export interface ReferralCode {
+      id: string;
+
+      createdAt: string;
+
+      deletedAt: string | null;
+
+      referralCode: string;
+
+      updatedAt: string;
+
+      userId: string;
+    }
+
+    export interface User {
+      id: string;
+
+      walletAddress: string;
+    }
+  }
+}
+
+export interface UserCreateReferralUserParams {
+  userIds: Array<string>;
+
+  referralCode?: string;
+
+  referralCodeId?: string;
+}
+
+export interface UserGetReferralsParams {
+  walletAddress: string | Array<string>;
+
+  includeEligibility?: boolean | null;
+
+  limit?: number;
+
+  organizationId?: string;
+
+  startingAfter?: string;
+
+  websiteId?: string;
+}
+
+export declare namespace Users {
+  export {
+    type UserCreateReferralUserResponse as UserCreateReferralUserResponse,
+    type UserGetReferralsResponse as UserGetReferralsResponse,
+    type UserCreateReferralUserParams as UserCreateReferralUserParams,
+    type UserGetReferralsParams as UserGetReferralsParams,
+  };
+}