@snagsolutions/sdk 0.1.0-alpha.26 → 0.1.0-alpha.260

package/src/core.ts

@@ -6,6 +6,7 @@ import {
   APIConnectionTimeoutError,
   APIUserAbortError,
 } from './error';
+import { stringifyQuery } from './internal/utils/query';
 import {
   kind as shimsKind,
   type Readable,
@@ -70,6 +71,12 @@ async function defaultParseResponse<T>(props: APIResponseProps): Promise<T> {
   const mediaType = contentType?.split(';')[0]?.trim();
   const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
   if (isJSON) {
+    const contentLength = response.headers.get('content-length');
+    if (contentLength === '0') {
+      // if there is no content we can't do anything
+      return undefined as T;
+    }
+
     const json = await response.json();
 
     debug('response', response.status, response.url, response.headers, json);
@@ -170,6 +177,7 @@ export class APIPromise<T> extends Promise<T> {
 
 export abstract class APIClient {
   baseURL: string;
+  #baseURLOverridden: boolean;
   maxRetries: number;
   timeout: number;
   httpAgent: Agent | undefined;
@@ -179,18 +187,21 @@ export abstract class APIClient {
 
   constructor({
     baseURL,
+    baseURLOverridden,
     maxRetries = 2,
     timeout = 60000, // 1 minute
     httpAgent,
     fetch: overriddenFetch,
   }: {
     baseURL: string;
+    baseURLOverridden: boolean;
     maxRetries?: number | undefined;
     timeout: number | undefined;
     httpAgent: Agent | undefined;
     fetch: Fetch | undefined;
   }) {
     this.baseURL = baseURL;
+    this.#baseURLOverridden = baseURLOverridden;
     this.maxRetries = validatePositiveInteger('maxRetries', maxRetries);
     this.timeout = validatePositiveInteger('timeout', timeout);
     this.httpAgent = httpAgent;
@@ -213,7 +224,7 @@ export abstract class APIClient {
   protected defaultHeaders(opts: FinalRequestOptions): Headers {
     return {
       Accept: 'application/json',
-      'Content-Type': 'application/json',
+      ...(['head', 'get'].includes(opts.method) ? {} : { 'Content-Type': 'application/json' }),
       'User-Agent': this.getUserAgent(),
       ...getPlatformHeaders(),
       ...this.authHeaders(opts),
@@ -295,12 +306,12 @@ export abstract class APIClient {
     return null;
   }
 
-  buildRequest<Req>(
-    options: FinalRequestOptions<Req>,
+  async buildRequest<Req>(
+    inputOptions: FinalRequestOptions<Req>,
     { retryCount = 0 }: { retryCount?: number } = {},
-  ): { req: RequestInit; url: string; timeout: number } {
-    options = { ...options };
-    const { method, path, query, headers: headers = {} } = options;
+  ): Promise<{ req: RequestInit; url: string; timeout: number }> {
+    const options = { ...inputOptions };
+    const { method, path, query, defaultBaseURL, headers: headers = {} } = options;
 
     const body =
       ArrayBuffer.isView(options.body) || (options.__binaryRequest && typeof options.body === 'string') ?
@@ -310,7 +321,7 @@ export abstract class APIClient {
       : null;
     const contentLength = this.calculateContentLength(body);
 
-    const url = this.buildURL(path!, query);
+    const url = this.buildURL(path!, query, defaultBaseURL);
     if ('timeout' in options) validatePositiveInteger('timeout', options.timeout);
     options.timeout = options.timeout ?? this.timeout;
     const httpAgent = options.httpAgent ?? this.httpAgent ?? getDefaultAgent(url);
@@ -327,8 +338,8 @@ export abstract class APIClient {
     }
 
     if (this.idempotencyHeader && method !== 'get') {
-      if (!options.idempotencyKey) options.idempotencyKey = this.defaultIdempotencyKey();
-      headers[this.idempotencyHeader] = options.idempotencyKey;
+      if (!inputOptions.idempotencyKey) inputOptions.idempotencyKey = this.defaultIdempotencyKey();
+      headers[this.idempotencyHeader] = inputOptions.idempotencyKey;
     }
 
     const reqHeaders = this.buildHeaders({ options, headers, contentLength, retryCount });
@@ -446,7 +457,9 @@ export abstract class APIClient {
 
     await this.prepareOptions(options);
 
-    const { req, url, timeout } = this.buildRequest(options, { retryCount: maxRetries - retriesRemaining });
+    const { req, url, timeout } = await this.buildRequest(options, {
+      retryCount: maxRetries - retriesRemaining,
+    });
 
     await this.prepareRequest(req, { url, options });
 
@@ -503,39 +516,28 @@ export abstract class APIClient {
     return new PagePromise<PageClass, Item>(this, request, Page);
   }
 
-  buildURL<Req>(path: string, query: Req | null | undefined): string {
+  buildURL<Req>(path: string, query: Req | null | undefined, defaultBaseURL?: string | undefined): string {
+    const baseURL = (!this.#baseURLOverridden && defaultBaseURL) || this.baseURL;
     const url =
       isAbsoluteURL(path) ?
         new URL(path)
-      : new URL(this.baseURL + (this.baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
+      : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query } as Req;
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query } as Req;
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
   }
 
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return Object.entries(query)
-      .filter(([_, value]) => typeof value !== 'undefined')
-      .map(([key, value]) => {
-        if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-          return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-        }
-        if (value === null) {
-          return `${encodeURIComponent(key)}=`;
-        }
-        throw new SnagSolutionsError(
-          `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-        );
-      })
-      .join('&');
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   async fetchWithTimeout(
@@ -617,9 +619,9 @@ export abstract class APIClient {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, do what it says.
+    // Otherwise calculate a default.
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -792,6 +794,7 @@ export type RequestOptions<
   query?: Req | undefined;
   body?: Req | null | undefined;
   headers?: Headers | undefined;
+  defaultBaseURL?: string | undefined;
 
   maxRetries?: number;
   stream?: boolean | undefined;
@@ -813,6 +816,7 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
   query: true,
   body: true,
   headers: true,
+  defaultBaseURL: true,
 
   maxRetries: true,
   stream: true,
@@ -1079,21 +1083,21 @@ export const coerceBoolean = (value: unknown): boolean => {
 };
 
 export const maybeCoerceInteger = (value: unknown): number | undefined => {
-  if (value === undefined) {
+  if (value == null) {
     return undefined;
   }
   return coerceInteger(value);
 };
 
 export const maybeCoerceFloat = (value: unknown): number | undefined => {
-  if (value === undefined) {
+  if (value == null) {
     return undefined;
   }
   return coerceFloat(value);
 };
 
 export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
-  if (value === undefined) {
+  if (value == null) {
     return undefined;
   }
   return coerceBoolean(value);

package/src/index.ts

@@ -1,16 +1,50 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { type Agent } from './_shims/index';
-import * as qs from './internal/qs';
+import { stringifyQuery } from './internal/utils/query';
 import * as Core from './core';
 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;
@@ -172,8 +221,8 @@ export class SnagSolutions extends Core.APIClient {
     return { 'X-API-KEY': this.apiKey };
   }
 
-  protected override stringifyQuery(query: Record<string, unknown>): string {
-    return qs.stringify(query, { arrayFormat: 'comma' });
+  protected override stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   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/internal/utils/query.ts

@@ -0,0 +1,7 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as qs from '../qs/stringify';
+
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return qs.stringify(query, { arrayFormat: 'repeat' });
+}

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)