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

package/src/resources/loyalty/transactions/index.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Posts,
+  type PostListResponse,
+  type PostRewardResponse,
+  type PostListParams,
+  type PostRewardParams,
+} from './posts';
+export {
+  RuleStatuses,
+  type RuleStatusUpdateResponse,
+  type RuleStatusListResponse,
+  type RuleStatusUpdateParams,
+  type RuleStatusListParams,
+} from './rule-statuses';
+export {
+  Transactions,
+  type TransactionCreateTransactionResponse,
+  type TransactionGetTransactionEntriesResponse,
+  type TransactionListBadgeUsersResponse,
+  type TransactionListRuleChainsResponse,
+  type TransactionResetLoyaltyCurrencyResponse,
+  type TransactionCreateTransactionParams,
+  type TransactionGetTransactionEntriesParams,
+  type TransactionListBadgeUsersParams,
+  type TransactionListRuleChainsParams,
+  type TransactionResetLoyaltyCurrencyParams,
+} from './transactions';

package/src/resources/loyalty/transactions/posts.ts

@@ -0,0 +1,221 @@
+// 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 Posts extends APIResource {
+  /**
+   * Fetch social posts with pagination and filtering options. Note: Rank is
+   * calculated for top 20,000 posts only. Posts beyond this threshold will have a
+   * null rank.
+   *
+   * @example
+   * ```ts
+   * const posts =
+   *   await client.loyalty.transactions.posts.list();
+   * ```
+   */
+  list(query?: PostListParams, options?: Core.RequestOptions): Core.APIPromise<PostListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<PostListResponse>;
+  list(
+    query: PostListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PostListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/api/loyalty/posts', { query, ...options });
+  }
+
+  /**
+   * Reward a user for their social post.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.transactions.posts.reward('id', {
+   *     amount: 100,
+   *     loyaltyCurrencyId:
+   *       '123e4567-e89b-12d3-a456-426614174000',
+   *   });
+   * ```
+   */
+  reward(
+    id: string,
+    body: PostRewardParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PostRewardResponse> {
+    return this._client.post(`/api/loyalty/posts/${id}/reward`, { body, ...options });
+  }
+}
+
+/**
+ * Response containing social posts with pagination info
+ */
+export interface PostListResponse {
+  data: Array<PostListResponse.Data>;
+
+  hasNextPage: boolean;
+}
+
+export namespace PostListResponse {
+  /**
+   * A social media post
+   */
+  export interface Data {
+    id: string;
+
+    authorId: string;
+
+    createdAt: string;
+
+    isSeen: boolean;
+
+    loyaltyCurrencyId: string;
+
+    loyaltyRuleId: string;
+
+    mediaType: 'image' | 'video';
+
+    platform: 'twitter' | 'tiktok';
+
+    postType: 'post' | 'comment' | 'repost';
+
+    updatedAt: string;
+
+    userId: string;
+
+    userMetadata: Data.UserMetadata;
+
+    commentCount?: number;
+
+    contentQualityScore?: number | null;
+
+    dynamicScore?: number | null;
+
+    externalIdentifier?: string | null;
+
+    latestReward?: number | null;
+
+    likeCount?: number;
+
+    manualRank?: number | null;
+
+    mediaUrl?: string;
+
+    parentPostId?: string;
+
+    postedAt?: string | null;
+
+    previewUrl?: string;
+
+    rank?: number | null;
+
+    repostCount?: number;
+
+    sentimentScore?: number | null;
+
+    text?: string;
+
+    viewCount?: number;
+  }
+
+  export namespace Data {
+    export interface UserMetadata {
+      twitterUser: string;
+
+      twitterUserFollowersCount: number;
+
+      twitterUserId: string;
+
+      twitterVerifiedAccount: boolean;
+
+      userId: string;
+
+      logoUrl?: string;
+    }
+  }
+}
+
+/**
+ * Response containing the reward transaction details
+ */
+export interface PostRewardResponse {
+  success: boolean;
+
+  transaction: PostRewardResponse.Transaction;
+}
+
+export namespace PostRewardResponse {
+  export interface Transaction {
+    id: string;
+
+    amount: number;
+
+    loyaltyCurrencyId: string;
+  }
+}
+
+export interface PostListParams {
+  /**
+   * Cursor for pagination
+   */
+  cursor?: string;
+
+  /**
+   * Number of posts to fetch per page
+   */
+  limit?: number;
+
+  /**
+   * Optional UUID of the loyalty post to filter posts
+   */
+  loyaltyPostId?: string | Array<string>;
+
+  /**
+   * UUID of the organization to fetch social posts for
+   */
+  organizationId?: string;
+
+  /**
+   * Sort posts by createdAt or rank
+   */
+  sortBy?: 'rank' | 'createdAt';
+
+  /**
+   * Optional UUID of the user group to filter posts
+   */
+  userGroupId?: string;
+
+  /**
+   * Optional UUID of the user to filter posts
+   */
+  userId?: string | Array<string>;
+
+  /**
+   * UUID of the website to fetch social posts for
+   */
+  websiteId?: string;
+}
+
+export interface PostRewardParams {
+  /**
+   * Amount to reward
+   */
+  amount: number;
+
+  /**
+   * UUID of the loyalty currency to reward with
+   */
+  loyaltyCurrencyId: string;
+}
+
+export declare namespace Posts {
+  export {
+    type PostListResponse as PostListResponse,
+    type PostRewardResponse as PostRewardResponse,
+    type PostListParams as PostListParams,
+    type PostRewardParams as PostRewardParams,
+  };
+}

package/src/resources/loyalty/transactions/rule-statuses.ts

@@ -0,0 +1,179 @@
+// 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 RuleStatuses extends APIResource {
+  /**
+   * Update a loyalty rule status
+   *
+   * @example
+   * ```ts
+   * const ruleStatus =
+   *   await client.loyalty.transactions.ruleStatuses.update({
+   *     loyaltyRuleId: '123e4567-e89b-12d3-a456-426614174030',
+   *   });
+   * ```
+   */
+  update(
+    body: RuleStatusUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<RuleStatusUpdateResponse> {
+    return this._client.post('/api/loyalty/rule_statuses', { body, ...options });
+  }
+
+  /**
+   * Retrieve loyalty rule statuses
+   *
+   * @example
+   * ```ts
+   * const ruleStatuses =
+   *   await client.loyalty.transactions.ruleStatuses.list();
+   * ```
+   */
+  list(query?: RuleStatusListParams, options?: Core.RequestOptions): Core.APIPromise<RuleStatusListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<RuleStatusListResponse>;
+  list(
+    query: RuleStatusListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<RuleStatusListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/api/loyalty/rule_statuses', { query, ...options });
+  }
+}
+
+export interface RuleStatusUpdateResponse {
+  id: string;
+
+  createdAt: string;
+
+  loyaltyRuleId: string;
+
+  organizationId: string;
+
+  progress: number;
+
+  updatedAt: string;
+
+  userId: string;
+
+  websiteId: string;
+}
+
+export interface RuleStatusListResponse {
+  data: Array<RuleStatusListResponse.Data>;
+
+  hasNextPage: boolean;
+}
+
+export namespace RuleStatusListResponse {
+  export interface Data {
+    id: string;
+
+    createdAt: string;
+
+    loyaltyRuleId: string;
+
+    organizationId: string;
+
+    progress: number;
+
+    updatedAt: string;
+
+    userId: string;
+
+    websiteId: string;
+  }
+}
+
+export interface RuleStatusUpdateParams {
+  /**
+   * Unique identifier for the loyalty rule
+   */
+  loyaltyRuleId: string;
+
+  /**
+   * Increment progress of the loyalty rule
+   */
+  incProgress?: number;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId?: string;
+
+  /**
+   * Progress of the loyalty rule
+   */
+  progress?: number;
+
+  /**
+   * Unique identifier for the user, either userId or walletAddress must be provided
+   */
+  userId?: string;
+
+  /**
+   * Unique identifier for the wallet address, either userId or walletAddress must be
+   * provided
+   */
+  walletAddress?: string;
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId?: string;
+}
+
+export interface RuleStatusListParams {
+  /**
+   * Number of items to return
+   */
+  limit?: number | null;
+
+  /**
+   * Unique identifier(s) for the loyalty rule(s). Accepts a single ID or an array
+   * (up to 100); for larger sets, batch requests to avoid URL length limits.
+   */
+  loyaltyRuleId?: string | Array<string>;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId?: string;
+
+  /**
+   * Starting after item
+   */
+  startingAfter?: string;
+
+  userGroupExternalIdentifier?: string;
+
+  userGroupId?: string;
+
+  /**
+   * User ID(s) to filter accounts by
+   */
+  userId?: string | Array<string>;
+
+  /**
+   * Wallet address(es) to filter accounts by
+   */
+  walletAddress?: string | Array<string>;
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId?: string;
+}
+
+export declare namespace RuleStatuses {
+  export {
+    type RuleStatusUpdateResponse as RuleStatusUpdateResponse,
+    type RuleStatusListResponse as RuleStatusListResponse,
+    type RuleStatusUpdateParams as RuleStatusUpdateParams,
+    type RuleStatusListParams as RuleStatusListParams,
+  };
+}