@snagsolutions/sdk 0.1.0-alpha.13 → 0.1.0-alpha.14

package/src/resources/loyalty/transaction-entries/accounts.ts

@@ -0,0 +1,251 @@
+// 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('/api/loyalty/accounts', { query, ...options });
+  }
+
+  /**
+   * 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.
+   */
+  retrieveRank(
+    pathId: string,
+    query: AccountRetrieveRankParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AccountRetrieveRankResponse> {
+    return this._client.get(`/api/loyalty/accounts/${pathId}/rank`, { 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 AccountRetrieveRankResponse {
+  /**
+   * Rank of the user
+   */
+  rank: number;
+}
+
+export interface AccountListParams {
+  /**
+   * Discord username to filter accounts by
+   */
+  discordUser?: string;
+
+  /**
+   * Maximum number of accounts to return
+   */
+  limit?: number;
+
+  /**
+   * 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;
+
+  /**
+   * External identifier for the user group controlled by you
+   */
+  userGroupExternalIdentifier?: string;
+
+  /**
+   * Unique identifier for the user group
+   */
+  userGroupId?: 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 interface AccountRetrieveRankParams {
+  /**
+   * UUID of the account
+   */
+  query_id: string;
+
+  /**
+   * UUID of the loyalty currency
+   */
+  loyaltyCurrencyId: string;
+
+  /**
+   * UUID of the organization
+   */
+  organizationId: string;
+
+  /**
+   * UUID of the website
+   */
+  websiteId: string;
+}
+
+export declare namespace Accounts {
+  export {
+    type AccountListResponse as AccountListResponse,
+    type AccountRetrieveRankResponse as AccountRetrieveRankResponse,
+    type AccountListParams as AccountListParams,
+    type AccountRetrieveRankParams as AccountRetrieveRankParams,
+  };
+}

package/src/resources/loyalty/transaction-entries/index.ts

@@ -0,0 +1,34 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Accounts,
+  type AccountListResponse,
+  type AccountRetrieveRankResponse,
+  type AccountListParams,
+  type AccountRetrieveRankParams,
+} from './accounts';
+export {
+  Questions,
+  type QuestionCreateResponse,
+  type QuestionUpdateResponse,
+  type QuestionListResponse,
+  type QuestionCreateParams,
+  type QuestionUpdateParams,
+  type QuestionListParams,
+} from './questions';
+export {
+  QuestionsResponses,
+  type QuestionsResponseListResponse,
+  type QuestionsResponseSubmitResponse,
+  type QuestionsResponseListParams,
+  type QuestionsResponseSubmitParams,
+} from './questions-responses';
+export {
+  TransactionEntries,
+  type TransactionEntryListResponse,
+  type TransactionEntryCreateTransactionResponse,
+  type TransactionEntryListRuleGroupsResponse,
+  type TransactionEntryListParams,
+  type TransactionEntryCreateTransactionParams,
+  type TransactionEntryListRuleGroupsParams,
+} from './transaction-entries';

package/src/resources/loyalty/transaction-entries/questions-responses.ts

@@ -0,0 +1,146 @@
+// 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 QuestionsResponses extends APIResource {
+  /**
+   * Retrieve responses submitted by the authenticated user, optionally filtered by
+   * question IDs
+   */
+  list(
+    query?: QuestionsResponseListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<QuestionsResponseListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<QuestionsResponseListResponse>;
+  list(
+    query: QuestionsResponseListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<QuestionsResponseListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/api/loyalty/questions_responses', { query, ...options });
+  }
+
+  /**
+   * This endpoint allows you to submit a response to a question.
+   */
+  submit(
+    body: QuestionsResponseSubmitParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<QuestionsResponseSubmitResponse> {
+    return this._client.post('/api/loyalty/questions_responses', { body, ...options });
+  }
+}
+
+/**
+ * List of question responses with details
+ */
+export interface QuestionsResponseListResponse {
+  responses: Array<QuestionsResponseListResponse.Response>;
+}
+
+export namespace QuestionsResponseListResponse {
+  /**
+   * Response details including the question and choice information
+   */
+  export interface Response {
+    id: string;
+
+    createdAt: string;
+
+    isCorrect: boolean;
+
+    loyaltyQuestionChoiceId: string;
+
+    loyaltyQuestionId: string;
+
+    question: Response.Question;
+
+    userId: string;
+  }
+
+  export namespace Response {
+    export interface Question {
+      loyaltyQuestionChoices: Array<Question.LoyaltyQuestionChoice>;
+
+      text: string;
+    }
+
+    export namespace Question {
+      export interface LoyaltyQuestionChoice {
+        id: string;
+
+        isCorrect: boolean;
+
+        text: string;
+      }
+    }
+  }
+}
+
+/**
+ * Response returned when submitting an answer to a question
+ */
+export interface QuestionsResponseSubmitResponse {
+  /**
+   * Whether the user had already submitted an answer to this question
+   */
+  alreadySubmitted: boolean;
+
+  /**
+   * Whether the submitted answer was correct
+   */
+  isCorrect: boolean;
+
+  response: QuestionsResponseSubmitResponse.Response;
+}
+
+export namespace QuestionsResponseSubmitResponse {
+  export interface Response {
+    /**
+     * UUID of the response
+     */
+    id: string;
+
+    /**
+     * UUID of the selected choice
+     */
+    loyaltyQuestionChoiceId: string;
+
+    /**
+     * UUID of the question being answered
+     */
+    loyaltyQuestionId: string;
+
+    /**
+     * UUID of the user who submitted the response
+     */
+    userId: string;
+  }
+}
+
+export interface QuestionsResponseListParams {
+  /**
+   * UUID(s) of the questions to filter responses
+   */
+  questionsId?: string | Array<string>;
+}
+
+export interface QuestionsResponseSubmitParams {
+  /**
+   * UUID of the selected choice
+   */
+  loyaltyQuestionChoiceId: string;
+}
+
+export declare namespace QuestionsResponses {
+  export {
+    type QuestionsResponseListResponse as QuestionsResponseListResponse,
+    type QuestionsResponseSubmitResponse as QuestionsResponseSubmitResponse,
+    type QuestionsResponseListParams as QuestionsResponseListParams,
+    type QuestionsResponseSubmitParams as QuestionsResponseSubmitParams,
+  };
+}

package/src/resources/loyalty/transaction-entries/questions.ts

@@ -0,0 +1,208 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import * as Core from '../../../core';
+
+export class Questions extends APIResource {
+  /**
+   * This endpoint allows you to create a new question.
+   */
+  create(body: QuestionCreateParams, options?: Core.RequestOptions): Core.APIPromise<QuestionCreateResponse> {
+    return this._client.post('/api/loyalty/questions', { body, ...options });
+  }
+
+  /**
+   * This endpoint allows you to update an existing question.
+   */
+  update(
+    id: string,
+    body: QuestionUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<QuestionUpdateResponse> {
+    return this._client.post(`/api/loyalty/questions/${id}`, { body, ...options });
+  }
+
+  /**
+   * This endpoint allows you to fetch questions for a loyalty rule.
+   */
+  list(query: QuestionListParams, options?: Core.RequestOptions): Core.APIPromise<QuestionListResponse> {
+    return this._client.get('/api/loyalty/questions', { query, ...options });
+  }
+}
+
+/**
+ * Response returned for a question
+ */
+export interface QuestionCreateResponse {
+  id: string;
+
+  loyaltyQuestionChoices: Array<QuestionCreateResponse.LoyaltyQuestionChoice>;
+
+  text: string;
+}
+
+export namespace QuestionCreateResponse {
+  export interface LoyaltyQuestionChoice {
+    id: string;
+
+    sortIdentifier: number;
+
+    text: string;
+  }
+}
+
+/**
+ * Response returned for a question
+ */
+export interface QuestionUpdateResponse {
+  id: string;
+
+  loyaltyQuestionChoices: Array<QuestionUpdateResponse.LoyaltyQuestionChoice>;
+
+  text: string;
+}
+
+export namespace QuestionUpdateResponse {
+  export interface LoyaltyQuestionChoice {
+    id: string;
+
+    sortIdentifier: number;
+
+    text: string;
+  }
+}
+
+export type QuestionListResponse = Array<QuestionListResponse.QuestionListResponseItem>;
+
+export namespace QuestionListResponse {
+  /**
+   * Response returned for a question
+   */
+  export interface QuestionListResponseItem {
+    id: string;
+
+    loyaltyQuestionChoices: Array<QuestionListResponseItem.LoyaltyQuestionChoice>;
+
+    text: string;
+  }
+
+  export namespace QuestionListResponseItem {
+    export interface LoyaltyQuestionChoice {
+      id: string;
+
+      sortIdentifier: number;
+
+      text: string;
+    }
+  }
+}
+
+export interface QuestionCreateParams {
+  /**
+   * Array of choices for the question
+   */
+  loyaltyQuestionAnswers: Array<QuestionCreateParams.LoyaltyQuestionAnswer>;
+
+  /**
+   * UUID of the loyalty rule
+   */
+  loyaltyRuleId: string;
+
+  /**
+   * The text of the question
+   */
+  questionText: string;
+
+  /**
+   * Whether the question allows multiple attempts
+   */
+  allowMultipleAttempts?: boolean;
+}
+
+export namespace QuestionCreateParams {
+  export interface LoyaltyQuestionAnswer {
+    /**
+     * Whether this choice is correct
+     */
+    isCorrect: boolean;
+
+    /**
+     * The order in which to display the choice
+     */
+    sortIdentifier: number;
+
+    /**
+     * The text of the choice
+     */
+    text: string;
+
+    /**
+     * UUID of the choice (optional for new choices)
+     */
+    id?: string;
+  }
+}
+
+export interface QuestionUpdateParams {
+  /**
+   * Array of choices for the question
+   */
+  loyaltyQuestionAnswers: Array<QuestionUpdateParams.LoyaltyQuestionAnswer>;
+
+  /**
+   * The text of the question
+   */
+  questionText: string;
+}
+
+export namespace QuestionUpdateParams {
+  export interface LoyaltyQuestionAnswer {
+    /**
+     * Whether this choice is correct
+     */
+    isCorrect: boolean;
+
+    /**
+     * The order in which to display the choice
+     */
+    sortIdentifier: number;
+
+    /**
+     * The text of the choice
+     */
+    text: string;
+
+    /**
+     * UUID of the choice (optional for new choices)
+     */
+    id?: string;
+  }
+}
+
+export interface QuestionListParams {
+  /**
+   * UUID of the loyalty rule to fetch questions for
+   */
+  loyaltyRuleIds: string | Array<string>;
+
+  /**
+   * UUID of the organization to fetch questions for
+   */
+  organizationId: string;
+
+  /**
+   * UUID of the website to fetch questions for
+   */
+  websiteId: string;
+}
+
+export declare namespace Questions {
+  export {
+    type QuestionCreateResponse as QuestionCreateResponse,
+    type QuestionUpdateResponse as QuestionUpdateResponse,
+    type QuestionListResponse as QuestionListResponse,
+    type QuestionCreateParams as QuestionCreateParams,
+    type QuestionUpdateParams as QuestionUpdateParams,
+    type QuestionListParams as QuestionListParams,
+  };
+}