Problems API

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

Method	HTTP request	Description
createProblem	POST /problems	Create Problem
deleteProblem	DELETE /problems/	Delete Problem
editProblem	PATCH /problems/	Edit Problem
getProblem	GET /problems/	Get Problem
listProblems	GET /problems	List Problems

createProblem

Problem createProblem(problemCreate)

Example

import { createConfiguration, ProblemsApi } from '';
import type { ProblemsApiCreateProblemRequest } from '';

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

const request: ProblemsApiCreateProblemRequest = {
  
  problemCreate: {
    description: "description_example",
    projectId: "projectId_example",
  },
};

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

Parameters

Name	Type	Description	Notes
problemCreate	ProblemCreate

Return type

Problem

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]

deleteProblem

any deleteProblem()

Example

import { createConfiguration, ProblemsApi } from '';
import type { ProblemsApiDeleteProblemRequest } from '';

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

const request: ProblemsApiDeleteProblemRequest = {
  
  problemId: "problem_id_example",
};

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

Parameters

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

editProblem

Problem editProblem(problemUpdate)

Example

import { createConfiguration, ProblemsApi } from '';
import type { ProblemsApiEditProblemRequest } from '';

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

const request: ProblemsApiEditProblemRequest = {
  
  problemId: "problem_id_example",
  
  problemUpdate: {
    description: "description_example",
  },
};

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

Parameters

Name	Type	Description	Notes
problemUpdate	ProblemUpdate
problemId	[string]		defaults to undefined

Return type

Problem

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]

getProblem

Problem getProblem()

Example

import { createConfiguration, ProblemsApi } from '';
import type { ProblemsApiGetProblemRequest } from '';

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

const request: ProblemsApiGetProblemRequest = {
  
  problemId: "problem_id_example",
};

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

Parameters

Name	Type	Description	Notes
problemId	[string]		defaults to undefined

Return type

Problem

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]

listProblems

PageProblem listProblems()

Example

import { createConfiguration, ProblemsApi } from '';
import type { ProblemsApiListProblemsRequest } from '';

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

const request: ProblemsApiListProblemsRequest = {
    // Comma-separated list of problem IDs (optional)
  id: "id_example",
    // Page number (optional)
  page: 1,
    // Page size (optional)
  size: 50,
};

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

Parameters

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

Return type

PageProblem

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]