@snagsolutions/sdk 0.1.0-alpha.215 → 0.1.0-alpha.217

package/src/resources/minting/contracts.ts

@@ -0,0 +1,405 @@
+// 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 Contracts extends APIResource {
+  /**
+   * Get minting contracts
+   *
+   * @example
+   * ```ts
+   * const contracts = await client.minting.contracts.list();
+   * ```
+   */
+  list(query?: ContractListParams, options?: Core.RequestOptions): Core.APIPromise<ContractListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<ContractListResponse>;
+  list(
+    query: ContractListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ContractListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/api/minting/contracts', { query, ...options });
+  }
+
+  /**
+   * Generates a signature for minting an asset on a given contract
+   *
+   * @example
+   * ```ts
+   * const response = await client.minting.contracts.mint({
+   *   assetId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   contractId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * });
+   * ```
+   */
+  mint(body: ContractMintParams, options?: Core.RequestOptions): Core.APIPromise<ContractMintResponse> {
+    return this._client.post('/api/minting/contracts/mint', { body, ...options });
+  }
+}
+
+export interface ContractListResponse {
+  data: Array<ContractListResponse.Data>;
+
+  hasNextPage: boolean;
+
+  stats: Array<ContractListResponse.Stat>;
+}
+
+export namespace ContractListResponse {
+  export interface Data {
+    id: string;
+
+    _count: Data._Count;
+
+    address: string;
+
+    description: string | null;
+
+    enableGasless: boolean;
+
+    externalLinkUrl: string | null;
+
+    hasRevealMechanic: boolean;
+
+    hideInactiveListings: boolean;
+
+    imageUrl: string | null;
+
+    isFreeClaimForBadgeHolders: boolean;
+
+    isFreeClaimForTokenHolders: boolean;
+
+    isListed: boolean;
+
+    isPerAssetMintLimit: boolean;
+
+    isSoulbound: boolean;
+
+    mintingContractAssets: Array<Data.MintingContractAsset>;
+
+    mintingContractBadgeAssociation: Array<Data.MintingContractBadgeAssociation>;
+
+    mustOwnCollections: Array<Data.MustOwnCollection>;
+
+    name: string;
+
+    network:
+      | 'abstract'
+      | 'abstractTestnet'
+      | 'apechain'
+      | 'arbitrum'
+      | 'avalanche'
+      | 'avalancheFuji'
+      | 'base'
+      | 'baseSepolia'
+      | 'berachain'
+      | 'berachainArtio'
+      | 'berachainBepolia'
+      | 'binance'
+      | 'bscTestnet'
+      | 'campTestnet'
+      | 'fantom'
+      | 'fantomTestnet'
+      | 'flowMainnet'
+      | 'mainnet'
+      | 'nexusTestnet'
+      | 'optimism'
+      | 'polygon'
+      | 'polygon_mumbai'
+      | 'skaleNebula'
+      | 'skaleEuropa'
+      | 'skaleCalypso'
+      | 'solana'
+      | 'sophon'
+      | 'sophonTestnet'
+      | 'sui'
+      | 'superseed'
+      | 'superseedSepolia'
+      | 'vanar'
+      | 'xai'
+      | 'zksync'
+      | 'coti'
+      | 'cotiTestnet'
+      | 'morph'
+      | 'morphTestnet'
+      | 'morphHolesky'
+      | 'ultra'
+      | 'ultraTestnet'
+      | 'nitrograph'
+      | 'sepolia'
+      | 'optimism_sepolia'
+      | 'arbitrumSepolia'
+      | 'goerli'
+      | 'optimism_goerli'
+      | 'arbitrumGoerli'
+      | 'basecamp'
+      | 'somnia'
+      | 'zkverify'
+      | 'polkadot'
+      | 'kusama'
+      | 'flow_cadence';
+
+    organizationId: string;
+
+    preRevealMedia: string | null;
+
+    primarySaleRecipientAddress: string;
+
+    relayerId: string | null;
+
+    requireHoldingAllGatedItems: boolean;
+
+    revealAvailableAt: string | null;
+
+    royaltyFee: unknown;
+
+    royaltyFeeAddress: string;
+
+    shouldCollectEmail: boolean;
+
+    showOnMarketplace: boolean;
+
+    sortId: number | null;
+
+    symbol: string;
+
+    tokenType: 'erc721' | 'erc1155' | 'erc721c';
+
+    websiteCollectionId: string | null;
+
+    websiteId: string;
+  }
+
+  export namespace Data {
+    export interface _Count {
+      mintingContractAssets: number;
+    }
+
+    export interface MintingContractAsset {
+      id: string;
+
+      animationUrl: string | null;
+
+      assetNr: number;
+
+      auctionItems: Array<MintingContractAsset.AuctionItem>;
+
+      collectInfoType: 'customInput' | 'freeText' | 'shippingDetails' | null;
+
+      currencyAddress: string | null;
+
+      currencyDecimals: number | null;
+
+      description: string | null;
+
+      imageUrl: string | null;
+
+      isHidden: boolean;
+
+      isListed: boolean;
+
+      isPhygitalItem: boolean;
+
+      listingEndsAt: string | null;
+
+      listingStartsAt: string | null;
+
+      loyaltyCurrencyId: string | null;
+
+      name: string;
+
+      organizationId: string;
+
+      price: unknown;
+
+      quantity: number;
+
+      quantityMinted: number;
+
+      revealedAt: string | null;
+
+      shouldCollectUserInfo: boolean;
+
+      tokenId: number | null;
+
+      unlimitedQty: boolean;
+
+      websiteId: string;
+    }
+
+    export namespace MintingContractAsset {
+      export interface AuctionItem {
+        id: string;
+      }
+    }
+
+    export interface MintingContractBadgeAssociation {
+      loyaltyBadge: MintingContractBadgeAssociation.LoyaltyBadge;
+    }
+
+    export namespace MintingContractBadgeAssociation {
+      export interface LoyaltyBadge {
+        id: string;
+
+        imageUrl: string | null;
+
+        name: string;
+      }
+    }
+
+    export interface MustOwnCollection {
+      address: string;
+
+      network:
+        | 'abstract'
+        | 'abstractTestnet'
+        | 'apechain'
+        | 'arbitrum'
+        | 'avalanche'
+        | 'avalancheFuji'
+        | 'base'
+        | 'baseSepolia'
+        | 'berachain'
+        | 'berachainArtio'
+        | 'berachainBepolia'
+        | 'binance'
+        | 'bscTestnet'
+        | 'campTestnet'
+        | 'fantom'
+        | 'fantomTestnet'
+        | 'flowMainnet'
+        | 'mainnet'
+        | 'nexusTestnet'
+        | 'optimism'
+        | 'polygon'
+        | 'polygon_mumbai'
+        | 'skaleNebula'
+        | 'skaleEuropa'
+        | 'skaleCalypso'
+        | 'solana'
+        | 'sophon'
+        | 'sophonTestnet'
+        | 'sui'
+        | 'superseed'
+        | 'superseedSepolia'
+        | 'vanar'
+        | 'xai'
+        | 'zksync'
+        | 'coti'
+        | 'cotiTestnet'
+        | 'morph'
+        | 'morphTestnet'
+        | 'morphHolesky'
+        | 'ultra'
+        | 'ultraTestnet'
+        | 'nitrograph'
+        | 'sepolia'
+        | 'optimism_sepolia'
+        | 'arbitrumSepolia'
+        | 'goerli'
+        | 'optimism_goerli'
+        | 'arbitrumGoerli'
+        | 'basecamp'
+        | 'somnia'
+        | 'zkverify'
+        | 'polkadot'
+        | 'kusama'
+        | 'flow_cadence';
+    }
+  }
+
+  export interface Stat {
+    _count: Stat._Count;
+
+    _sum: Stat._Sum;
+
+    mintingContractId: string;
+  }
+
+  export namespace Stat {
+    export interface _Count {
+      isListed: number;
+    }
+
+    export interface _Sum {
+      quantity: number | null;
+
+      quantityMinted: number | null;
+    }
+  }
+}
+
+/**
+ * Use the id returned here to fetch the status and signature of the mint from the
+ * `/api/minting/status/:id` endpoint
+ */
+export interface ContractMintResponse {
+  mintingContractAssetMintStatusId: string;
+}
+
+export interface ContractListParams {
+  includeDeleted?: boolean | null;
+
+  limit?: number;
+
+  organizationId?: string;
+
+  showOnMarketplace?: boolean | null;
+
+  startingAfter?: string;
+
+  websiteId?: string;
+}
+
+export interface ContractMintParams {
+  assetId: string;
+
+  contractId: string;
+
+  agreedToSendW9?: boolean | null;
+
+  customInputValue?: string | null;
+
+  emailAddress?: string;
+
+  quantity?: number;
+
+  shippingId?: string;
+
+  shippingOrderType?:
+    | 'stripe'
+    | 'shipstation'
+    | 'drip'
+    | 'twitter_bearer'
+    | 'epic_games'
+    | 'stardust'
+    | 'twitter_clientsecret'
+    | 'immutable_passport'
+    | 'sequence'
+    | 'google'
+    | 'walletConnect'
+    | 'auth0'
+    | 'privy'
+    | 'thirdweb'
+    | 'steam'
+    | 'discord'
+    | 'google_api'
+    | 'shopify'
+    | 'ultra'
+    | 'github';
+
+  walletAddress?: string;
+}
+
+export declare namespace Contracts {
+  export {
+    type ContractListResponse as ContractListResponse,
+    type ContractMintResponse as ContractMintResponse,
+    type ContractListParams as ContractListParams,
+    type ContractMintParams as ContractMintParams,
+  };
+}

package/src/resources/minting/index.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Allowlist,
+  type AllowlistListResponse,
+  type AllowlistUpsertResponse,
+  type AllowlistListParams,
+  type AllowlistUpsertParams,
+} from './allowlist';
+export {
+  Contracts,
+  type ContractListResponse,
+  type ContractMintResponse,
+  type ContractListParams,
+  type ContractMintParams,
+} from './contracts';
+export {
+  Minting,
+  type MintingGetAssetsResponse,
+  type MintingGetTokenGateStatusResponse,
+  type MintingGetAssetsParams,
+  type MintingGetTokenGateStatusParams,
+} from './minting';
+export {
+  Status,
+  type StatusRetrieveResponse,
+  type StatusUpdateResponse,
+  type StatusUpdateParams,
+} from './status';

package/src/resources/minting/minting.ts

@@ -0,0 +1,277 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as AllowlistAPI from './allowlist';
+import {
+  Allowlist,
+  AllowlistListParams,
+  AllowlistListResponse,
+  AllowlistUpsertParams,
+  AllowlistUpsertResponse,
+} from './allowlist';
+import * as ContractsAPI from './contracts';
+import {
+  ContractListParams,
+  ContractListResponse,
+  ContractMintParams,
+  ContractMintResponse,
+  Contracts,
+} from './contracts';
+import * as StatusAPI from './status';
+import { Status, StatusRetrieveResponse, StatusUpdateParams, StatusUpdateResponse } from './status';
+
+export class Minting extends APIResource {
+  status: StatusAPI.Status = new StatusAPI.Status(this._client);
+  allowlist: AllowlistAPI.Allowlist = new AllowlistAPI.Allowlist(this._client);
+  contracts: ContractsAPI.Contracts = new ContractsAPI.Contracts(this._client);
+
+  /**
+   * Returns minting assets and any relevant context
+   *
+   * @example
+   * ```ts
+   * const response = await client.minting.getAssets({
+   *   organizationId: '00000000-0000-0000-0000-000000000000',
+   *   websiteId: '00000000-0000-0000-0000-000000000000',
+   * });
+   * ```
+   */
+  getAssets(
+    query: MintingGetAssetsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MintingGetAssetsResponse> {
+    return this._client.get('/api/minting/assets', { query, ...options });
+  }
+
+  /**
+   * Pass in to see if a token is eligible for minting
+   *
+   * @example
+   * ```ts
+   * const response = await client.minting.getTokenGateStatus({
+   *   collectionAddress: 'collectionAddress',
+   *   mintingContractAssetId:
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   mintingContractId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   network: 'network',
+   *   tokenId: 'tokenId',
+   * });
+   * ```
+   */
+  getTokenGateStatus(
+    query: MintingGetTokenGateStatusParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MintingGetTokenGateStatusResponse> {
+    return this._client.get('/api/minting/token_gate', { query, ...options });
+  }
+}
+
+/**
+ * Schema for getting minting assets response
+ */
+export interface MintingGetAssetsResponse {
+  /**
+   * Array of minting assets
+   */
+  data: Array<MintingGetAssetsResponse.Data>;
+
+  /**
+   * Indicates if more pages are available
+   */
+  hasNextPage: boolean;
+}
+
+export namespace MintingGetAssetsResponse {
+  export interface Data {
+    /**
+     * UUID of the minting asset
+     */
+    id: string;
+  }
+}
+
+export interface MintingGetTokenGateStatusResponse {
+  eligible: boolean;
+
+  message: string;
+}
+
+export interface MintingGetAssetsParams {
+  /**
+   * 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;
+
+  /**
+   * Comma-separated list of Minting Contract UUIDs
+   */
+  mintingContractIds?: string | null;
+
+  /**
+   * Network
+   */
+  network?:
+    | 'abstract'
+    | 'abstractTestnet'
+    | 'apechain'
+    | 'arbitrum'
+    | 'avalanche'
+    | 'avalancheFuji'
+    | 'base'
+    | 'baseSepolia'
+    | 'berachain'
+    | 'berachainArtio'
+    | 'berachainBepolia'
+    | 'binance'
+    | 'bscTestnet'
+    | 'campTestnet'
+    | 'fantom'
+    | 'fantomTestnet'
+    | 'flowMainnet'
+    | 'mainnet'
+    | 'nexusTestnet'
+    | 'optimism'
+    | 'polygon'
+    | 'polygon_mumbai'
+    | 'skaleNebula'
+    | 'skaleEuropa'
+    | 'skaleCalypso'
+    | 'solana'
+    | 'sophon'
+    | 'sophonTestnet'
+    | 'sui'
+    | 'superseed'
+    | 'superseedSepolia'
+    | 'vanar'
+    | 'xai'
+    | 'zksync'
+    | 'coti'
+    | 'cotiTestnet'
+    | 'morph'
+    | 'morphTestnet'
+    | 'morphHolesky'
+    | 'ultra'
+    | 'ultraTestnet'
+    | 'nitrograph'
+    | 'sepolia'
+    | 'optimism_sepolia'
+    | 'arbitrumSepolia'
+    | 'goerli'
+    | 'optimism_goerli'
+    | 'arbitrumGoerli'
+    | 'basecamp'
+    | 'somnia'
+    | 'zkverify'
+    | 'polkadot'
+    | 'kusama'
+    | 'flow_cadence';
+
+  /**
+   * Sort Key
+   */
+  sortBy?: 'price' | 'startsAt' | 'assetNr' | null;
+
+  /**
+   * Sort Dir
+   */
+  sortDir?: 'asc' | 'desc' | null;
+
+  /**
+   * Status
+   */
+  status?: 'active' | 'past' | null;
+
+  /**
+   * Token ID
+   */
+  tokenId?: string | Array<number> | null;
+
+  /**
+   * Wallet Address
+   */
+  walletAddress?: string | Array<string>;
+}
+
+export interface MintingGetTokenGateStatusParams {
+  collectionAddress: string;
+
+  mintingContractAssetId: string;
+
+  mintingContractId: string;
+
+  network: string;
+
+  tokenId: string;
+}
+
+Minting.Status = Status;
+Minting.Allowlist = Allowlist;
+Minting.Contracts = Contracts;
+
+export declare namespace Minting {
+  export {
+    type MintingGetAssetsResponse as MintingGetAssetsResponse,
+    type MintingGetTokenGateStatusResponse as MintingGetTokenGateStatusResponse,
+    type MintingGetAssetsParams as MintingGetAssetsParams,
+    type MintingGetTokenGateStatusParams as MintingGetTokenGateStatusParams,
+  };
+
+  export {
+    Status as Status,
+    type StatusRetrieveResponse as StatusRetrieveResponse,
+    type StatusUpdateResponse as StatusUpdateResponse,
+    type StatusUpdateParams as StatusUpdateParams,
+  };
+
+  export {
+    Allowlist as Allowlist,
+    type AllowlistListResponse as AllowlistListResponse,
+    type AllowlistUpsertResponse as AllowlistUpsertResponse,
+    type AllowlistListParams as AllowlistListParams,
+    type AllowlistUpsertParams as AllowlistUpsertParams,
+  };
+
+  export {
+    Contracts as Contracts,
+    type ContractListResponse as ContractListResponse,
+    type ContractMintResponse as ContractMintResponse,
+    type ContractListParams as ContractListParams,
+    type ContractMintParams as ContractMintParams,
+  };
+}