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

package/src/resources/api/loyalty.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './loyalty/index';

package/src/resources/api/minting.ts

@@ -0,0 +1,157 @@
+// 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
+   */
+  getAssets(
+    query: MintingGetAssetsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MintingGetAssetsResponse> {
+    return this._client.get('/api/minting/assets', { 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 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?:
+    | 'mainnet'
+    | 'polygon'
+    | 'polygon_mumbai'
+    | 'optimism'
+    | 'arbitrum'
+    | 'binance'
+    | 'bscTestnet'
+    | 'avalanche'
+    | 'avalancheFuji'
+    | 'zksync'
+    | 'fantom'
+    | 'fantomTestnet'
+    | 'base'
+    | 'baseSepolia'
+    | 'skaleNebula'
+    | 'xai'
+    | 'berachainArtio'
+    | 'solana'
+    | 'apechain'
+    | 'flowMainnet'
+    | 'campTestnet'
+    | 'sui'
+    | 'vanar'
+    | 'superseed'
+    | 'superseedSepolia'
+    | 'sepolia'
+    | 'optimism_sepolia'
+    | 'arbitrumSepolia'
+    | 'goerli'
+    | 'optimism_goerli'
+    | 'arbitrumGoerli'
+    | 'basecamp'
+    | 'abstract';
+
+  /**
+   * 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 MintingGetAssetsResponse as MintingGetAssetsResponse,
+    type MintingGetAssetsParams as MintingGetAssetsParams,
+  };
+}

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

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Referral, type ReferralCreateCodeResponse, type ReferralCreateCodeParams } from './referral';
+export {
+  Users,
+  type UserCreateResponse,
+  type UserListResponse,
+  type UserCreateParams,
+  type UserListParams,
+} from './users';

package/src/resources/api/referral/referral.ts

@@ -0,0 +1,70 @@
+// 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 { UserCreateParams, UserCreateResponse, UserListParams, UserListResponse, 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
+   */
+  createCode(
+    body?: ReferralCreateCodeParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ReferralCreateCodeResponse>;
+  createCode(options?: Core.RequestOptions): Core.APIPromise<ReferralCreateCodeResponse>;
+  createCode(
+    body: ReferralCreateCodeParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ReferralCreateCodeResponse> {
+    if (isRequestOptions(body)) {
+      return this.createCode({}, body);
+    }
+    return this._client.post('/api/referral/codes', { body, ...options });
+  }
+}
+
+export interface ReferralCreateCodeResponse {
+  id: string;
+
+  createdAt: string;
+
+  deletedAt: string | null;
+
+  organizationId: string;
+
+  referralCode: string;
+
+  updatedAt: string;
+
+  userId: string;
+
+  websiteId: string;
+}
+
+export interface ReferralCreateCodeParams {
+  loyaltyRuleId?: string;
+
+  userId?: string;
+}
+
+Referral.Users = Users;
+
+export declare namespace Referral {
+  export {
+    type ReferralCreateCodeResponse as ReferralCreateCodeResponse,
+    type ReferralCreateCodeParams as ReferralCreateCodeParams,
+  };
+
+  export {
+    Users as Users,
+    type UserCreateResponse as UserCreateResponse,
+    type UserListResponse as UserListResponse,
+    type UserCreateParams as UserCreateParams,
+    type UserListParams as UserListParams,
+  };
+}

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

@@ -0,0 +1,93 @@
+// 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
+   */
+  create(body: UserCreateParams, options?: Core.RequestOptions): Core.APIPromise<UserCreateResponse> {
+    return this._client.post('/api/referral/users', { body, ...options });
+  }
+
+  /**
+   * This endpoint allows you to get referrals
+   */
+  list(query: UserListParams, options?: Core.RequestOptions): Core.APIPromise<UserListResponse> {
+    return this._client.get('/api/referral/users', { query, ...options });
+  }
+}
+
+export interface UserCreateResponse {
+  message: string;
+}
+
+export interface UserListResponse {
+  data: Array<UserListResponse.Data>;
+
+  hasNextPage: boolean;
+}
+
+export namespace UserListResponse {
+  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 UserCreateParams {
+  userIds: Array<string>;
+
+  referralCode?: string;
+
+  referralCodeId?: string;
+}
+
+export interface UserListParams {
+  walletAddress: string | Array<string>;
+
+  includeEligibility?: boolean | null;
+
+  limit?: number;
+
+  organizationId?: string;
+
+  startingAfter?: string;
+
+  websiteId?: string;
+}
+
+export declare namespace Users {
+  export {
+    type UserCreateResponse as UserCreateResponse,
+    type UserListResponse as UserListResponse,
+    type UserCreateParams as UserCreateParams,
+    type UserListParams as UserListParams,
+  };
+}

package/src/resources/api/referral.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './referral/index';

package/src/resources/api/users/index.ts

@@ -0,0 +1,18 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Metadatas,
+  type MetadataCreateResponse,
+  type MetadataListResponse,
+  type MetadataCreateParams,
+  type MetadataListParams,
+} from './metadatas';
+export {
+  Users,
+  type UserConnectResponse,
+  type UserCountResponse,
+  type UserDisconnectResponse,
+  type UserConnectParams,
+  type UserCountParams,
+  type UserDisconnectParams,
+} from './users';

package/src/resources/api/users/metadatas.ts

@@ -0,0 +1,206 @@
+// 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 Metadatas extends APIResource {
+  /**
+   * This endpoint is used to create user metadata
+   */
+  create(body?: MetadataCreateParams, options?: Core.RequestOptions): Core.APIPromise<MetadataCreateResponse>;
+  create(options?: Core.RequestOptions): Core.APIPromise<MetadataCreateResponse>;
+  create(
+    body: MetadataCreateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MetadataCreateResponse> {
+    if (isRequestOptions(body)) {
+      return this.create({}, body);
+    }
+    return this._client.post('/api/users/metadatas', { body, ...options });
+  }
+
+  /**
+   * This endpoint is used to get user metadata
+   */
+  list(query?: MetadataListParams, options?: Core.RequestOptions): Core.APIPromise<MetadataListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<MetadataListResponse>;
+  list(
+    query: MetadataListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MetadataListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/api/users/metadatas', { query, ...options });
+  }
+}
+
+export interface MetadataCreateResponse {
+  /**
+   * Unique identifier for the user metadata
+   */
+  id: string;
+
+  /**
+   * Timestamp when the wallet was created
+   */
+  createdAt: string;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId: string;
+
+  user: MetadataCreateResponse.User;
+
+  userGroup: MetadataCreateResponse.UserGroup;
+
+  /**
+   * Identifier for the user group set via api
+   */
+  userGroupId: string | null;
+
+  /**
+   * Identifier for the user wallet group set via api
+   */
+  walletGroupIdentifier: string | null;
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId: string;
+}
+
+export namespace MetadataCreateResponse {
+  export interface User {
+    /**
+     * Id for the user
+     */
+    id: string;
+
+    /**
+     * Wallet address of the user
+     */
+    walletAddress: string;
+  }
+
+  export interface UserGroup {
+    /**
+     * id for the user group
+     */
+    id: string;
+
+    /**
+     * External identifier for the user group
+     */
+    externalIdentifier: string | null;
+  }
+}
+
+/**
+ * Response schema for fetching user metadata
+ */
+export interface MetadataListResponse {
+  data: Array<MetadataListResponse.Data>;
+
+  /**
+   * Indicates if there are more records available
+   */
+  hasNextPage: boolean;
+}
+
+export namespace MetadataListResponse {
+  export interface Data {
+    /**
+     * Unique identifier for the user metadata
+     */
+    id: string;
+  }
+}
+
+export interface MetadataCreateParams {
+  discordUser?: string | null;
+
+  discordUserId?: string | null;
+
+  displayName?: string | null;
+
+  emailAddress?: string | null;
+
+  epicAccountIdentifier?: string | null;
+
+  externalIdentifier?: string | null;
+
+  isBlocked?: boolean;
+
+  logoUrl?: string | null;
+
+  stardustProfileIdentifier?: string | null;
+
+  stardustWalletIdentifier?: string | null;
+
+  telegramUserId?: string | null;
+
+  telegramUsername?: string | null;
+
+  twitterUser?: string | null;
+
+  twitterUserId?: string | null;
+
+  userGroupExternalIdentifier?: string | null;
+
+  userGroupId?: string;
+
+  userId?: string;
+
+  walletAddress?: string;
+
+  walletGroupIdentifier?: string | null;
+}
+
+export interface MetadataListParams {
+  /**
+   * External identifier for the user
+   */
+  externalIdentifier?: string | null;
+
+  /**
+   * Number of records to fetch
+   */
+  limit?: number;
+
+  /**
+   * UUID of the organization
+   */
+  organizationId?: string;
+
+  /**
+   * Fetch records starting after this ID
+   */
+  startingAfter?: string;
+
+  /**
+   * UUID of the user
+   */
+  userId?: string;
+
+  /**
+   * Wallet address of the user
+   */
+  walletAddress?: string;
+
+  /**
+   * UUID of the website
+   */
+  websiteId?: string;
+}
+
+export declare namespace Metadatas {
+  export {
+    type MetadataCreateResponse as MetadataCreateResponse,
+    type MetadataListResponse as MetadataListResponse,
+    type MetadataCreateParams as MetadataCreateParams,
+    type MetadataListParams as MetadataListParams,
+  };
+}