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

package/src/resources/loyalty/transactions.ts

@@ -0,0 +1,332 @@
+// 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 Transactions extends APIResource {
+  /**
+   * Create a loyalty transaction to update account balances.
+   */
+  createTransaction(
+    body: TransactionCreateTransactionParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TransactionCreateTransactionResponse> {
+    return this._client.post('/api/loyalty/transactions', { body, ...options });
+  }
+
+  /**
+   * Fetch loyalty transaction entries for wallets or users, representing account
+   * balance changes.
+   */
+  getTransactionEntries(
+    query?: TransactionGetTransactionEntriesParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TransactionGetTransactionEntriesResponse>;
+  getTransactionEntries(
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TransactionGetTransactionEntriesResponse>;
+  getTransactionEntries(
+    query: TransactionGetTransactionEntriesParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TransactionGetTransactionEntriesResponse> {
+    if (isRequestOptions(query)) {
+      return this.getTransactionEntries({}, query);
+    }
+    return this._client.get('/api/loyalty/transaction_entries', { query, ...options });
+  }
+}
+
+export interface TransactionCreateTransactionResponse {
+  id: string;
+
+  createdAt: string;
+
+  description: string;
+
+  entries: Array<TransactionCreateTransactionResponse.Entry>;
+
+  updatedAt: string;
+}
+
+export namespace TransactionCreateTransactionResponse {
+  export interface Entry {
+    amount: number;
+
+    /**
+     * Direction of the transaction entry
+     */
+    direction: 'credit' | 'debit';
+
+    walletAddress: string;
+
+    idempotencyKey?: string;
+  }
+}
+
+export interface TransactionGetTransactionEntriesResponse {
+  data: Array<TransactionGetTransactionEntriesResponse.Data>;
+
+  hasNextPage: boolean;
+}
+
+export namespace TransactionGetTransactionEntriesResponse {
+  /**
+   * 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 TransactionCreateTransactionParams {
+  /**
+   * Description of the loyalty transaction
+   */
+  description: string;
+
+  /**
+   * Array of transaction entries
+   */
+  entries: Array<TransactionCreateTransactionParams.Entry>;
+
+  /**
+   * Unique identifier for the loyalty currency
+   */
+  loyaltyCurrencyId?: string;
+}
+
+export namespace TransactionCreateTransactionParams {
+  export interface Entry {
+    /**
+     * Transaction entry amount.
+     */
+    amount: number;
+
+    /**
+     * Direction of the transaction entry for this wallet address
+     */
+    direction?: 'credit' | 'debit';
+
+    /**
+     * Idempotency key for the transaction entry. Creation will fail if already exists
+     * for this wallet address.
+     */
+    idempotencyKey?: string;
+
+    /**
+     * The wallet address of the user
+     */
+    walletAddress?: string;
+  }
+}
+
+export interface TransactionGetTransactionEntriesParams {
+  /**
+   * End date to filter by (exclusive, less than)
+   */
+  createdAtEnd?: string;
+
+  /**
+   * Start date to filter by (inclusive, greater than or equal to)
+   */
+  createdAtStart?: string;
+
+  /**
+   * 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>;
+
+  /**
+   * External identifier for the user group controlled by you
+   */
+  userGroupExternalIdentifier?: string;
+
+  /**
+   * Unique identifier for the user group
+   */
+  userGroupId?: 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 Transactions {
+  export {
+    type TransactionCreateTransactionResponse as TransactionCreateTransactionResponse,
+    type TransactionGetTransactionEntriesResponse as TransactionGetTransactionEntriesResponse,
+    type TransactionCreateTransactionParams as TransactionCreateTransactionParams,
+    type TransactionGetTransactionEntriesParams as TransactionGetTransactionEntriesParams,
+  };
+}

package/src/resources/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/{assets/minting.ts → minting.ts}

@@ -1,16 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../resource';
+import * as Core from '../core';
 
 export class Minting extends APIResource {
   /**
    * Returns minting assets and any relevant context
    */
-  getMintingAssets(
-    query: MintingGetMintingAssetsParams,
+  getAssets(
+    query: MintingGetAssetsParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<MintingGetMintingAssetsResponse> {
+  ): Core.APIPromise<MintingGetAssetsResponse> {
     return this._client.get('/api/minting/assets', { query, ...options });
   }
 }
@@ -18,11 +18,11 @@ export class Minting extends APIResource {
 /**
  * Schema for getting minting assets response
  */
-export interface MintingGetMintingAssetsResponse {
+export interface MintingGetAssetsResponse {
   /**
    * Array of minting assets
    */
-  data: Array<MintingGetMintingAssetsResponse.Data>;
+  data: Array<MintingGetAssetsResponse.Data>;
 
   /**
    * Indicates if more pages are available
@@ -30,7 +30,7 @@ export interface MintingGetMintingAssetsResponse {
   hasNextPage: boolean;
 }
 
-export namespace MintingGetMintingAssetsResponse {
+export namespace MintingGetAssetsResponse {
   export interface Data {
     /**
      * UUID of the minting asset
@@ -39,7 +39,7 @@ export namespace MintingGetMintingAssetsResponse {
   }
 }
 
-export interface MintingGetMintingAssetsParams {
+export interface MintingGetAssetsParams {
   /**
    * Organization ID
    */
@@ -81,7 +81,7 @@ export interface MintingGetMintingAssetsParams {
   mintingContractAssetId?: string | null;
 
   /**
-   * Minting Contract IDs
+   * Comma-separated list of Minting Contract UUIDs
    */
   mintingContractIds?: string | null;
 
@@ -89,35 +89,40 @@ export interface MintingGetMintingAssetsParams {
    * Network
    */
   network?:
-    | 'mainnet'
-    | 'polygon'
-    | 'polygon_mumbai'
-    | 'optimism'
+    | 'apechain'
     | 'arbitrum'
-    | 'binance'
-    | 'bscTestnet'
     | 'avalanche'
     | 'avalancheFuji'
-    | 'zksync'
-    | 'fantom'
-    | 'fantomTestnet'
     | 'base'
     | 'baseSepolia'
-    | 'skaleNebula'
-    | 'xai'
     | 'berachainArtio'
-    | 'solana'
-    | 'apechain'
-    | 'flowMainnet'
+    | 'binance'
+    | 'bscTestnet'
     | 'campTestnet'
+    | 'fantom'
+    | 'fantomTestnet'
+    | 'flowMainnet'
+    | 'mainnet'
+    | 'optimism'
+    | 'polygon'
+    | 'polygon_mumbai'
+    | 'skaleNebula'
+    | 'solana'
+    | 'sophon'
     | 'sui'
+    | 'superseed'
+    | 'superseedSepolia'
     | 'vanar'
+    | 'xai'
+    | 'zksync'
     | 'sepolia'
     | 'optimism_sepolia'
     | 'arbitrumSepolia'
     | 'goerli'
     | 'optimism_goerli'
-    | 'arbitrumGoerli';
+    | 'arbitrumGoerli'
+    | 'basecamp'
+    | 'abstract';
 
   /**
    * Sort Dir
@@ -147,7 +152,7 @@ export interface MintingGetMintingAssetsParams {
 
 export declare namespace Minting {
   export {
-    type MintingGetMintingAssetsResponse as MintingGetMintingAssetsResponse,
-    type MintingGetMintingAssetsParams as MintingGetMintingAssetsParams,
+    type MintingGetAssetsResponse as MintingGetAssetsResponse,
+    type MintingGetAssetsParams as MintingGetAssetsParams,
   };
 }

package/src/resources/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/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/{assets/referral → referral}/users.ts

@@ -1,41 +1,35 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
+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> {
+  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
    */
-  getReferrals(
-    query: UserGetReferralsParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<UserGetReferralsResponse> {
+  list(query: UserListParams, options?: Core.RequestOptions): Core.APIPromise<UserListResponse> {
     return this._client.get('/api/referral/users', { query, ...options });
   }
 }
 
-export interface UserCreateReferralUserResponse {
+export interface UserCreateResponse {
   message: string;
 }
 
-export interface UserGetReferralsResponse {
-  data: Array<UserGetReferralsResponse.Data>;
+export interface UserListResponse {
+  data: Array<UserListResponse.Data>;
 
   hasNextPage: boolean;
 }
 
-export namespace UserGetReferralsResponse {
+export namespace UserListResponse {
   export interface Data {
     id: string;
 
@@ -67,7 +61,7 @@ export namespace UserGetReferralsResponse {
   }
 }
 
-export interface UserCreateReferralUserParams {
+export interface UserCreateParams {
   userIds: Array<string>;
 
   referralCode?: string;
@@ -75,7 +69,7 @@ export interface UserCreateReferralUserParams {
   referralCodeId?: string;
 }
 
-export interface UserGetReferralsParams {
+export interface UserListParams {
   walletAddress: string | Array<string>;
 
   includeEligibility?: boolean | null;
@@ -91,9 +85,9 @@ export interface UserGetReferralsParams {
 
 export declare namespace Users {
   export {
-    type UserCreateReferralUserResponse as UserCreateReferralUserResponse,
-    type UserGetReferralsResponse as UserGetReferralsResponse,
-    type UserCreateReferralUserParams as UserCreateReferralUserParams,
-    type UserGetReferralsParams as UserGetReferralsParams,
+    type UserCreateResponse as UserCreateResponse,
+    type UserListResponse as UserListResponse,
+    type UserCreateParams as UserCreateParams,
+    type UserListParams as UserListParams,
   };
 }

package/src/resources/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/users/index.ts

@@ -3,9 +3,18 @@
 export {
   Metadatas,
   type MetadataCreateResponse,
-  type MetadataRetrieveResponse,
+  type MetadataListResponse,
   type MetadataCreateParams,
-  type MetadataRetrieveParams,
+  type MetadataListParams,
 } from './metadatas';
-export { Users } from './users';
-export { Wallets } from './wallets';
+export {
+  Users,
+  type UserListResponse,
+  type UserConnectResponse,
+  type UserCountResponse,
+  type UserDisconnectResponse,
+  type UserListParams,
+  type UserConnectParams,
+  type UserCountParams,
+  type UserDisconnectParams,
+} from './users';