featurebase-node 0.14.3 → 0.15.1

package/resources/surveys.js

@@ -11,41 +11,41 @@ const path_1 = require("../internal/utils/path.js");
  */
 class Surveys extends resource_1.APIResource {
     /**
-     * Returns all surveys configured in your Featurebase organization.
-     *
-     * ### Query Parameters
-     *
-     * - `limit` - Number of items to return (1-100, default 10)
-     * - `cursor` - Cursor for pagination
-     * - `type` - Filter by survey page type (text, link, rating, multiple-choice)
-     * - `isActive` - Filter by active status
-     *
-     * ### Response Format
-     *
-     * Returns a list object with:
+     * Retrieves a single survey by its unique identifier.
      *
-     * - `object` - Always "list"
-     * - `data` - Array of survey objects
-     * - `nextCursor` - Cursor for next page (null if no more results)
+     * Returns the survey object if found in your organization.
      *
-     * ### Survey Object
+     * ### Response
      *
-     * Each survey includes:
+     * Returns a survey object with:
      *
      * - `id` - Unique identifier
      * - `title` - Survey title
      * - `description` - Survey description
      * - `isActive` - Whether the survey is active
      * - `responseCount` - Number of responses received
-     * - `targeting` - Targeting configuration (segments, URLs, CSS selectors)
+     * - `targeting` - Targeting configuration
      * - `pages` - Array of survey pages/questions
      * - `createdAt` - ISO 8601 timestamp when created
      * - `updatedAt` - ISO 8601 timestamp when last updated
+     *
+     * ### Survey Pages
+     *
+     * Each page represents a question or screen in the survey:
+     *
+     * - `type` - Page type (text, link, rating, multiple-choice)
+     * - `title` - Question title
+     * - `description` - Optional description
+     * - `logic` - Conditional logic rules
+     * - `defaultAction` - Default action when no logic matches
+     *
+     * ### Errors
+     *
+     * - `404` - Survey not found in your organization
      */
-    list(params = {}, options) {
-        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-        return this._client.getAPIList('/v2/surveys', (pagination_1.CursorPage), {
-            query,
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get((0, path_1.path) `/v2/surveys/${id}`, {
             ...options,
             headers: (0, headers_1.buildHeaders)([
                 {
@@ -58,41 +58,41 @@ class Surveys extends resource_1.APIResource {
         });
     }
     /**
-     * Retrieves a single survey by its unique identifier.
+     * Returns all surveys configured in your Featurebase organization.
      *
-     * Returns the survey object if found in your organization.
+     * ### Query Parameters
      *
-     * ### Response
+     * - `limit` - Number of items to return (1-100, default 10)
+     * - `cursor` - Cursor for pagination
+     * - `type` - Filter by survey page type (text, link, rating, multiple-choice)
+     * - `isActive` - Filter by active status
      *
-     * Returns a survey object with:
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of survey objects
+     * - `nextCursor` - Cursor for next page (null if no more results)
+     *
+     * ### Survey Object
+     *
+     * Each survey includes:
      *
      * - `id` - Unique identifier
      * - `title` - Survey title
      * - `description` - Survey description
      * - `isActive` - Whether the survey is active
      * - `responseCount` - Number of responses received
-     * - `targeting` - Targeting configuration
+     * - `targeting` - Targeting configuration (segments, URLs, CSS selectors)
      * - `pages` - Array of survey pages/questions
      * - `createdAt` - ISO 8601 timestamp when created
      * - `updatedAt` - ISO 8601 timestamp when last updated
-     *
-     * ### Survey Pages
-     *
-     * Each page represents a question or screen in the survey:
-     *
-     * - `type` - Page type (text, link, rating, multiple-choice)
-     * - `title` - Question title
-     * - `description` - Optional description
-     * - `logic` - Conditional logic rules
-     * - `defaultAction` - Default action when no logic matches
-     *
-     * ### Errors
-     *
-     * - `404` - Survey not found in your organization
      */
-    retrieve(id, params = {}, options) {
-        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-        return this._client.get((0, path_1.path) `/v2/surveys/${id}`, {
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+        return this._client.getAPIList('/v2/surveys', (pagination_1.CursorPage), {
+            query,
             ...options,
             headers: (0, headers_1.buildHeaders)([
                 {

package/resources/surveys.js.map

@@ -1 +1 @@
-{"version":3,"file":"surveys.js","sourceRoot":"","sources":["../src/resources/surveys.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAoF;AACpF,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,uBAAkB,CAAA,EAAE;YAChE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CACN,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CACX,EAAU,EACV,SAAuD,EAAE,EACzD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,eAAe,EAAE,YAAY,EACjC,CAAA,uBAAuC,CAAA,EACvC;YACE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CACF,CAAC;IACJ,CAAC;CACF;AArKD,0BAqKC"}
+{"version":3,"file":"surveys.js","sourceRoot":"","sources":["../src/resources/surveys.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAoF;AACpF,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CACN,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,uBAAkB,CAAA,EAAE;YAChE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CACX,EAAU,EACV,SAAuD,EAAE,EACzD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,eAAe,EAAE,YAAY,EACjC,CAAA,uBAAuC,CAAA,EACvC;YACE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CACF,CAAC;IACJ,CAAC;CACF;AArKD,0BAqKC"}

package/resources/surveys.mjs

@@ -8,41 +8,41 @@ import { path } from "../internal/utils/path.mjs";
  */
 export class Surveys extends APIResource {
     /**
-     * Returns all surveys configured in your Featurebase organization.
-     *
-     * ### Query Parameters
-     *
-     * - `limit` - Number of items to return (1-100, default 10)
-     * - `cursor` - Cursor for pagination
-     * - `type` - Filter by survey page type (text, link, rating, multiple-choice)
-     * - `isActive` - Filter by active status
-     *
-     * ### Response Format
-     *
-     * Returns a list object with:
+     * Retrieves a single survey by its unique identifier.
      *
-     * - `object` - Always "list"
-     * - `data` - Array of survey objects
-     * - `nextCursor` - Cursor for next page (null if no more results)
+     * Returns the survey object if found in your organization.
      *
-     * ### Survey Object
+     * ### Response
      *
-     * Each survey includes:
+     * Returns a survey object with:
      *
      * - `id` - Unique identifier
      * - `title` - Survey title
      * - `description` - Survey description
      * - `isActive` - Whether the survey is active
      * - `responseCount` - Number of responses received
-     * - `targeting` - Targeting configuration (segments, URLs, CSS selectors)
+     * - `targeting` - Targeting configuration
      * - `pages` - Array of survey pages/questions
      * - `createdAt` - ISO 8601 timestamp when created
      * - `updatedAt` - ISO 8601 timestamp when last updated
+     *
+     * ### Survey Pages
+     *
+     * Each page represents a question or screen in the survey:
+     *
+     * - `type` - Page type (text, link, rating, multiple-choice)
+     * - `title` - Question title
+     * - `description` - Optional description
+     * - `logic` - Conditional logic rules
+     * - `defaultAction` - Default action when no logic matches
+     *
+     * ### Errors
+     *
+     * - `404` - Survey not found in your organization
      */
-    list(params = {}, options) {
-        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-        return this._client.getAPIList('/v2/surveys', (CursorPage), {
-            query,
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get(path `/v2/surveys/${id}`, {
             ...options,
             headers: buildHeaders([
                 {
@@ -55,41 +55,41 @@ export class Surveys extends APIResource {
         });
     }
     /**
-     * Retrieves a single survey by its unique identifier.
+     * Returns all surveys configured in your Featurebase organization.
      *
-     * Returns the survey object if found in your organization.
+     * ### Query Parameters
      *
-     * ### Response
+     * - `limit` - Number of items to return (1-100, default 10)
+     * - `cursor` - Cursor for pagination
+     * - `type` - Filter by survey page type (text, link, rating, multiple-choice)
+     * - `isActive` - Filter by active status
      *
-     * Returns a survey object with:
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of survey objects
+     * - `nextCursor` - Cursor for next page (null if no more results)
+     *
+     * ### Survey Object
+     *
+     * Each survey includes:
      *
      * - `id` - Unique identifier
      * - `title` - Survey title
      * - `description` - Survey description
      * - `isActive` - Whether the survey is active
      * - `responseCount` - Number of responses received
-     * - `targeting` - Targeting configuration
+     * - `targeting` - Targeting configuration (segments, URLs, CSS selectors)
      * - `pages` - Array of survey pages/questions
      * - `createdAt` - ISO 8601 timestamp when created
      * - `updatedAt` - ISO 8601 timestamp when last updated
-     *
-     * ### Survey Pages
-     *
-     * Each page represents a question or screen in the survey:
-     *
-     * - `type` - Page type (text, link, rating, multiple-choice)
-     * - `title` - Question title
-     * - `description` - Optional description
-     * - `logic` - Conditional logic rules
-     * - `defaultAction` - Default action when no logic matches
-     *
-     * ### Errors
-     *
-     * - `404` - Survey not found in your organization
      */
-    retrieve(id, params = {}, options) {
-        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-        return this._client.get(path `/v2/surveys/${id}`, {
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+        return this._client.getAPIList('/v2/surveys', (CursorPage), {
+            query,
             ...options,
             headers: buildHeaders([
                 {

package/resources/surveys.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"surveys.mjs","sourceRoot":"","sources":["../src/resources/surveys.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,UAAU,EAAsC,+BAA2B;AACpF,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,UAAkB,CAAA,EAAE;YAChE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CACN,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CACX,EAAU,EACV,SAAuD,EAAE,EACzD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,eAAe,EAAE,YAAY,EACjC,CAAA,UAAuC,CAAA,EACvC;YACE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CACF,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"surveys.mjs","sourceRoot":"","sources":["../src/resources/surveys.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,UAAU,EAAsC,+BAA2B;AACpF,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CACN,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,UAAkB,CAAA,EAAE;YAChE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CACX,EAAU,EACV,SAAuD,EAAE,EACzD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,eAAe,EAAE,YAAY,EACjC,CAAA,UAAuC,CAAA,EACvC;YACE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CACF,CAAC;IACJ,CAAC;CACF"}

package/resources/training-data/files.d.mts

@@ -0,0 +1,292 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Training data teaches the AI agent about your product beyond your public Help Center: training files (documents, policies, internal notes) and Q&A entries (question variants with the exact answer to give). Use these endpoints to keep that knowledge in sync from your own systems — for example, pushing resolved support conversations, internal runbooks, or SOP documents automatically.
+ */
+export declare class Files extends APIResource {
+    /**
+     * Adds a document the AI agent can learn from. Provide exactly one source:
+     *
+     * - **Inline text** — `{ "name": "refund-policy.md", "content": "..." }`. Markdown
+     *   or plain text is stored as-is and indexing is attempted before the response
+     *   returns; check `indexStatus` (`status` is `completed`). Best for content you
+     *   generate yourself, such as an SOP compiled from resolved conversations.
+     * - **Remote file** — `{ "url": "https://..." }` (optional `name`). The file (PDF,
+     *   DOCX, PPTX, XLSX, TXT, HTML, …; max 50 MB) is downloaded and converted to text
+     *   in the background. The response returns immediately with
+     *   `status: "processing"`; poll the file until it is `completed` or `failed`.
+     * - **Multipart upload** — send `multipart/form-data` with the document in a
+     *   `file` part and, optionally, a JSON `data` field such as `{"name": "..."}`.
+     *   Converted in the background like a remote file.
+     *
+     * **Keeping files in sync (create-or-update).** Pass your own `externalId` (unique
+     * per workspace) and the same request becomes idempotent: a new ID creates the
+     * file (`201`), a known ID with different content updates that file in place and
+     * re-indexes it (`200`), and a known ID with identical content is a no-op (`200`,
+     * no embedding work). Add a `source` label to group everything one pipeline owns,
+     * then list by `source` to find entries to remove. Every response carries
+     * `contentHash` so you can diff a whole library from the list endpoint.
+     *
+     * Without `externalId`, uploading a file whose name and bytes match an existing
+     * file returns the existing file with status `200` instead of creating a
+     * duplicate. Multipart uploads over 50 MB are rejected with `413`.
+     *
+     * @example
+     * ```ts
+     * const trainingFile =
+     *   await client.trainingData.files.create();
+     * ```
+     */
+    create(params?: FileCreateParams | null | undefined, options?: RequestOptions): APIPromise<TrainingFile>;
+    /**
+     * Returns a training file including its extracted text (`content`). Poll this
+     * endpoint after an upload until `status` is `completed`.
+     *
+     * @example
+     * ```ts
+     * const trainingFile =
+     *   await client.trainingData.files.retrieve(
+     *     '67ec1234abcd5678ef901234',
+     *   );
+     * ```
+     */
+    retrieve(id: string, params?: FileRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<TrainingFile>;
+    /**
+     * Renames a training file, replaces content, or sets externalId / source. Indexing
+     * is attempted before returning when content is available. Check status and
+     * indexStatus; HTTP success alone does not establish search readiness. Serialize
+     * updates to a source identity in your pipeline.
+     *
+     * @example
+     * ```ts
+     * const trainingFile = await client.trainingData.files.update(
+     *   '67ec1234abcd5678ef901234',
+     * );
+     * ```
+     */
+    update(id: string, params: FileUpdateParams, options?: RequestOptions): APIPromise<TrainingFile>;
+    /**
+     * Returns uploaded training files, newest first, with cursor pagination. Filter by
+     * `externalId` (exact) or `source`. The extracted text is omitted from list
+     * responses — compare `contentHash` to detect changes, and retrieve a single file
+     * to read it.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const trainingFile of client.trainingData.files.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(params?: FileListParams | null | undefined, options?: RequestOptions): PagePromise<TrainingFilesCursorPage, TrainingFile>;
+    /**
+     * Removes a training file from the workspace and attempts search-index cleanup.
+     * In-flight answers may already contain earlier knowledge.
+     *
+     * @example
+     * ```ts
+     * const file = await client.trainingData.files.delete(
+     *   '67ec1234abcd5678ef901234',
+     * );
+     * ```
+     */
+    delete(id: string, params?: FileDeleteParams | null | undefined, options?: RequestOptions): APIPromise<FileDeleteResponse>;
+}
+export type TrainingFilesCursorPage = CursorPage<TrainingFile>;
+export interface TrainingFile {
+    /**
+     * Training file ID
+     */
+    id: string;
+    /**
+     * Characters of extracted text
+     */
+    characterCount: number | null;
+    /**
+     * SHA-256 (hex) of the stored source: for inline text and content edits the
+     * trimmed text, for uploads and URLs the original bytes. Compare it with your own
+     * hash to detect changes without downloading `content`.
+     */
+    contentHash: string | null;
+    /**
+     * First 200 characters of the extracted text
+     */
+    contentPreview: string | null;
+    /**
+     * ISO timestamp of the upload
+     */
+    createdAt: string;
+    /**
+     * Your own identifier for this file, if one was set
+     */
+    externalId: string | null;
+    /**
+     * Size of the originally uploaded source in bytes (unchanged by content edits)
+     */
+    fileSize: number | null;
+    /**
+     * Whether the content is searchable by the AI agent. `pending` while indexing,
+     * `indexed` when the AI agent can use it, `failed` if indexing failed (the content
+     * is stored and indexing is retried hourly).
+     */
+    indexStatus: 'pending' | 'indexed' | 'failed';
+    /**
+     * MIME type of the originally uploaded source
+     */
+    mimeType: string | null;
+    /**
+     * File name shown in the dashboard
+     */
+    name: string;
+    /**
+     * Object type identifier
+     */
+    object: 'training_file';
+    /**
+     * Conversion error message when `status` is `failed`
+     */
+    processingError: string | null;
+    /**
+     * Pipeline label, if one was set
+     */
+    source: string | null;
+    /**
+     * `processing` while the file is being converted to text, `completed` once the
+     * content is stored, `failed` if conversion failed (see `processingError`).
+     */
+    status: 'processing' | 'completed' | 'failed';
+    /**
+     * ISO timestamp of the last change
+     */
+    updatedAt: string;
+    /**
+     * Words of extracted text
+     */
+    wordCount: number | null;
+    /**
+     * Full extracted text (markdown). Returned when retrieving or updating a single
+     * file; omitted from list and create responses.
+     */
+    content?: string | null;
+    /**
+     * On create and update responses: `created`, `updated` (same `externalId` or same
+     * name and bytes, content replaced and re-indexed), or `unchanged` (identical
+     * content, nothing done). Absent on reads.
+     */
+    outcome?: 'created' | 'updated' | 'unchanged';
+}
+export interface FileDeleteResponse {
+    /**
+     * ID of the deleted training file
+     */
+    id: string;
+    /**
+     * Indicates the resource was deleted
+     */
+    deleted: true;
+    /**
+     * Object type identifier
+     */
+    object: 'training_file';
+}
+export interface FileCreateParams {
+    /**
+     * Body param: Text or markdown to train on. Stored as-is; indexing is attempted
+     * before returning. Check indexStatus. Cannot be combined with `url`.
+     */
+    content?: string;
+    /**
+     * Body param: Your own identifier for this entry (unique per workspace). When
+     * provided, the request creates the entry if the ID is new and otherwise updates
+     * the existing entry in place — an unchanged payload is a no-op. Use it to keep
+     * the AI agent in sync with a system of record without tracking Featurebase IDs.
+     */
+    externalId?: string;
+    /**
+     * Body param: Display name of the file. Required with `content`; optional with
+     * `url` (defaults to the downloaded file name) or a multipart upload (defaults to
+     * the uploaded file name).
+     */
+    name?: string;
+    /**
+     * Body param: Free-form label for the pipeline or system this entry came from.
+     * Filter lists by it to review or sweep everything from one source.
+     */
+    source?: string;
+    /**
+     * Body param: Public http(s) URL of a document to download and convert (PDF, DOCX,
+     * TXT, HTML, …; max 50 MB). Conversion runs in the background — poll the file
+     * until `status` is `completed`. Cannot be combined with `content`.
+     */
+    url?: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+export interface FileRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+export interface FileUpdateParams {
+    /**
+     * Body param: Replacement text/markdown. Indexing is attempted before returning;
+     * check indexStatus.
+     */
+    content?: string;
+    /**
+     * Body param: Your own identifier for this entry (unique per workspace).
+     */
+    externalId?: string;
+    /**
+     * Body param: New display name
+     */
+    name?: string;
+    /**
+     * Body param: Free-form label for the pipeline or system this entry came from.
+     * Filter lists by it to review or sweep everything from one source.
+     */
+    source?: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+export interface FileListParams extends CursorPageParams {
+    /**
+     * Query param: Only return the entry with this `externalId`
+     */
+    externalId?: string;
+    /**
+     * Query param: Only return entries with this `source` label
+     */
+    source?: string;
+    /**
+     * Query param: Only return files in this processing state
+     */
+    status?: 'processing' | 'completed' | 'failed';
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+export interface FileDeleteParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+export declare namespace Files {
+    export { type TrainingFile as TrainingFile, type FileDeleteResponse as FileDeleteResponse, type TrainingFilesCursorPage as TrainingFilesCursorPage, type FileCreateParams as FileCreateParams, type FileRetrieveParams as FileRetrieveParams, type FileUpdateParams as FileUpdateParams, type FileListParams as FileListParams, type FileDeleteParams as FileDeleteParams, };
+}
+//# sourceMappingURL=files.d.mts.map

package/resources/training-data/files.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.mts","sourceRoot":"","sources":["../../src/resources/training-data/files.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,kCAA8B;AAEvF,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,MAAM,CACJ,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAgB3B;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAe3B;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAgBhG;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,MAAM,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,YAAY,CAAC;IAgBrD;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;CAclC;AAED,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;AAE/D,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;OAIG;IACH,WAAW,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;IAE9C;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,MAAM,EAAE,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE9C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;OAIG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,CAAC;CAC/C;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE/C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}