OpenAPIClient-php

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

Installation & Usage

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/fastreports/FastReport-Cloud-PHP.git"
    }
  ],
  "require": {
    "fastreports/FastReport-Cloud-PHP": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

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


$apiInstance = new OpenAPI\Client\Api\ApiKeysApi(
    // 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
);
$create_api_key_vm = new \OpenAPI\Client\cloud\fastreport\model\CreateApiKeyVM(); // \OpenAPI\Client\cloud\fastreport\model\CreateApiKeyVM

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

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
ApiKeysApi	apiKeysCreateApiKey	POST /api/manage/v1/ApiKeys	Create a new apikey, 5 apikeys for user. Hardcoded for ddos.
ApiKeysApi	apiKeysDeleteApiKey	DELETE /api/manage/v1/ApiKeys	Delete an apikey
ApiKeysApi	apiKeysGetApiKeys	GET /api/manage/v1/ApiKeys	Returns list with all apikeys of current user
ConfigurationApi	configurationGet	GET /api/v1/Configuration	returns information about server configuration
ContactGroupsApi	contactGroupsCreate	POST /api/v1/ContactGroups/group	Creates contact group
ContactGroupsApi	contactGroupsDelete	DELETE /api/v1/ContactGroups/{id}	Removes contact by id
ContactGroupsApi	contactGroupsGet	GET /api/v1/ContactGroups/{id}	Returns contact group by id
ContactGroupsApi	contactGroupsGetList	GET /api/v1/ContactGroups/subscription/{subscriptionId}/groups	Returns contact groups by subscriptionId
ContactGroupsApi	contactGroupsUpdate	PUT /api/v1/ContactGroups/{id}	Updates contact group by id
ContactsApi	contactsCreate	POST /api/v1/Contacts/contact	Creates new contact
ContactsApi	contactsDelete	DELETE /api/v1/Contacts/{id}	Removes contact by id
ContactsApi	contactsGet	GET /api/v1/Contacts/{id}	Returns contact group by id
ContactsApi	contactsGetByGroup	GET /api/v1/Contacts/group/{groupId}/contacts	Returns contacts by group id
ContactsApi	contactsGetList	GET /api/v1/Contacts/subscription/{subscriptionId}/contacts	Allows to search for contacts
ContactsApi	contactsUpdate	PUT /api/v1/Contacts/{id}	Updates contact by id
DataSourcesApi	dataSourcesCountDataSourcesAsync	GET /api/data/v1/DataSources/{subscriptionId}/count	Returns a number of data sources in subscription
DataSourcesApi	dataSourcesCreateDataSource	POST /api/data/v1/DataSources	Create new data source
DataSourcesApi	dataSourcesDeleteDataSource	DELETE /api/data/v1/DataSources/{id}	Delete data source by id
DataSourcesApi	dataSourcesFetchData	GET /api/data/v1/DataSources/{id}/fetch	This should connect to a database and set data structure
DataSourcesApi	dataSourcesGetAvailableDataSources	GET /api/data/v1/DataSources	Returns all of the data sources, that current user have permission for in a subscription <br /> The method will return minimal infomration about the datasources: <br /> id, name, editedTime, status.
DataSourcesApi	dataSourcesGetDataSource	GET /api/data/v1/DataSources/{id}	Get data source by id
DataSourcesApi	dataSourcesGetParameterTypes	GET /api/data/v1/DataSources/parameterTypes/{dataSourceType}	Get data source parameter DataType's
DataSourcesApi	dataSourcesGetPermissions	GET /api/data/v1/DataSources/{id}/permissions	Get all Data source permissions
DataSourcesApi	dataSourcesRenameDataSource	PUT /api/data/v1/DataSources/{id}/rename	Rename data source by id
DataSourcesApi	dataSourcesUpdateConnectionString	PUT /api/data/v1/DataSources/{id}/connectionString	Update data source's connection string by id
DataSourcesApi	dataSourcesUpdatePermissions	POST /api/data/v1/DataSources/{id}/permissions	Update permissions
DataSourcesApi	dataSourcesUpdateSelectCommands	PUT /api/data/v1/DataSources/{id}/selectCommands	Update data source's select commands by id
DataSourcesApi	dataSourcesUpdateSubscriptionDataSource	PUT /api/data/v1/DataSources/{id}/updateSubscription	Update data source's subscription
DownloadApi	downloadGetExport	GET /download/e/{id}	Returns a export file with specified id
DownloadApi	downloadGetExportThumbnail	GET /download/e/{id}/thumbnail	Returns export's thumbnail
DownloadApi	downloadGetExports	GET /download/es/{archiveName}	Returns a zip archive with selected ids
DownloadApi	downloadGetLastSVGExport	GET /download/lastPreview/{reportId}	returns export, that was created from report with specified id. INTERNAL USAGE ONLY!
DownloadApi	downloadGetReport	GET /download/r/{id}	Returns a prepared file with specified id
DownloadApi	downloadGetReportThumbnail	GET /download/r/{id}/thumbnail	Returns report's thumbnail
DownloadApi	downloadGetReports	GET /download/rs/{archiveName}	Returns a zip archive with selected files
DownloadApi	downloadGetTemplate	GET /download/t/{id}	Returns a Template file with specified id
DownloadApi	downloadGetTemplateThumbnail	GET /download/t/{id}/thumbnail	Returns template's thumbnail
DownloadApi	downloadGetTemplates	GET /download/ts/{archiveName}	Returns a zip archive with selected files
ExportsApi	exportFolderAndFileClearRecycleBin	DELETE /api/rp/v1/Exports/{subscriptionId}/ClearRecycleBin	Delete all folders and files from recycle bin
ExportsApi	exportFolderAndFileCopyFiles	POST /api/rp/v1/Exports/{subscriptionId}/CopyFiles	Copy folders and files to a specified folder
ExportsApi	exportFolderAndFileCountRecycleBinFoldersAndFiles	GET /api/rp/v1/Exports/{subscriptionId}/CountRecycleBinFolderAndFiles	Count all folders and files from recycle bin
ExportsApi	exportFolderAndFileDeleteFiles	POST /api/rp/v1/Exports/{subscriptionId}/DeleteFiles	Delete folders and files
ExportsApi	exportFolderAndFileGetCount	GET /api/rp/v1/Exports/Folder/{id}/CountFolderAndFiles	Get count of files and folders what contains in a specified folder
ExportsApi	exportFolderAndFileGetFoldersAndFiles	GET /api/rp/v1/Exports/Folder/{id}/ListFolderAndFiles	Get all folders and files from specified folder
ExportsApi	exportFolderAndFileGetRecycleBinFoldersAndFiles	GET /api/rp/v1/Exports/{subscriptionId}/ListRecycleBinFolderAndFiles	Get all folders and files from recycle bin
ExportsApi	exportFolderAndFileMoveFiles	POST /api/rp/v1/Exports/{subscriptionId}/MoveFiles	Move folders and files to a specified folder
ExportsApi	exportFolderAndFileMoveFilesToBin	POST /api/rp/v1/Exports/{subscriptionId}/ToBin	Move folders and files to bin
ExportsApi	exportFolderAndFileRecoverAllFromRecycleBin	POST /api/rp/v1/Exports/{subscriptionId}/RecoverRecycleBin	Recover all folders and files from recycle bin
ExportsApi	exportFolderAndFileRecoverFiles	POST /api/rp/v1/Exports/{subscriptionId}/RecoverFiles	Recover folders and files from bin
ExportsApi	exportFoldersCalculateFolderSize	GET /api/rp/v1/Exports/Folder/{id}/size	Get specified folder, calculate it's size
ExportsApi	exportFoldersCopyFolder	POST /api/rp/v1/Exports/Folder/{id}/Copy/{folderId}	Move folder to a specified folder
ExportsApi	exportFoldersDeleteFolder	DELETE /api/rp/v1/Exports/Folder/{id}	Delete specified folder
ExportsApi	exportFoldersGetBreadcrumbs	GET /api/rp/v1/Exports/Folder/{id}/Breadcrumbs	Get specified folder breadcrumbs
ExportsApi	exportFoldersGetFolder	GET /api/rp/v1/Exports/Folder/{id}	Get specified folder
ExportsApi	exportFoldersGetFolders	GET /api/rp/v1/Exports/Folder/{id}/ListFolders	Get all folders from specified folder
ExportsApi	exportFoldersGetFoldersCount	GET /api/rp/v1/Exports/Folder/{id}/CountFolders	Get count of folders what contains in a specified folder
ExportsApi	exportFoldersGetOrCreate	GET /api/rp/v1/Exports/Folder/getOrCreate	Get specified folder
ExportsApi	exportFoldersGetPermissions	GET /api/rp/v1/Exports/Folder/{id}/permissions	Get all folder permissions
ExportsApi	exportFoldersGetRootFolder	GET /api/rp/v1/Exports/Root	Get user's root folder (without parents)
ExportsApi	exportFoldersMoveFolder	POST /api/rp/v1/Exports/Folder/{id}/Move/{folderId}	Move folder to a specified folder
ExportsApi	exportFoldersMoveFolderToBin	DELETE /api/rp/v1/Exports/Folder/{id}/ToBin	Move specified folder to recycle bin
ExportsApi	exportFoldersPostFolder	POST /api/rp/v1/Exports/Folder/{id}/Folder	Create folder
ExportsApi	exportFoldersRecoverFolder	POST /api/rp/v1/Exports/Folder/{id}/Recover	Recover specified folder
ExportsApi	exportFoldersRenameFolder	PUT /api/rp/v1/Exports/Folder/{id}/Rename	Rename a folder
ExportsApi	exportFoldersUpdateIcon	PUT /api/rp/v1/Exports/Folder/{id}/Icon	Update a folder's icon
ExportsApi	exportFoldersUpdatePermissions	POST /api/rp/v1/Exports/{id}/permissions	Update permissions
ExportsApi	exportFoldersUpdateTags	PUT /api/rp/v1/Exports/Folder/{id}/UpdateTags	Update tags
ExportsApi	exportsCopyFile	POST /api/rp/v1/Exports/File/{id}/Copy/{folderId}	Copy file to a specified folder
ExportsApi	exportsCreateSharingKey	POST /api/rp/v1/Exports/File/{id}/sharingKey	Create a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)
ExportsApi	exportsDeleteFile	DELETE /api/rp/v1/Exports/File/{id}	Delete specified file
ExportsApi	exportsDeleteSharingKey	DELETE /api/rp/v1/Exports/File/{id}/sharingKey	Deletes a sharing key, making links, that utilizing it no longer work
ExportsApi	exportsGetFile	GET /api/rp/v1/Exports/File/{id}	Get export by specified id
ExportsApi	exportsGetFileHistory	GET /api/rp/v1/Exports/File/{id}/History	Returns list of actions, performed on this file
ExportsApi	exportsGetFilesCount	GET /api/rp/v1/Exports/Folder/{id}/CountFiles	Get count of files what contains in a specified folder
ExportsApi	exportsGetFilesList	GET /api/rp/v1/Exports/Folder/{id}/ListFiles	Get all files from specified folder. <br /> User with Get Entity permission can access this method. <br /> The method will returns minimal infomration about the file: <br /> id, name, size, editedTime, createdTime, tags, status, statusReason.
ExportsApi	exportsGetPermissions	GET /api/rp/v1/Exports/File/{id}/permissions
ExportsApi	exportsGetSharingKeys	GET /api/rp/v1/Exports/File/{id}/sharingKeys	Returns all sharing keys, associated with the file
ExportsApi	exportsMoveFile	POST /api/rp/v1/Exports/File/{id}/Move/{folderId}	Move file to a specified folder
ExportsApi	exportsMoveFileToBin	DELETE /api/rp/v1/Exports/File/{id}/ToBin	Move specified file to recycle bin
ExportsApi	exportsRecoverFile	POST /api/rp/v1/Exports/File/{id}/Recover	Recover specified file from bin
ExportsApi	exportsRenameFile	PUT /api/rp/v1/Exports/File/{id}/Rename	Rename a file
ExportsApi	exportsUpdateIcon	PUT /api/rp/v1/Exports/File/{id}/Icon	Update a files's icon
ExportsApi	exportsUpdatePermissions	POST /api/rp/v1/Exports/File/{id}/permissions	Update permissions
ExportsApi	exportsUpdateTags	PUT /api/rp/v1/Exports/File/{id}/UpdateTags	Update tags
GroupUsersApi	groupUsersAddUserToGroup	PUT /api/manage/v1/Groups/{id}/Users/{userId}	Add user to the group by identifier
GroupUsersApi	groupUsersGetUsersInGroup	GET /api/manage/v1/Groups/{id}/Users	Returns users in the group by identifier
GroupUsersApi	groupUsersLeaveFromGroup	DELETE /api/manage/v1/Groups/{id}/leave	Leave from the group
GroupUsersApi	groupUsersRemoveFromGroup	DELETE /api/manage/v1/Groups/{id}/Users/{userId}	Remove user from the group by identifier
GroupsApi	groupsCreateGroup	POST /api/manage/v1/Groups	Create a new user group
GroupsApi	groupsDeleteGroup	DELETE /api/manage/v1/Groups/{id}	Delete group by identifier
GroupsApi	groupsGetGroup	GET /api/manage/v1/Groups/{id}	Gets group by identifier
GroupsApi	groupsGetGroupList	GET /api/manage/v1/Groups	Returns a list of current user's groups<br /> This method will return following data about groups : <br /> Id, Name, Created time (UTC), Edited time (UTC), creator id, <br /> editor id, subscription id
GroupsApi	groupsGetPermissions	GET /api/manage/v1/Groups/{id}/permissions	Gets group permissions by identifier
GroupsApi	groupsRenameGroup	PUT /api/manage/v1/Groups/{id}/rename	Rename group by identifier
GroupsApi	groupsUpdatePermissions	POST /api/manage/v1/Groups/{id}/permissions	Update permissions
HealthCheckApi	healthCheckDataGet	GET /api/backend/v1/HealthCheck	healthcheck
ReportsApi	reportFolderAndFileClearRecycleBin	DELETE /api/rp/v1/Reports/{subscriptionId}/ClearRecycleBin	Delete all folders and files from recycle bin
ReportsApi	reportFolderAndFileCopyFiles	POST /api/rp/v1/Reports/{subscriptionId}/CopyFiles	Copy folders and files to a specified folder
ReportsApi	reportFolderAndFileCountRecycleBinFoldersAndFiles	GET /api/rp/v1/Reports/{subscriptionId}/CountRecycleBinFolderAndFiles	Count all folders and files from recycle bin
ReportsApi	reportFolderAndFileDeleteFiles	POST /api/rp/v1/Reports/{subscriptionId}/DeleteFiles	Delete folders and files
ReportsApi	reportFolderAndFileGetCount	GET /api/rp/v1/Reports/Folder/{id}/CountFolderAndFiles	Get count of files and folders what contains in a specified folder
ReportsApi	reportFolderAndFileGetFoldersAndFiles	GET /api/rp/v1/Reports/Folder/{id}/ListFolderAndFiles	Get all folders and files from specified folder
ReportsApi	reportFolderAndFileGetRecycleBinFoldersAndFiles	GET /api/rp/v1/Reports/{subscriptionId}/ListRecycleBinFolderAndFiles	Get all folders and files from recycle bin
ReportsApi	reportFolderAndFileMoveFiles	POST /api/rp/v1/Reports/{subscriptionId}/MoveFiles	Move folders and files to a specified folder
ReportsApi	reportFolderAndFileMoveFilesToBin	POST /api/rp/v1/Reports/{subscriptionId}/ToBin	Move folders and files to bin
ReportsApi	reportFolderAndFileRecoverAllFromRecycleBin	POST /api/rp/v1/Reports/{subscriptionId}/RecoverRecycleBin	Recover all folders and files from recycle bin
ReportsApi	reportFolderAndFileRecoverFiles	POST /api/rp/v1/Reports/{subscriptionId}/RecoverFiles	Recover folders and files from bin
ReportsApi	reportFoldersCalculateFolderSize	GET /api/rp/v1/Reports/Folder/{id}/size	Get specified folder, calculate it's size
ReportsApi	reportFoldersCopyFolder	POST /api/rp/v1/Reports/Folder/{id}/Copy/{folderId}	Move folder to a specified folder
ReportsApi	reportFoldersDeleteFolder	DELETE /api/rp/v1/Reports/Folder/{id}	Delete specified folder
ReportsApi	reportFoldersExport	POST /api/rp/v1/Reports/Folder/{id}/Export	Export specified report folder to a specified format
ReportsApi	reportFoldersGetBreadcrumbs	GET /api/rp/v1/Reports/Folder/{id}/Breadcrumbs	Get specified folder breadcrumbs
ReportsApi	reportFoldersGetFolder	GET /api/rp/v1/Reports/Folder/{id}	Get specified folder
ReportsApi	reportFoldersGetFolders	GET /api/rp/v1/Reports/Folder/{id}/ListFolders	Get all folders from specified folder
ReportsApi	reportFoldersGetFoldersCount	GET /api/rp/v1/Reports/Folder/{id}/CountFolders	Get count of folders what contains in a specified folder
ReportsApi	reportFoldersGetOrCreate	GET /api/rp/v1/Reports/Folder/getOrCreate	Get specified folder
ReportsApi	reportFoldersGetPermissions	GET /api/rp/v1/Reports/Folder/{id}/permissions	Get all folder permissions
ReportsApi	reportFoldersGetRootFolder	GET /api/rp/v1/Reports/Root	Get user's root folder (without parents)
ReportsApi	reportFoldersMoveFolder	POST /api/rp/v1/Reports/Folder/{id}/Move/{folderId}	Move folder to a specified folder
ReportsApi	reportFoldersMoveFolderToBin	DELETE /api/rp/v1/Reports/Folder/{id}/ToBin	Move specified folder to recycle bin
ReportsApi	reportFoldersPostFolder	POST /api/rp/v1/Reports/Folder/{id}/Folder	Create folder
ReportsApi	reportFoldersRecoverFolder	POST /api/rp/v1/Reports/Folder/{id}/Recover	Recover specified folder
ReportsApi	reportFoldersRenameFolder	PUT /api/rp/v1/Reports/Folder/{id}/Rename	Rename a folder
ReportsApi	reportFoldersUpdateIcon	PUT /api/rp/v1/Reports/Folder/{id}/Icon	Update a folder's icon
ReportsApi	reportFoldersUpdatePermissions	POST /api/rp/v1/Reports/{id}/permissions	Update permissions
ReportsApi	reportFoldersUpdateTags	PUT /api/rp/v1/Reports/Folder/{id}/UpdateTags	Update tags
ReportsApi	reportsCopyFile	POST /api/rp/v1/Reports/File/{id}/Copy/{folderId}	Copy file to a specified folder
ReportsApi	reportsCreateSharingKey	POST /api/rp/v1/Reports/File/{id}/sharingKey	Create a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)
ReportsApi	reportsDeleteFile	DELETE /api/rp/v1/Reports/File/{id}	Delete specified file
ReportsApi	reportsDeleteSharingKey	DELETE /api/rp/v1/Reports/File/{id}/sharingKey	Deletes a sharing key, making links, that utilizing it no longer work
ReportsApi	reportsExport	POST /api/rp/v1/Reports/File/{id}/Export	Export specified report to a specified format
ReportsApi	reportsGetFile	GET /api/rp/v1/Reports/File/{id}	Get specified file
ReportsApi	reportsGetFileHistory	GET /api/rp/v1/Reports/File/{id}/History	Returns list of actions, performed on this file
ReportsApi	reportsGetFilesCount	GET /api/rp/v1/Reports/Folder/{id}/CountFiles	Get count of files what contains in a specified folder
ReportsApi	reportsGetFilesList	GET /api/rp/v1/Reports/Folder/{id}/ListFiles	Get all files from specified folder. <br /> User with Get Entity permission can access this method. <br /> The method will returns minimal infomration about the file: <br /> id, name, size, editedTime, createdTime, tags, status, statusReason.
ReportsApi	reportsGetPermissions	GET /api/rp/v1/Reports/File/{id}/permissions
ReportsApi	reportsGetSharingKeys	GET /api/rp/v1/Reports/File/{id}/sharingKeys	Returns all sharing keys, associated with the file
ReportsApi	reportsMoveFile	POST /api/rp/v1/Reports/File/{id}/Move/{folderId}	Move file to a specified folder
ReportsApi	reportsMoveFileToBin	DELETE /api/rp/v1/Reports/File/{id}/ToBin	Move specified file to recycle bin
ReportsApi	reportsRecoverFile	POST /api/rp/v1/Reports/File/{id}/Recover	Recover specified file from bin
ReportsApi	reportsRenameFile	PUT /api/rp/v1/Reports/File/{id}/Rename	Rename a file
ReportsApi	reportsStaticPreview	POST /api/rp/v1/Reports/File/{id}/StaticPreview	Make preview for the report. Generate a new or return exist prepared svg files. If template was changed will be returned a new. Pass the `` parameter to check prepared timestamp
ReportsApi	reportsUpdateIcon	PUT /api/rp/v1/Reports/File/{id}/Icon	Update a files's icon
ReportsApi	reportsUpdatePermissions	POST /api/rp/v1/Reports/File/{id}/permissions	Update permissions
ReportsApi	reportsUpdateTags	PUT /api/rp/v1/Reports/File/{id}/UpdateTags	Update tags
ReportsApi	reportsUploadFile	POST /api/rp/v1/Reports/Folder/{id}/File	Upload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!
ReportsApi	reportsUploadFileV2	POST /api/rp/v2/Reports/Folder/{id}/File	Alternative api for upload a file to the specified folder!
SubscriptionGroupsApi	subscriptionGroupsCountGroupsAsync	GET /api/manage/v1/Subscriptions/{subscriptionId}/count	Returns a number of groups in subscription
SubscriptionGroupsApi	subscriptionGroupsGetGroupsList	GET /api/manage/v1/Subscriptions/{subscriptionId}/groups	returns groups of the subscription or subscription user
SubscriptionInvitesApi	subscriptionInvitesAcceptInvite	GET /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accessToken}/accept	Add a user to the subscription using invite, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.
SubscriptionInvitesApi	subscriptionInvitesCreateInvite	POST /api/manage/v1/Subscriptions/{subscriptionId}/invite	Create invite to subscription
SubscriptionInvitesApi	subscriptionInvitesDeleteInvite	DELETE /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accesstoken}	Delete invite with specified token
SubscriptionInvitesApi	subscriptionInvitesGetInvites	GET /api/manage/v1/Subscriptions/{subscriptionId}/invites	Get list of invites in a subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.
SubscriptionPlansApi	subscriptionPlansGetSubscriptionPlan	GET /api/manage/v1/SubscriptionPlans/{id}	Returns a subscription plan. Not all subscriptions can be issued for customer.
SubscriptionPlansApi	subscriptionPlansGetSubscriptionPlans	GET /api/manage/v1/SubscriptionPlans	Returns a list of active subscription plans that can be issued to the user.
SubscriptionUsersApi	subscriptionUsersAddUser	PUT /api/manage/v1/Subscriptions/{subscriptionId}/users/{userId}	Add a user to the subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.
SubscriptionUsersApi	subscriptionUsersCountUsersAsync	GET /api/manage/v1/Subscriptions/{subscriptionId}/UsersCount	Returns a number of users in subscription
SubscriptionUsersApi	subscriptionUsersGetUsers	GET /api/manage/v1/Subscriptions/{subscriptionId}/users	Returns all users of subscription
SubscriptionUsersApi	subscriptionUsersLeaveSubscripiton	DELETE /api/manage/v1/Subscriptions/{subscriptionId}/leave	Allows user to leave subscription,.
SubscriptionUsersApi	subscriptionUsersRemoveUser	DELETE /api/manage/v1/Subscriptions/{subscriptionId}/users/{userId}	Delete a user from the subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.
SubscriptionsApi	subscriptionsGetDefaultPermissions	GET /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions	Get subscription's default permissions for new entities
SubscriptionsApi	subscriptionsGetMyPermissions	GET /api/manage/v1/Subscriptions/{subId}/mypermissions	Get user's permissions for a subscription by id
SubscriptionsApi	subscriptionsGetPermissions	GET /api/manage/v1/Subscriptions/{id}/permissions	Get permissions for a subscription by id
SubscriptionsApi	subscriptionsGetSubscription	GET /api/manage/v1/Subscriptions/{id}	Returns the subscription by id
SubscriptionsApi	subscriptionsGetSubscriptions	GET /api/manage/v1/Subscriptions	Returns a list of all subscriptions of current user
SubscriptionsApi	subscriptionsRenameSubscription	PUT /api/manage/v1/Subscriptions/{subscriptionId}/rename	Rename subscription
SubscriptionsApi	subscriptionsUpdateDefaultPermissions	PUT /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions	Change subscription's default permissions for new entities
SubscriptionsApi	subscriptionsUpdateLocale	PUT /api/manage/v1/Subscriptions/{subscriptionId}/Locale	Update subscription's default locale
SubscriptionsApi	subscriptionsUpdatePermissions	POST /api/manage/v1/Subscriptions/{id}/permissions	Update permissions
TasksApi	tasksCreateTask	POST /api/tasks/v1/Tasks	Create a new task
TasksApi	tasksDeleteTask	DELETE /api/tasks/v1/Tasks/{taskId}	Delete a task from a storage
TasksApi	tasksGet	GET /api/tasks/v1/Tasks/{taskId}	Get a task by a specified id
TasksApi	tasksGetList	GET /api/tasks/v1/Tasks	Get tasks list
TasksApi	tasksGetPermissions	GET /api/tasks/v1/Tasks/{id}/permissions	Get all Task permissions
TasksApi	tasksRenameTask	PUT /api/tasks/v1/Tasks/{taskId}/rename	Rename a task
TasksApi	tasksRunTask	POST /api/tasks/v1/Tasks/run	Run a task from request body
TasksApi	tasksRunTaskById	POST /api/tasks/v1/Tasks/{taskId}/run	Run a task by id
TasksApi	tasksUpdatePermissions	POST /api/tasks/v1/Tasks/{id}/permissions	Update permissions
TasksApi	tasksUpdateTask	PUT /api/tasks/v1/Tasks/{taskId}	Update a task
TemplatesApi	templateFolderAndFileClearRecycleBin	DELETE /api/rp/v1/Templates/{subscriptionId}/ClearRecycleBin	Delete all folders and files from recycle bin
TemplatesApi	templateFolderAndFileCopyFiles	POST /api/rp/v1/Templates/{subscriptionId}/CopyFiles	Copy folders and files to a specified folder
TemplatesApi	templateFolderAndFileCountRecycleBinFoldersAndFiles	GET /api/rp/v1/Templates/{subscriptionId}/CountRecycleBinFolderAndFiles	Count all folders and files from recycle bin
TemplatesApi	templateFolderAndFileDeleteFiles	POST /api/rp/v1/Templates/{subscriptionId}/DeleteFiles	Delete folders and files
TemplatesApi	templateFolderAndFileGetCount	GET /api/rp/v1/Templates/Folder/{id}/CountFolderAndFiles	Get count of files and folders what contains in a specified folder
TemplatesApi	templateFolderAndFileGetFoldersAndFiles	GET /api/rp/v1/Templates/Folder/{id}/ListFolderAndFiles	Get all folders and files from specified folder
TemplatesApi	templateFolderAndFileGetRecycleBinFoldersAndFiles	GET /api/rp/v1/Templates/{subscriptionId}/ListRecycleBinFolderAndFiles	Get all folders and files from recycle bin
TemplatesApi	templateFolderAndFileMoveFiles	POST /api/rp/v1/Templates/{subscriptionId}/MoveFiles	Move folders and files to a specified folder
TemplatesApi	templateFolderAndFileMoveFilesToBin	POST /api/rp/v1/Templates/{subscriptionId}/ToBin	Move folders and files to bin
TemplatesApi	templateFolderAndFileRecoverAllFromRecycleBin	POST /api/rp/v1/Templates/{subscriptionId}/RecoverRecycleBin	Recover all folders and files from recycle bin
TemplatesApi	templateFolderAndFileRecoverFiles	POST /api/rp/v1/Templates/{subscriptionId}/RecoverFiles	Recover folders and files from bin
TemplatesApi	templateFoldersCalculateFolderSize	GET /api/rp/v1/Templates/Folder/{id}/size	Get specified folder, calculate it's size
TemplatesApi	templateFoldersCopyFolder	POST /api/rp/v1/Templates/Folder/{id}/Copy/{folderId}	Move folder to a specified folder
TemplatesApi	templateFoldersDeleteFolder	DELETE /api/rp/v1/Templates/Folder/{id}	Delete specified folder
TemplatesApi	templateFoldersExport	POST /api/rp/v1/Templates/Folder/{id}/Export	Export specified template folder to a specified format
TemplatesApi	templateFoldersGetBreadcrumbs	GET /api/rp/v1/Templates/Folder/{id}/Breadcrumbs	Get specified folder breadcrumbs
TemplatesApi	templateFoldersGetFolder	GET /api/rp/v1/Templates/Folder/{id}	Get specified folder
TemplatesApi	templateFoldersGetFolders	GET /api/rp/v1/Templates/Folder/{id}/ListFolders	Get all folders from specified folder
TemplatesApi	templateFoldersGetFoldersCount	GET /api/rp/v1/Templates/Folder/{id}/CountFolders	Get count of folders what contains in a specified folder
TemplatesApi	templateFoldersGetOrCreate	GET /api/rp/v1/Templates/Folder/getOrCreate	Get specified folder
TemplatesApi	templateFoldersGetPermissions	GET /api/rp/v1/Templates/Folder/{id}/permissions	Get all folder permissions
TemplatesApi	templateFoldersGetRootFolder	GET /api/rp/v1/Templates/Root	Get user's root folder (without parents)
TemplatesApi	templateFoldersMoveFolder	POST /api/rp/v1/Templates/Folder/{id}/Move/{folderId}	Move folder to a specified folder
TemplatesApi	templateFoldersMoveFolderToBin	DELETE /api/rp/v1/Templates/Folder/{id}/ToBin	Move specified folder to recycle bin
TemplatesApi	templateFoldersPostFolder	POST /api/rp/v1/Templates/Folder/{id}/Folder	Create folder
TemplatesApi	templateFoldersPrepare	POST /api/rp/v1/Templates/Folder/{id}/Prepare	Prepare specified template folder to report folder
TemplatesApi	templateFoldersRecoverFolder	POST /api/rp/v1/Templates/Folder/{id}/Recover	Recover specified folder
TemplatesApi	templateFoldersRenameFolder	PUT /api/rp/v1/Templates/Folder/{id}/Rename	Rename a folder
TemplatesApi	templateFoldersUpdateIcon	PUT /api/rp/v1/Templates/Folder/{id}/Icon	Update a folder's icon
TemplatesApi	templateFoldersUpdatePermissions	POST /api/rp/v1/Templates/{id}/permissions	Update permissions
TemplatesApi	templateFoldersUpdateTags	PUT /api/rp/v1/Templates/Folder/{id}/UpdateTags	Update tags
TemplatesApi	templatesCopyFile	POST /api/rp/v1/Templates/File/{id}/Copy/{folderId}	Copy file to a specified folder
TemplatesApi	templatesCreateSharingKey	POST /api/rp/v1/Templates/File/{id}/sharingKey	Create a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)
TemplatesApi	templatesDeleteFile	DELETE /api/rp/v1/Templates/File/{id}	Delete specified file
TemplatesApi	templatesDeleteSharingKey	DELETE /api/rp/v1/Templates/File/{id}/sharingKey	Deletes a sharing key, making links, that utilizing it no longer work
TemplatesApi	templatesExport	POST /api/rp/v1/Templates/File/{id}/Export	Export specified report template to a specified format
TemplatesApi	templatesGetFile	GET /api/rp/v1/Templates/File/{id}	Get specified file
TemplatesApi	templatesGetFileHistory	GET /api/rp/v1/Templates/File/{id}/History	Returns list of actions, performed on this file
TemplatesApi	templatesGetFilesCount	GET /api/rp/v1/Templates/Folder/{id}/CountFiles	Get count of files what contains in a specified folder
TemplatesApi	templatesGetFilesList	GET /api/rp/v1/Templates/Folder/{id}/ListFiles	Get all files from specified folder. <br /> User with Get Entity permission can access this method. <br /> The method will returns minimal infomration about the file: <br /> id, name, size, editedTime, createdTime, tags, status, statusReason.
TemplatesApi	templatesGetPermissions	GET /api/rp/v1/Templates/File/{id}/permissions
TemplatesApi	templatesGetSharingKeys	GET /api/rp/v1/Templates/File/{id}/sharingKeys	Returns all sharing keys, associated with the file
TemplatesApi	templatesMoveFile	POST /api/rp/v1/Templates/File/{id}/Move/{folderId}	Move file to a specified folder
TemplatesApi	templatesMoveFileToBin	DELETE /api/rp/v1/Templates/File/{id}/ToBin	Move specified file to recycle bin
TemplatesApi	templatesPrepare	POST /api/rp/v1/Templates/File/{id}/Prepare	Prepare specified template to report
TemplatesApi	templatesRecoverFile	POST /api/rp/v1/Templates/File/{id}/Recover	Recover specified file from bin
TemplatesApi	templatesRenameFile	PUT /api/rp/v1/Templates/File/{id}/Rename	Rename a file
TemplatesApi	templatesStaticPreview	POST /api/rp/v1/Templates/File/{id}/StaticPreview	Make preview for the report. Generate a new or return exist prepared svg files. If template was changed will be returned a new. Pass the `` parameter to check prepared timestamp
TemplatesApi	templatesUpdateContent	PUT /api/rp/v1/Templates/File/{id}/Content	Updates contnet of the template. The method is deprecated, use the UpdateContentV2 method instead!
TemplatesApi	templatesUpdateContentV2	PUT /api/rp/v2/Templates/File/{id}/Content	Updates contnet of the template.
TemplatesApi	templatesUpdateIcon	PUT /api/rp/v1/Templates/File/{id}/Icon	Update a files's icon
TemplatesApi	templatesUpdatePermissions	POST /api/rp/v1/Templates/File/{id}/permissions	Update permissions
TemplatesApi	templatesUpdateTags	PUT /api/rp/v1/Templates/File/{id}/UpdateTags	Update tags
TemplatesApi	templatesUploadFile	POST /api/rp/v1/Templates/Folder/{id}/File	Upload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!
TemplatesApi	templatesUploadFileV2	POST /api/rp/v2/Templates/Folder/{id}/File	Alternative api for upload a file to the specified folder!
UserNotificationsApi	userNotificationsClearNotifications	DELETE /api/manage/v1/notifications	Use this endpoint to &quot;clear&quot; your notifications
UserNotificationsApi	userNotificationsGetNotifications	GET /api/manage/v1/notifications	Use this endpoint to recieve notifications
UserProfileApi	userProfileGetMyProfile	GET /api/manage/v1/UserProfile	Return current profile of the current user
UserProfileApi	userProfileGetUserProfile	GET /api/manage/v1/UserProfile/{userId}	Return user profile by user identifier. If the user did not provide information about himself or blocked, then the endpoint will return an empty model. (only id)
UserProfileApi	userProfileUpdateMyProfile	PUT /api/manage/v1/UserProfile	Update profile of the current user
UserSettingsApi	userSettingsAcceptAgreements	POST /api/manage/v1/UserSettings/accept	Use this endpoint to accept current version of service license agreement
UserSettingsApi	userSettingsGetCurrentUserSettings	GET /api/manage/v1/UserSettings	Return current user settings.
UserSettingsApi	userSettingsUpdateMySettings	PUT /api/manage/v1/UserSettings	Update settings of the current user

Models

• AcceptAgreementsVM
• AdminAdministrate
• AdminCreate
• AdminCreateAdminGetAdminUpdateAdminDeleteAdminExecuteAdminAdministratePermission
• AdminDelete
• AdminExecute
• AdminExportFolderCreateVM
• AdminFolderCreateVM
• AdminGet
• AdminPermission
• AdminReportFolderCreateVM
• AdminSubscriptionVM
• AdminSubscriptionsVM
• AdminTemplateFolderCreateVM
• AdminUpdate
• AdminUpdateCurrentSubscriptionPlanVM
• AnalysisResultVM
• AnalysisResultsVM
• ApiKeyVM
• ApiKeysVM
• AppMixinsVM
• AuditActionVM
• AuditActionsVM
• AuditActiveStatsVM
• AuditFilePropertyChangedVM
• AuditStatVM
• AuditStatsVM
• AuditSubscriptionActionVM
• AuditTaskActionVM
• AuditType
• AuthConfigVM
• BreadcrumbsModel
• BreadcrumbsVM
• CheckUserByPasswordInternalVM
• ClearNotificationsVM
• CloudBaseVM
• ContactGroupVM
• ContactGroupsVM
• ContactVM
• ContactsVM
• CountVM
• CreateApiKeyVM
• CreateAuditActionVM
• CreateContactGroupVM
• CreateContactVM
• CreateDataSourceAdminVM
• CreateDataSourceVM
• CreateEmailTaskVM
• CreateExportReportTaskVM
• CreateExportTemplateTaskVM
• CreateFTPUploadTaskVM
• CreateFetchTaskVM
• CreateFileShareVM
• CreateGroupAdminVM
• CreateGroupVM
• CreateIfNotExistInternalVM
• CreatePrepareTemplateTaskVM
• CreateSubscriptionInviteVM
• CreateSubscriptionPeriodVM
• CreateSubscriptionPlanVM
• CreateSubscriptionVM
• CreateTaskBaseVM
• CreateTaskEndVM
• CreateThumbnailReportTaskVM
• CreateThumbnailTemplateTaskVM
• CreateTransformTaskBaseVM
• CreateTransportTaskBaseVM
• CreateWebhookTaskVM
• DataSourceAdministrate
• DataSourceConnectionType
• DataSourceCreate
• DataSourceDelete
• DataSourceExecute
• DataSourceGet
• DataSourceParameterTypeVM
• DataSourceParameterTypesVM
• DataSourcePermissionCRUDVM
• DataSourcePermissionsCRUDVM
• DataSourcePermissionsVM
• DataSourceSelectCommandParameterVM
• DataSourceSelectCommandVM
• DataSourceSorting
• DataSourceStatus
• DataSourceUpdate
• DataSourceVM
• DataSourcesVM
• DefaultPermissionsVM
• DeleteApiKeyVM
• EmailTaskVM
• EntityType
• ExportCreateAdminVM
• ExportCreateVM
• ExportFolderCreateVM
• ExportFormat
• ExportReportTaskVM
• ExportReportVM
• ExportTemplateTaskVM
• ExportTemplateVM
• ExportVM
• ExportsVM
• FTPUploadTaskVM
• FetchTaskVM
• FileAdministrate
• FileContentVM
• FileCreate
• FileCreateFormVM
• FileCreateVM
• FileDelete
• FileExecute
• FileGet
• FileIconVM
• FileKind
• FilePermissionCRUDVM
• FilePermissionsCRUDVM
• FilePermissionsVM
• FileRenameVM
• FileShareVM
• FileSharingKeysVM
• FileSorting
• FileStatus
• FileStatusReason
• FileStatusUpdateInternalVM
• FileStatusVM
• FileTagsUpdateVM
• FileThumbnailUpdateInternalVM
• FileType
• FileUpdate
• FileUpdateVM
• FileVM
• FilesVM
• FilesVMBase
• FolderCreateVM
• FolderIconVM
• FolderRenameVM
• FolderSizeVM
• FolderTagsUpdateVM
• FrontendAppVM
• GroupAdministrate
• GroupCreate
• GroupDelete
• GroupExecute
• GroupGet
• GroupPermissionCRUDVM
• GroupPermissionsCRUDVM
• GroupPermissionsVM
• GroupUpdate
• GroupUserVM
• GroupUsersVM
• GroupVM
• GroupsVM
• HttpValidationProblemDetails
• InputFileVM
• InvitedUser
• MyPermissionsVM
• OutputFileVM
• PrepareTemplateTaskVM
• PrepareTemplateVM
• PreviewReportVM
• PreviewTemplateVM
• ProblemDetails
• ProblemLevel
• ProblemType
• ProfileVisibility
• RegisterUserVM
• RenameDataSourceVM
• RenameGroupVM
• RenameSubscriptionVM
• ReportCreateAdminVM
• ReportCreateFormVM
• ReportCreateVM
• ReportFolderCreateVM
• ReportInfo
• ReportVM
• ReportsVM
• RestOfSpaceVM
• RunEmailTaskVM
• RunExportReportTaskVM
• RunExportTemplateTaskVM
• RunFTPUploadTaskVM
• RunFetchTaskVM
• RunInputFileVM
• RunPrepareTemplateTaskVM
• RunTaskBaseVM
• RunThumbnailReportTaskVM
• RunThumbnailTemplateTaskVM
• RunTransformTaskBaseVM
• RunTransportTaskBaseVM
• RunWebhookTaskVM
• SaveMode
• SelectedFilesVM
• ServerConfigurationVM
• SolvationReportVM
• SubscriptionAdministrate
• SubscriptionCreate
• SubscriptionDelete
• SubscriptionExecute
• SubscriptionFolder
• SubscriptionGet
• SubscriptionInviteVM
• SubscriptionInvitesVM
• SubscriptionPeriodVM
• SubscriptionPermissionCRUDVM
• SubscriptionPermissionsCRUDVM
• SubscriptionPermissionsVM
• SubscriptionPlanVM
• SubscriptionPlansVM
• SubscriptionUpdate
• SubscriptionUserVM
• SubscriptionUsersVM
• SubscriptionVM
• SubscriptionsVM
• TaskAdministrate
• TaskBaseVM
• TaskCreate
• TaskDelete
• TaskEnd
• TaskExecute
• TaskGet
• TaskIdsVM
• TaskMessageIdVM
• TaskPermissionCRUDVM
• TaskPermissionsCRUDVM
• TaskPermissionsVM
• TaskSettingsVM
• TaskUpdate
• TasksVM
• TemplateContentVM
• TemplateCreateAdminVM
• TemplateCreateFormVM
• TemplateCreateVM
• TemplateFolderCreateVM
• TemplateVM
• TemplatesVM
• ThumbnailReportTaskVM
• ThumbnailTemplateTaskVM
• TimePeriodType
• TransformTaskBaseVM
• TransportTaskBaseVM
• UpdateContactGroupVM
• UpdateContactVM
• UpdateContentInternalVM
• UpdateDataSourceConnectionStringVM
• UpdateDataSourcePermissionsVM
• UpdateDataSourceSelectCommandsVM
• UpdateDataSourceSubscriptionVM
• UpdateDataSourceVM
• UpdateDataVM
• UpdateDefaultPermissionsVM
• UpdateEmailTaskVM
• UpdateExportReportTaskVM
• UpdateExportTemplateTaskVM
• UpdateFTPUploadTaskVM
• UpdateFetchTaskVM
• UpdateFileContentFormVM
• UpdateFileContentInternalVM
• UpdateFileContentVM
• UpdateFilePermissionsVM
• UpdateGroupPermissionsVM
• UpdateGroupVM
• UpdatePrepareTemplateTaskVM
• UpdateSubscriptionLocaleVM
• UpdateSubscriptionPermissionsVM
• UpdateSubscriptionPlanVM
• UpdateSubscriptionVM
• UpdateTaskBaseVM
• UpdateTaskPermissionsVM
• UpdateThumbnailReportTaskVM
• UpdateThumbnailTemplateTaskVM
• UpdateTransformTaskBaseVM
• UpdateTransportTaskBaseVM
• UpdateUserProfileVM
• UpdateUserSettingsVM
• UpdateUserVM
• UpdateWebhookTaskVM
• UserIsAdminVM
• UserProfileVM
• UserResultVM
• UserSettingsVM
• UserVM
• UsersVM
• WebhookTaskVM

Authorization

JWT

• Type: Bearer authentication (JWT)

ApiKey

• Type: HTTP basic authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

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

• API version: v1
• Build package: org.openapitools.codegen.languages.PhpClientCodegen