Skip to content

MysteryDragon/planfix-api

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
.swagger-codegen
.swagger-codegen
 
 
docs
docs
 
 
generation
generation
 
 
src
src
 
 
test
test
 
 
.gitignore
.gitignore
 
 
.php_cs
.php_cs
 
 
.swagger-codegen-ignore
.swagger-codegen-ignore
 
 
.travis.yml
.travis.yml
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 
git_push.sh
git_push.sh
 
 
phpunit.xml.dist
phpunit.xml.dist
 
 

Repository files navigation

./

Documentation for Planfix REST API.
Generated <a href="https://root/restapidocs/swagger.json\">swagger.json

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 1.0.3
  • Package version: 1.0.3
  • Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/demliz-org/planfix-api.git"
    }
  ],
  "require": {
    "demliz-org/planfix-api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/.//vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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


$apiInstance = new Planfix\Api\CommentsApi(
    // 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
);
$id = 56; // int | 

try {
    $apiInstance->deleteCommentId($id);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->deleteCommentId: ', $e->getMessage(), PHP_EOL;
}


$apiInstance = new Planfix\Api\CommentsApi(
    // 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
);
$id = "id_example"; // string | Number of comment
$fields = "fields_example"; // string | Fields returned - custom field identifiers, system field names, comma-delimited
$sourceId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | Unique identifier of external application

try {
    $result = $apiInstance->getCommentId($id, $fields, $sourceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->getCommentId: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://your-account.planfix.com/rest

Class Method HTTP request Description
CommentsApi deleteCommentId DELETE /comment/{id} Delete comment
CommentsApi getCommentId GET /comment/{id} Get comment by number
ContactApi getContactById GET /contact/{id} Get contact by number
ContactApi getContactComments POST /contact/{id}/comments/list Get list of comments added to contact
ContactApi getContactList POST /contact/list Get list of contacts and companies
ContactApi getContactListGroups GET /contact/groups Get list of contact groups
ContactApi getContactListTemplates GET /contact/templates Get list of contact or company templates
ContactApi postContact POST /contact/ Create contact or company
ContactApi postContactAddComment POST /contact/{id}/comments/ Add comment
ContactApi postContactAddDataTagEntryExistingComment POST /contact/{id}/datatags/{commentId} Add a data tag entry to an existing comment
ContactApi postContactAddDataTagEntryNewComment POST /contact/{id}/datatags/ Add a data tag entry with a new comment
ContactApi postContactById POST /contact/{id} Update contact by number
ContactApi postContactFilters POST /contact/filters Get list contact filters
ContactApi postContactImport POST /contact/import Import contact list
ContactApi postContactUpdateComment POST /contact/{id}/comments/{commentId} Update comment
CustomFieldsApi getCustomfieldContact GET /customfield/contact Get a list of a custom contact fields
CustomFieldsApi getCustomfieldGeneric GET /customfield/main Get list of custom main fields
CustomFieldsApi getCustomfieldProject GET /customfield/project Get a list of custom project fields
CustomFieldsApi getCustomfieldTask GET /customfield/task Get list of custom task fields
CustomFieldsApi getCustomfieldUser GET /customfield/user Get list of custom employee fields
CustomFieldsApi getCustomfieldsForContact GET /customfield/contact/{id} Get a list of a custom fields for contact
CustomFieldsApi getCustomfieldsForDatatag GET /customfield/datatag/{id} Get list of custom fields for data tag
CustomFieldsApi getCustomfieldsForDirectory GET /customfield/directory/{id} Get list of custom fields for directory
CustomFieldsApi getCustomfieldsForProject GET /customfield/project/{id} Get list of custom fields for project
CustomFieldsApi getCustomfieldsForTask GET /customfield/task/{id} Get list of custom fields for task
CustomFieldsApi getCustomfieldsForUser GET /customfield/user/{id} Get list of custom fields for employee
DataTagsApi deleteDatatagEntryKey DELETE /datatag/entry/{key} Delete data tag entry
DataTagsApi getDataTags POST /datatag/list Get data tags
DataTagsApi getDatatagEntryKey GET /datatag/entry/{key} Get data tag entry
DataTagsApi getDatatagId GET /datatag/{id} Get data tag by identifier
DataTagsApi postListDataTagEntrys POST /datatag/{id}/entry/list Get list of data tag entries
DataTagsApi postUpdateDataTagEntry POST /datatag/entry/{key} Update data tag entry
DirectoryApi deleteDirectoryEntryKey DELETE /directory/{id}/entry/{key} Delete directory entry
DirectoryApi getDirectoriesGroups GET /directory/groups Get list of directory groups
DirectoryApi getDirectoryById GET /directory/{id} Get directory by identifier
DirectoryApi getDirectoryIdEntryKey GET /directory/{id}/entry/{key} Get directory entry
DirectoryApi getListDirectories POST /directory/list Get list of directories
DirectoryApi postAddDirectoryEntry POST /directory/{id}/entry/ Add directory entry
DirectoryApi postListDirectoryEntries POST /directory/{id}/entry/list Get list of directory entries
DirectoryApi postUpdateDirectoryEntry POST /directory/{id}/entry/{key} Update directory entry
EmployeeApi getUserId GET /user/{id} Get employee by number
EmployeeApi getUserList POST /user/list Get list of employees
EmployeeApi getUserListGroups GET /user/groups Get list of employee groups
EmployeeApi getUserPosts GET /user/posts Get list of employee posts
EmployeeApi postUser POST /user/ Create employee
EmployeeApi postUserId POST /user/{id} Update employee by number
FileApi deleteFileId DELETE /file/{id} Delete file
FileApi getFileId GET /file/{id} Get file by identifier
FileApi getFileIdDownload GET /file/{id}/download Download file
FileApi postFileUpload POST /file/ Upload file
FileApi postFileUploadByUrl POST /file/from-url/ Upload file by link
ProjectApi getProjectById GET /project/{id} Get project by number
ProjectApi getProjectList POST /project/list Get list of projects
ProjectApi getProjectListTemplates GET /project /templates Get list of project templates
ProjectApi getUserListGroups GET /project/groups Get list of project groups
ProjectApi postProject POST /project/ Create project
ProjectApi postProjectById POST /project/{id} Update project by number
TaskApi getTaskById GET /task/{id} Get task by number
TaskApi getTaskComments POST /task/{id}/comments/list Get task comments
TaskApi getTaskList POST /task/list Get list of tasks
TaskApi getTaskListTemplates GET /task/templates Get list of task templates
TaskApi postTask POST /task/ Create task
TaskApi postTaskAddComment POST /task/{id}/comments/ Add comment
TaskApi postTaskAddDataTagEntryExistingComment POST /task/{id}/datatags/{commentId} Add a data tag entry to an existing comment
TaskApi postTaskAddDataTagEntryNewComment POST /task/{id}/datatags/ Add data tag entry as new comment
TaskApi postTaskById POST /task/{id} Update task by number
TaskApi postTaskFilters POST /task/filters Get list task filters
TaskApi postTaskUpdateComment POST /task/{id}/comments/{commentId} Updating comments

Documentation For Models

Documentation For Authorization

rest_auth

  • Type: HTTP bearer authentication

Author

About

Autogenerated REST API by Planfix OpenAPI spec

Resources

Readme
Activity

Stars

1 star

Watchers

1 watching

Forks

0 forks
Report repository

Releases

1 tags

Packages

No packages published

Languages