@snagsolutions/sdk 0.1.0-alpha.10

package/src/resources/loyalty/transaction-entries.ts

@@ -0,0 +1,229 @@
+// 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 TransactionEntries extends APIResource {
+  /**
+   * Fetch loyalty transaction entries for wallets or users, representing account
+   * balance changes.
+   */
+  list(
+    query?: TransactionEntryListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TransactionEntryListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<TransactionEntryListResponse>;
+  list(
+    query: TransactionEntryListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TransactionEntryListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/api/loyalty/transaction_entries', { query, ...options });
+  }
+}
+
+export interface TransactionEntryListResponse {
+  data: Array<TransactionEntryListResponse.Data>;
+
+  hasNextPage: boolean;
+}
+
+export namespace TransactionEntryListResponse {
+  /**
+   * Schema for a loyalty transaction entry
+   */
+  export interface Data {
+    /**
+     * Unique identifier for the transaction entry
+     */
+    id: string;
+
+    /**
+     * Amount involved in the transaction
+     */
+    amount: number;
+
+    /**
+     * Timestamp when the transaction entry was created
+     */
+    createdAt: string;
+
+    /**
+     * Direction of the transaction entry
+     */
+    direction: 'credit' | 'debit';
+
+    /**
+     * Unique identifier for the loyalty account
+     */
+    loyaltyAccountId: string;
+
+    /**
+     * Details of the loyalty transaction
+     */
+    loyaltyTransaction: Data.LoyaltyTransaction;
+
+    /**
+     * Unique identifier for the organization
+     */
+    organizationId: string;
+
+    /**
+     * Type of the loyalty transaction
+     */
+    type: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order';
+
+    /**
+     * Timestamp when the transaction entry was last updated
+     */
+    updatedAt: string;
+
+    /**
+     * Unique identifier for the website
+     */
+    websiteId: string;
+
+    /**
+     * Optional metadata for the transaction entry
+     */
+    metadata?: Record<string, unknown>;
+  }
+
+  export namespace Data {
+    /**
+     * Details of the loyalty transaction
+     */
+    export interface LoyaltyTransaction {
+      /**
+       * Unique identifier for the loyalty transaction
+       */
+      id: string;
+
+      /**
+       * Type of the loyalty transaction
+       */
+      type: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order';
+
+      /**
+       * Details of the loyalty rule associated with the transaction
+       */
+      loyaltyRule?: LoyaltyTransaction.LoyaltyRule;
+    }
+
+    export namespace LoyaltyTransaction {
+      /**
+       * Details of the loyalty rule associated with the transaction
+       */
+      export interface LoyaltyRule {
+        /**
+         * Unique identifier for the loyalty rule
+         */
+        id: string;
+
+        /**
+         * Type of the loyalty rule
+         */
+        type: string;
+
+        /**
+         * Description of the loyalty rule
+         */
+        description?: string;
+
+        /**
+         * Optional metadata for the loyalty rule
+         */
+        metadata?: Record<string, unknown>;
+
+        /**
+         * Name of the loyalty rule
+         */
+        name?: string;
+      }
+    }
+  }
+}
+
+export interface TransactionEntryListParams {
+  /**
+   * Direction of the transaction entry to filter by
+   */
+  direction?: 'credit' | 'debit';
+
+  /**
+   * Key to ensure idempotency of the request
+   */
+  idempotencyKey?: string;
+
+  /**
+   * Maximum number of records to return (max 1000)
+   */
+  limit?: number;
+
+  /**
+   * Unique identifier for the loyalty rule to filter by
+   */
+  loyaltyRuleId?: string;
+
+  /**
+   * Unique identifier for the loyalty transaction to filter by
+   */
+  loyaltyTransactionId?: string;
+
+  /**
+   * Field to order the results by
+   */
+  orderBy?: 'createdAt' | 'updatedAt' | 'loyaltyAccountLockVersion';
+
+  /**
+   * Unique identifier for the organization to filter by
+   */
+  organizationId?: string;
+
+  /**
+   * Pagination cursor to start after a specific resource ID
+   */
+  startingAfter?: string;
+
+  /**
+   * Type of the loyalty transaction to filter by
+   */
+  type?: 'auction_bid' | 'direct_mint' | 'loyalty_rule' | 'api_key' | 'order';
+
+  /**
+   * When passed in return the list of fulfilled entries for loyalty rules. If a
+   * loyalty rule has a fulfilled entry this means the user cannot currently complete
+   * the rule. Must be passed in with userId or walletAddress.
+   */
+  userCompletedLoyaltyRuleId?: string | Array<string>;
+
+  /**
+   * User ID or array of User IDs to filter by
+   */
+  userId?: string | Array<string>;
+
+  /**
+   * Wallet address or array of wallet addresses to filter by
+   */
+  walletAddress?: string | Array<string>;
+
+  /**
+   * Identifier for the wallet group to filter by
+   */
+  walletGroupIdentifier?: string;
+
+  /**
+   * Unique identifier for the website to filter by
+   */
+  websiteId?: string;
+}
+
+export declare namespace TransactionEntries {
+  export {
+    type TransactionEntryListResponse as TransactionEntryListResponse,
+    type TransactionEntryListParams as TransactionEntryListParams,
+  };
+}

package/src/resources/users/index.ts

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Metadatas, type MetadataCreateResponse, type MetadataCreateParams } from './metadatas';
+export { Users } from './users';
+export {
+  Wallets,
+  type WalletCreateResponse,
+  type WalletListResponse,
+  type WalletDeleteResponse,
+  type WalletCreateParams,
+  type WalletListParams,
+} from './wallets';

package/src/resources/users/metadatas.ts

@@ -0,0 +1,103 @@
+// 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 allows you to create or edit a 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 });
+  }
+}
+
+/**
+ * Schema for user metadata response
+ */
+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;
+
+  /**
+   * Timestamp when the wallet was last updated
+   */
+  updatedAt: string;
+
+  /**
+   * Validated and formatted wallet address
+   */
+  walletAddress: string;
+
+  /**
+   * Identifier for the user wallet group set via api
+   */
+  walletGroupIdentifier: string | null;
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId: string;
+}
+
+export interface MetadataCreateParams {
+  discordUser?: string | null;
+
+  discordUserId?: string | null;
+
+  displayName?: string | null;
+
+  emailAddress?: string | null;
+
+  epicAccountIdentifier?: 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;
+
+  userId?: string;
+
+  walletAddress?: string;
+
+  walletGroupIdentifier?: string | null;
+}
+
+export declare namespace Metadatas {
+  export {
+    type MetadataCreateResponse as MetadataCreateResponse,
+    type MetadataCreateParams as MetadataCreateParams,
+  };
+}

package/src/resources/users/users.ts

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as MetadatasAPI from './metadatas';
+import { MetadataCreateParams, MetadataCreateResponse, Metadatas } from './metadatas';
+import * as WalletsAPI from './wallets';
+import {
+  WalletCreateParams,
+  WalletCreateResponse,
+  WalletDeleteResponse,
+  WalletListParams,
+  WalletListResponse,
+  Wallets,
+} from './wallets';
+
+export class Users extends APIResource {
+  wallets: WalletsAPI.Wallets = new WalletsAPI.Wallets(this._client);
+  metadatas: MetadatasAPI.Metadatas = new MetadatasAPI.Metadatas(this._client);
+}
+
+Users.Wallets = Wallets;
+Users.Metadatas = Metadatas;
+
+export declare namespace Users {
+  export {
+    Wallets as Wallets,
+    type WalletCreateResponse as WalletCreateResponse,
+    type WalletListResponse as WalletListResponse,
+    type WalletDeleteResponse as WalletDeleteResponse,
+    type WalletCreateParams as WalletCreateParams,
+    type WalletListParams as WalletListParams,
+  };
+
+  export {
+    Metadatas as Metadatas,
+    type MetadataCreateResponse as MetadataCreateResponse,
+    type MetadataCreateParams as MetadataCreateParams,
+  };
+}

package/src/resources/users/wallets.ts

@@ -0,0 +1,271 @@
+// 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 Wallets extends APIResource {
+  /**
+   * This endpoint allows you to create a user wallet
+   */
+  create(body: WalletCreateParams, options?: Core.RequestOptions): Core.APIPromise<WalletCreateResponse> {
+    return this._client.post('/api/users/wallets', { body, ...options });
+  }
+
+  /**
+   * This endpoint allows you to get users wallet
+   */
+  list(query?: WalletListParams, options?: Core.RequestOptions): Core.APIPromise<WalletListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<WalletListResponse>;
+  list(
+    query: WalletListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WalletListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/api/users/wallets', { query, ...options });
+  }
+
+  /**
+   * This endpoint allows you to delete a user wallet
+   */
+  delete(id: string, options?: Core.RequestOptions): Core.APIPromise<WalletDeleteResponse> {
+    return this._client.delete(`/api/users/wallets/${id}`, options);
+  }
+}
+
+/**
+ * Schema for user wallet response
+ */
+export interface WalletCreateResponse {
+  /**
+   * Unique identifier for the user wallet
+   */
+  id: string;
+
+  /**
+   * Timestamp when the wallet was created
+   */
+  createdAt: string;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId: string;
+
+  /**
+   * Timestamp when the wallet was last updated
+   */
+  updatedAt: string;
+
+  /**
+   * Validated and formatted wallet address
+   */
+  walletAddress: string;
+
+  /**
+   * Type of the wallet
+   */
+  walletType: 'evm' | 'solana' | 'imx' | 'sui' | 'ton';
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId: string;
+
+  /**
+   * Optional identifier for the wallet
+   */
+  walletIdentifier?: string | null;
+}
+
+/**
+ * Schema for a list of user wallets
+ */
+export interface WalletListResponse {
+  /**
+   * Array of user wallets
+   */
+  data: Array<WalletListResponse.Data>;
+}
+
+export namespace WalletListResponse {
+  /**
+   * Schema for user wallet response
+   */
+  export interface Data {
+    /**
+     * Unique identifier for the user wallet
+     */
+    id: string;
+
+    /**
+     * Timestamp when the wallet was created
+     */
+    createdAt: string;
+
+    /**
+     * Unique identifier for the organization
+     */
+    organizationId: string;
+
+    /**
+     * Timestamp when the wallet was last updated
+     */
+    updatedAt: string;
+
+    /**
+     * Validated and formatted wallet address
+     */
+    walletAddress: string;
+
+    /**
+     * Type of the wallet
+     */
+    walletType: 'evm' | 'solana' | 'imx' | 'sui' | 'ton';
+
+    /**
+     * Unique identifier for the website
+     */
+    websiteId: string;
+
+    /**
+     * Optional identifier for the wallet
+     */
+    walletIdentifier?: string | null;
+  }
+}
+
+/**
+ * Schema for user wallet response
+ */
+export interface WalletDeleteResponse {
+  /**
+   * Unique identifier for the user wallet
+   */
+  id: string;
+
+  /**
+   * Timestamp when the wallet was created
+   */
+  createdAt: string;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId: string;
+
+  /**
+   * Timestamp when the wallet was last updated
+   */
+  updatedAt: string;
+
+  /**
+   * Validated and formatted wallet address
+   */
+  walletAddress: string;
+
+  /**
+   * Type of the wallet
+   */
+  walletType: 'evm' | 'solana' | 'imx' | 'sui' | 'ton';
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId: string;
+
+  /**
+   * Optional identifier for the wallet
+   */
+  walletIdentifier?: string | null;
+}
+
+export interface WalletCreateParams {
+  walletAddress: string;
+
+  walletType: 'evm' | 'solana' | 'imx' | 'sui' | 'ton';
+
+  confirmDisconnect?: boolean;
+
+  userId?: string;
+
+  verificationData?: WalletCreateParams.VerificationData;
+
+  walletIdentifier?: string;
+}
+
+export namespace WalletCreateParams {
+  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 WalletListParams {
+  limit?: number | null;
+
+  startingAfter?: string;
+
+  userId?: string;
+
+  walletAddress?: string;
+
+  walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton';
+}
+
+export declare namespace Wallets {
+  export {
+    type WalletCreateResponse as WalletCreateResponse,
+    type WalletListResponse as WalletListResponse,
+    type WalletDeleteResponse as WalletDeleteResponse,
+    type WalletCreateParams as WalletCreateParams,
+    type WalletListParams as WalletListParams,
+  };
+}