Suggestions API

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

Method	HTTP request	Description
createSuggestion	POST /suggestions	Create Suggestion
deleteSuggestion	DELETE /suggestions/	Delete Suggestion
executeSuggestion	POST /suggestions/{suggestion_id}/execute	Execute Suggestion
getSuggestion	GET /suggestions/	Get Suggestion
listSuggestions	GET /suggestions	List Suggestions
regenerateSuggestion	POST /suggestions/{suggestion_id}/regenerate	Regenerate Suggestion
updateSuggestion	PATCH /suggestions/	Update Suggestion

createSuggestion

Suggestion createSuggestion(suggestionCreate)

Example

import { createConfiguration, SuggestionsApi } from '';
import type { SuggestionsApiCreateSuggestionRequest } from '';

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

const request: SuggestionsApiCreateSuggestionRequest = {
  
  suggestionCreate: {
    subplanId: "subplanId_example",
    status: "status_example",
    data: {
      "key": null,
    },
    quantity: 1,
    files: [
      "files_example",
    ],
  },
};

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

Parameters

Name	Type	Description	Notes
suggestionCreate	SuggestionCreate

Return type

Suggestion

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]

deleteSuggestion

any deleteSuggestion()

Example

import { createConfiguration, SuggestionsApi } from '';
import type { SuggestionsApiDeleteSuggestionRequest } from '';

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

const request: SuggestionsApiDeleteSuggestionRequest = {
  
  suggestionId: "suggestion_id_example",
};

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

Parameters

Name	Type	Description	Notes
suggestionId	[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]

executeSuggestion

Suggestion executeSuggestion()

Example

import { createConfiguration, SuggestionsApi } from '';
import type { SuggestionsApiExecuteSuggestionRequest } from '';

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

const request: SuggestionsApiExecuteSuggestionRequest = {
  
  suggestionId: "suggestion_id_example",
};

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

Parameters

Name	Type	Description	Notes
suggestionId	[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]

getSuggestion

Suggestion getSuggestion()

Example

import { createConfiguration, SuggestionsApi } from '';
import type { SuggestionsApiGetSuggestionRequest } from '';

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

const request: SuggestionsApiGetSuggestionRequest = {
  
  suggestionId: "suggestion_id_example",
};

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

Parameters

Name	Type	Description	Notes
suggestionId	[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]

listSuggestions

PageSuggestion listSuggestions()

Example

import { createConfiguration, SuggestionsApi } from '';
import type { SuggestionsApiListSuggestionsRequest } from '';

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

const request: SuggestionsApiListSuggestionsRequest = {
    // Comma-separated list of interviews IDs (optional)
  id: "id_example",
    // Comma-separated list of project IDs (optional)
  projectId: "projectId_example",
    // Comma-separated list of subplans IDs (optional)
  subplanId: "subplanId_example",
    // Page number (optional)
  page: 1,
    // Page size (optional)
  size: 50,
};

const data = await apiInstance.listSuggestions(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
subplanId	[string]	Comma-separated list of subplans IDs	(optional) defaults to undefined
page	[number]	Page number	(optional) defaults to 1
size	[number]	Page size	(optional) defaults to 50

Return type

PageSuggestion

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]

regenerateSuggestion

Suggestion regenerateSuggestion()

Example

import { createConfiguration, SuggestionsApi } from '';
import type { SuggestionsApiRegenerateSuggestionRequest } from '';

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

const request: SuggestionsApiRegenerateSuggestionRequest = {
  
  suggestionId: "suggestion_id_example",
};

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

Parameters

Name	Type	Description	Notes
suggestionId	[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]

updateSuggestion

Suggestion updateSuggestion(suggestionUpdate)

Example

import { createConfiguration, SuggestionsApi } from '';
import type { SuggestionsApiUpdateSuggestionRequest } from '';

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

const request: SuggestionsApiUpdateSuggestionRequest = {
  
  suggestionId: "suggestion_id_example",
  
  suggestionUpdate: {
    status: "status_example",
    data: {
      "key": null,
    },
    quantity: 1,
    files: [
      "files_example",
    ],
  },
};

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

Parameters

Name	Type	Description	Notes
suggestionUpdate	SuggestionUpdate
suggestionId	[string]		defaults to undefined

Return type

Suggestion

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]