Ageras\Api\ProjectsApi

All URIs are relative to https://api.ageras.com/v2

Method	HTTP request	Description
projectsCreate	POST /projects
projectsDelete	DELETE /projects/{project_id}
projectsEventsCreate	POST /projects/events
projectsEventsCreate_0	POST /projects/{project_id}/events
projectsEventsDelete	DELETE /projects/{project_id}/events/{project_event_id}
projectsEventsGet	GET /projects/events/{project_event_id}
projectsEventsGet_0	GET /projects/{project_id}/events/{project_event_id}
projectsEventsIndex	GET /projects/events
projectsEventsIndex_0	GET /projects/{project_id}/events
projectsEventsUpdate	PUT /projects/events/{project_event_id}
projectsEventsUpdate_0	PUT /projects/{project_id}/events/{project_event_id}
projectsGet	GET /projects/{project_id}
projectsIndex	GET /projects
projectsNotesCreate	POST /projects/notes
projectsNotesCreate_0	POST /projects/{project_id}/notes
projectsNotesDelete	DELETE /projects/{project_id}/notes/{project_note_id}
projectsNotesGet	GET /projects/notes/{project_note_id}
projectsNotesGet_0	GET /projects/{project_id}/notes/{project_note_id}
projectsNotesIndex	GET /projects/notes
projectsNotesIndex_0	GET /projects/{project_id}/notes
projectsNotesUpdate	PUT /projects/notes/{project_note_id}
projectsNotesUpdate_0	PUT /projects/{project_id}/notes/{project_note_id}
projectsStatusesGet	GET /projects/{status}/statuses
projectsStatusesIndex	GET /projects/statuses
projectsUpdate	PUT /projects/{project_id}

projectsCreate

\Ageras\Api\ProjectResource projectsCreate($project_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_resource = new \Ageras\Api\ProjectResource(); // \Ageras\Api\ProjectResource | 

try {
    $result = $api_instance->projectsCreate($project_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_resource	\Ageras\Api\ProjectResource

Return type

\Ageras\Api\ProjectResource

Authorization

jwt, login

HTTP request headers

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

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

projectsDelete

projectsDelete($project_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_id = "project_id_example"; // string | 

try {
    $api_instance->projectsDelete($project_id );
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string

Return type

void (empty response body)

Authorization

jwt, login

HTTP request headers

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

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

projectsEventsCreate

\Ageras\Api\ProjectNoteResource projectsEventsCreate($project_event_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_event_resource = new \Ageras\Api\ProjectEventResource(); // \Ageras\Api\ProjectEventResource | 

try {
    $result = $api_instance->projectsEventsCreate($project_event_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsEventsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_event_resource	\Ageras\Api\ProjectEventResource

Return type

\Ageras\Api\ProjectNoteResource

Authorization

jwt, login

HTTP request headers

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

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

projectsEventsCreate_0

\Ageras\Api\ProjectNoteResource projectsEventsCreate_0($project_id , $project_event_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_id = "project_id_example"; // string | 
$project_event_resource = new \Ageras\Api\ProjectEventResource(); // \Ageras\Api\ProjectEventResource | 

try {
    $result = $api_instance->projectsEventsCreate_0($project_id , $project_event_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsEventsCreate_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string
project_event_resource	\Ageras\Api\ProjectEventResource

Return type

\Ageras\Api\ProjectNoteResource

Authorization

jwt, login

HTTP request headers

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

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

projectsEventsDelete

projectsEventsDelete($project_id, $project_event_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_id = "project_id_example"; // string | 
$project_event_id = "project_event_id_example"; // string | 

try {
    $api_instance->projectsEventsDelete($project_id,  $project_event_id );
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsEventsDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string
project_event_id	string

Return type

void (empty response body)

Authorization

jwt, login

HTTP request headers

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

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

projectsEventsGet

\Ageras\Api\ProjectNoteResource projectsEventsGet($project_event_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_event_id = "project_event_id_example"; // string | 

try {
    $result = $api_instance->projectsEventsGet($project_event_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsEventsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_event_id	string

Return type

\Ageras\Api\ProjectNoteResource

Authorization

jwt, login

HTTP request headers

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

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

projectsEventsGet_0

\Ageras\Api\ProjectNoteResource projectsEventsGet_0($project_id, $project_event_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_id = "project_id_example"; // string | 
$project_event_id = "project_event_id_example"; // string | 

try {
    $result = $api_instance->projectsEventsGet_0($project_id,  $project_event_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsEventsGet_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string
project_event_id	string

Return type

\Ageras\Api\ProjectNoteResource

Authorization

jwt, login

HTTP request headers

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

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

projectsEventsIndex

\Ageras\Api\ProjectNoteResult projectsEventsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$criteria = [
        'project_event_id' => "project_event_id_example"; // string | Id for the Projects's events.
        'project_id' => "project_id_example"; // string | Project ID.
        'partner_id' => "partner_id_example"; // string | Partner Id.
        'partner_user_id' => "partner_user_id_example"; // string | Partner User Id.
        'scheduled_from' => "scheduled_from_example"; // string | Events scheduled from.
        'scheduled_to' => "scheduled_to_example"; // string | Events scheduled to.
        'type' => "unknown"; // string | Project Event Types.
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->projectsEventsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsEventsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_event_id	string	Id for the Projects's events.	[optional]
project_id	string	Project ID.	[optional]
partner_id	string	Partner Id.	[optional]
partner_user_id	string	Partner User Id.	[optional]
scheduled_from	string	Events scheduled from.	[optional]
scheduled_to	string	Events scheduled to.	[optional]
type	string	Project Event Types.	[optional] [default to unknown]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\ProjectNoteResult

Authorization

jwt, login

HTTP request headers

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

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

projectsEventsIndex_0

\Ageras\Api\ProjectNoteResult projectsEventsIndex_0($project_id , $criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_id = "project_id_example"; // string | 
$criteria = [
        'project_event_id' => "project_event_id_example"; // string | Id for the Projects's events.
        'partner_id' => "partner_id_example"; // string | Partner Id.
        'partner_user_id' => "partner_user_id_example"; // string | Partner User Id.
        'scheduled_from' => "scheduled_from_example"; // string | Events scheduled from.
        'scheduled_to' => "scheduled_to_example"; // string | Events scheduled to.
        'type' => "unknown"; // string | Project Event Types.
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->projectsEventsIndex_0($project_id , $criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsEventsIndex_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string
project_event_id	string	Id for the Projects's events.	[optional]
partner_id	string	Partner Id.	[optional]
partner_user_id	string	Partner User Id.	[optional]
scheduled_from	string	Events scheduled from.	[optional]
scheduled_to	string	Events scheduled to.	[optional]
type	string	Project Event Types.	[optional] [default to unknown]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\ProjectNoteResult

Authorization

jwt, login

HTTP request headers

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

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

projectsEventsUpdate

\Ageras\Api\ProjectNoteResource projectsEventsUpdate($project_event_id , $project_event_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_event_id = "project_event_id_example"; // string | 
$project_event_resource = new \Ageras\Api\ProjectEventResource(); // \Ageras\Api\ProjectEventResource | 

try {
    $result = $api_instance->projectsEventsUpdate($project_event_id , $project_event_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsEventsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_event_id	string
project_event_resource	\Ageras\Api\ProjectEventResource

Return type

\Ageras\Api\ProjectNoteResource

Authorization

jwt, login

HTTP request headers

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

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

projectsEventsUpdate_0

\Ageras\Api\ProjectNoteResource projectsEventsUpdate_0($project_id, $project_event_id , $project_event_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_id = "project_id_example"; // string | 
$project_event_id = "project_event_id_example"; // string | 
$project_event_resource = new \Ageras\Api\ProjectEventResource(); // \Ageras\Api\ProjectEventResource | 

try {
    $result = $api_instance->projectsEventsUpdate_0($project_id,  $project_event_id , $project_event_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsEventsUpdate_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string
project_event_id	string
project_event_resource	\Ageras\Api\ProjectEventResource

Return type

\Ageras\Api\ProjectNoteResource

Authorization

jwt, login

HTTP request headers

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

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

projectsGet

\Ageras\Api\ProjectResource projectsGet($project_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_id = "project_id_example"; // string | 

try {
    $result = $api_instance->projectsGet($project_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string

Return type

\Ageras\Api\ProjectResource

Authorization

jwt, login

HTTP request headers

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

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

projectsIndex

\Ageras\Api\ProjectResult projectsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$criteria = [
        'project_id' => "project_id_example"; // string | Project ID.
        'partner_id' => "partner_id_example"; // string | Partner Id.
        'partner_user_id' => "partner_user_id_example"; // string | Partner User Id.
        'lead_id' => "lead_id_example"; // string | Lead Id.
        'name' => "name_example"; // string | Project name in its native language.
        'geo_code' => "geo_code_example"; // string | Project geo code origin.
        'status' => "status_example"; // string | Project Status.
        'progress' => "progress_example"; // string | Project quote progress.
        'sort' => "created_at"; // string | Sort projects
        'is_archived' => false; // bool | Filter projects that are archived.
        'is_lead_validated' => false; // bool | 
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->projectsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	Project ID.	[optional]
partner_id	string	Partner Id.	[optional]
partner_user_id	string	Partner User Id.	[optional]
lead_id	string	Lead Id.	[optional]
name	string	Project name in its native language.	[optional]
geo_code	string	Project geo code origin.	[optional]
status	string	Project Status.	[optional]
progress	string	Project quote progress.	[optional]
sort	string	Sort projects	[optional] [default to created_at]
is_archived	bool	Filter projects that are archived.	[optional] [default to false]
is_lead_validated	bool		[optional] [default to false]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\ProjectResult

Authorization

jwt, login

HTTP request headers

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

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

projectsNotesCreate

\Ageras\Api\ProjectNoteResource projectsNotesCreate($project_note_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_note_resource = new \Ageras\Api\ProjectNoteResource(); // \Ageras\Api\ProjectNoteResource | 

try {
    $result = $api_instance->projectsNotesCreate($project_note_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsNotesCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_note_resource	\Ageras\Api\ProjectNoteResource

Return type

\Ageras\Api\ProjectNoteResource

Authorization

jwt, login

HTTP request headers

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

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

projectsNotesCreate_0

\Ageras\Api\ProjectNoteResource projectsNotesCreate_0($project_id , $project_note_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_id = "project_id_example"; // string | 
$project_note_resource = new \Ageras\Api\ProjectNoteResource(); // \Ageras\Api\ProjectNoteResource | 

try {
    $result = $api_instance->projectsNotesCreate_0($project_id , $project_note_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsNotesCreate_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string
project_note_resource	\Ageras\Api\ProjectNoteResource

Return type

\Ageras\Api\ProjectNoteResource

Authorization

jwt, login

HTTP request headers

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

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

projectsNotesDelete

projectsNotesDelete($project_id, $project_note_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_id = "project_id_example"; // string | 
$project_note_id = "project_note_id_example"; // string | 

try {
    $api_instance->projectsNotesDelete($project_id,  $project_note_id );
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsNotesDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string
project_note_id	string

Return type

void (empty response body)

Authorization

jwt, login

HTTP request headers

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

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

projectsNotesGet

\Ageras\Api\ProjectNoteResource projectsNotesGet($project_note_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_note_id = "project_note_id_example"; // string | 

try {
    $result = $api_instance->projectsNotesGet($project_note_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsNotesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_note_id	string

Return type

\Ageras\Api\ProjectNoteResource

Authorization

jwt, login

HTTP request headers

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

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

projectsNotesGet_0

\Ageras\Api\ProjectNoteResource projectsNotesGet_0($project_id, $project_note_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_id = "project_id_example"; // string | 
$project_note_id = "project_note_id_example"; // string | 

try {
    $result = $api_instance->projectsNotesGet_0($project_id,  $project_note_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsNotesGet_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string
project_note_id	string

Return type

\Ageras\Api\ProjectNoteResource

Authorization

jwt, login

HTTP request headers

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

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

projectsNotesIndex

\Ageras\Api\ProjectNoteResult projectsNotesIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$criteria = [
        'project_note_id' => "project_note_id_example"; // string | Id for the Project's notes.
        'project_id' => "project_id_example"; // string | Project ID.
        'partner_id' => "partner_id_example"; // string | Partner Id.
        'partner_user_id' => "partner_user_id_example"; // string | Partner User Id.
        'lead_id' => "lead_id_example"; // string | Lead Id.
        'name' => "name_example"; // string | Project name in its native language.
        'geo_code' => "geo_code_example"; // string | Project geo code origin.
        'status' => "status_example"; // string | Project Status.
        'sort' => "created_at"; // string | Sort project notes
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->projectsNotesIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsNotesIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_note_id	string	Id for the Project's notes.	[optional]
project_id	string	Project ID.	[optional]
partner_id	string	Partner Id.	[optional]
partner_user_id	string	Partner User Id.	[optional]
lead_id	string	Lead Id.	[optional]
name	string	Project name in its native language.	[optional]
geo_code	string	Project geo code origin.	[optional]
status	string	Project Status.	[optional]
sort	string	Sort project notes	[optional] [default to created_at]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\ProjectNoteResult

Authorization

jwt, login

HTTP request headers

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

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

projectsNotesIndex_0

\Ageras\Api\ProjectNoteResult projectsNotesIndex_0($project_id , $criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_id = "project_id_example"; // string | 
$criteria = [
        'project_note_id' => "project_note_id_example"; // string | Id for the Project's notes.
        'partner_id' => "partner_id_example"; // string | Partner Id.
        'partner_user_id' => "partner_user_id_example"; // string | Partner User Id.
        'lead_id' => "lead_id_example"; // string | Lead Id.
        'name' => "name_example"; // string | Project name in its native language.
        'geo_code' => "geo_code_example"; // string | Project geo code origin.
        'status' => "status_example"; // string | Project Status.
        'sort' => "created_at"; // string | Sort project notes
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->projectsNotesIndex_0($project_id , $criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsNotesIndex_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string
project_note_id	string	Id for the Project's notes.	[optional]
partner_id	string	Partner Id.	[optional]
partner_user_id	string	Partner User Id.	[optional]
lead_id	string	Lead Id.	[optional]
name	string	Project name in its native language.	[optional]
geo_code	string	Project geo code origin.	[optional]
status	string	Project Status.	[optional]
sort	string	Sort project notes	[optional] [default to created_at]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\ProjectNoteResult

Authorization

jwt, login

HTTP request headers

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

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

projectsNotesUpdate

\Ageras\Api\ProjectNoteResource projectsNotesUpdate($project_note_id , $project_note_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_note_id = "project_note_id_example"; // string | 
$project_note_resource = new \Ageras\Api\ProjectNoteResource(); // \Ageras\Api\ProjectNoteResource | 

try {
    $result = $api_instance->projectsNotesUpdate($project_note_id , $project_note_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsNotesUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_note_id	string
project_note_resource	\Ageras\Api\ProjectNoteResource

Return type

\Ageras\Api\ProjectNoteResource

Authorization

jwt, login

HTTP request headers

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

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

projectsNotesUpdate_0

\Ageras\Api\ProjectNoteResource projectsNotesUpdate_0($project_id, $project_note_id , $project_note_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_id = "project_id_example"; // string | 
$project_note_id = "project_note_id_example"; // string | 
$project_note_resource = new \Ageras\Api\ProjectNoteResource(); // \Ageras\Api\ProjectNoteResource | 

try {
    $result = $api_instance->projectsNotesUpdate_0($project_id,  $project_note_id , $project_note_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsNotesUpdate_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string
project_note_id	string
project_note_resource	\Ageras\Api\ProjectNoteResource

Return type

\Ageras\Api\ProjectNoteResource

Authorization

jwt, login

HTTP request headers

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

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

projectsStatusesGet

\Ageras\Api\ProjectStatusResource projectsStatusesGet($status )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$status = "status_example"; // string | 

try {
    $result = $api_instance->projectsStatusesGet($status );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsStatusesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
status	string

Return type

\Ageras\Api\ProjectStatusResource

Authorization

jwt, login

HTTP request headers

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

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

projectsStatusesIndex

\Ageras\Api\ProjectStatusResult projectsStatusesIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$criteria = [
        'status' => "status_example"; // string | 
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->projectsStatusesIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsStatusesIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
status	string		[optional]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\ProjectStatusResult

Authorization

jwt, login

HTTP request headers

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

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

projectsUpdate

\Ageras\Api\ProjectResource projectsUpdate($project_id , $project_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProjectsApi();
$project_id = "project_id_example"; // string | 
$project_resource = new \Ageras\Api\ProjectResource(); // \Ageras\Api\ProjectResource | 

try {
    $result = $api_instance->projectsUpdate($project_id , $project_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string
project_resource	\Ageras\Api\ProjectResource

Return type

\Ageras\Api\ProjectResource

Authorization

jwt, login

HTTP request headers

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

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

Files

ProjectsApi.md

Latest commit

History

ProjectsApi.md

File metadata and controls

Ageras\Api\ProjectsApi

projectsCreate

Example

Parameters

Return type

Authorization

HTTP request headers

projectsDelete

Example

Parameters

Return type

Authorization

HTTP request headers

projectsEventsCreate

Example

Parameters

Return type

Authorization

HTTP request headers

projectsEventsCreate_0

Example

Parameters

Return type

Authorization

HTTP request headers

projectsEventsDelete

Example

Parameters

Return type

Authorization

HTTP request headers

projectsEventsGet

Example

Parameters

Return type

Authorization

HTTP request headers

projectsEventsGet_0

Example

Parameters

Return type

Authorization

HTTP request headers

projectsEventsIndex

Example

Parameters

Return type

Authorization

HTTP request headers

projectsEventsIndex_0

Example

Parameters

Return type

Authorization

HTTP request headers

projectsEventsUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

projectsEventsUpdate_0

Example

Parameters

Return type

Authorization

HTTP request headers

projectsGet

Example

Parameters

Return type

Authorization

HTTP request headers

projectsIndex