@snagsolutions/sdk 0.1.0-alpha.10

package/src/resources/drip/status.ts

@@ -0,0 +1,33 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class Status extends APIResource {
+  /**
+   * Retrieves the current status of a drip quest verification using the verification
+   * ID.
+   */
+  retrieve(verificationId: string, options?: Core.RequestOptions): Core.APIPromise<StatusRetrieveResponse> {
+    return this._client.get(`/api/drip/status/${verificationId}`, options);
+  }
+}
+
+/**
+ * Schema for verification status
+ */
+export interface StatusRetrieveResponse {
+  /**
+   * Current status of the verification
+   */
+  status: 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED';
+
+  /**
+   * Unique identifier for the verification
+   */
+  verificationId: string;
+}
+
+export declare namespace Status {
+  export { type StatusRetrieveResponse as StatusRetrieveResponse };
+}

package/src/resources/index.ts

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Assets, type AssetCreateResponse, type AssetCreateParams } from './assets';
+export { AuctionBids, type AuctionBidCreateParams, type AuctionBidListParams } from './auction-bids';
+export { Drip } from './drip/drip';
+export { Loyalty } from './loyalty/loyalty';
+export { Users } from './users/users';
+export {
+  Websites,
+  type WebsiteCreateResponse,
+  type WebsiteListResponse,
+  type WebsiteCreateParams,
+  type WebsiteListParams,
+} from './websites';

package/src/resources/loyalty/accounts.ts

@@ -0,0 +1,199 @@
+// 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 Accounts extends APIResource {
+  /**
+   * Get loyalty accounts
+   */
+  list(query?: AccountListParams, options?: Core.RequestOptions): Core.APIPromise<AccountListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<AccountListResponse>;
+  list(
+    query: AccountListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AccountListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/', { query, ...options });
+  }
+}
+
+/**
+ * Schema for the response of getting loyalty accounts
+ */
+export interface AccountListResponse {
+  /**
+   * Array of loyalty accounts
+   */
+  data: Array<AccountListResponse.Data>;
+
+  /**
+   * Indicates if there is a next page of results
+   */
+  hasNextPage: boolean;
+
+  /**
+   * Optional message
+   */
+  message?: string;
+}
+
+export namespace AccountListResponse {
+  /**
+   * Schema for a loyalty account
+   */
+  export interface Data {
+    /**
+     * Unique identifier for the loyalty account
+     */
+    id: string;
+
+    /**
+     * Unique identifier for the loyalty currency
+     */
+    loyaltyCurrencyId: string;
+
+    /**
+     * User associated with the loyalty account
+     */
+    user: Data.User | null;
+
+    /**
+     * Unique identifier for the user
+     */
+    userId: string | null;
+
+    /**
+     * Balance amount in the loyalty account
+     */
+    amount?: unknown;
+
+    /**
+     * Version number used for optimistic locking
+     */
+    lockVersion?: unknown;
+  }
+
+  export namespace Data {
+    /**
+     * Schema for a user
+     */
+    export interface User {
+      /**
+       * Unique identifier for the user
+       */
+      id: string;
+
+      /**
+       * Array of metadata associated with the user
+       */
+      userMetadata: Array<User.UserMetadata>;
+
+      /**
+       * Ethereum wallet address of the user
+       */
+      walletAddress: string | null;
+    }
+
+    export namespace User {
+      /**
+       * Schema for user metadata
+       */
+      export interface UserMetadata {
+        /**
+         * Discord username associated with the user
+         */
+        discordUser: string | null;
+
+        /**
+         * Display name of the user
+         */
+        displayName: string | null;
+
+        /**
+         * URL of the user's logo
+         */
+        logoUrl: string | null;
+
+        /**
+         * Twitter username associated with the user
+         */
+        twitterUser: string | null;
+
+        /**
+         * Identifier for the wallet group
+         */
+        walletGroupIdentifier: string | null;
+      }
+    }
+  }
+}
+
+export interface AccountListParams {
+  /**
+   * Discord username to filter accounts by
+   */
+  discordUser?: string;
+
+  /**
+   * Whether to include wallet group information
+   */
+  includeWalletGroup?: boolean | null;
+
+  /**
+   * Maximum number of accounts to return
+   */
+  limit?: number | null;
+
+  /**
+   * Unique identifier for the loyalty currency
+   */
+  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
+   */
+  startingAfter?: string;
+
+  /**
+   * Twitter username to filter accounts by
+   */
+  twitterUser?: string;
+
+  /**
+   * User ID(s) to filter accounts by
+   */
+  userId?: string | Array<string>;
+
+  /**
+   * Wallet address(es) to filter accounts by
+   */
+  walletAddress?: string | Array<string>;
+
+  /**
+   * Wallet group identifier to filter accounts by
+   */
+  walletGroupIdentifier?: string;
+
+  /**
+   * Unique identifier for the website to filter by
+   */
+  websiteId?: string;
+}
+
+export declare namespace Accounts {
+  export { type AccountListResponse as AccountListResponse, type AccountListParams as AccountListParams };
+}

package/src/resources/loyalty/badges.ts

@@ -0,0 +1,435 @@
+// 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 Badges extends APIResource {
+  /**
+   * This endpoint allows you to configure a new badge.
+   */
+  create(body: BadgeCreateParams, options?: Core.RequestOptions): Core.APIPromise<BadgeCreateResponse> {
+    return this._client.post('/api/loyalty/badges', { body, ...options });
+  }
+
+  /**
+   * This endpoint allows you to update an existing badge.
+   */
+  update(
+    id: string,
+    body?: BadgeUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BadgeUpdateResponse>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<BadgeUpdateResponse>;
+  update(
+    id: string,
+    body: BadgeUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BadgeUpdateResponse> {
+    if (isRequestOptions(body)) {
+      return this.update(id, {}, body);
+    }
+    return this._client.post(`/api/loyalty/badges/${id}`, { body, ...options });
+  }
+
+  /**
+   * This endpoint allows you to fetch badge(s) data.
+   */
+  list(query?: BadgeListParams, options?: Core.RequestOptions): Core.APIPromise<BadgeListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<BadgeListResponse>;
+  list(
+    query: BadgeListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BadgeListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/api/loyalty/badges', { query, ...options });
+  }
+
+  /**
+   * This endpoint allows you to delete a badge.
+   */
+  delete(id: string, options?: Core.RequestOptions): Core.APIPromise<BadgeDeleteResponse> {
+    return this._client.delete(`/api/loyalty/badges/${id}`, options);
+  }
+
+  /**
+   * This endpoint allows you to revoke a badge from an account
+   */
+  revoke(
+    id: string,
+    body?: BadgeRevokeParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BadgeRevokeResponse>;
+  revoke(id: string, options?: Core.RequestOptions): Core.APIPromise<BadgeRevokeResponse>;
+  revoke(
+    id: string,
+    body: BadgeRevokeParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BadgeRevokeResponse> {
+    if (isRequestOptions(body)) {
+      return this.revoke(id, {}, body);
+    }
+    return this._client.post(`/api/loyalty/badges/${id}/revoke`, { body, ...options });
+  }
+
+  /**
+   * This endpoint allows you to reward a badge for an account
+   */
+  reward(
+    id: string,
+    body?: BadgeRewardParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BadgeRewardResponse>;
+  reward(id: string, options?: Core.RequestOptions): Core.APIPromise<BadgeRewardResponse>;
+  reward(
+    id: string,
+    body: BadgeRewardParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BadgeRewardResponse> {
+    if (isRequestOptions(body)) {
+      return this.reward(id, {}, body);
+    }
+    return this._client.post(`/api/loyalty/badges/${id}/reward`, { body, ...options });
+  }
+}
+
+/**
+ * Response returned upon successful creation of the badge.
+ */
+export interface BadgeCreateResponse {
+  id: string;
+}
+
+/**
+ * Response returned upon successful update of the badge.
+ */
+export interface BadgeUpdateResponse {
+  id: string;
+}
+
+/**
+ * Response returned upon successful fetching of the badges.
+ */
+export interface BadgeListResponse {
+  badges: Array<BadgeListResponse.Badge>;
+}
+
+export namespace BadgeListResponse {
+  export interface Badge {
+    /**
+     * UUID of the badge (converted to lowercase)
+     */
+    id: string;
+
+    /**
+     * Count of rules and accounts with the badge
+     */
+    _count: Badge._Count;
+
+    /**
+     * The URL of the badge image
+     */
+    imageUrl: string;
+
+    /**
+     * Array of rules for the badge
+     */
+    loyaltyConditions: Array<Badge.LoyaltyCondition>;
+
+    /**
+     * The name of the badge
+     */
+    name: string;
+
+    /**
+     * The description of the badge
+     */
+    description?: string;
+  }
+
+  export namespace Badge {
+    /**
+     * Count of rules and accounts with the badge
+     */
+    export interface _Count {
+      /**
+       * The number of accounts with the badge
+       */
+      LoyaltyBadgeUser: number;
+
+      /**
+       * The number of rules
+       */
+      loyaltyConditions: number;
+    }
+
+    export interface LoyaltyCondition {
+      /**
+       * UUID of the rule (converted to lowercase)
+       */
+      id: string;
+
+      /**
+       * The type of rule
+       */
+      type: 'rule' | 'section' | 'level' | 'points' | 'api' | 'badge';
+
+      /**
+       * The amount of the rule
+       */
+      amount?: number;
+
+      /**
+       * The description of the rule
+       */
+      description?: string;
+
+      /**
+       * UUID of the currency (optional, converted to lowercase)
+       */
+      loyaltyCurrencyId?: string;
+
+      /**
+       * UUID of the rule group (optional, converted to lowercase)
+       */
+      loyaltyRuleGroupId?: string;
+
+      /**
+       * UUID of the rule (optional, converted to lowercase)
+       */
+      loyaltyRuleId?: string;
+    }
+  }
+}
+
+/**
+ * Response returned upon successful deletion of the badge.
+ */
+export interface BadgeDeleteResponse {
+  id: string;
+
+  deletedAt: string;
+}
+
+/**
+ * Response returned upon successful update of the user badge
+ */
+export interface BadgeRevokeResponse {
+  data: BadgeRevokeResponse.Data;
+
+  /**
+   * The message returned upon update of the badge
+   */
+  message: string;
+}
+
+export namespace BadgeRevokeResponse {
+  export interface Data {
+    id: string;
+
+    loyaltyBadgeId: string;
+
+    status: 'active' | 'inactive' | 'revoked';
+
+    userId: string;
+  }
+}
+
+/**
+ * Response returned upon successful update of the user badge
+ */
+export interface BadgeRewardResponse {
+  data: BadgeRewardResponse.Data;
+
+  /**
+   * The message returned upon update of the badge
+   */
+  message: string;
+}
+
+export namespace BadgeRewardResponse {
+  export interface Data {
+    id: string;
+
+    loyaltyBadgeId: string;
+
+    status: 'active' | 'inactive' | 'revoked';
+
+    userId: string;
+  }
+}
+
+export interface BadgeCreateParams {
+  /**
+   * The URL of the badge image
+   */
+  imageUrl: string;
+
+  /**
+   * The name of the badge
+   */
+  name: string;
+
+  /**
+   * UUID of the organization (optional, converted to lowercase)
+   */
+  organizationId: string;
+
+  /**
+   * Array of rules for the badge
+   */
+  rules: Array<BadgeCreateParams.Rule>;
+
+  /**
+   * UUID of the website (optional, converted to lowercase)
+   */
+  websiteId: string;
+
+  /**
+   * The description of the badge
+   */
+  description?: string;
+}
+
+export namespace BadgeCreateParams {
+  /**
+   * Schema for a loyalty condition rule.
+   */
+  export interface Rule {
+    /**
+     * The type of rule
+     */
+    type: 'rule' | 'section' | 'level' | 'points' | 'api' | 'badge';
+
+    /**
+     * The amount of the rule
+     */
+    amount?: number | null;
+
+    /**
+     * The description of the rule
+     */
+    description?: string;
+
+    /**
+     * UUID of the badge (optional, converted to lowercase)
+     */
+    loyaltyBadgeId?: string | null;
+
+    /**
+     * UUID of the currency (optional, converted to lowercase)
+     */
+    loyaltyCurrencyId?: string | null;
+
+    /**
+     * UUID of the Loyalty Leaderboard (optional, converted to lowercase)
+     */
+    loyaltyLeaderboardViewId?: string | null;
+
+    /**
+     * UUID of the rule group (optional, converted to lowercase)
+     */
+    loyaltyRuleGroupId?: string | null;
+
+    /**
+     * UUID of the rule (optional, converted to lowercase)
+     */
+    loyaltyRuleId?: string | null;
+  }
+}
+
+export interface BadgeUpdateParams {
+  /**
+   * The description of the badge
+   */
+  description?: string;
+
+  /**
+   * The URL of the badge image
+   */
+  imageUrl?: string;
+
+  /**
+   * The name of the badge
+   */
+  name?: string;
+}
+
+export interface BadgeListParams {
+  /**
+   * Array of badge IDs (converted to lowercase) to fetch
+   */
+  badgeIds?: Array<string>;
+
+  /**
+   * Include deleted badges in the response
+   */
+  includeDeleted?: boolean | null;
+
+  /**
+   * Number of badges to fetch
+   */
+  limit?: number | null;
+
+  /**
+   * UUID of the organization (optional, converted to lowercase)
+   */
+  organizationId?: string;
+
+  /**
+   * UUID of the badge to start after (converted to lowercase)
+   */
+  startingAfter?: string;
+
+  /**
+   * UUID of the user (optional, converted to lowercase)
+   */
+  userId?: string;
+
+  /**
+   * UUID of the website (optional, converted to lowercase)
+   */
+  websiteId?: string;
+}
+
+export interface BadgeRevokeParams {
+  /**
+   * UUID of the user (converted to lowercase)
+   */
+  userId?: string;
+
+  /**
+   * Validated and formatted wallet address
+   */
+  walletAddress?: string;
+}
+
+export interface BadgeRewardParams {
+  /**
+   * UUID of the user (converted to lowercase)
+   */
+  userId?: string;
+
+  /**
+   * Validated and formatted wallet address
+   */
+  walletAddress?: string;
+}
+
+export declare namespace Badges {
+  export {
+    type BadgeCreateResponse as BadgeCreateResponse,
+    type BadgeUpdateResponse as BadgeUpdateResponse,
+    type BadgeListResponse as BadgeListResponse,
+    type BadgeDeleteResponse as BadgeDeleteResponse,
+    type BadgeRevokeResponse as BadgeRevokeResponse,
+    type BadgeRewardResponse as BadgeRewardResponse,
+    type BadgeCreateParams as BadgeCreateParams,
+    type BadgeUpdateParams as BadgeUpdateParams,
+    type BadgeListParams as BadgeListParams,
+    type BadgeRevokeParams as BadgeRevokeParams,
+    type BadgeRewardParams as BadgeRewardParams,
+  };
+}