few-line-engine/out/ts/docs/ProjectManagementApi.md

ProjectManagementApi

All URIs are relative to http://localhost:3000

Method	HTTP request	Description
projectApiTokensGet	GET /project/api-tokens	Get all API tokens
projectCreatePut	PUT /project/create	Create project
projectCreateWithoutDbPut	PUT /project/create-without-db	Create project without database
projectSettingsCreatePut	PUT /project/settings/create	Create project setting
projectSettingsDeleteKeyDelete	DELETE /project/settings/delete/{key}	Delete project setting
projectSettingsGet	GET /project/settings	Get all project settings

projectApiTokensGet

Array projectApiTokensGet()

Retrieve all API tokens for the current project

Example

import {
    ProjectManagementApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ProjectManagementApi(configuration);

const { status, data } = await apiInstance.projectApiTokensGet();

Parameters

This endpoint does not have any parameters.

Return type

Array

Authorization

AdminAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	API tokens retrieved successfully	-
401	Unauthorized	-
403	Admin access required	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

projectCreatePut

Project projectCreatePut(projectCreatePutRequest)

Create a new project with database

Example

import {
    ProjectManagementApi,
    Configuration,
    ProjectCreatePutRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new ProjectManagementApi(configuration);

let projectCreatePutRequest: ProjectCreatePutRequest; //

const { status, data } = await apiInstance.projectCreatePut(
    projectCreatePutRequest
);

Parameters

Name	Type	Description	Notes
projectCreatePutRequest	ProjectCreatePutRequest

Return type

Project

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Project created successfully	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

projectCreateWithoutDbPut

Project projectCreateWithoutDbPut(projectCreatePutRequest)

Create a new project without creating a database

Example

import {
    ProjectManagementApi,
    Configuration,
    ProjectCreatePutRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new ProjectManagementApi(configuration);

let projectCreatePutRequest: ProjectCreatePutRequest; //

const { status, data } = await apiInstance.projectCreateWithoutDbPut(
    projectCreatePutRequest
);

Parameters

Name	Type	Description	Notes
projectCreatePutRequest	ProjectCreatePutRequest

Return type

Project

Authorization

AdminAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Project created successfully	-
401	Unauthorized	-
403	Admin access required	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

projectSettingsCreatePut

ProjectSetting projectSettingsCreatePut(projectSettingsCreatePutRequest)

Create a new project setting

Example

import {
    ProjectManagementApi,
    Configuration,
    ProjectSettingsCreatePutRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new ProjectManagementApi(configuration);

let projectSettingsCreatePutRequest: ProjectSettingsCreatePutRequest; //

const { status, data } = await apiInstance.projectSettingsCreatePut(
    projectSettingsCreatePutRequest
);

Parameters

Name	Type	Description	Notes
projectSettingsCreatePutRequest	ProjectSettingsCreatePutRequest

Return type

ProjectSetting

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Setting created successfully	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

projectSettingsDeleteKeyDelete

projectSettingsDeleteKeyDelete()

Delete a project setting by key

Example

import {
    ProjectManagementApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ProjectManagementApi(configuration);

let key: string; //Setting key to delete (default to undefined)

const { status, data } = await apiInstance.projectSettingsDeleteKeyDelete(
    key
);

Parameters

Name	Type	Description	Notes
key	[string]	Setting key to delete	defaults to undefined

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Setting deleted successfully	-
401	Unauthorized	-
404	Setting not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

projectSettingsGet

Array projectSettingsGet()

Retrieve all settings for the current project

Example

import {
    ProjectManagementApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ProjectManagementApi(configuration);

const { status, data } = await apiInstance.projectSettingsGet();

Parameters

This endpoint does not have any parameters.

Return type

Array

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Settings retrieved successfully	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]