Tectly PHP Client

ProjectsApi
in package

Tectly

OpenAPI

ProjectsApi Class Doc Comment

Constants

contentTypes = ['createProject' => ['application/json'], 'exportProject' => ['application/json'], 'fetchProject' => ['application/json'], 'fetchProjects' => ['application/json'], 'removeProject' => ['application/json'], 'updateProject' => ['application/json']]

Properties

$client : ClientInterface
$config : Configuration
$headerSelector : HeaderSelector
$hostIndex : int

Methods

__construct() : mixed
createProject() : mixed: Operation createProject
createProjectAsync() : PromiseInterface: Operation createProjectAsync
createProjectAsyncWithHttpInfo() : PromiseInterface: Operation createProjectAsyncWithHttpInfo
createProjectRequest() : Request: Create request for operation 'createProject'
createProjectWithHttpInfo() : array<string|int, mixed>: Operation createProjectWithHttpInfo
exportProject() : ResourceReference: Operation exportProject
exportProjectAsync() : PromiseInterface: Operation exportProjectAsync
exportProjectAsyncWithHttpInfo() : PromiseInterface: Operation exportProjectAsyncWithHttpInfo
exportProjectRequest() : Request: Create request for operation 'exportProject'
exportProjectWithHttpInfo() : array<string|int, mixed>: Operation exportProjectWithHttpInfo
fetchProject() : Project: Operation fetchProject
fetchProjectAsync() : PromiseInterface: Operation fetchProjectAsync
fetchProjectAsyncWithHttpInfo() : PromiseInterface: Operation fetchProjectAsyncWithHttpInfo
fetchProjectRequest() : Request: Create request for operation 'fetchProject'
fetchProjects() : ProjectsPage: Operation fetchProjects
fetchProjectsAsync() : PromiseInterface: Operation fetchProjectsAsync
fetchProjectsAsyncWithHttpInfo() : PromiseInterface: Operation fetchProjectsAsyncWithHttpInfo
fetchProjectsRequest() : Request: Create request for operation 'fetchProjects'
fetchProjectsWithHttpInfo() : array<string|int, mixed>: Operation fetchProjectsWithHttpInfo
fetchProjectWithHttpInfo() : array<string|int, mixed>: Operation fetchProjectWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
removeProject() : void: Operation removeProject
removeProjectAsync() : PromiseInterface: Operation removeProjectAsync
removeProjectAsyncWithHttpInfo() : PromiseInterface: Operation removeProjectAsyncWithHttpInfo
removeProjectRequest() : Request: Create request for operation 'removeProject'
removeProjectWithHttpInfo() : array<string|int, mixed>: Operation removeProjectWithHttpInfo
setHostIndex() : void: Set the host index
updateProject() : void: Operation updateProject
updateProjectAsync() : PromiseInterface: Operation updateProjectAsync
updateProjectAsyncWithHttpInfo() : PromiseInterface: Operation updateProjectAsyncWithHttpInfo
updateProjectRequest() : Request: Create request for operation 'updateProject'
updateProjectWithHttpInfo() : array<string|int, mixed>: Operation updateProjectWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['createProject' => ['application/json'], 'exportProject' => ['application/json'], 'fetchProject' => ['application/json'], 'fetchProjects' => ['application/json'], 'removeProject' => ['application/json'], 'updateProject' => ['application/json']]

$client


        protected
            ClientInterface
    $client

$config


        protected
            Configuration
    $config

$headerSelector


        protected
            HeaderSelector
    $headerSelector

$hostIndex


        protected
            int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int = 0: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

createProject()

Operation createProject


    public
                    createProject(ProjectCreate $project_create[, string $contentType = self::contentTypes['createProject'][0] ]) : mixed

Create a new project.

Parameters

$project_create : ProjectCreate: project_create (required)
$contentType : string = self::contentTypes['createProject'][0]: The value for the Content-Type header. Check self::contentTypes['createProject'] to see the possible values for this operation

createProjectAsync()

Operation createProjectAsync


    public
                    createProjectAsync(ProjectCreate $project_create[, string $contentType = self::contentTypes['createProject'][0] ]) : PromiseInterface

Create a new project.

Parameters

$project_create : ProjectCreate: (required)
$contentType : string = self::contentTypes['createProject'][0]: The value for the Content-Type header. Check self::contentTypes['createProject'] to see the possible values for this operation

Return values

PromiseInterface

createProjectAsyncWithHttpInfo()

Operation createProjectAsyncWithHttpInfo


    public
                    createProjectAsyncWithHttpInfo(ProjectCreate $project_create[, string $contentType = self::contentTypes['createProject'][0] ]) : PromiseInterface

Create a new project.

Parameters

$project_create : ProjectCreate: (required)
$contentType : string = self::contentTypes['createProject'][0]: The value for the Content-Type header. Check self::contentTypes['createProject'] to see the possible values for this operation

Return values

PromiseInterface

createProjectRequest()

Create request for operation 'createProject'


    public
                    createProjectRequest(ProjectCreate $project_create[, string $contentType = self::contentTypes['createProject'][0] ]) : Request

Parameters

$project_create : ProjectCreate: (required)
$contentType : string = self::contentTypes['createProject'][0]: The value for the Content-Type header. Check self::contentTypes['createProject'] to see the possible values for this operation

Return values

Request

createProjectWithHttpInfo()

Operation createProjectWithHttpInfo


    public
                    createProjectWithHttpInfo(ProjectCreate $project_create[, string $contentType = self::contentTypes['createProject'][0] ]) : array<string|int, mixed>

Create a new project.

Parameters

$project_create : ProjectCreate: (required)
$contentType : string = self::contentTypes['createProject'][0]: The value for the Content-Type header. Check self::contentTypes['createProject'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of |\Tectly\OpenAPI\Model\ProjectSummary, HTTP status code, HTTP response headers (array of strings)

exportProject()

Operation exportProject


    public
                    exportProject(string $id, ProjectExport $project_export[, string $contentType = self::contentTypes['exportProject'][0] ]) : ResourceReference

Export project data into an XLSX workbook

Parameters

$id : string: id (required)
$project_export : ProjectExport: project_export (required)
$contentType : string = self::contentTypes['exportProject'][0]: The value for the Content-Type header. Check self::contentTypes['exportProject'] to see the possible values for this operation

Return values

ResourceReference

exportProjectAsync()

Operation exportProjectAsync


    public
                    exportProjectAsync(string $id, ProjectExport $project_export[, string $contentType = self::contentTypes['exportProject'][0] ]) : PromiseInterface

Export project data into an XLSX workbook

Parameters

$id : string: (required)
$project_export : ProjectExport: (required)
$contentType : string = self::contentTypes['exportProject'][0]: The value for the Content-Type header. Check self::contentTypes['exportProject'] to see the possible values for this operation

Return values

PromiseInterface

exportProjectAsyncWithHttpInfo()

Operation exportProjectAsyncWithHttpInfo


    public
                    exportProjectAsyncWithHttpInfo(string $id, ProjectExport $project_export[, string $contentType = self::contentTypes['exportProject'][0] ]) : PromiseInterface

Export project data into an XLSX workbook

Parameters

$id : string: (required)
$project_export : ProjectExport: (required)
$contentType : string = self::contentTypes['exportProject'][0]: The value for the Content-Type header. Check self::contentTypes['exportProject'] to see the possible values for this operation

Return values

PromiseInterface

exportProjectRequest()

Create request for operation 'exportProject'


    public
                    exportProjectRequest(string $id, ProjectExport $project_export[, string $contentType = self::contentTypes['exportProject'][0] ]) : Request

Parameters

$id : string: (required)
$project_export : ProjectExport: (required)
$contentType : string = self::contentTypes['exportProject'][0]: The value for the Content-Type header. Check self::contentTypes['exportProject'] to see the possible values for this operation

Return values

Request

exportProjectWithHttpInfo()

Operation exportProjectWithHttpInfo


    public
                    exportProjectWithHttpInfo(string $id, ProjectExport $project_export[, string $contentType = self::contentTypes['exportProject'][0] ]) : array<string|int, mixed>

Export project data into an XLSX workbook

Parameters

$id : string: (required)
$project_export : ProjectExport: (required)
$contentType : string = self::contentTypes['exportProject'][0]: The value for the Content-Type header. Check self::contentTypes['exportProject'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \Tectly\OpenAPI\Model\ResourceReference, HTTP status code, HTTP response headers (array of strings)

fetchProject()

Operation fetchProject


    public
                    fetchProject(string $id[, string $contentType = self::contentTypes['fetchProject'][0] ]) : Project

Get a project by its id.

Parameters

$id : string: id (required)
$contentType : string = self::contentTypes['fetchProject'][0]: The value for the Content-Type header. Check self::contentTypes['fetchProject'] to see the possible values for this operation

Return values

Project

fetchProjectAsync()

Operation fetchProjectAsync


    public
                    fetchProjectAsync(string $id[, string $contentType = self::contentTypes['fetchProject'][0] ]) : PromiseInterface

Get a project by its id.

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['fetchProject'][0]: The value for the Content-Type header. Check self::contentTypes['fetchProject'] to see the possible values for this operation

Return values

PromiseInterface

fetchProjectAsyncWithHttpInfo()

Operation fetchProjectAsyncWithHttpInfo


    public
                    fetchProjectAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['fetchProject'][0] ]) : PromiseInterface

Get a project by its id.

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['fetchProject'][0]: The value for the Content-Type header. Check self::contentTypes['fetchProject'] to see the possible values for this operation

Return values

PromiseInterface

fetchProjectRequest()

Create request for operation 'fetchProject'


    public
                    fetchProjectRequest(string $id[, string $contentType = self::contentTypes['fetchProject'][0] ]) : Request

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['fetchProject'][0]: The value for the Content-Type header. Check self::contentTypes['fetchProject'] to see the possible values for this operation

Return values

Request

fetchProjects()

Operation fetchProjects


    public
                    fetchProjects([int|null $page = 0 ][, int|null $size = 20 ][, array<string|int, string>|null $sort = null ][, string $contentType = self::contentTypes['fetchProjects'][0] ]) : ProjectsPage

Get all projects paged

Parameters

$page : int|null = 0: Zero-based page index (0..N) (optional, default to 0)
$size : int|null = 20: The size of the page to be returned (optional, default to 20)
$sort : array<string|int, string>|null = null: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional)
$contentType : string = self::contentTypes['fetchProjects'][0]: The value for the Content-Type header. Check self::contentTypes['fetchProjects'] to see the possible values for this operation

Return values

ProjectsPage

fetchProjectsAsync()

Operation fetchProjectsAsync


    public
                    fetchProjectsAsync([int|null $page = 0 ][, int|null $size = 20 ][, array<string|int, string>|null $sort = null ][, string $contentType = self::contentTypes['fetchProjects'][0] ]) : PromiseInterface

Get all projects paged

Parameters

$page : int|null = 0: Zero-based page index (0..N) (optional, default to 0)
$size : int|null = 20: The size of the page to be returned (optional, default to 20)
$sort : array<string|int, string>|null = null: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional)
$contentType : string = self::contentTypes['fetchProjects'][0]: The value for the Content-Type header. Check self::contentTypes['fetchProjects'] to see the possible values for this operation

Return values

PromiseInterface

fetchProjectsAsyncWithHttpInfo()

Operation fetchProjectsAsyncWithHttpInfo


    public
                    fetchProjectsAsyncWithHttpInfo([int|null $page = 0 ][, int|null $size = 20 ][, array<string|int, string>|null $sort = null ][, string $contentType = self::contentTypes['fetchProjects'][0] ]) : PromiseInterface

Get all projects paged

Parameters

$page : int|null = 0: Zero-based page index (0..N) (optional, default to 0)
$size : int|null = 20: The size of the page to be returned (optional, default to 20)
$sort : array<string|int, string>|null = null: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional)
$contentType : string = self::contentTypes['fetchProjects'][0]: The value for the Content-Type header. Check self::contentTypes['fetchProjects'] to see the possible values for this operation

Return values

PromiseInterface

fetchProjectsRequest()

Create request for operation 'fetchProjects'


    public
                    fetchProjectsRequest([int|null $page = 0 ][, int|null $size = 20 ][, array<string|int, string>|null $sort = null ][, string $contentType = self::contentTypes['fetchProjects'][0] ]) : Request

Parameters

$page : int|null = 0: Zero-based page index (0..N) (optional, default to 0)
$size : int|null = 20: The size of the page to be returned (optional, default to 20)
$sort : array<string|int, string>|null = null: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional)
$contentType : string = self::contentTypes['fetchProjects'][0]: The value for the Content-Type header. Check self::contentTypes['fetchProjects'] to see the possible values for this operation

Return values

Request

fetchProjectsWithHttpInfo()

Operation fetchProjectsWithHttpInfo


    public
                    fetchProjectsWithHttpInfo([int|null $page = 0 ][, int|null $size = 20 ][, array<string|int, string>|null $sort = null ][, string $contentType = self::contentTypes['fetchProjects'][0] ]) : array<string|int, mixed>

Get all projects paged

Parameters

$page : int|null = 0: Zero-based page index (0..N) (optional, default to 0)
$size : int|null = 20: The size of the page to be returned (optional, default to 20)
$sort : array<string|int, string>|null = null: Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional)
$contentType : string = self::contentTypes['fetchProjects'][0]: The value for the Content-Type header. Check self::contentTypes['fetchProjects'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \Tectly\OpenAPI\Model\ProjectsPage, HTTP status code, HTTP response headers (array of strings)

fetchProjectWithHttpInfo()

Operation fetchProjectWithHttpInfo


    public
                    fetchProjectWithHttpInfo(string $id[, string $contentType = self::contentTypes['fetchProject'][0] ]) : array<string|int, mixed>

Get a project by its id.

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['fetchProject'][0]: The value for the Content-Type header. Check self::contentTypes['fetchProject'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \Tectly\OpenAPI\Model\Project, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

removeProject()

Operation removeProject


    public
                    removeProject(string $id[, string $contentType = self::contentTypes['removeProject'][0] ]) : void

Delete a project.

Parameters

$id : string: id (required)
$contentType : string = self::contentTypes['removeProject'][0]: The value for the Content-Type header. Check self::contentTypes['removeProject'] to see the possible values for this operation

removeProjectAsync()

Operation removeProjectAsync


    public
                    removeProjectAsync(string $id[, string $contentType = self::contentTypes['removeProject'][0] ]) : PromiseInterface

Delete a project.

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['removeProject'][0]: The value for the Content-Type header. Check self::contentTypes['removeProject'] to see the possible values for this operation

Return values

PromiseInterface

removeProjectAsyncWithHttpInfo()

Operation removeProjectAsyncWithHttpInfo


    public
                    removeProjectAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['removeProject'][0] ]) : PromiseInterface

Delete a project.

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['removeProject'][0]: The value for the Content-Type header. Check self::contentTypes['removeProject'] to see the possible values for this operation

Return values

PromiseInterface

removeProjectRequest()

Create request for operation 'removeProject'


    public
                    removeProjectRequest(string $id[, string $contentType = self::contentTypes['removeProject'][0] ]) : Request

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['removeProject'][0]: The value for the Content-Type header. Check self::contentTypes['removeProject'] to see the possible values for this operation

Return values

Request

removeProjectWithHttpInfo()

Operation removeProjectWithHttpInfo


    public
                    removeProjectWithHttpInfo(string $id[, string $contentType = self::contentTypes['removeProject'][0] ]) : array<string|int, mixed>

Delete a project.

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['removeProject'][0]: The value for the Content-Type header. Check self::contentTypes['removeProject'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

updateProject()

Operation updateProject


    public
                    updateProject(string $id, ProjectUpdate $project_update[, string $contentType = self::contentTypes['updateProject'][0] ]) : void

Update project.

Parameters

$id : string: id (required)
$project_update : ProjectUpdate: project_update (required)
$contentType : string = self::contentTypes['updateProject'][0]: The value for the Content-Type header. Check self::contentTypes['updateProject'] to see the possible values for this operation

updateProjectAsync()

Operation updateProjectAsync


    public
                    updateProjectAsync(string $id, ProjectUpdate $project_update[, string $contentType = self::contentTypes['updateProject'][0] ]) : PromiseInterface

Update project.

Parameters

$id : string: (required)
$project_update : ProjectUpdate: (required)
$contentType : string = self::contentTypes['updateProject'][0]: The value for the Content-Type header. Check self::contentTypes['updateProject'] to see the possible values for this operation

Return values

PromiseInterface

updateProjectAsyncWithHttpInfo()

Operation updateProjectAsyncWithHttpInfo


    public
                    updateProjectAsyncWithHttpInfo(string $id, ProjectUpdate $project_update[, string $contentType = self::contentTypes['updateProject'][0] ]) : PromiseInterface

Update project.

Parameters

$id : string: (required)
$project_update : ProjectUpdate: (required)
$contentType : string = self::contentTypes['updateProject'][0]: The value for the Content-Type header. Check self::contentTypes['updateProject'] to see the possible values for this operation

Return values

PromiseInterface

updateProjectRequest()

Create request for operation 'updateProject'


    public
                    updateProjectRequest(string $id, ProjectUpdate $project_update[, string $contentType = self::contentTypes['updateProject'][0] ]) : Request

Parameters

$id : string: (required)
$project_update : ProjectUpdate: (required)
$contentType : string = self::contentTypes['updateProject'][0]: The value for the Content-Type header. Check self::contentTypes['updateProject'] to see the possible values for this operation

Return values

Request

updateProjectWithHttpInfo()

Operation updateProjectWithHttpInfo


    public
                    updateProjectWithHttpInfo(string $id, ProjectUpdate $project_update[, string $contentType = self::contentTypes['updateProject'][0] ]) : array<string|int, mixed>

Update project.

Parameters

$id : string: (required)
$project_update : ProjectUpdate: (required)
$contentType : string = self::contentTypes['updateProject'][0]: The value for the Content-Type header. Check self::contentTypes['updateProject'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

handleResponseWithDataType()


    private
                    handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>

Parameters

$dataType : string
$request : RequestInterface
$response : ResponseInterface

Return values

array<string|int, mixed>

responseWithinRangeCode()


    private
                    responseWithinRangeCode(string $rangeCode, int $statusCode) : bool

Parameters

$rangeCode : string
$statusCode : int

Return values

bool

ProjectsApi in package Tectly OpenAPI

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

createProject()

Parameters

Tags

createProjectAsync()

Parameters

Tags

Return values

createProjectAsyncWithHttpInfo()

Parameters

Tags

Return values

createProjectRequest()

Parameters

Tags

Return values

createProjectWithHttpInfo()

Parameters

Tags

Return values

exportProject()

Parameters

Tags

Return values

exportProjectAsync()

Parameters

Tags

Return values

exportProjectAsyncWithHttpInfo()

Parameters

Tags

Return values

exportProjectRequest()

Parameters

Tags

Return values

exportProjectWithHttpInfo()

Parameters

Tags

Return values

fetchProject()

Parameters

Tags

Return values

fetchProjectAsync()

Parameters

Tags

Return values

fetchProjectAsyncWithHttpInfo()

Parameters

Tags

Return values

fetchProjectRequest()

Parameters

Tags

Return values

fetchProjects()

Parameters

Tags

Return values

fetchProjectsAsync()

Parameters

Tags

Return values

fetchProjectsAsyncWithHttpInfo()

ProjectsApi
in package

Tectly

OpenAPI