ShareProjectApi

ShareProjectApi - object-oriented interface

Export

ShareProjectApi

Extends

  • BaseAPI

Constructors

new ShareProjectApi()

new ShareProjectApi(configuration?, basePath?, axios?): ShareProjectApi

Parameters

configuration?

basePath?

string = BASE_PATH

axios?

AxiosInstance = globalAxios

Returns

Inherited from

BaseAPI.constructor

Properties

axios

protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios


basePath

protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath


configuration

protected configuration: undefined | Configuration

Inherited from

BaseAPI.configuration

Methods

apiV1ShareProjectGet()

apiV1ShareProjectGet(type?, skip?, take?, options?): Promise<AxiosResponse<SharedProjectDescriptionResponseDTO[]>>

Parameters

type?

skip?

number

take?

number

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<SharedProjectDescriptionResponseDTO[]>>

Throws

Memberof

ShareProjectApi


apiV1ShareProjectIdContentGet()

apiV1ShareProjectIdContentGet(id, options?): Promise<AxiosResponse<string>>

Parameters

id

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<string>>

Throws

Memberof

ShareProjectApi


apiV1ShareProjectIdDelete()

apiV1ShareProjectIdDelete(id, options?): Promise<AxiosResponse<SharedProjectDescriptionResponseDTO>>

Parameters

id

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<SharedProjectDescriptionResponseDTO>>

Throws

Memberof

ShareProjectApi


apiV1ShareProjectIdFileDelete()

apiV1ShareProjectIdFileDelete(id, path?, options?): Promise<AxiosResponse<void>>

Parameters

id

string

path?

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<void>>

Throws

Memberof

ShareProjectApi


apiV1ShareProjectIdFileGet()

apiV1ShareProjectIdFileGet(id, path?, options?): Promise<AxiosResponse<string>>

Parameters

id

string

path?

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<string>>

Throws

Memberof

ShareProjectApi


apiV1ShareProjectIdFilePost()

apiV1ShareProjectIdFilePost(id, body, path?, options?): Promise<AxiosResponse<void>>

Parameters

id

string

body

File

path?

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<void>>

Throws

Memberof

ShareProjectApi


apiV1ShareProjectIdGet()

apiV1ShareProjectIdGet(id, options?): Promise<AxiosResponse<SharedProjectDescriptionResponseDTO>>

Parameters

id

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<SharedProjectDescriptionResponseDTO>>

Throws

Memberof

ShareProjectApi


apiV1ShareProjectIdListGet()

apiV1ShareProjectIdListGet(id, path?, options?): Promise<AxiosResponse<FileStorageItem[]>>

Parameters

id

string

path?

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<FileStorageItem[]>>

Throws

Memberof

ShareProjectApi


apiV1ShareProjectIdPatch()

apiV1ShareProjectIdPatch(id, nameValue?, nameHasValue?, descriptionValue?, descriptionHasValue?, sharedAccessValue?, sharedAccessHasValue?, customMetaDataValue?, customMetaDataHasValue?, body?, options?): Promise<AxiosResponse<SharedProjectDescriptionResponseDTO>>

Parameters

id

string

nameValue?

string

nameHasValue?

boolean

descriptionValue?

string

descriptionHasValue?

boolean

sharedAccessValue?

boolean

sharedAccessHasValue?

boolean

customMetaDataValue?

string

customMetaDataHasValue?

boolean

body?

File

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<SharedProjectDescriptionResponseDTO>>

Throws

Memberof

ShareProjectApi


apiV1ShareProjectIdStatGet()

apiV1ShareProjectIdStatGet(id, path?, options?): Promise<AxiosResponse<FileStorageItem>>

Parameters

id

string

path?

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<FileStorageItem>>

Throws

Memberof

ShareProjectApi


apiV1ShareProjectPost()

apiV1ShareProjectPost(name, description, body, sharedAccess?, customMetaData?, options?): Promise<AxiosResponse<SharedProjectDescriptionResponseDTO>>

Parameters

name

string

description

string

body

File

sharedAccess?

boolean

customMetaData?

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<SharedProjectDescriptionResponseDTO>>

Throws

Memberof

ShareProjectApi

Found a mistake? Let us know.

Enroll in beta

Request invite to our private Beta program for developers to join the waitlist. No spam, we promise.