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

package/src/resources/{api/loyalty → loyalty}/questions.ts

@@ -1,11 +1,22 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
+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 });
@@ -13,6 +24,19 @@ export class Questions extends APIResource {
 
   /**
    * 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,
@@ -24,6 +48,13 @@ export class Questions extends APIResource {
 
   /**
    * 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 });
@@ -188,12 +219,17 @@ export interface QuestionListParams {
   /**
    * UUID of the organization to fetch questions for
    */
-  organizationId: string;
+  organizationId?: string;
+
+  /**
+   * UUID of the user to fetch questions for
+   */
+  userId?: string;
 
   /**
    * UUID of the website to fetch questions for
    */
-  websiteId: string;
+  websiteId?: string;
 }
 
 export declare namespace Questions {