ProjectApi

All URIs are relative to http://127.0.0.1:8000/api

Method HTTP request Description
projectDestroy DELETE /project/{project} Remove the specified resource from storage
projectEnabled GET /project/enabled Get all visible projects. The project becomes \"visible\" when all conditions are matched: - is_enabled is true - is_launched is true - current date >= launch_date
projectIndex GET /project Display a listing of the resource
projectSetEnabled PATCH /project/{project}/enabled Toggle Enable/disable on a project
projectSetLaunched PATCH /project/{project}/launched Toggle Launched/not-launched on a project. Important: It is independant from the `launch_date` value. It is an idicator showing that the project is to be considered \'laucnhed\' as soon as the launch date it reached
projectShow GET /project/{project} Display the specified resource
projectStore POST /project Store a newly created resource in storage
projectUpdate PATCH /project/{project} Update the specified resource in storage
projectUpdate2 PUT /project/{project} Update the specified resource in storage

projectDestroy

projectDestroy()

Example

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

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

let project: string; //The project ID (default to undefined)

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

Parameters

Name Type Description Notes
project [string] The project ID defaults to undefined

Return type

void (empty response body)

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |204 | No content | - | |404 | Not found | - | |401 | Unauthenticated | - |

Back to top Back to API list Back to Model list Back to README

projectEnabled

ProjectEnabled200Response projectEnabled()

Example

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

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

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

Parameters

This endpoint does not have any parameters.

Return type

ProjectEnabled200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ProjectResource` | - | |422 | Validation error | - | |401 | Unauthenticated | - |

Back to top Back to API list Back to Model list Back to README

projectIndex

ProjectIndex200Response projectIndex()

Example

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

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

let page: number; // (optional) (default to undefined)
let perPage: number; // (optional) (default to undefined)
let include: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.projectIndex(
    page,
    perPage,
    include
);

Parameters

Name Type Description Notes
page [number]   (optional) defaults to undefined
perPage [number]   (optional) defaults to undefined
include [string]   (optional) defaults to undefined

Return type

ProjectIndex200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Paginated set of `ProjectResource` | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

projectSetEnabled

ProjectShow200Response projectSetEnabled(setEnabledProjectRequest)

Example

import {
    ProjectApi,
    Configuration,
    SetEnabledProjectRequest
} from './api';

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

let project: string; //The project ID (default to undefined)
let setEnabledProjectRequest: SetEnabledProjectRequest; //

const { status, data } = await apiInstance.projectSetEnabled(
    project,
    setEnabledProjectRequest
);

Parameters

Name Type Description Notes
setEnabledProjectRequest SetEnabledProjectRequest    
project [string] The project ID defaults to undefined

Return type

ProjectShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ProjectResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

projectSetLaunched

ProjectShow200Response projectSetLaunched(setLaunchedProjectRequest)

Example

import {
    ProjectApi,
    Configuration,
    SetLaunchedProjectRequest
} from './api';

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

let project: string; //The project ID (default to undefined)
let setLaunchedProjectRequest: SetLaunchedProjectRequest; //

const { status, data } = await apiInstance.projectSetLaunched(
    project,
    setLaunchedProjectRequest
);

Parameters

Name Type Description Notes
setLaunchedProjectRequest SetLaunchedProjectRequest    
project [string] The project ID defaults to undefined

Return type

ProjectShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ProjectResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

projectShow

ProjectShow200Response projectShow()

Example

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

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

let project: string; //The project ID (default to undefined)
let include: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.projectShow(
    project,
    include
);

Parameters

Name Type Description Notes
project [string] The project ID defaults to undefined
include [string]   (optional) defaults to undefined

Return type

ProjectShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ProjectResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

projectStore

ProjectShow200Response projectStore(storeProjectRequest)

Example

import {
    ProjectApi,
    Configuration,
    StoreProjectRequest
} from './api';

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

let storeProjectRequest: StoreProjectRequest; //

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

Parameters

Name Type Description Notes
storeProjectRequest StoreProjectRequest    

Return type

ProjectShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ProjectResource` | - | |422 | Validation error | - | |401 | Unauthenticated | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

projectUpdate

ProjectShow200Response projectUpdate(updateProjectRequest)

Example

import {
    ProjectApi,
    Configuration,
    UpdateProjectRequest
} from './api';

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

let project: string; //The project ID (default to undefined)
let updateProjectRequest: UpdateProjectRequest; //

const { status, data } = await apiInstance.projectUpdate(
    project,
    updateProjectRequest
);

Parameters

Name Type Description Notes
updateProjectRequest UpdateProjectRequest    
project [string] The project ID defaults to undefined

Return type

ProjectShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ProjectResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

projectUpdate2

ProjectShow200Response projectUpdate2(updateProjectRequest)

Example

import {
    ProjectApi,
    Configuration,
    UpdateProjectRequest
} from './api';

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

let project: string; //The project ID (default to undefined)
let updateProjectRequest: UpdateProjectRequest; //

const { status, data } = await apiInstance.projectUpdate2(
    project,
    updateProjectRequest
);

Parameters

Name Type Description Notes
updateProjectRequest UpdateProjectRequest    
project [string] The project ID defaults to undefined

Return type

ProjectShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ProjectResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

This documentation was automatically generated from the TypeScript API client.