Skip to content

Latest commit

 

History

History
328 lines (225 loc) · 9.93 KB

TicketApi.md

File metadata and controls

328 lines (225 loc) · 9.93 KB
Raw

NETZFABRIK\TicketApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method HTTP request Description
createMessage() POST /tickets/{id}/messages Create message
createTicket() POST /tickets Create ticket
getTicket() GET /tickets/{id} Get ticket
getTickets() GET /tickets Get tickets
replyTicket() POST /tickets/{id}/reply Reply to ticket

createMessage()

createMessage($id, $ticketMessageMessageCreate): \NETZFABRIK\Model\TicketTicketRead

Create message

Creates a Ticket resource.

Example

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


// Configure API key authorization: JWT
$config = NETZFABRIK\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NETZFABRIK\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new NETZFABRIK\Api\TicketApi(
    // 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 | Ticket identifier
$ticketMessageMessageCreate = new \NETZFABRIK\Model\TicketMessageMessageCreate(); // \NETZFABRIK\Model\TicketMessageMessageCreate | The new Ticket resource

try {
    $result = $apiInstance->createMessage($id, $ticketMessageMessageCreate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketApi->createMessage: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string Ticket identifier
ticketMessageMessageCreate \NETZFABRIK\Model\TicketMessageMessageCreate The new Ticket resource

Return type

\NETZFABRIK\Model\TicketTicketRead

Authorization

JWT

HTTP request headers

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

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

createTicket()

createTicket($ticketCreateTicketRequestTicketCreate): \NETZFABRIK\Model\TicketTicketRead

Create ticket

Creates a Ticket resource.

Example

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


// Configure API key authorization: JWT
$config = NETZFABRIK\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NETZFABRIK\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new NETZFABRIK\Api\TicketApi(
    // 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
);
$ticketCreateTicketRequestTicketCreate = new \NETZFABRIK\Model\TicketCreateTicketRequestTicketCreate(); // \NETZFABRIK\Model\TicketCreateTicketRequestTicketCreate | The new Ticket resource

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

Parameters

Name Type Description Notes
ticketCreateTicketRequestTicketCreate \NETZFABRIK\Model\TicketCreateTicketRequestTicketCreate The new Ticket resource

Return type

\NETZFABRIK\Model\TicketTicketRead

Authorization

JWT

HTTP request headers

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

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

getTicket()

getTicket($id): \NETZFABRIK\Model\TicketTicketReadMaintenanceRead

Get ticket

Retrieves a Ticket resource.

Example

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


// Configure API key authorization: JWT
$config = NETZFABRIK\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NETZFABRIK\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new NETZFABRIK\Api\TicketApi(
    // 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 | Ticket identifier

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

Parameters

Name Type Description Notes
id string Ticket identifier

Return type

\NETZFABRIK\Model\TicketTicketReadMaintenanceRead

Authorization

JWT

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/html

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

getTickets()

getTickets($page, $orderCreatedAt): \NETZFABRIK\Model\TicketTicketList[]

Get tickets

Retrieves the collection of Ticket resources.

Example

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


// Configure API key authorization: JWT
$config = NETZFABRIK\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NETZFABRIK\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new NETZFABRIK\Api\TicketApi(
    // 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
);
$page = 1; // int | The collection page number
$orderCreatedAt = 'orderCreatedAt_example'; // string | 

try {
    $result = $apiInstance->getTickets($page, $orderCreatedAt);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketApi->getTickets: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
page int The collection page number [optional] [default to 1]
orderCreatedAt string [optional]

Return type

\NETZFABRIK\Model\TicketTicketList[]

Authorization

JWT

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/html

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

replyTicket()

replyTicket($id, $ticketReplyTicketRequestMessageCreate): \NETZFABRIK\Model\TicketTicketRead

Reply to ticket

Creates a Ticket resource.

Example

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


// Configure API key authorization: JWT
$config = NETZFABRIK\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NETZFABRIK\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new NETZFABRIK\Api\TicketApi(
    // 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 | Ticket identifier
$ticketReplyTicketRequestMessageCreate = new \NETZFABRIK\Model\TicketReplyTicketRequestMessageCreate(); // \NETZFABRIK\Model\TicketReplyTicketRequestMessageCreate | The new Ticket resource

try {
    $result = $apiInstance->replyTicket($id, $ticketReplyTicketRequestMessageCreate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketApi->replyTicket: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string Ticket identifier
ticketReplyTicketRequestMessageCreate \NETZFABRIK\Model\TicketReplyTicketRequestMessageCreate The new Ticket resource

Return type

\NETZFABRIK\Model\TicketTicketRead

Authorization

JWT

HTTP request headers

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

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