Solutions API

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

Method	HTTP request	Description
createSolution	POST /solutions	Create Solution
deleteSolution	DELETE /solutions/	Delete Solution
editSolution	PATCH /solutions/	Edit Solution
getSolution	GET /solutions/	Get Solution
listSolutions	GET /solutions	List Solutions

createSolution

Solution createSolution(solutionCreate)

Example

import { createConfiguration, SolutionsApi } from '';
import type { SolutionsApiCreateSolutionRequest } from '';

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

const request: SolutionsApiCreateSolutionRequest = {
  
  solutionCreate: {
    description: "description_example",
    projectId: "projectId_example",
  },
};

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

Parameters

Name	Type	Description	Notes
solutionCreate	SolutionCreate

Return type

Solution

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]

deleteSolution

any deleteSolution()

Example

import { createConfiguration, SolutionsApi } from '';
import type { SolutionsApiDeleteSolutionRequest } from '';

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

const request: SolutionsApiDeleteSolutionRequest = {
  
  solutionId: "solution_id_example",
};

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

Parameters

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

editSolution

Solution editSolution(solutionUpdate)

Example

import { createConfiguration, SolutionsApi } from '';
import type { SolutionsApiEditSolutionRequest } from '';

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

const request: SolutionsApiEditSolutionRequest = {
  
  solutionId: "solution_id_example",
  
  solutionUpdate: {
    description: "description_example",
  },
};

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

Parameters

Name	Type	Description	Notes
solutionUpdate	SolutionUpdate
solutionId	[string]		defaults to undefined

Return type

Solution

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]

getSolution

Solution getSolution()

Example

import { createConfiguration, SolutionsApi } from '';
import type { SolutionsApiGetSolutionRequest } from '';

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

const request: SolutionsApiGetSolutionRequest = {
  
  solutionId: "solution_id_example",
};

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

Parameters

Name	Type	Description	Notes
solutionId	[string]		defaults to undefined

Return type

Solution

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]

listSolutions

PageSolution listSolutions()

Example

import { createConfiguration, SolutionsApi } from '';
import type { SolutionsApiListSolutionsRequest } from '';

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

const request: SolutionsApiListSolutionsRequest = {
    // Page number (optional)
  page: 1,
    // Page size (optional)
  size: 50,
};

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

Parameters

Name	Type	Description	Notes
page	[number]	Page number	(optional) defaults to 1
size	[number]	Page size	(optional) defaults to 50

Return type

PageSolution

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]