@snagsolutions/sdk 0.1.0-alpha.15 → 0.1.0-alpha.150

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

@@ -0,0 +1,207 @@
+// 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 ValuesAPI from './values';
+import { ValueCreateParams, ValueCreateResponse, ValueListParams, ValueListResponse, 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 });
+  }
+
+  /**
+   * Get all website user attributes
+   *
+   * @example
+   * ```ts
+   * const websiteUserAttributes =
+   *   await client.auctions.websiteUserAttributes.list();
+   * ```
+   */
+  list(
+    query?: WebsiteUserAttributeListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WebsiteUserAttributeListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<WebsiteUserAttributeListResponse>;
+  list(
+    query: WebsiteUserAttributeListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WebsiteUserAttributeListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/api/website_user_attributes', { query, ...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 WebsiteUserAttributeListResponse {
+  data: Array<WebsiteUserAttributeListResponse.Data>;
+
+  hasNextPage: boolean;
+}
+
+export namespace WebsiteUserAttributeListResponse {
+  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 WebsiteUserAttributeListParams {
+  /**
+   * Number of website user attributes to return
+   */
+  limit?: string;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId?: string;
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId?: 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 WebsiteUserAttributeListResponse as WebsiteUserAttributeListResponse,
+    type WebsiteUserAttributeDeleteResponse as WebsiteUserAttributeDeleteResponse,
+    type WebsiteUserAttributeCreateParams as WebsiteUserAttributeCreateParams,
+    type WebsiteUserAttributeListParams as WebsiteUserAttributeListParams,
+    type WebsiteUserAttributeDeleteParams as WebsiteUserAttributeDeleteParams,
+  };
+
+  export {
+    Values as Values,
+    type ValueCreateResponse as ValueCreateResponse,
+    type ValueListResponse as ValueListResponse,
+    type ValueCreateParams as ValueCreateParams,
+    type ValueListParams as ValueListParams,
+  };
+}

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/{api.ts → auctions.ts}

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

package/src/resources/auth.ts

@@ -0,0 +1,79 @@
+// 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 Auth extends APIResource {
+  /**
+   * This endpoint allows you to connect your auth account to a Snag account
+   */
+  connectAuth(
+    authType: 'twitter' | 'discord' | 'telegram' | 'epic' | 'steam' | 'ultra' | 'google',
+    query?: AuthConnectAuthParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AuthConnectAuthResponse>;
+  connectAuth(
+    authType: 'twitter' | 'discord' | 'telegram' | 'epic' | 'steam' | 'ultra' | 'google',
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AuthConnectAuthResponse>;
+  connectAuth(
+    authType: 'twitter' | 'discord' | 'telegram' | 'epic' | 'steam' | 'ultra' | 'google',
+    query: AuthConnectAuthParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AuthConnectAuthResponse> {
+    if (isRequestOptions(query)) {
+      return this.connectAuth(authType, {}, query);
+    }
+    return this._client.get(`/api/${authType}/auth`, { query, ...options });
+  }
+}
+
+/**
+ * Schema for a connect social auth response schema
+ */
+export interface AuthConnectAuthResponse {
+  /**
+   * The URL to redirect to
+   */
+  url: string;
+}
+
+export interface AuthConnectAuthParams {
+  /**
+   * The redirect URL where the user will land after completing the auth
+   */
+  redirect?: string;
+
+  /**
+   * The type of response to return
+   */
+  responseType?: 'redirect' | 'json';
+
+  /**
+   * Whether to skip the YouTube channel check
+   */
+  skipYTChannelCheck?: string;
+
+  /**
+   * The ID of the user
+   */
+  userId?: string;
+
+  /**
+   * The wallet address of the user
+   */
+  walletAddress?: string;
+
+  /**
+   * The ID of the website
+   */
+  websiteId?: string;
+}
+
+export declare namespace Auth {
+  export {
+    type AuthConnectAuthResponse as AuthConnectAuthResponse,
+    type AuthConnectAuthParams as AuthConnectAuthParams,
+  };
+}

package/src/resources/index.ts

@@ -1,11 +1,40 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export { Assets, type AssetCreateAssetResponse, type AssetCreateAssetParams } from './assets';
 export {
-  API,
-  type APICreateAssetUploadURLResponse,
-  type APIListAuctionsResponse,
-  type APIListUsersResponse,
-  type APICreateAssetUploadURLParams,
-  type APIListAuctionBidsParams,
-  type APIListUsersParams,
-} from './api/api';
+  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';
+export {
+  Referral,
+  type ReferralCreateCodeResponse,
+  type ReferralCreateCodeParams,
+} from './referral/referral';
+export {
+  Users,
+  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';

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/{api/loyalty → loyalty}/accounts.ts

@@ -1,12 +1,17 @@
 // 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 { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+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,13 +29,26 @@ 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',
+   *   },
+   * );
+   * ```
    */
-  getRank(
-    pathId: string,
-    query: AccountGetRankParams,
+  retrieveRank(
+    id: string,
+    query: AccountRetrieveRankParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<AccountGetRankResponse> {
-    return this._client.get(`/api/loyalty/accounts/${pathId}/rank`, { query, ...options });
+  ): Core.APIPromise<AccountRetrieveRankResponse> {
+    return this._client.get(`/api/loyalty/accounts/${id}/rank`, { query, ...options });
   }
 }
 
@@ -145,19 +163,17 @@ export namespace AccountListResponse {
   }
 }
 
-export interface AccountGetRankResponse {
+/**
+ * Schema for a get account rank response
+ */
+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
    */
@@ -173,25 +189,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
@@ -204,9 +215,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
@@ -224,12 +235,7 @@ export interface AccountListParams {
   websiteId?: string;
 }
 
-export interface AccountGetRankParams {
-  /**
-   * UUID of the account
-   */
-  query_id: string;
-
+export interface AccountRetrieveRankParams {
   /**
    * UUID of the loyalty currency
    */
@@ -249,8 +255,8 @@ export interface AccountGetRankParams {
 export declare namespace Accounts {
   export {
     type AccountListResponse as AccountListResponse,
-    type AccountGetRankResponse as AccountGetRankResponse,
+    type AccountRetrieveRankResponse as AccountRetrieveRankResponse,
     type AccountListParams as AccountListParams,
-    type AccountGetRankParams as AccountGetRankParams,
+    type AccountRetrieveRankParams as AccountRetrieveRankParams,
   };
 }