@snagsolutions/sdk 0.1.0-alpha.23 → 0.1.0-alpha.231

package/src/index.ts

@@ -7,10 +7,44 @@ import * as Errors from './error';
 import * as Uploads from './uploads';
 import * as API from './resources/index';
 import { AssetCreateAssetParams, AssetCreateAssetResponse, Assets } from './resources/assets';
-import { AuctionListAuctionBidsParams, AuctionListAuctionsResponse, Auctions } from './resources/auctions';
-import { Auth, AuthConnectAuthParams, AuthConnectAuthResponse } from './resources/auth';
-import { Minting, MintingGetAssetsParams, MintingGetAssetsResponse } from './resources/minting';
+import {
+  Auth,
+  AuthConnectAuthParams,
+  AuthConnectAuthResponse,
+  AuthConnectAuthVerifyParams,
+  AuthConnectAuthVerifyResponse,
+} from './resources/auth';
+import {
+  TokenClaimCheckEligibilityParams,
+  TokenClaimCheckEligibilityResponse,
+  TokenClaimGetProofParams,
+  TokenClaimGetProofResponse,
+  TokenClaimListParams,
+  TokenClaimListResponse,
+  TokenClaimListUsersParams,
+  TokenClaimListUsersResponse,
+  TokenClaimRetrieveParams,
+  TokenClaimRetrieveResponse,
+  TokenClaimUpdateClaimParams,
+  TokenClaimUpdateClaimResponse,
+  TokenClaims,
+} from './resources/token-claims';
+import {
+  AuctionGetPageSectionsParams,
+  AuctionGetPageSectionsResponse,
+  AuctionListAuctionBidsParams,
+  AuctionListAuctionBidsResponse,
+  AuctionListAuctionsResponse,
+  Auctions,
+} from './resources/auctions/auctions';
 import { Loyalty } from './resources/loyalty/loyalty';
+import {
+  Minting,
+  MintingGetAssetsParams,
+  MintingGetAssetsResponse,
+  MintingGetTokenGateStatusParams,
+  MintingGetTokenGateStatusResponse,
+} from './resources/minting/minting';
 import {
   Referral,
   ReferralCreateCodeParams,
@@ -21,10 +55,14 @@ import {
   UserConnectResponse,
   UserCountParams,
   UserCountResponse,
+  UserCreateDeviceParams,
+  UserCreateDeviceResponse,
   UserDisconnectParams,
   UserDisconnectResponse,
   UserListParams,
   UserListResponse,
+  UserVerifyParams,
+  UserVerifyResponse,
   Users,
 } from './resources/users/users';
 import {
@@ -54,6 +92,8 @@ export interface ClientOptions {
    *
    * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
    * much longer than this timeout before the promise succeeds or fails.
+   *
+   * @unit milliseconds
    */
   timeout?: number | undefined;
 
@@ -137,6 +177,7 @@ export class SnagSolutions extends Core.APIClient {
 
     super({
       baseURL: options.baseURL!,
+      baseURLOverridden: baseURL ? baseURL !== 'https://admin.snagsolutions.io/' : false,
       timeout: options.timeout ?? 60000 /* 1 minute */,
       httpAgent: options.httpAgent,
       maxRetries: options.maxRetries,
@@ -156,6 +197,14 @@ export class SnagSolutions extends Core.APIClient {
   minting: API.Minting = new API.Minting(this);
   referral: API.Referral = new API.Referral(this);
   websites: API.Websites = new API.Websites(this);
+  tokenClaims: API.TokenClaims = new API.TokenClaims(this);
+
+  /**
+   * Check whether the base URL is set to its default.
+   */
+  #baseURLOverridden(): boolean {
+    return this.baseURL !== 'https://admin.snagsolutions.io/';
+  }
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
     return this._options.defaultQuery;
@@ -173,7 +222,7 @@ export class SnagSolutions extends Core.APIClient {
   }
 
   protected override stringifyQuery(query: Record<string, unknown>): string {
-    return qs.stringify(query, { arrayFormat: 'comma' });
+    return qs.stringify(query, { arrayFormat: 'repeat' });
   }
 
   static SnagSolutions = this;
@@ -205,6 +254,8 @@ SnagSolutions.Loyalty = Loyalty;
 SnagSolutions.Minting = Minting;
 SnagSolutions.Referral = Referral;
 SnagSolutions.Websites = Websites;
+SnagSolutions.TokenClaims = TokenClaims;
+
 export declare namespace SnagSolutions {
   export type RequestOptions = Core.RequestOptions;
 
@@ -217,12 +268,17 @@ export declare namespace SnagSolutions {
   export {
     Auth as Auth,
     type AuthConnectAuthResponse as AuthConnectAuthResponse,
+    type AuthConnectAuthVerifyResponse as AuthConnectAuthVerifyResponse,
     type AuthConnectAuthParams as AuthConnectAuthParams,
+    type AuthConnectAuthVerifyParams as AuthConnectAuthVerifyParams,
   };
 
   export {
     Auctions as Auctions,
+    type AuctionGetPageSectionsResponse as AuctionGetPageSectionsResponse,
+    type AuctionListAuctionBidsResponse as AuctionListAuctionBidsResponse,
     type AuctionListAuctionsResponse as AuctionListAuctionsResponse,
+    type AuctionGetPageSectionsParams as AuctionGetPageSectionsParams,
     type AuctionListAuctionBidsParams as AuctionListAuctionBidsParams,
   };
 
@@ -231,11 +287,15 @@ export declare namespace SnagSolutions {
     type UserListResponse as UserListResponse,
     type UserConnectResponse as UserConnectResponse,
     type UserCountResponse as UserCountResponse,
+    type UserCreateDeviceResponse as UserCreateDeviceResponse,
     type UserDisconnectResponse as UserDisconnectResponse,
+    type UserVerifyResponse as UserVerifyResponse,
     type UserListParams as UserListParams,
     type UserConnectParams as UserConnectParams,
     type UserCountParams as UserCountParams,
+    type UserCreateDeviceParams as UserCreateDeviceParams,
     type UserDisconnectParams as UserDisconnectParams,
+    type UserVerifyParams as UserVerifyParams,
   };
 
   export { Loyalty as Loyalty };
@@ -243,7 +303,9 @@ export declare namespace SnagSolutions {
   export {
     Minting as Minting,
     type MintingGetAssetsResponse as MintingGetAssetsResponse,
+    type MintingGetTokenGateStatusResponse as MintingGetTokenGateStatusResponse,
     type MintingGetAssetsParams as MintingGetAssetsParams,
+    type MintingGetTokenGateStatusParams as MintingGetTokenGateStatusParams,
   };
 
   export {
@@ -259,6 +321,22 @@ export declare namespace SnagSolutions {
     type WebsiteCreateParams as WebsiteCreateParams,
     type WebsiteListParams as WebsiteListParams,
   };
+
+  export {
+    TokenClaims as TokenClaims,
+    type TokenClaimRetrieveResponse as TokenClaimRetrieveResponse,
+    type TokenClaimListResponse as TokenClaimListResponse,
+    type TokenClaimCheckEligibilityResponse as TokenClaimCheckEligibilityResponse,
+    type TokenClaimGetProofResponse as TokenClaimGetProofResponse,
+    type TokenClaimListUsersResponse as TokenClaimListUsersResponse,
+    type TokenClaimUpdateClaimResponse as TokenClaimUpdateClaimResponse,
+    type TokenClaimRetrieveParams as TokenClaimRetrieveParams,
+    type TokenClaimListParams as TokenClaimListParams,
+    type TokenClaimCheckEligibilityParams as TokenClaimCheckEligibilityParams,
+    type TokenClaimGetProofParams as TokenClaimGetProofParams,
+    type TokenClaimListUsersParams as TokenClaimListUsersParams,
+    type TokenClaimUpdateClaimParams as TokenClaimUpdateClaimParams,
+  };
 }
 
 export { toFile, fileFromPath } from './uploads';

package/src/resource.ts

@@ -2,7 +2,7 @@
 
 import type { SnagSolutions } from './index';
 
-export class APIResource {
+export abstract class APIResource {
   protected _client: SnagSolutions;
 
   constructor(client: SnagSolutions) {

package/src/resources/assets.ts

@@ -8,6 +8,14 @@ export class Assets extends APIResource {
    * 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.
+   *
+   * @example
+   * ```ts
+   * const response = await client.assets.createAsset({
+   *   fileName: 'example.png',
+   *   fileSize: 1024,
+   * });
+   * ```
    */
   createAsset(
     body: AssetCreateAssetParams,
@@ -35,15 +43,21 @@ export interface AssetCreateAssetResponse {
 
 export interface AssetCreateAssetParams {
   /**
-   * The name of the file, must match the regex pattern (converted to lowercase)
+   * The name of the file, must match the regex pattern (converted to lowercase) and
+   * have a valid extension.
    */
   fileName: string;
 
+  /**
+   * Size of the file in bytes. Uploaded file must match this file size. 1mb for
+   * images and 10mb for videos.
+   */
+  fileSize: number;
+
   /**
    * The file path, must be a valid enum value.
    */
   filePath?:
-    | 'announcements'
     | 'images'
     | 'videos'
     | 'banners'
@@ -51,7 +65,8 @@ export interface AssetCreateAssetParams {
     | 'posts'
     | 'profiles'
     | 'minting'
-    | 'loyalty';
+    | 'loyalty'
+    | 'tokenClaims';
 
   /**
    * UUID of the organization (optional, converted to lowercase)