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

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

@@ -1,8 +1,8 @@
 // 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';
+import { APIResource } from '../../../resource';
+import { isRequestOptions } from '../../../core';
+import * as Core from '../../../core';
 
 export class Multipliers extends APIResource {
   /**
@@ -56,6 +56,16 @@ export class Multipliers extends APIResource {
   delete(multiplierId: string, options?: Core.RequestOptions): Core.APIPromise<MultiplierDeleteResponse> {
     return this._client.delete(`/api/loyalty/multipliers/${multiplierId}`, options);
   }
+
+  /**
+   * Delete a loyalty multiplier by its external identifier.
+   */
+  deleteByExternalId(
+    body: MultiplierDeleteByExternalIDParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MultiplierDeleteByExternalIDResponse> {
+    return this._client.delete('/api/loyalty/multipliers', { body, ...options });
+  }
 }
 
 /**
@@ -181,6 +191,43 @@ export interface MultiplierDeleteResponse {
   id: string;
 }
 
+/**
+ * Schema for loyalty multiplier
+ */
+export interface MultiplierDeleteByExternalIDResponse {
+  id: string;
+
+  createdAt: string;
+
+  deletedAt: string | null;
+
+  description: string | null;
+
+  externalIdentifier: string | null;
+
+  multiplier: number;
+
+  organizationId: string;
+
+  title: string | null;
+
+  updatedAt: string;
+
+  user: MultiplierDeleteByExternalIDResponse.User;
+
+  userId: string;
+
+  websiteId: string;
+}
+
+export namespace MultiplierDeleteByExternalIDResponse {
+  export interface User {
+    id: string;
+
+    walletAddress: string;
+  }
+}
+
 export interface MultiplierCreateParams {
   multiplier: number;
 
@@ -206,7 +253,7 @@ export interface MultiplierListParams {
 
   externalIdentifier?: string;
 
-  includeDeleted?: boolean;
+  includeDeleted?: string;
 
   limit?: number;
 
@@ -216,6 +263,10 @@ export interface MultiplierListParams {
 
   twitterUser?: string;
 
+  userGroupExternalIdentifier?: string;
+
+  userGroupId?: string;
+
   userId?: string | Array<string>;
 
   walletAddress?: string | Array<string>;
@@ -225,14 +276,20 @@ export interface MultiplierListParams {
   websiteId?: string;
 }
 
+export interface MultiplierDeleteByExternalIDParams {
+  externalIdentifier: string;
+}
+
 export declare namespace Multipliers {
   export {
     type MultiplierCreateResponse as MultiplierCreateResponse,
     type MultiplierUpdateResponse as MultiplierUpdateResponse,
     type MultiplierListResponse as MultiplierListResponse,
     type MultiplierDeleteResponse as MultiplierDeleteResponse,
+    type MultiplierDeleteByExternalIDResponse as MultiplierDeleteByExternalIDResponse,
     type MultiplierCreateParams as MultiplierCreateParams,
     type MultiplierUpdateParams as MultiplierUpdateParams,
     type MultiplierListParams as MultiplierListParams,
+    type MultiplierDeleteByExternalIDParams as MultiplierDeleteByExternalIDParams,
   };
 }

package/src/resources/api/loyalty/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/api/loyalty/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,
+  };
+}

package/src/resources/{loyalty → api/loyalty}/rule-edits.ts

@@ -1,16 +1,13 @@
 // 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 RuleEdits extends APIResource {
   /**
    * Retrieve configured loyalty rule edits with optional pagination and filters
    */
-  retrieve(
-    query: RuleEditRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<RuleEditRetrieveResponse> {
+  list(query: RuleEditListParams, options?: Core.RequestOptions): Core.APIPromise<RuleEditListResponse> {
     return this._client.get('/api/loyalty/rule_edits', { query, ...options });
   }
 
@@ -22,17 +19,17 @@ export class RuleEdits extends APIResource {
     body?: RuleEditRestoreParams | null | undefined,
     options?: Core.RequestOptions,
   ): Core.APIPromise<RuleEditRestoreResponse> {
-    return this._client.post(`/api/api/loyalty/rule_edits/${id}/restore`, { body, ...options });
+    return this._client.post(`/api/loyalty/rule_edits/${id}/restore`, { body, ...options });
   }
 }
 
-export interface RuleEditRetrieveResponse {
-  data: Array<RuleEditRetrieveResponse.Data>;
+export interface RuleEditListResponse {
+  data: Array<RuleEditListResponse.Data>;
 
   hasNextPage: boolean;
 }
 
-export namespace RuleEditRetrieveResponse {
+export namespace RuleEditListResponse {
   export interface Data {
     /**
      * Unique identifier for the rule edit
@@ -382,7 +379,7 @@ export namespace RuleEditRestoreResponse {
   }
 }
 
-export interface RuleEditRetrieveParams {
+export interface RuleEditListParams {
   /**
    * ID of the loyalty rule
    */
@@ -391,7 +388,7 @@ export interface RuleEditRetrieveParams {
   /**
    * Maximum number of edits to return
    */
-  limit?: number | null;
+  limit?: number;
 
   /**
    * Unique identifier for the organization to filter by
@@ -413,9 +410,9 @@ export interface RuleEditRestoreParams {}
 
 export declare namespace RuleEdits {
   export {
-    type RuleEditRetrieveResponse as RuleEditRetrieveResponse,
+    type RuleEditListResponse as RuleEditListResponse,
     type RuleEditRestoreResponse as RuleEditRestoreResponse,
-    type RuleEditRetrieveParams as RuleEditRetrieveParams,
+    type RuleEditListParams as RuleEditListParams,
     type RuleEditRestoreParams as RuleEditRestoreParams,
   };
 }