WorkspacesApi.md

PDFGeneratorAPI\WorkspacesApi

All URIs are relative to https://us1.pdfgeneratorapi.com/api/v3.

Method	HTTP request	Description
deleteWorkspace()	DELETE /workspaces/{workspaceId}	Delete workspace
getWorkspace()	GET /workspaces/{workspaceId}	Get workspace

deleteWorkspace()

deleteWorkspace($workspace_id): \PDFGeneratorAPI\Model\InlineResponse2002

Delete workspace

Deletes the workspace

Example

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


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


$apiInstance = new PDFGeneratorAPI\Api\WorkspacesApi(
    // 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
);
$workspace_id = demo.example@actualreports.com; // string | Workspace identifier

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

Parameters

Name	Type	Description	Notes
workspace_id	string	Workspace identifier

Return type

\PDFGeneratorAPI\Model\InlineResponse2002

Authorization

JSONWebTokenAuth

HTTP request headers

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

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

getWorkspace()

getWorkspace($workspace_id): \PDFGeneratorAPI\Model\InlineResponse2005

Get workspace

Returns workspace information

Example

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


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


$apiInstance = new PDFGeneratorAPI\Api\WorkspacesApi(
    // 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
);
$workspace_id = demo.example@actualreports.com; // string | Workspace identifier

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

Parameters

Name	Type	Description	Notes
workspace_id	string	Workspace identifier

Return type

\PDFGeneratorAPI\Model\InlineResponse2005

Authorization

JSONWebTokenAuth

HTTP request headers

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

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