README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/ProcessMaker/pm4-sdk-php.git"
    }
  ],
  "require": {
    "ProcessMaker/pm4-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/pm4-sdk-php/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');


// Configure Bearer authorization: pm_api_bearer
$config = ProcessMaker\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new ProcessMaker\Client\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
);
$comments_editable = new \ProcessMaker\Client\Model\CommentsEditable(); // \ProcessMaker\Client\Model\CommentsEditable | 

try {
    $result = $apiInstance->createComments($comments_editable);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->createComments: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to http://localhost/api/1.0

Class	Method	HTTP request	Description
CommentsApi	createComments	POST /comments	Save a new comment
CommentsApi	deleteComments	DELETE /comments/id	Delete a comments
CommentsApi	getCommentById	GET /comments/commentId	Get single comment by ID
CommentsApi	getComments	GET /comments	Returns all comments for a given type
CommentsApi	updateComment	PUT /comments/commentId	Update a comment
EnvironmentVariablesApi	createEnvironmentVariables	POST /environment_variables	Save a new environment_variables
EnvironmentVariablesApi	deleteEnvironmentVariables	DELETE /environment_variables/{environment_variables_id}	Delete a environment_variables
EnvironmentVariablesApi	getEnvironmentVariables	GET /environment_variables	Returns all environmentVariables that the user has access to
EnvironmentVariablesApi	getEnvironmentVariablesById	GET /environment_variables/{environment_variables_id}	Get single environment_variables by ID
EnvironmentVariablesApi	updateEnvironmentVariables	PUT /environment_variables/{environment_variables_id}	Update a environment_variables
FilesApi	createFile	POST /requests/{request_id}/files	Save a new media file
FilesApi	deleteFile	DELETE /requests/{request_id}	Delete a media file
FilesApi	getFiles	GET /requests/{request_id}/files	Returns the list of files associated to a request
FilesApi	getFilesById	GET /requests/{request_id}/files/{file_id}	Get a file uploaded to a request
FilesApi	updateFile	PUT /requests/{request_id}/files/{file_id}	Update a media file
GroupMembersApi	createGroupMember	POST /group_members	Save a new group member
GroupMembersApi	deleteGroupMember	DELETE /group_members/{group_member_id}	Delete a group member
GroupMembersApi	getGroupMemberById	GET /group_members/{group_member_id}	Get single group member by ID
GroupMembersApi	getGroupMembers	GET /group_members	Returns all groups for a given member
GroupMembersApi	getGroupMembersAvailable	GET /group_members_available	Returns all groups available for a given member
GroupMembersApi	getUserMembersAvailable	GET /user_members_available	Returns all users available for a given member
GroupUsersApi	getMembers	GET /group_users	Returns all users of a group
GroupsApi	createGroup	POST /groups	Save a new group
GroupsApi	deleteGroup	DELETE /groups/{group_id}	Delete a group
GroupsApi	getGroupById	GET /groups/{group_id}	Get single group by ID
GroupsApi	getGroups	GET /groups	Returns all groups that the user has access to
GroupsApi	updateGroup	PUT /groups/{group_id}	Update a group
NotificationsApi	createNotification	POST /notifications	Save a new notifications
NotificationsApi	deleteNotification	DELETE /notifications/notificationId	Delete a notification
NotificationsApi	getNotificationById	GET /notifications/notificationId	Get single notification by ID
NotificationsApi	getNotifications	GET /notifications	Returns all notifications that the user has access to
NotificationsApi	processMakerHttpControllersApiNotificationControllerUpdateAsRead	PUT /read_notifications	Mark notifications as read by the user
NotificationsApi	processMakerHttpControllersApiNotificationControllerUpdateAsReadAll	PUT /read_all_notifications	Mark notifications as read by id and type
NotificationsApi	updateNotification	PUT /notifications/notificationId	Update a notification
PermissionsApi	processMakerHttpControllersApiPermissionControllerUpdate	PUT /permissions	Update the permissions of an user
ProcessCategoriesApi	createProcessCategory	POST /process_categories	Save a new process Category
ProcessCategoriesApi	deleteProcessCategory	DELETE /process_categories/{process_category_id}	Delete a process category
ProcessCategoriesApi	getProcessCategories	GET /process_categories	Returns all processes categories that the user has access to
ProcessCategoriesApi	getProcessCategoryById	GET /process_categories/{process_category_id}	Get single process category by ID
ProcessCategoriesApi	updateProcessCategory	PUT /process_categories/{process_category_id}	Update a process Category
ProcessRequestsApi	deleteProcessRequest	DELETE /requests/{process_request_id}	Delete a process request
ProcessRequestsApi	getProcessRequestById	GET /requests/{process_request_id}	Get single process request by ID
ProcessRequestsApi	getProcessesRequests	GET /requests	Returns all process Requests that the user has access to
ProcessRequestsApi	updateProcessRequest	PUT /requests/{process_request_id}	Update a process request
ProcessWebhooksApi	createProcessWebhook	POST /processes/{process_id}/webhooks/	Save a new webhook for a start node
ProcessWebhooksApi	deleteProcessWebhook	DELETE /processes/{process_id}/webhooks/	Delete (revoke) a webhook for a start node
ProcessWebhooksApi	getProcessWebhook	GET /processes/{process_id}/webhooks/	Get the webhook for a start node
ProcessesApi	createProcess	POST /processes	Save a new process
ProcessesApi	deleteProcess	DELETE /processes/{processId}	Delete a process
ProcessesApi	exportProcess	GET /processes/{processId}/export	Export a single process by ID
ProcessesApi	getProcessById	GET /processes/{processId}	Get single process by ID
ProcessesApi	getProcesses	GET /processes	Returns all processes that the user has access to
ProcessesApi	importProcess	POST /processes/import	Import a new process
ProcessesApi	restoreProcess	PUT /processes/{processId}/restore	Restore an inactive process
ProcessesApi	startProcesses	GET /start_processes	Returns the list of processes that the user can start
ProcessesApi	triggerStartEvent	POST /process_events/{process_id}	Start a new process
ProcessesApi	updateProcess	PUT /processes/{processId}	Update a process
ScreenCategoriesApi	createScreenCategory	POST /screen_categories	Save a new Screen Category
ScreenCategoriesApi	deleteScreenCategory	DELETE /screen_categories/screen_category_id	Delete a screen category
ScreenCategoriesApi	getScreenCategories	GET /screen_categories	Returns all screens categories that the user has access to
ScreenCategoriesApi	getScreenCategoryById	GET /screen_categories/screen_category_id	Get single screen category by ID
ScreenCategoriesApi	updateScreenCategory	PUT /screen_categories/screen_category_id	Update a screen Category
ScreensApi	createScreens	POST /screens	Save a new screens
ScreensApi	deleteScreen	DELETE /screens/screensId	Delete a screen
ScreensApi	duplicateScript	PUT /screens/screensId/duplicate	duplicate a screen
ScreensApi	getScreens	GET /screens	Returns all screens that the user has access to
ScreensApi	getScreensById	GET /screens/screensId	Get single screens by ID
ScreensApi	updateScreen	PUT /screens/screensId	Update a screen
ScriptsApi	createScript	POST /scripts	Save a new script
ScriptsApi	deleteScript	DELETE /scripts/scriptsId	Delete a script
ScriptsApi	duplicateScreen	PUT /scripts/scriptsId/duplicate	duplicate a script
ScriptsApi	getScripts	GET /scripts	Returns all scripts that the user has access to
ScriptsApi	getScriptsById	GET /scripts/scriptsId	Get single script by ID
ScriptsApi	getScriptsPreview	GET /scripts/preview	Returns all scripts that the user has access to
ScriptsApi	updateScript	PUT /scripts/scriptsId	Update a script
TaskAssignmentsApi	createTaskAssignments	POST /task_assignments	Save a new task assignments
TaskAssignmentsApi	updateTaskAssignments	PUT /task_assignments/{task_assignments_id}	Update a task assignments
TasksApi	getTasks	GET /tasks	Returns all tasks that the user has access to
TasksApi	updateTask	PUT /tasks/{task_id}	Update a task
UsersApi	createUser	POST /users	Save a new users
UsersApi	deleteUser	DELETE /users/{user_id}	Delete a user
UsersApi	getUserById	GET /users/{user_id}	Get single user by ID
UsersApi	getUsers	GET /users	Returns all users
UsersApi	updateUsers	PUT /users/{user_id}	Update a user

Documentation For Models

Documentation For Authorization

pm_api_bearer

Type: Bearer authentication

Author

info@processmaker.com

nolanpro / pm4-sdk-php

Maintainers

Details