Sub Plans API

All URIs are relative to https://api.syntheticusers.com/api/v1

Method	HTTP request	Description
createSubplan	POST /subplans	Create Subplan
deleteSubplan	DELETE /subplans/	Delete Subplan
executeSubplan	POST /subplans/{subplan_id}/execute	Execute Subplan
extendSubplan	POST /subplans/{subplan_id}/extend	Extend Subplan
generateSubplanReport	POST /subplans/{subplan_id}/report	Generate Subplan Report
getReportPdf	GET /subplans/{subplan_id}/report/{report_id}/pdf	Get Report Pdf
getSubplan	GET /subplans/	Get Subplan
listSubplans	GET /subplans	List Subplans
subplanFollowUp	POST /subplans/{subplan_id}/follow_up	Subplan Follow Up
updateSubplan	PATCH /subplans/	Update Subplan

createSubplan

SubPlan createSubplan(subPlanCreate)

Example

import { createConfiguration, SubPlansApi } from '';
import type { SubPlansApiCreateSubplanRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SubPlansApi(configuration);

const request: SubPlansApiCreateSubplanRequest = {
  
  subPlanCreate: {
    createdAt: new Date('1970-01-01T00:00:00.00Z'),
    planId: "planId_example",
    parentId: "parentId_example",
    type: "multiconcept",
    maxStudy: 1,
    suggestions: [
      {
        id: "id_example",
        subplanId: "subplanId_example",
        studyId: "studyId_example",
        type: "type_example",
        status: "status_example",
        data: {
          "key": null,
        },
        quantity: 1,
        createdAt: new Date('1970-01-01T00:00:00.00Z'),
        files: [
          "files_example",
        ],
      },
    ],
    data: {
      "key": null,
    },
    concepts: [
      {
        title: "title_example",
        description: "description_example",
        files: [
          "files_example",
        ],
      },
    ],
    audienceId: "audienceId_example",
  },
};

const data = await apiInstance.createSubplan(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
subPlanCreate	SubPlanCreate

Return type

SubPlan

Authorization

HTTPBearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

deleteSubplan

any deleteSubplan()

Example

import { createConfiguration, SubPlansApi } from '';
import type { SubPlansApiDeleteSubplanRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SubPlansApi(configuration);

const request: SubPlansApiDeleteSubplanRequest = {
  
  subplanId: "subplan_id_example",
};

const data = await apiInstance.deleteSubplan(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
subplanId	[string]		defaults to undefined

Return type

any

Authorization

HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

executeSubplan

SubPlan executeSubplan(subPlanExecutionOptions)

Example

import { createConfiguration, SubPlansApi } from '';
import type { SubPlansApiExecuteSubplanRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SubPlansApi(configuration);

const request: SubPlansApiExecuteSubplanRequest = {
  
  subplanId: "subplan_id_example",
  
  subPlanExecutionOptions: {
    customScript: "customScript_example",
  },
};

const data = await apiInstance.executeSubplan(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
subPlanExecutionOptions	SubPlanExecutionOptions
subplanId	[string]		defaults to undefined

Return type

SubPlan

Authorization

HTTPBearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

extendSubplan

Suggestion extendSubplan()

Example

import { createConfiguration, SubPlansApi } from '';
import type { SubPlansApiExtendSubplanRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SubPlansApi(configuration);

const request: SubPlansApiExtendSubplanRequest = {
  
  subplanId: "subplan_id_example",
};

const data = await apiInstance.extendSubplan(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
subplanId	[string]		defaults to undefined

Return type

Suggestion

Authorization

HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

generateSubplanReport

SubPlan generateSubplanReport(subPlanReport)

Example

import { createConfiguration, SubPlansApi } from '';
import type { SubPlansApiGenerateSubplanReportRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SubPlansApi(configuration);

const request: SubPlansApiGenerateSubplanReportRequest = {
  
  subplanId: "subplan_id_example",
  
  subPlanReport: {
    suggestions: [
      "suggestions_example",
    ],
  },
};

const data = await apiInstance.generateSubplanReport(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
subPlanReport	SubPlanReport
subplanId	[string]		defaults to undefined

Return type

SubPlan

Authorization

HTTPBearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

getReportPdf

HttpFile getReportPdf()

Example

import { createConfiguration, SubPlansApi } from '';
import type { SubPlansApiGetReportPdfRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SubPlansApi(configuration);

const request: SubPlansApiGetReportPdfRequest = {
  
  subplanId: "subplan_id_example",
  
  reportId: "report_id_example",
};

const data = await apiInstance.getReportPdf(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
subplanId	[string]		defaults to undefined
reportId	[string]		defaults to undefined

Return type

HttpFile

Authorization

HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/pdf, application/json

HTTP response details

Status code	Description	Response headers
200	Returns the PDF report	-
404	Report not found	-
500	Error generating report	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

getSubplan

SubPlan getSubplan()

Example

import { createConfiguration, SubPlansApi } from '';
import type { SubPlansApiGetSubplanRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SubPlansApi(configuration);

const request: SubPlansApiGetSubplanRequest = {
  
  subplanId: "subplan_id_example",
};

const data = await apiInstance.getSubplan(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
subplanId	[string]		defaults to undefined

Return type

SubPlan

Authorization

HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

listSubplans

PageSubPlan listSubplans()

Example

import { createConfiguration, SubPlansApi } from '';
import type { SubPlansApiListSubplansRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SubPlansApi(configuration);

const request: SubPlansApiListSubplansRequest = {
    // Comma-separated list of interviews IDs (optional)
  id: "id_example",
    // Comma-separated list of project IDs (optional)
  projectId: "projectId_example",
    // Comma-separated list of plans IDs (optional)
  planId: "planId_example",
    // Page number (optional)
  page: 1,
    // Page size (optional)
  size: 50,
};

const data = await apiInstance.listSubplans(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
id	[string]	Comma-separated list of interviews IDs	(optional) defaults to undefined
projectId	[string]	Comma-separated list of project IDs	(optional) defaults to undefined
planId	[string]	Comma-separated list of plans IDs	(optional) defaults to undefined
page	[number]	Page number	(optional) defaults to 1
size	[number]	Page size	(optional) defaults to 50

Return type

PageSubPlan

Authorization

HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

subplanFollowUp

Array<Conversation> subplanFollowUp(conversationCreate)

Create follow-up questions for all interviews across all studies in a subplan.

Example

import { createConfiguration, SubPlansApi } from '';
import type { SubPlansApiSubplanFollowUpRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SubPlansApi(configuration);

const request: SubPlansApiSubplanFollowUpRequest = {
  
  subplanId: "subplan_id_example",
  
  conversationCreate: {
    message: "message_example",
  },
};

const data = await apiInstance.subplanFollowUp(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
conversationCreate	ConversationCreate
subplanId	[string]		defaults to undefined

Return type

Array<Conversation>

Authorization

HTTPBearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

updateSubplan

SubPlan updateSubplan(subPlanUpdate)

Example

import { createConfiguration, SubPlansApi } from '';
import type { SubPlansApiUpdateSubplanRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SubPlansApi(configuration);

const request: SubPlansApiUpdateSubplanRequest = {
  
  subPlanId: "sub_plan_id_example",
  
  subPlanUpdate: {
    createdAt: new Date('1970-01-01T00:00:00.00Z'),
    type: "multiconcept",
    maxStudy: 1,
    suggestions: [
      {
        id: "id_example",
        subplanId: "subplanId_example",
        studyId: "studyId_example",
        type: "type_example",
        status: "status_example",
        data: {
          "key": null,
        },
        quantity: 1,
        createdAt: new Date('1970-01-01T00:00:00.00Z'),
        files: [
          "files_example",
        ],
      },
    ],
    data: {
      "key": null,
    },
  },
};

const data = await apiInstance.updateSubplan(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
subPlanUpdate	SubPlanUpdate
subPlanId	[string]		defaults to undefined

Return type

SubPlan

Authorization

HTTPBearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]