@snagsolutions/sdk 0.1.0-alpha.11 → 0.1.0-alpha.111

package/resources/loyalty/questions.d.ts

@@ -0,0 +1,183 @@
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+export declare 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>;
+    /**
+     * 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>;
+    /**
+     * 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',
+     *   organizationId: '123e4567-e89b-12d3-a456-426614174002',
+     *   websiteId: '123e4567-e89b-12d3-a456-426614174001',
+     * });
+     * ```
+     */
+    list(query: QuestionListParams, options?: Core.RequestOptions): Core.APIPromise<QuestionListResponse>;
+}
+/**
+ * Response returned for a question
+ */
+export interface QuestionCreateResponse {
+    id: string;
+    loyaltyQuestionChoices: Array<QuestionCreateResponse.LoyaltyQuestionChoice>;
+    text: string;
+}
+export declare namespace QuestionCreateResponse {
+    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 declare namespace QuestionUpdateResponse {
+    interface LoyaltyQuestionChoice {
+        id: string;
+        sortIdentifier: number;
+        text: string;
+    }
+}
+export type QuestionListResponse = Array<QuestionListResponse.QuestionListResponseItem>;
+export declare namespace QuestionListResponse {
+    /**
+     * Response returned for a question
+     */
+    interface QuestionListResponseItem {
+        id: string;
+        loyaltyQuestionChoices: Array<QuestionListResponseItem.LoyaltyQuestionChoice>;
+        text: string;
+    }
+    namespace QuestionListResponseItem {
+        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 declare namespace QuestionCreateParams {
+    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 declare namespace QuestionUpdateParams {
+    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, };
+}
+//# sourceMappingURL=questions.d.ts.map

package/resources/loyalty/questions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"questions.d.ts","sourceRoot":"","sources":["../../src/resources/loyalty/questions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1G;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1C;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAGtG;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IAEX,sBAAsB,EAAE,KAAK,CAAC,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;IAE5E,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,qBAAqB;QACpC,EAAE,EAAE,MAAM,CAAC;QAEX,cAAc,EAAE,MAAM,CAAC;QAEvB,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IAEX,sBAAsB,EAAE,KAAK,CAAC,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;IAE5E,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,qBAAqB;QACpC,EAAE,EAAE,MAAM,CAAC;QAEX,cAAc,EAAE,MAAM,CAAC;QAEvB,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;AAExF,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,wBAAwB;QACvC,EAAE,EAAE,MAAM,CAAC;QAEX,sBAAsB,EAAE,KAAK,CAAC,wBAAwB,CAAC,qBAAqB,CAAC,CAAC;QAE9E,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,wBAAwB,CAAC;QACxC,UAAiB,qBAAqB;YACpC,EAAE,EAAE,MAAM,CAAC;YAEX,cAAc,EAAE,MAAM,CAAC;YAEvB,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,sBAAsB,EAAE,KAAK,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;IAE1E;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,qBAAqB;QACpC;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,sBAAsB,EAAE,KAAK,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;IAE1E;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,qBAAqB;QACpC;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/loyalty/questions.js

@@ -0,0 +1,60 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Questions = void 0;
+const resource_1 = require("../../resource.js");
+class Questions extends resource_1.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, options) {
+        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, body, options) {
+        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',
+     *   organizationId: '123e4567-e89b-12d3-a456-426614174002',
+     *   websiteId: '123e4567-e89b-12d3-a456-426614174001',
+     * });
+     * ```
+     */
+    list(query, options) {
+        return this._client.get('/api/loyalty/questions', { query, ...options });
+    }
+}
+exports.Questions = Questions;
+//# sourceMappingURL=questions.js.map

package/resources/loyalty/questions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"questions.js","sourceRoot":"","sources":["../../src/resources/loyalty/questions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAU,EACV,IAA0B,EAC1B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,KAAyB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AA1DD,8BA0DC"}

package/resources/loyalty/questions.mjs

@@ -0,0 +1,56 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../resource.mjs";
+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, options) {
+        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, body, options) {
+        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',
+     *   organizationId: '123e4567-e89b-12d3-a456-426614174002',
+     *   websiteId: '123e4567-e89b-12d3-a456-426614174001',
+     * });
+     * ```
+     */
+    list(query, options) {
+        return this._client.get('/api/loyalty/questions', { query, ...options });
+    }
+}
+//# sourceMappingURL=questions.mjs.map

package/resources/loyalty/questions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"questions.mjs","sourceRoot":"","sources":["../../src/resources/loyalty/questions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAU,EACV,IAA0B,EAC1B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,KAAyB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF"}