feat(subsequences): add OpenAPI schema for advanded features DEV-1230

jsapp/js/api/models/advancedFeaturePostRequestParamsItem.ts

@@ -9,5 +9,7 @@ The endpoints are grouped by area of intended use. Each category contains relate
 **General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
  * OpenAPI spec version: 2.0.0 (api_v2)
  */
+import type { NLPActionParams } from './nLPActionParams'
+import type { QualActionParams } from './qualActionParams'
 
-export type AdvancedFeaturePostRequestParamsItem = { [key: string]: unknown }
+export type AdvancedFeaturePostRequestParamsItem = NLPActionParams | QualActionParams

jsapp/js/api/models/advancedFeatureResponseParamsItem.ts

@@ -9,5 +9,7 @@ The endpoints are grouped by area of intended use. Each category contains relate
 **General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
  * OpenAPI spec version: 2.0.0 (api_v2)
  */
+import type { NLPActionParams } from './nLPActionParams'
+import type { QualActionParams } from './qualActionParams'
 
-export type AdvancedFeatureResponseParamsItem = { [key: string]: unknown }
+export type AdvancedFeatureResponseParamsItem = NLPActionParams | QualActionParams

jsapp/js/api/models/nLPActionParams.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+import type { NLPActionParamsItem } from './nLPActionParamsItem'
+
+export type NLPActionParams = NLPActionParamsItem[]

jsapp/js/api/models/nLPActionParamsItem.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type NLPActionParamsItem = {
+  language: string
+}

jsapp/js/api/models/patchedAdvancedFeaturePatchRequestParamsItem.ts

@@ -9,5 +9,7 @@ The endpoints are grouped by area of intended use. Each category contains relate
 **General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
  * OpenAPI spec version: 2.0.0 (api_v2)
  */
+import type { NLPActionParams } from './nLPActionParams'
+import type { QualActionParams } from './qualActionParams'
 
-export type PatchedAdvancedFeaturePatchRequestParamsItem = { [key: string]: unknown }
+export type PatchedAdvancedFeaturePatchRequestParamsItem = NLPActionParams | QualActionParams

jsapp/js/api/models/qualActionParams.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+import type { QualActionParamsItem } from './qualActionParamsItem'
+
+export type QualActionParams = QualActionParamsItem[]

jsapp/js/api/models/qualActionParamsItem.ts

@@ -0,0 +1,15 @@
+import type { QualSelectQuestionParams } from './qualSelectQuestionParams'
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+import type { QualSimpleQuestionParams } from './qualSimpleQuestionParams'
+
+export type QualActionParamsItem = QualSimpleQuestionParams | QualSelectQuestionParams

jsapp/js/api/models/qualSelectQuestionParams.ts

@@ -0,0 +1,23 @@
+import type { QualSelectQuestionParamsChoicesItem } from './qualSelectQuestionParamsChoicesItem'
+import type { QualSelectQuestionParamsLabels } from './qualSelectQuestionParamsLabels'
+import type { QualSelectQuestionParamsOptions } from './qualSelectQuestionParamsOptions'
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+import type { QualSelectQuestionParamsTypeEnum } from './qualSelectQuestionParamsTypeEnum'
+
+export interface QualSelectQuestionParams {
+  uuid: string
+  type: QualSelectQuestionParamsTypeEnum
+  labels: QualSelectQuestionParamsLabels
+  choices: QualSelectQuestionParamsChoicesItem[]
+  options?: QualSelectQuestionParamsOptions
+}

jsapp/js/api/models/qualSelectQuestionParamsChoicesItem.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+import type { QualSelectQuestionParamsChoicesItemLabels } from './qualSelectQuestionParamsChoicesItemLabels'
+import type { QualSelectQuestionParamsChoicesItemOptions } from './qualSelectQuestionParamsChoicesItemOptions'
+
+export type QualSelectQuestionParamsChoicesItem = {
+  labels: QualSelectQuestionParamsChoicesItemLabels
+  uuid: string
+  options?: QualSelectQuestionParamsChoicesItemOptions
+}

jsapp/js/api/models/qualSelectQuestionParamsChoicesItemLabels.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type QualSelectQuestionParamsChoicesItemLabels = { [key: string]: string }

jsapp/js/api/models/qualSelectQuestionParamsChoicesItemOptions.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type QualSelectQuestionParamsChoicesItemOptions = { [key: string]: unknown }

jsapp/js/api/models/qualSelectQuestionParamsLabels.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type QualSelectQuestionParamsLabels = { [key: string]: string }

jsapp/js/api/models/qualSelectQuestionParamsOptions.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type QualSelectQuestionParamsOptions = { [key: string]: unknown }

jsapp/js/api/models/qualSelectQuestionParamsTypeEnum.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type QualSelectQuestionParamsTypeEnum =
+  (typeof QualSelectQuestionParamsTypeEnum)[keyof typeof QualSelectQuestionParamsTypeEnum]
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const QualSelectQuestionParamsTypeEnum = {
+  qualSelectMultiple: 'qualSelectMultiple',
+  qualSelectOne: 'qualSelectOne',
+} as const

jsapp/js/api/models/qualSimpleQuestionParams.ts

@@ -0,0 +1,21 @@
+import type { QualSimpleQuestionParamsLabels } from './qualSimpleQuestionParamsLabels'
+import type { QualSimpleQuestionParamsOptions } from './qualSimpleQuestionParamsOptions'
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+import type { QualSimpleQuestionParamsTypeEnum } from './qualSimpleQuestionParamsTypeEnum'
+
+export interface QualSimpleQuestionParams {
+  uuid: string
+  type: QualSimpleQuestionParamsTypeEnum
+  labels: QualSimpleQuestionParamsLabels
+  options?: QualSimpleQuestionParamsOptions
+}

jsapp/js/api/models/qualSimpleQuestionParamsLabels.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type QualSimpleQuestionParamsLabels = { [key: string]: string }

jsapp/js/api/models/qualSimpleQuestionParamsOptions.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type QualSimpleQuestionParamsOptions = { [key: string]: unknown }

jsapp/js/api/models/qualSimpleQuestionParamsTypeEnum.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type QualSimpleQuestionParamsTypeEnum =
+  (typeof QualSimpleQuestionParamsTypeEnum)[keyof typeof QualSimpleQuestionParamsTypeEnum]
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const QualSimpleQuestionParamsTypeEnum = {
+  qualInteger: 'qualInteger',
+  qualTags: 'qualTags',
+  qualText: 'qualText',
+  qualNote: 'qualNote',
+} as const