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

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

@@ -0,0 +1,191 @@
+// 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
+   *
+   * @example
+   * ```ts
+   * const questionsResponses =
+   *   await client.loyalty.questionsResponses.list();
+   * ```
+   */
+  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.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.questionsResponses.submit({
+   *     loyaltyQuestionChoiceId:
+   *       '123e4567-e89b-12d3-a456-426614174001',
+   *   });
+   * ```
+   */
+  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 of the organization to filter responses
+   */
+  organizationId?: string;
+
+  /**
+   * UUID(s) of the questions to filter responses
+   */
+  questionsId?: string | Array<string>;
+
+  /**
+   * UUID of the user to filter responses
+   */
+  userId?: string;
+
+  /**
+   * UUID of the website to filter responses
+   */
+  websiteId?: string;
+}
+
+export interface QuestionsResponseSubmitParams {
+  /**
+   * UUID of the selected choice
+   */
+  loyaltyQuestionChoiceId: string;
+
+  /**
+   * UUID of the organization to filter responses
+   */
+  organizationId?: string;
+
+  /**
+   * UUID of the user who submitted the response
+   */
+  userId?: string;
+
+  /**
+   * UUID of the website to filter responses
+   */
+  websiteId?: 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/questions.ts

@@ -0,0 +1,244 @@
+// 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.
+   *
+   * @example
+   * ```ts
+   * const question = await client.loyalty.questions.create({
+   *   loyaltyQuestionAnswers: [
+   *     { isCorrect: true, sortIdentifier: 1, text: 'Red' },
+   *   ],
+   *   loyaltyRuleId: '123e4567-e89b-12d3-a456-426614174000',
+   *   questionText: 'What is your favorite color?',
+   * });
+   * ```
+   */
+  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.
+   *
+   * @example
+   * ```ts
+   * const question = await client.loyalty.questions.update(
+   *   'id',
+   *   {
+   *     loyaltyQuestionAnswers: [
+   *       { isCorrect: true, sortIdentifier: 1, text: 'Red' },
+   *     ],
+   *     questionText: 'What is your favorite color?',
+   *   },
+   * );
+   * ```
+   */
+  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.
+   *
+   * @example
+   * ```ts
+   * const questions = await client.loyalty.questions.list({
+   *   loyaltyRuleIds: '123e4567-e89b-12d3-a456-426614174000',
+   * });
+   * ```
+   */
+  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 user to fetch questions for
+   */
+  userId?: 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,
+  };
+}