OpenAPI\Client\AttachmentsApi

All URIs are relative to https://api.pocketsmith.com/v2, except if the operation defines another base path.

Method	HTTP request	Description
attachmentsIdDelete()	DELETE /attachments/{id}	Delete attachment
attachmentsIdGet()	GET /attachments/{id}	Get attachment
attachmentsIdPut()	PUT /attachments/{id}	Update attachment
transactionsIdAttachmentsGet()	GET /transactions/{id}/attachments	List attachments in transaction
transactionsIdAttachmentsPost()	POST /transactions/{id}/attachments	Assigns attachment to transaction
transactionsTransactionIdAttachmentsAttachmentIdDelete()	DELETE /transactions/{transaction_id}/attachments/{attachment_id}	Unassigns attachment in transaction
usersIdAttachmentsGet()	GET /users/{id}/attachments	Lists attachments in user
usersIdAttachmentsPost()	POST /users/{id}/attachments	Create attachment in user

`attachmentsIdDelete()`

attachmentsIdDelete($id)

Delete attachment

Deletes a particular attachment by its ID.

Example

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


// Configure API key authorization: developerKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Developer-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Developer-Key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\AttachmentsApi(
    // 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 = 42; // int | The unique identifier of the attachment.

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

Parameters

Name	Type	Description	Notes
id	int	The unique identifier of the attachment.

Return type

void (empty response body)

Authorization

developerKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`attachmentsIdGet()`

attachmentsIdGet($id): \OpenAPI\Client\Model\Attachment

Get attachment

Gets a particular attachment by its ID.

Example

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


// Configure API key authorization: developerKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Developer-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Developer-Key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\AttachmentsApi(
    // 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 = 42; // int | The unique identifier of the attachment.

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

Parameters

Name	Type	Description	Notes
id	int	The unique identifier of the attachment.

Return type

\OpenAPI\Client\Model\Attachment

Authorization

developerKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`attachmentsIdPut()`

attachmentsIdPut($id, $attachments_id_put_request): \OpenAPI\Client\Model\Attachment

Update attachment

Updates the title of the attachment.

Example

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


// Configure API key authorization: developerKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Developer-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Developer-Key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\AttachmentsApi(
    // 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 = 42; // int | The unique identifier of the attachment.
$attachments_id_put_request = new \OpenAPI\Client\Model\AttachmentsIdPutRequest(); // \OpenAPI\Client\Model\AttachmentsIdPutRequest

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

Parameters

Name	Type	Description	Notes
id	int	The unique identifier of the attachment.
attachments_id_put_request	\OpenAPI\Client\Model\AttachmentsIdPutRequest		[optional]

Return type

\OpenAPI\Client\Model\Attachment

Authorization

developerKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`transactionsIdAttachmentsGet()`

transactionsIdAttachmentsGet($id): \OpenAPI\Client\Model\Attachment[]

List attachments in transaction

Lists attachments belonging to a transaction by their ID.

Example

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


// Configure API key authorization: developerKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Developer-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Developer-Key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\AttachmentsApi(
    // 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 = 42; // int | The unique identifier of the transaction.

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

Parameters

Name	Type	Description	Notes
id	int	The unique identifier of the transaction.

Return type

\OpenAPI\Client\Model\Attachment[]

Authorization

developerKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`transactionsIdAttachmentsPost()`

transactionsIdAttachmentsPost($id, $transactions_id_attachments_post_request): \OpenAPI\Client\Model\Attachment

Assigns attachment to transaction

Assigns an attachment to the transaction by their ID.

Example

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


// Configure API key authorization: developerKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Developer-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Developer-Key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\AttachmentsApi(
    // 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 = 42; // int | The unique identifier of the transaction.
$transactions_id_attachments_post_request = new \OpenAPI\Client\Model\TransactionsIdAttachmentsPostRequest(); // \OpenAPI\Client\Model\TransactionsIdAttachmentsPostRequest

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

Parameters

Name	Type	Description	Notes
id	int	The unique identifier of the transaction.
transactions_id_attachments_post_request	\OpenAPI\Client\Model\TransactionsIdAttachmentsPostRequest		[optional]

Return type

\OpenAPI\Client\Model\Attachment

Authorization

developerKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`transactionsTransactionIdAttachmentsAttachmentIdDelete()`

transactionsTransactionIdAttachmentsAttachmentIdDelete($transaction_id, $attachment_id)

Unassigns attachment in transaction

Unassigns a particular attachment by its ID from the transaction ID. This does not delete the attachment, it only removes its association from the transaction.

Example

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


// Configure API key authorization: developerKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Developer-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Developer-Key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\AttachmentsApi(
    // 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
);
$transaction_id = 42; // int | The unique identifier of the transaction.
$attachment_id = 1438154; // int | The unique identifier of the attachment.

try {
    $apiInstance->transactionsTransactionIdAttachmentsAttachmentIdDelete($transaction_id, $attachment_id);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentsApi->transactionsTransactionIdAttachmentsAttachmentIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
transaction_id	int	The unique identifier of the transaction.
attachment_id	int	The unique identifier of the attachment.

Return type

void (empty response body)

Authorization

developerKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`usersIdAttachmentsGet()`

usersIdAttachmentsGet($id, $unassigned): \OpenAPI\Client\Model\Attachment[]

Lists attachments in user

Lists attachments belonging to a user by their ID.

Example

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


// Configure API key authorization: developerKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Developer-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Developer-Key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\AttachmentsApi(
    // 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 = 42; // int | The unique identifier of the user.
$unassigned = 1; // int | If set, returns unassigned attachments, that are available for assigning to a transaction.

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

Parameters

Name	Type	Description	Notes
id	int	The unique identifier of the user.
unassigned	int	If set, returns unassigned attachments, that are available for assigning to a transaction.	[optional]

Return type

\OpenAPI\Client\Model\Attachment[]

Authorization

developerKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`usersIdAttachmentsPost()`

usersIdAttachmentsPost($id, $users_id_attachments_post_request): \OpenAPI\Client\Model\Attachment

Create attachment in user

Creates an attachment belonging to the user by their ID.

Example

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


// Configure API key authorization: developerKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Developer-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Developer-Key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\AttachmentsApi(
    // 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 = 42; // int | The unique identifier of the user.
$users_id_attachments_post_request = new \OpenAPI\Client\Model\UsersIdAttachmentsPostRequest(); // \OpenAPI\Client\Model\UsersIdAttachmentsPostRequest

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

Parameters

Name	Type	Description	Notes
id	int	The unique identifier of the user.
users_id_attachments_post_request	\OpenAPI\Client\Model\UsersIdAttachmentsPostRequest		[optional]

Return type

\OpenAPI\Client\Model\Attachment

Authorization

developerKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

AttachmentsApi.md

Latest commit

History

AttachmentsApi.md

File metadata and controls

OpenAPI\Client\AttachmentsApi

attachmentsIdDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

attachmentsIdGet()

Example

Parameters

Return type

Authorization

HTTP request headers

attachmentsIdPut()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsIdAttachmentsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsIdAttachmentsPost()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsTransactionIdAttachmentsAttachmentIdDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

usersIdAttachmentsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

usersIdAttachmentsPost()

Example

Parameters

Return type

Authorization

HTTP request headers

`attachmentsIdDelete()`

`attachmentsIdGet()`

`attachmentsIdPut()`

`transactionsIdAttachmentsGet()`

`transactionsIdAttachmentsPost()`

`transactionsTransactionIdAttachmentsAttachmentIdDelete()`

`usersIdAttachmentsGet()`

`usersIdAttachmentsPost()`