@snagsolutions/sdk 0.1.0-alpha.20 → 0.1.0-alpha.200

package/src/index.ts

@@ -7,9 +7,16 @@ 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 {
+  AuctionGetPageSectionsParams,
+  AuctionGetPageSectionsResponse,
+  AuctionListAuctionBidsParams,
+  AuctionListAuctionBidsResponse,
+  AuctionListAuctionsResponse,
+  Auctions,
+} from './resources/auctions/auctions';
 import { Loyalty } from './resources/loyalty/loyalty';
 import {
   Referral,
@@ -21,10 +28,14 @@ import {
   UserConnectResponse,
   UserCountParams,
   UserCountResponse,
+  UserCreateDeviceParams,
+  UserCreateDeviceResponse,
   UserDisconnectParams,
   UserDisconnectResponse,
   UserListParams,
   UserListResponse,
+  UserVerifyParams,
+  UserVerifyResponse,
   Users,
 } from './resources/users/users';
 import {
@@ -54,6 +65,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 +150,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,
@@ -157,6 +171,13 @@ export class SnagSolutions extends Core.APIClient {
   referral: API.Referral = new API.Referral(this);
   websites: API.Websites = new API.Websites(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 +194,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 +226,7 @@ SnagSolutions.Loyalty = Loyalty;
 SnagSolutions.Minting = Minting;
 SnagSolutions.Referral = Referral;
 SnagSolutions.Websites = Websites;
+
 export declare namespace SnagSolutions {
   export type RequestOptions = Core.RequestOptions;
 
@@ -222,7 +244,10 @@ export declare namespace SnagSolutions {
 
   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 +256,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 };

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)

package/src/resources/auctions/auctions.ts

@@ -0,0 +1,561 @@
+// 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 WebsiteUserAttributesAPI from './website-user-attributes/website-user-attributes';
+import {
+  WebsiteUserAttributeCreateParams,
+  WebsiteUserAttributeCreateResponse,
+  WebsiteUserAttributeDeleteParams,
+  WebsiteUserAttributeDeleteResponse,
+  WebsiteUserAttributeListParams,
+  WebsiteUserAttributeListResponse,
+  WebsiteUserAttributes,
+} from './website-user-attributes/website-user-attributes';
+
+export class Auctions extends APIResource {
+  websiteUserAttributes: WebsiteUserAttributesAPI.WebsiteUserAttributes =
+    new WebsiteUserAttributesAPI.WebsiteUserAttributes(this._client);
+
+  /**
+   * This endpoint allows you to fetch page sections
+   *
+   * @example
+   * ```ts
+   * const response = await client.auctions.getPageSections({
+   *   organizationId: '123e4567-e89b-12d3-a456-426614174334',
+   *   placement: 'page',
+   *   websiteId: '123e4567-e89b-12d3-a456-426614174333',
+   * });
+   * ```
+   */
+  getPageSections(
+    query: AuctionGetPageSectionsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AuctionGetPageSectionsResponse> {
+    return this._client.get('/api/page_sections', { query, ...options });
+  }
+
+  /**
+   * Returns a list of auction bids with optional filtering and pagination.
+   *
+   * @example
+   * ```ts
+   * const response = await client.auctions.listAuctionBids();
+   * ```
+   */
+  listAuctionBids(
+    query?: AuctionListAuctionBidsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AuctionListAuctionBidsResponse>;
+  listAuctionBids(options?: Core.RequestOptions): Core.APIPromise<AuctionListAuctionBidsResponse>;
+  listAuctionBids(
+    query: AuctionListAuctionBidsParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AuctionListAuctionBidsResponse> {
+    if (isRequestOptions(query)) {
+      return this.listAuctionBids({}, query);
+    }
+    return this._client.get('/api/auction_bids', { query, ...options });
+  }
+
+  /**
+   * Returns a list of auctions with optional filtering and pagination.
+   *
+   * @example
+   * ```ts
+   * const response = await client.auctions.listAuctions();
+   * ```
+   */
+  listAuctions(options?: Core.RequestOptions): Core.APIPromise<AuctionListAuctionsResponse> {
+    return this._client.get('/api/auctions', options);
+  }
+}
+
+export interface AuctionGetPageSectionsResponse {
+  /**
+   * Unique identifier for the page section
+   */
+  id: string;
+
+  /**
+   * Start time of the page section visibility
+   */
+  durationStart: string;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId: string;
+
+  /**
+   * Placement of the page section
+   */
+  placement: 'global' | 'page';
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId: string;
+
+  banner?: AuctionGetPageSectionsResponse.Banner | null;
+
+  discoveryItems?: Array<AuctionGetPageSectionsResponse.DiscoveryItem>;
+
+  /**
+   * End time of the page section visibility
+   */
+  durationEnd?: string | null;
+
+  itemsGrids?: Array<AuctionGetPageSectionsResponse.ItemsGrid>;
+
+  /**
+   * ID of the page this section belongs to
+   */
+  pageId?: string;
+
+  /**
+   * Type of the page section
+   */
+  pageSectionType?: 'all_items' | 'discovery_item' | 'discovery_items_grid' | null;
+
+  /**
+   * Order of the page section
+   */
+  sortId?: number;
+
+  /**
+   * Title of the page section
+   */
+  title?: string | null;
+}
+
+export namespace AuctionGetPageSectionsResponse {
+  export interface Banner {
+    id: string;
+
+    websiteCollectionBanners: Array<Banner.WebsiteCollectionBanner>;
+
+    carousel?: Banner.Carousel | null;
+  }
+
+  export namespace Banner {
+    export interface WebsiteCollectionBanner {
+      id: string;
+
+      websiteCollectionId: string;
+    }
+
+    export interface Carousel {
+      id: string;
+
+      carouselItems: Array<Carousel.CarouselItem>;
+    }
+
+    export namespace Carousel {
+      export interface CarouselItem {
+        id: string;
+
+        sortId: number;
+      }
+    }
+  }
+
+  export interface DiscoveryItem {
+    id: string;
+
+    title: string;
+
+    buttonText?: string | null;
+
+    description?: string | null;
+
+    externalLink?: string | null;
+
+    hideQuestInfo?: boolean;
+
+    layout?: 'container_style' | 'full_width_hero' | null;
+
+    loyaltyRuleGroupId?: string | null;
+
+    loyaltySection?: string | null;
+
+    mediaLink?: string | null;
+
+    pageMediaLink?: string | null;
+
+    sortId?: number;
+
+    twitter?: string | null;
+
+    website?: string | null;
+  }
+
+  export interface ItemsGrid {
+    id: string;
+
+    websiteCollection: ItemsGrid.WebsiteCollection;
+  }
+
+  export namespace ItemsGrid {
+    export interface WebsiteCollection {
+      id: string;
+
+      mintingContractId?: string | null;
+    }
+  }
+}
+
+export interface AuctionListAuctionBidsResponse {
+  data: Array<AuctionListAuctionBidsResponse.Data>;
+
+  /**
+   * Indicates if there is a next page of results
+   */
+  hasNextPage: boolean;
+
+  /**
+   * Total count of matching bids (only present when includeCount=true)
+   */
+  count?: number;
+}
+
+export namespace AuctionListAuctionBidsResponse {
+  /**
+   * Schema for a get auction bids response
+   */
+  export interface Data {
+    id: string;
+
+    auction: Data.Auction | null;
+
+    auctionId: string;
+
+    auctionItem: Data.AuctionItem | null;
+
+    auctionItemId: string | null;
+
+    currencyAddress: string | null;
+
+    currencyDecimals: number;
+
+    loyaltyCurrency: Data.LoyaltyCurrency | null;
+
+    status: 'submitted' | 'accepted' | 'rejected' | 'fulfilled';
+
+    updatedAt: string;
+
+    user: Data.User;
+
+    amount?: unknown;
+  }
+
+  export namespace Data {
+    export interface Auction {
+      id: string;
+
+      name: string;
+    }
+
+    export interface AuctionItem {
+      id: string;
+
+      mintingContractAsset: AuctionItem.MintingContractAsset | null;
+
+      quantity: number;
+    }
+
+    export namespace AuctionItem {
+      export interface MintingContractAsset {
+        id: string;
+
+        isPhygitalItem: boolean;
+
+        revealedAt: string | null;
+
+        tokenId: number | null;
+
+        shippingPrice?: unknown;
+      }
+    }
+
+    export interface LoyaltyCurrency {
+      id: string;
+
+      apiAuthKey: string | null;
+
+      apiAuthType: 'none' | 'basic' | 'bearer' | 'apiKey' | null;
+
+      apiAuthValue: string | null;
+
+      apiGetTransactionEntryUrl: string | null;
+
+      apiGetUrl: string | null;
+
+      apiPostUrl: string | null;
+
+      decimals: number;
+
+      imageUrl: string | null;
+
+      name: string;
+
+      symbol: string;
+    }
+
+    export interface User {
+      id: string;
+
+      walletAddress: string;
+    }
+  }
+}
+
+/**
+ * Schema for the response when fetching auctions
+ */
+export interface AuctionListAuctionsResponse {
+  data: Array<AuctionListAuctionsResponse.Data>;
+
+  hasNextPage: boolean;
+}
+
+export namespace AuctionListAuctionsResponse {
+  export interface Data {
+    id: string;
+
+    auctionBids: Array<Data.AuctionBid>;
+
+    auctionItems: Array<Data.AuctionItem>;
+
+    biddersOwnCollectionAddresses: Array<string>;
+
+    createdAt: string;
+
+    currencyAddress: string | null;
+
+    currencyDecimals: number;
+
+    deletedAt: string | null;
+
+    description: string;
+
+    endsAt: string;
+
+    extendedDurationInSeconds: number | null;
+
+    hideBids: boolean;
+
+    /**
+     * Schema representing a loyalty currency
+     */
+    loyaltyCurrency: Data.LoyaltyCurrency | null;
+
+    loyaltyCurrencyId: string | null;
+
+    minBidAmount: string;
+
+    minBidIncrement: string | null;
+
+    mintingContractId: string;
+
+    name: string;
+
+    network: 'ethereum' | 'zksync';
+
+    organizationId: string;
+
+    reservePrice: string | null;
+
+    signature: string;
+
+    startsAt: string;
+
+    status: 'in_progress' | 'completed' | 'cancelled';
+
+    type: 'first_price' | 'second_price' | 'english';
+
+    updatedAt: string;
+
+    userId: string;
+
+    websiteId: string;
+  }
+
+  export namespace Data {
+    /**
+     * Schema representing an auction bid
+     */
+    export interface AuctionBid {
+      id: string;
+
+      amount: string;
+
+      createdAt: string;
+    }
+
+    export interface AuctionItem {
+      id: string;
+
+      /**
+       * Schema representing a minting contract asset
+       */
+      mintingContractAsset: AuctionItem.MintingContractAsset;
+
+      quantity: number;
+
+      sortId: number;
+    }
+
+    export namespace AuctionItem {
+      /**
+       * Schema representing a minting contract asset
+       */
+      export interface MintingContractAsset {
+        id: string;
+      }
+    }
+
+    /**
+     * Schema representing a loyalty currency
+     */
+    export interface LoyaltyCurrency {
+      id: string;
+
+      decimals: number;
+
+      imageUrl: string | null;
+
+      name: string;
+
+      symbol: string;
+    }
+  }
+}
+
+export interface AuctionGetPageSectionsParams {
+  /**
+   * Unique identifier for the organization to filter by
+   */
+  organizationId: string;
+
+  /**
+   * Placement of the page section
+   */
+  placement: 'global' | 'page';
+
+  /**
+   * Unique identifier for the website to filter by
+   */
+  websiteId: string;
+
+  /**
+   * Whether to get all sections regardless of duration
+   */
+  all?: '1';
+
+  /**
+   * Unique identifier for the page to filter by
+   */
+  pageId?: string;
+
+  /**
+   * Type of the page section to filter by
+   */
+  pageSectionType?: 'all_items' | 'discovery_item' | 'discovery_items_grid' | null;
+
+  /**
+   * Unique identifier for the website collection to filter by
+   */
+  websiteCollectionId?: string;
+}
+
+export interface AuctionListAuctionBidsParams {
+  /**
+   * The bid ID(s) - accepts a single ID or an array of IDs
+   */
+  id?: string | Array<string> | unknown;
+
+  /**
+   * ID of the auction
+   */
+  auctionId?: string;
+
+  /**
+   * Include total count of matching bids in response
+   */
+  includeCount?: boolean | null;
+
+  /**
+   * Maximum number of bids to return
+   */
+  limit?: number;
+
+  /**
+   * Order bids by amount (ascending or descending). Defaults to desc.
+   */
+  orderBy?: 'asc' | 'desc';
+
+  /**
+   * ID of the organization
+   */
+  organizationId?: string;
+
+  /**
+   * Number of bids to skip (for offset-based pagination)
+   */
+  skip?: number | null;
+
+  /**
+   * Pagination cursor to start after a specific bid ID
+   */
+  startingAfter?: string;
+
+  /**
+   * Status of the bid
+   */
+  status?: 'submitted' | 'accepted' | 'rejected' | 'fulfilled';
+
+  /**
+   * Filter by multiple bid statuses (OR condition)
+   */
+  statuses?: Array<'submitted' | 'accepted' | 'rejected' | 'fulfilled'>;
+
+  /**
+   * ID of the user who made the bid
+   */
+  userId?: string;
+
+  /**
+   * Wallet address of the bidder
+   */
+  walletAddress?: string;
+
+  /**
+   * ID of the website
+   */
+  websiteId?: string;
+}
+
+Auctions.WebsiteUserAttributes = WebsiteUserAttributes;
+
+export declare namespace Auctions {
+  export {
+    type AuctionGetPageSectionsResponse as AuctionGetPageSectionsResponse,
+    type AuctionListAuctionBidsResponse as AuctionListAuctionBidsResponse,
+    type AuctionListAuctionsResponse as AuctionListAuctionsResponse,
+    type AuctionGetPageSectionsParams as AuctionGetPageSectionsParams,
+    type AuctionListAuctionBidsParams as AuctionListAuctionBidsParams,
+  };
+
+  export {
+    WebsiteUserAttributes as WebsiteUserAttributes,
+    type WebsiteUserAttributeCreateResponse as WebsiteUserAttributeCreateResponse,
+    type WebsiteUserAttributeListResponse as WebsiteUserAttributeListResponse,
+    type WebsiteUserAttributeDeleteResponse as WebsiteUserAttributeDeleteResponse,
+    type WebsiteUserAttributeCreateParams as WebsiteUserAttributeCreateParams,
+    type WebsiteUserAttributeListParams as WebsiteUserAttributeListParams,
+    type WebsiteUserAttributeDeleteParams as WebsiteUserAttributeDeleteParams,
+  };
+}