yellowgrid-api-ts 3.2.101-dev.0 → 3.2.103-dev.0

package/docs/AccountPageDetailsDTO.md

@@ -0,0 +1,35 @@
+# AccountPageDetailsDTO
+
+Account Page Details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**xeroId** | **string** | Xero ID | [optional] [default to undefined]
+**companyName** | **string** | Company | [optional] [default to undefined]
+**billingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
+**defaultShippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
+**previousShippingAddreses** | [**Array<AddressModel>**](AddressModel.md) | Addresses | [optional] [default to undefined]
+**portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
+**cname** | **string** | CNAME | [optional] [default to undefined]
+**prizesEnabled** | **boolean** | Prizes Enabled | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AccountPageDetailsDTO } from 'yellowgrid-api-ts';
+
+const instance: AccountPageDetailsDTO = {
+    xeroId,
+    companyName,
+    billingAddress,
+    defaultShippingAddress,
+    previousShippingAddreses,
+    portalAccess,
+    cname,
+    prizesEnabled,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AccountsApi.md

@@ -9,11 +9,15 @@ All URIs are relative to *https://localhost*
 |[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
 |[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
 |[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
+|[**getGetAccountPageInfo**](#getgetaccountpageinfo) | **GET** /{id} | |
 |[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
 |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
 |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
 |[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
+|[**patchSetPortalAccess**](#patchsetportalaccess) | **PATCH** /{id}/portal/access/{state} | |
+|[**patchSetPrizePromo**](#patchsetprizepromo) | **PATCH** /{id}/prizes/{state} | |
 |[**patchSetTcxWizardCname**](#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | |
+|[**patchUpdateAccountCname**](#patchupdateaccountcname) | **PATCH** /{id}/cname | |
 |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
 |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
 |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
@@ -23,6 +27,8 @@ All URIs are relative to *https://localhost*
 |[**postSendPasswordReset**](#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email|
 |[**postSubmitResellerApplication**](#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application|
 |[**putUpdateAccountContact**](#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact|
+|[**putUpdateBillingAddress**](#putupdatebillingaddress) | **PUT** /{id}/billing/address | |
+|[**putUpdateShippingAddress**](#putupdateshippingaddress) | **PUT** /{id}/shipping/address | |
 
 # **deleteDeleteClientCredentials**
 > deleteDeleteClientCredentials()
@@ -287,6 +293,60 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getGetAccountPageInfo**
+> AccountPageDetailsDTO getGetAccountPageInfo()
+
+Get Account Page Details
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Xero ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetAccountPageInfo(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Xero ID | defaults to undefined|
+
+
+### Return type
+
+**AccountPageDetailsDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Accounts Page Details |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **getGetAccounts**
 > AccountsResponseModel getGetAccounts()
 
@@ -498,6 +558,120 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **patchSetPortalAccess**
+> patchSetPortalAccess()
+
+Set Account Portal Access
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Xero ID (default to undefined)
+let state: 'enable' | 'disable'; //Portal Access State (default to undefined)
+
+const { status, data } = await apiInstance.patchSetPortalAccess(
+    id,
+    state
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Xero ID | defaults to undefined|
+| **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | Portal Access State | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **patchSetPrizePromo**
+> patchSetPrizePromo()
+
+Set Account Prize Promo
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Xero ID (default to undefined)
+let state: 'enable' | 'disable'; //Prize Promo State (default to undefined)
+
+const { status, data } = await apiInstance.patchSetPrizePromo(
+    id,
+    state
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Xero ID | defaults to undefined|
+| **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | Prize Promo State | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **patchSetTcxWizardCname**
 > patchSetTcxWizardCname()
 
@@ -509,16 +683,16 @@ Set 3CX Wizard CNAME
 import {
     AccountsApi,
     Configuration,
-    PatchSetTcxWizardCnameRequest
+    PatchUpdateAccountCnameRequest
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new AccountsApi(configuration);
 
-let patchSetTcxWizardCnameRequest: PatchSetTcxWizardCnameRequest; //CNAME Request (optional)
+let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
 
 const { status, data } = await apiInstance.patchSetTcxWizardCname(
-    patchSetTcxWizardCnameRequest
+    patchUpdateAccountCnameRequest
 );
 ```
 
@@ -526,7 +700,7 @@ const { status, data } = await apiInstance.patchSetTcxWizardCname(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **patchSetTcxWizardCnameRequest** | **PatchSetTcxWizardCnameRequest**| CNAME Request | |
+| **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
 
 
 ### Return type
@@ -553,6 +727,64 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **patchUpdateAccountCname**
+> patchUpdateAccountCname()
+
+Set Account Prize Promo
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration,
+    PatchUpdateAccountCnameRequest
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Xero ID (default to undefined)
+let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
+
+const { status, data } = await apiInstance.patchUpdateAccountCname(
+    id,
+    patchUpdateAccountCnameRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
+| **id** | [**string**] | Xero ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **patchUpdateAccountContactPassword**
 > patchUpdateAccountContactPassword()
 
@@ -1049,3 +1281,119 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **putUpdateBillingAddress**
+> putUpdateBillingAddress()
+
+Update Account Billing Address
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration,
+    AddressModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Xero ID (default to undefined)
+let addressModel: AddressModel; //Updated Billing Address (optional)
+
+const { status, data } = await apiInstance.putUpdateBillingAddress(
+    id,
+    addressModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **addressModel** | **AddressModel**| Updated Billing Address | |
+| **id** | [**string**] | Xero ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **putUpdateShippingAddress**
+> putUpdateShippingAddress()
+
+Update Account Shipping Address
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration,
+    AddressModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Xero ID (default to undefined)
+let addressModel: AddressModel; //Updated Shipping Address (optional)
+
+const { status, data } = await apiInstance.putUpdateShippingAddress(
+    id,
+    addressModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **addressModel** | **AddressModel**| Updated Shipping Address | |
+| **id** | [**string**] | Xero ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/AdminNumberPortDTO.md

@@ -25,6 +25,8 @@ Name | Type | Description | Notes
 **statusText** | **string** | Status Text | [optional] [default to undefined]
 **ticketId** | **number** | Ticket ID | [optional] [default to undefined]
 **notes** | [**Array<NumberPortNoteDTO>**](NumberPortNoteDTO.md) | Notes | [optional] [default to undefined]
+**cloas** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
+**createdAt** | **string** | Created At | [optional] [default to undefined]
 
 ## Example
 
@@ -51,6 +53,8 @@ const instance: AdminNumberPortDTO = {
     statusText,
     ticketId,
     notes,
+    cloas,
+    createdAt,
 };
 ```
 

package/docs/BatchDTO.md

@@ -0,0 +1,59 @@
+# BatchDTO
+
+Batch DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**supplierId** | **number** | supplierId | [optional] [default to undefined]
+**poNumber** | **string** | poNumber | [optional] [default to undefined]
+**carriage** | **number** | carriage | [optional] [default to undefined]
+**courier** | **string** | courier | [optional] [default to undefined]
+**courierService** | **string** | courierService | [optional] [default to undefined]
+**courierReference** | **string** | courierReference | [optional] [default to undefined]
+**courierUnique** | **string** | courierUnique | [optional] [default to undefined]
+**notes** | **string** | notes | [optional] [default to undefined]
+**ordered** | **number** | ordered | [optional] [default to undefined]
+**carriagePaid** | **number** | carriagePaid | [optional] [default to undefined]
+**carriageRefunded** | **number** | carriageRefunded | [optional] [default to undefined]
+**carriageRefundedDue** | **number** | carriageRefundedDue | [optional] [default to undefined]
+**netdespatchLabel** | **string** | netdespatchLabel | [optional] [default to undefined]
+**courierBoxes** | **number** | courierBoxes | [optional] [default to undefined]
+**mac** | **string** | mac | [optional] [default to undefined]
+**shipments** | [**Array<ShipmentDTO>**](ShipmentDTO.md) | Shipments | [optional] [default to undefined]
+**items** | [**Array<OrderedItemModel>**](OrderedItemModel.md) | Items | [optional] [default to undefined]
+**supplier** | [**SupplierModel**](SupplierModel.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BatchDTO } from 'yellowgrid-api-ts';
+
+const instance: BatchDTO = {
+    id,
+    orderId,
+    supplierId,
+    poNumber,
+    carriage,
+    courier,
+    courierService,
+    courierReference,
+    courierUnique,
+    notes,
+    ordered,
+    carriagePaid,
+    carriageRefunded,
+    carriageRefundedDue,
+    netdespatchLabel,
+    courierBoxes,
+    mac,
+    shipments,
+    items,
+    supplier,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreditNoteDTO.md

@@ -0,0 +1,21 @@
+# CreditNoteDTO
+
+Credit Note
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<CreditNoteItemDTO>**](CreditNoteItemDTO.md) | Items | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditNoteDTO } from 'yellowgrid-api-ts';
+
+const instance: CreditNoteDTO = {
+    items,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreditNoteEntity.md

@@ -0,0 +1,29 @@
+# CreditNoteEntity
+
+CreditNotesEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**transactionId** | **string** | transactionId | [optional] [default to undefined]
+**amount** | **number** | amount | [optional] [default to undefined]
+**timestamp** | **string** | timestamp | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditNoteEntity } from 'yellowgrid-api-ts';
+
+const instance: CreditNoteEntity = {
+    id,
+    orderId,
+    transactionId,
+    amount,
+    timestamp,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreditNoteItemDTO.md

@@ -0,0 +1,25 @@
+# CreditNoteItemDTO
+
+Credit Note Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**itemId** | **number** | Item ID | [optional] [default to undefined]
+**quantity** | **number** | Quantity | [optional] [default to undefined]
+**amount** | **number** | Amount | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditNoteItemDTO } from 'yellowgrid-api-ts';
+
+const instance: CreditNoteItemDTO = {
+    itemId,
+    quantity,
+    amount,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreditNoteItemEntity.md

@@ -0,0 +1,29 @@
+# CreditNoteItemEntity
+
+CreditNotesItemsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**creditNoteId** | **number** | creditNoteId | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**itemId** | **number** | itemId | [optional] [default to undefined]
+**amount** | **number** | amount | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditNoteItemEntity } from 'yellowgrid-api-ts';
+
+const instance: CreditNoteItemEntity = {
+    id,
+    creditNoteId,
+    orderId,
+    itemId,
+    amount,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreditNoteItemModel.md

@@ -0,0 +1,29 @@
+# CreditNoteItemModel
+
+Credit Note Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**creditNoteId** | **number** | creditNoteId | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**itemId** | **number** | itemId | [optional] [default to undefined]
+**amount** | **number** | amount | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditNoteItemModel } from 'yellowgrid-api-ts';
+
+const instance: CreditNoteItemModel = {
+    id,
+    creditNoteId,
+    orderId,
+    itemId,
+    amount,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreditNoteModel.md

@@ -0,0 +1,31 @@
+# CreditNoteModel
+
+Credit Note Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**transactionId** | **string** | transactionId | [optional] [default to undefined]
+**amount** | **number** | amount | [optional] [default to undefined]
+**timestamp** | **string** | timestamp | [optional] [default to undefined]
+**items** | [**Array<CreditNoteItemModel>**](CreditNoteItemModel.md) | Credit Note Items | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditNoteModel } from 'yellowgrid-api-ts';
+
+const instance: CreditNoteModel = {
+    id,
+    orderId,
+    transactionId,
+    amount,
+    timestamp,
+    items,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)