Skip to content

Latest commit

 

History

History
217 lines (153 loc) · 7.01 KB

TeamMembersApi.md

File metadata and controls

217 lines (153 loc) · 7.01 KB

SternerStuff\InsightlyPHP\TeamMembersApi

All URIs are relative to https://api.insightly.com/v3.1

Method HTTP request Description
addTeamMember POST /TeamMembers Adds a new Team Member
deleteTeamMember DELETE /TeamMembers/{id} Deletes a Team Member
getTeamMember GET /TeamMembers/{id} Gets a Team Member
getTeamMembers GET /TeamMembers Gets a list of Team Members

addTeamMember

object addTeamMember($api_team_member, $authorization)

Adds a new Team Member

Note: Team Members of Anonymous Teams can only be created via the /Teams endpoint.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\TeamMembersApi(
    // 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()
);
$api_team_member = new \SternerStuff\InsightlyPHP\Model\APITeamMember(); // \SternerStuff\InsightlyPHP\Model\APITeamMember | The Team Member to add (just include JSON object as request body)
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->addTeamMember($api_team_member, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamMembersApi->addTeamMember: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
api_team_member \SternerStuff\InsightlyPHP\Model\APITeamMember The Team Member to add (just include JSON object as request body)
authorization string Authorization [default to {{Authorization}}]

Return type

object

Authorization

No authorization required

HTTP request headers

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

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

deleteTeamMember

deleteTeamMember($id, $authorization)

Deletes a Team Member

Note: Team Members of Anonymous Teams can only be deleted via the /Teams endpoint.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\TeamMembersApi(
    // 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()
);
$id = 789; // int | A Team Member's ID (PERMISSION_ID)
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->deleteTeamMember($id, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling TeamMembersApi->deleteTeamMember: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Team Member's ID (PERMISSION_ID)
authorization string Authorization [default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

getTeamMember

object getTeamMember($id, $authorization)

Gets a Team Member

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\TeamMembersApi(
    // 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()
);
$id = 789; // int | A Team Member's ID (PERMISSION_ID)
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->getTeamMember($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamMembersApi->getTeamMember: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Team Member's ID (PERMISSION_ID)
authorization string Authorization [default to {{Authorization}}]

Return type

object

Authorization

No authorization required

HTTP request headers

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

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

getTeamMembers

object[] getTeamMembers($authorization, $skip, $top, $count_total)

Gets a list of Team Members

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\TeamMembersApi(
    // 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()
);
$authorization = "{{Authorization}}"; // string | Authorization
$skip = 56; // int | Optional, number of team members to skip.
$top = 56; // int | Optional, maximum number of team members to return in the response.
$count_total = false; // bool | Optional, true if total number of records should be returned in the response headers.

try {
    $result = $apiInstance->getTeamMembers($authorization, $skip, $top, $count_total);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamMembersApi->getTeamMembers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
authorization string Authorization [default to {{Authorization}}]
skip int Optional, number of team members to skip. [optional]
top int Optional, maximum number of team members to return in the response. [optional]
count_total bool Optional, true if total number of records should be returned in the response headers. [optional] [default to false]

Return type

object[]

Authorization

No authorization required

HTTP request headers

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

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