Tinq\Projects

Official Tinq.ai PHP SDK.

All URIs are relative to https://tinq.ai/api/v2, except if the operation defines another base path.

MethodHTTP requestDescription
createProjectPOST /projectsCreate Project
getAllProjectsGET /projects/Get All Projects
getProjectGET /projects/Get Project
updateProjectPUT /projects/Update Project

createProject()

createProject($body)

Create Project

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Tinq\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Tinq\Api\Projects(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = array('key' => new \stdClass); // object

try {
    $apiInstance->createProject($body);
} catch (Exception $e) {
    echo 'Exception when calling Projects->createProject: ', $e->getMessage(), PHP_EOL;
}

Parameters

NameTypeDescriptionNotes
bodyobject[optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

getAllProjects()

getAllProjects($order, $column_sort, $name)

Get All Projects

Get all your projects

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Tinq\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Tinq\Api\Projects(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$order = DESC; // string
$column_sort = created_at; // string
$name = 'name_example'; // string

try {
    $apiInstance->getAllProjects($order, $column_sort, $name);
} catch (Exception $e) {
    echo 'Exception when calling Projects->getAllProjects: ', $e->getMessage(), PHP_EOL;
}

Parameters

NameTypeDescriptionNotes
orderstring[optional]
column_sortstring[optional]
namestring[optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

getProject()

getProject($project)

Get Project

Get a specific project given its identifier

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Tinq\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Tinq\Api\Projects(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project = 'project_example'; // string

try {
    $apiInstance->getProject($project);
} catch (Exception $e) {
    echo 'Exception when calling Projects->getProject: ', $e->getMessage(), PHP_EOL;
}

Parameters

NameTypeDescriptionNotes
projectstring

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

updateProject()

updateProject($project, $body)

Update Project

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Tinq\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Tinq\Api\Projects(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project = 'project_example'; // string
$body = array('key' => new \stdClass); // object

try {
    $apiInstance->updateProject($project, $body);
} catch (Exception $e) {
    echo 'Exception when calling Projects->updateProject: ', $e->getMessage(), PHP_EOL;
}

Parameters

NameTypeDescriptionNotes
projectstring
bodyobject[optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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