@snagsolutions/sdk 0.1.0-alpha.17 → 0.1.0-alpha.171

package/src/resources/auctions/website-user-attributes/website-user-attributes.ts

@@ -0,0 +1,137 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import * as Core from '../../../core';
+import * as ValuesAPI from './values';
+import { ValueCreateParams, ValueCreateResponse, Values } from './values';
+
+export class WebsiteUserAttributes extends APIResource {
+  values: ValuesAPI.Values = new ValuesAPI.Values(this._client);
+
+  /**
+   * Create a new website user attribute
+   *
+   * @example
+   * ```ts
+   * const websiteUserAttribute =
+   *   await client.auctions.websiteUserAttributes.create({
+   *     data: [{ label: 'Website User Attribute Label' }],
+   *   });
+   * ```
+   */
+  create(
+    body: WebsiteUserAttributeCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WebsiteUserAttributeCreateResponse> {
+    return this._client.post('/api/website_user_attributes', { body, ...options });
+  }
+
+  /**
+   * Delete a website user attribute
+   *
+   * @example
+   * ```ts
+   * const websiteUserAttribute =
+   *   await client.auctions.websiteUserAttributes.delete('id', {
+   *     body_id: '123e4567-e89b-12d3-a456-426614174003',
+   *     organizationId: '123e4567-e89b-12d3-a456-426614174002',
+   *     websiteId: '123e4567-e89b-12d3-a456-426614174001',
+   *   });
+   * ```
+   */
+  delete(
+    pathId: string,
+    body: WebsiteUserAttributeDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WebsiteUserAttributeDeleteResponse> {
+    return this._client.delete(`/api/website_user_attributes/${pathId}`, { body, ...options });
+  }
+}
+
+export interface WebsiteUserAttributeCreateResponse {
+  data: Array<WebsiteUserAttributeCreateResponse.Data>;
+}
+
+export namespace WebsiteUserAttributeCreateResponse {
+  export interface Data {
+    id: string;
+
+    createdAt: string;
+
+    deletedAt: string | null;
+
+    label: string;
+
+    organizationId: string;
+
+    updatedAt: string;
+
+    websiteId: string;
+  }
+}
+
+export interface WebsiteUserAttributeDeleteResponse {
+  message: string;
+}
+
+export interface WebsiteUserAttributeCreateParams {
+  data: Array<WebsiteUserAttributeCreateParams.Data>;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId?: string;
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId?: string;
+}
+
+export namespace WebsiteUserAttributeCreateParams {
+  export interface Data {
+    /**
+     * Label for the website user attribute
+     */
+    label: string;
+
+    /**
+     * Unique identifier for the website user attribute
+     */
+    id?: string;
+  }
+}
+
+export interface WebsiteUserAttributeDeleteParams {
+  /**
+   * Unique identifier for the website user attribute
+   */
+  body_id: string;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId: string;
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId: string;
+}
+
+WebsiteUserAttributes.Values = Values;
+
+export declare namespace WebsiteUserAttributes {
+  export {
+    type WebsiteUserAttributeCreateResponse as WebsiteUserAttributeCreateResponse,
+    type WebsiteUserAttributeDeleteResponse as WebsiteUserAttributeDeleteResponse,
+    type WebsiteUserAttributeCreateParams as WebsiteUserAttributeCreateParams,
+    type WebsiteUserAttributeDeleteParams as WebsiteUserAttributeDeleteParams,
+  };
+
+  export {
+    Values as Values,
+    type ValueCreateResponse as ValueCreateResponse,
+    type ValueCreateParams as ValueCreateParams,
+  };
+}

package/src/resources/auctions/website-user-attributes.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './website-user-attributes/index';

package/src/resources/auctions.ts

@@ -1,209 +1,3 @@
 // 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 Auctions extends APIResource {
-  /**
-   * Returns a list of auction bids with optional filtering and pagination.
-   */
-  listAuctionBids(query?: AuctionListAuctionBidsParams, options?: Core.RequestOptions): Core.APIPromise<void>;
-  listAuctionBids(options?: Core.RequestOptions): Core.APIPromise<void>;
-  listAuctionBids(
-    query: AuctionListAuctionBidsParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<void> {
-    if (isRequestOptions(query)) {
-      return this.listAuctionBids({}, query);
-    }
-    return this._client.get('/api/auction_bids', {
-      query,
-      ...options,
-      headers: { Accept: '*/*', ...options?.headers },
-    });
-  }
-
-  /**
-   * Returns a list of auctions with optional filtering and pagination.
-   */
-  listAuctions(options?: Core.RequestOptions): Core.APIPromise<AuctionListAuctionsResponse> {
-    return this._client.get('/api/auctions', options);
-  }
-}
-
-/**
- * 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 AuctionListAuctionBidsParams {
-  /**
-   * The bid ID
-   */
-  id?: string;
-
-  /**
-   * ID of the auction
-   */
-  auctionId?: string;
-
-  /**
-   * Maximum number of bids to return
-   */
-  limit?: number;
-
-  /**
-   * ID of the organization
-   */
-  organizationId?: string;
-
-  /**
-   * Pagination cursor to start after a specific bid ID
-   */
-  startingAfter?: string;
-
-  /**
-   * Status of the bid
-   */
-  status?: '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;
-}
-
-export declare namespace Auctions {
-  export {
-    type AuctionListAuctionsResponse as AuctionListAuctionsResponse,
-    type AuctionListAuctionBidsParams as AuctionListAuctionBidsParams,
-  };
-}
+export * from './auctions/index';

package/src/resources/auth.ts

@@ -6,19 +6,19 @@ import * as Core from '../core';
 
 export class Auth extends APIResource {
   /**
-   * This endpoint allows you to connect your Twitter account to a Snag account
+   * This endpoint allows you to connect your auth account to a Snag account
    */
   connectAuth(
-    authType: 'twitter' | 'discord' | 'telegram' | 'epic' | 'steam',
+    authType: 'twitter' | 'discord' | 'telegram' | 'epic' | 'steam' | 'ultra' | 'google' | 'tiktok' | 'email',
     query?: AuthConnectAuthParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<AuthConnectAuthResponse>;
   connectAuth(
-    authType: 'twitter' | 'discord' | 'telegram' | 'epic' | 'steam',
+    authType: 'twitter' | 'discord' | 'telegram' | 'epic' | 'steam' | 'ultra' | 'google' | 'tiktok' | 'email',
     options?: Core.RequestOptions,
   ): Core.APIPromise<AuthConnectAuthResponse>;
   connectAuth(
-    authType: 'twitter' | 'discord' | 'telegram' | 'epic' | 'steam',
+    authType: 'twitter' | 'discord' | 'telegram' | 'epic' | 'steam' | 'ultra' | 'google' | 'tiktok' | 'email',
     query: AuthConnectAuthParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<AuthConnectAuthResponse> {
@@ -40,21 +40,37 @@ export interface AuthConnectAuthResponse {
 }
 
 export interface AuthConnectAuthParams {
+  /**
+   * The email address of the user, this is only required for email auth
+   */
+  emailAddress?: string;
+
   /**
    * The redirect URL where the user will land after completing the auth
    */
   redirect?: string;
 
   /**
-   * The type of response to return
+   * The type of response to return, this is not valid for email auth, email auth
+   * only supports the redirect flow via verification link.
    */
   responseType?: 'redirect' | 'json';
 
+  /**
+   * Whether to skip the YouTube channel check, this is only value for google auth
+   */
+  skipYTChannelCheck?: string;
+
   /**
    * The ID of the user
    */
   userId?: string;
 
+  /**
+   * The wallet address of the user
+   */
+  walletAddress?: string;
+
   /**
    * The ID of the website
    */

package/src/resources/index.ts

@@ -1,7 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Assets, type AssetCreateAssetResponse, type AssetCreateAssetParams } from './assets';
-export { Auctions, type AuctionListAuctionsResponse, type AuctionListAuctionBidsParams } from './auctions';
+export {
+  Auctions,
+  type AuctionGetPageSectionsResponse,
+  type AuctionListAuctionsResponse,
+  type AuctionGetPageSectionsParams,
+  type AuctionListAuctionBidsParams,
+} from './auctions/auctions';
 export { Auth, type AuthConnectAuthResponse, type AuthConnectAuthParams } from './auth';
 export { Loyalty } from './loyalty/loyalty';
 export { Minting, type MintingGetAssetsResponse, type MintingGetAssetsParams } from './minting';
@@ -15,16 +21,14 @@ export {
   type UserListResponse,
   type UserConnectResponse,
   type UserCountResponse,
+  type UserCreateDeviceResponse,
   type UserDisconnectResponse,
+  type UserVerifyResponse,
   type UserListParams,
   type UserConnectParams,
   type UserCountParams,
+  type UserCreateDeviceParams,
   type UserDisconnectParams,
+  type UserVerifyParams,
 } from './users/users';
-export {
-  Websites,
-  type WebsiteCreateResponse,
-  type WebsiteListResponse,
-  type WebsiteCreateParams,
-  type WebsiteListParams,
-} from './websites/websites';
+export { Websites, type WebsiteListResponse, type WebsiteListParams } from './websites/websites';

package/src/resources/loyalty/account-streaks.ts

@@ -0,0 +1,110 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class AccountStreaks extends APIResource {
+  /**
+   * Get loyalty account streaks
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.accountStreaks.getStreaks({
+   *     loyaltyRuleId:
+   *       'loyaltyRuleId=123e4567-e89b-12d3-a456-426614174001&loyaltyRuleId=123e4567-e89b-12d3-a456-426614174002',
+   *   });
+   * ```
+   */
+  getStreaks(
+    query: AccountStreakGetStreaksParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AccountStreakGetStreaksResponse> {
+    return this._client.get('/api/loyalty/account_streaks', { query, ...options });
+  }
+}
+
+/**
+ * Response schema for getting loyalty account streaks, null if no streak
+ */
+export type AccountStreakGetStreaksResponse =
+  Array<AccountStreakGetStreaksResponse.AccountStreakGetStreaksResponseItem>;
+
+export namespace AccountStreakGetStreaksResponse {
+  export interface AccountStreakGetStreaksResponseItem {
+    /**
+     * ID of the loyalty account streak, null if no streak yet
+     */
+    id: string | null;
+
+    /**
+     * Date and time the streak was created, null if no streak yet
+     */
+    createdAt: string | null;
+
+    /**
+     * Date and time the streak expires, null if no streak yet
+     */
+    expiresAt: string | null;
+
+    loyaltyRuleId: string;
+
+    milestone: Array<AccountStreakGetStreaksResponseItem.Milestone>;
+
+    /**
+     * Number of days in the streak, 0 if no streak
+     */
+    streakCount: number;
+
+    /**
+     * Date and time the streak was last updated, null if no streak yet
+     */
+    updatedAt: string | null;
+
+    userId: string;
+
+    walletAddress: string;
+  }
+
+  export namespace AccountStreakGetStreaksResponseItem {
+    export interface Milestone {
+      streakAmount: number;
+
+      streakMilestone: number;
+    }
+  }
+}
+
+export interface AccountStreakGetStreaksParams {
+  /**
+   * Loyalty rule id(s) to filter by, array or single id
+   */
+  loyaltyRuleId: string | Array<string>;
+
+  /**
+   * Maximum number of records to return (max 1000)
+   */
+  limit?: number;
+
+  /**
+   * Pagination cursor to start after a specific resource ID
+   */
+  startingAfter?: string;
+
+  /**
+   * User id to filter by
+   */
+  userId?: string;
+
+  /**
+   * Wallet address to filter by
+   */
+  walletAddress?: string;
+}
+
+export declare namespace AccountStreaks {
+  export {
+    type AccountStreakGetStreaksResponse as AccountStreakGetStreaksResponse,
+    type AccountStreakGetStreaksParams as AccountStreakGetStreaksParams,
+  };
+}

package/src/resources/loyalty/accounts.ts

@@ -7,6 +7,11 @@ import * as Core from '../../core';
 export class Accounts extends APIResource {
   /**
    * Get loyalty accounts
+   *
+   * @example
+   * ```ts
+   * const accounts = await client.loyalty.accounts.list();
+   * ```
    */
   list(query?: AccountListParams, options?: Core.RequestOptions): Core.APIPromise<AccountListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<AccountListResponse>;
@@ -24,6 +29,19 @@ export class Accounts extends APIResource {
    * Returns the user's rank determined by their loyalty points for the specified
    * loyalty currency. This can be a slow operation for large organizations. We
    * recommend caching when possible.
+   *
+   * @example
+   * ```ts
+   * const response = await client.loyalty.accounts.retrieveRank(
+   *   '123e4567-e89b-12d3-a456-426614174333',
+   *   {
+   *     loyaltyCurrencyId:
+   *       '123e4567-e89b-12d3-a456-426614174333',
+   *     organizationId: '123e4567-e89b-12d3-a456-426614174333',
+   *     websiteId: '123e4567-e89b-12d3-a456-426614174333',
+   *   },
+   * );
+   * ```
    */
   retrieveRank(
     id: string,
@@ -109,6 +127,11 @@ export namespace AccountListResponse {
        * Ethereum wallet address of the user
        */
       walletAddress: string | null;
+
+      /**
+       * Array of website user attribute values for the user
+       */
+      websiteUserAttributeValues: Array<User.WebsiteUserAttributeValue>;
     }
 
     export namespace User {
@@ -141,6 +164,38 @@ export namespace AccountListResponse {
          */
         walletGroupIdentifier: string | null;
       }
+
+      /**
+       * Schema for a website user attribute value
+       */
+      export interface WebsiteUserAttributeValue {
+        /**
+         * Value for the website user attribute
+         */
+        value: string;
+
+        /**
+         * Website user attribute details
+         */
+        websiteUserAttribute: WebsiteUserAttributeValue.WebsiteUserAttribute;
+      }
+
+      export namespace WebsiteUserAttributeValue {
+        /**
+         * Website user attribute details
+         */
+        export interface WebsiteUserAttribute {
+          /**
+           * Unique identifier for the website user attribute
+           */
+          id: string;
+
+          /**
+           * Label for the website user attribute
+           */
+          label: string;
+        }
+      }
     }
   }
 }
@@ -150,17 +205,12 @@ export namespace AccountListResponse {
  */
 export interface AccountRetrieveRankResponse {
   /**
-   * Rank of the user
+   * Rank of the user. null means the user has no amount.
    */
-  rank: number;
+  rank: number | null;
 }
 
 export interface AccountListParams {
-  /**
-   * Discord username to filter accounts by
-   */
-  discordUser?: string;
-
   /**
    * External identifier for the user
    */
@@ -176,25 +226,20 @@ export interface AccountListParams {
    */
   loyaltyCurrencyId?: string;
 
-  /**
-   * Order the accounts by amount in ascending or descending order
-   */
-  'orderBy[amount]'?: 'asc' | 'desc';
-
   /**
    * Unique identifier for the organization to filter by
    */
   organizationId?: string;
 
   /**
-   * Pagination cursor to start after a specific account ID
+   * Order the accounts in ascending or descending order, sorted by amount
    */
-  startingAfter?: string;
+  sortDir?: 'asc' | 'desc';
 
   /**
-   * Twitter username to filter accounts by
+   * Pagination cursor to start after a specific account ID
    */
-  twitterUser?: string;
+  startingAfter?: string;
 
   /**
    * External identifier for the user group controlled by you
@@ -207,9 +252,9 @@ export interface AccountListParams {
   userGroupId?: string;
 
   /**
-   * User ID(s) to filter accounts by
+   * User ID(s) to filter accounts by. Pass in null to get a currencys main accounts.
    */
-  userId?: string | Array<string>;
+  userId?: string | 'null' | Array<string>;
 
   /**
    * Wallet address(es) to filter accounts by