yellowgrid-api-ts 3.0.79

package/docs/AccountsResponseModel.md

@@ -0,0 +1,27 @@
+# AccountsResponseModel
+
+Accounts
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<CreditAccountEntity>**](CreditAccountEntity.md) | Results | [optional] [default to undefined]
+**page** | **number** | Page | [optional] [default to undefined]
+**perPage** | **number** | Per Page | [optional] [default to undefined]
+**totalResults** | **number** | Total Results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AccountsResponseModel } from 'yellowgrid-api-ts';
+
+const instance: AccountsResponseModel = {
+    results,
+    page,
+    perPage,
+    totalResults,
+};
+```
+
+[[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/AddressModel.md

@@ -0,0 +1,45 @@
+# AddressModel
+
+Order Address
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**firstName** | **string** | Contact First Name | [optional] [default to undefined]
+**lastName** | **string** | Contact Last Name | [optional] [default to undefined]
+**fullName** | **string** | Contact Full Name | [optional] [default to undefined]
+**telephone** | **string** | Contact Telephone | [optional] [default to undefined]
+**vatNumber** | **string** | VAT Number | [optional] [default to undefined]
+**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
+**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
+**addressLine3** | **string** | Address Line 3 | [optional] [default to undefined]
+**city** | **string** | City | [optional] [default to undefined]
+**region** | **string** | Region | [optional] [default to undefined]
+**postalCode** | **string** | Postal Code | [optional] [default to undefined]
+**iso** | **string** | Country | [optional] [default to undefined]
+**company** | **string** | Company | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AddressModel } from 'yellowgrid-api-ts';
+
+const instance: AddressModel = {
+    firstName,
+    lastName,
+    fullName,
+    telephone,
+    vatNumber,
+    addressLine1,
+    addressLine2,
+    addressLine3,
+    city,
+    region,
+    postalCode,
+    iso,
+    company,
+};
+```
+
+[[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/AddressRequestModel.md

@@ -0,0 +1,27 @@
+# AddressRequestModel
+
+Address Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
+**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
+**addressCity** | **string** | City | [optional] [default to undefined]
+**addressPostcode** | **string** | Postal Code | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AddressRequestModel } from 'yellowgrid-api-ts';
+
+const instance: AddressRequestModel = {
+    addressLine1,
+    addressLine2,
+    addressCity,
+    addressPostcode,
+};
+```
+
+[[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/AgentHoursGraphModel.md

@@ -0,0 +1,27 @@
+# AgentHoursGraphModel
+
+Agent Hours Graph
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agentName** | **string** | Agent Name | [optional] [default to undefined]
+**months** | [**Array<AgentHoursGraphMonthModel>**](AgentHoursGraphMonthModel.md) | Agent Hours By Month | [optional] [default to undefined]
+**agentColour** | **string** | Agent Colour | [optional] [default to undefined]
+**annualHours** | **number** | Annual Hours | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgentHoursGraphModel } from 'yellowgrid-api-ts';
+
+const instance: AgentHoursGraphModel = {
+    agentName,
+    months,
+    agentColour,
+    annualHours,
+};
+```
+
+[[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/AgentHoursGraphMonthModel.md

@@ -0,0 +1,23 @@
+# AgentHoursGraphMonthModel
+
+Agent Hours Graph Month
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ticketHours** | **number** | Month Ticket Hours | [optional] [default to undefined]
+**timeEntryHours** | **number** | Month Time Entry Hours | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgentHoursGraphMonthModel } from 'yellowgrid-api-ts';
+
+const instance: AgentHoursGraphMonthModel = {
+    ticketHours,
+    timeEntryHours,
+};
+```
+
+[[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/ApiLogEntity.md

@@ -0,0 +1,43 @@
+# ApiLogEntity
+
+API Log
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | ID | [optional] [default to undefined]
+**timestamp** | **string** | Timestamp | [optional] [default to undefined]
+**method** | **string** | HTTP Method | [optional] [default to undefined]
+**uri** | **string** | URI | [optional] [default to undefined]
+**client_ip** | **string** | Client IP | [optional] [default to undefined]
+**request_headers** | **Array<string>** | Request Headers | [optional] [default to undefined]
+**request_body** | **object** | Request Body | [optional] [default to undefined]
+**client_id** | **string** | Client ID | [optional] [default to undefined]
+**response_code** | **number** | HTTP Response Code | [optional] [default to undefined]
+**response_headers** | **Array<string>** | Response Headers | [optional] [default to undefined]
+**response_body** | **object** | Response Body | [optional] [default to undefined]
+**http_origin** | **string** | HTTP Origin | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ApiLogEntity } from 'yellowgrid-api-ts';
+
+const instance: ApiLogEntity = {
+    id,
+    timestamp,
+    method,
+    uri,
+    client_ip,
+    request_headers,
+    request_body,
+    client_id,
+    response_code,
+    response_headers,
+    response_body,
+    http_origin,
+};
+```
+
+[[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/AreaCodeModel.md

@@ -0,0 +1,23 @@
+# AreaCodeModel
+
+UK Area Code
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** | Area Code | [optional] [default to undefined]
+**name** | **string** | Location | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AreaCodeModel } from 'yellowgrid-api-ts';
+
+const instance: AreaCodeModel = {
+    code,
+    name,
+};
+```
+
+[[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/AttachmentModel.md

@@ -0,0 +1,29 @@
+# AttachmentModel
+
+Ticket Attachment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Attachment ID | [optional] [default to undefined]
+**contentType** | **string** | Content Type | [optional] [default to undefined]
+**size** | **string** | Size | [optional] [default to undefined]
+**fileName** | **string** | File Name | [optional] [default to undefined]
+**attachmentUrl** | **string** | Attachment URL | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AttachmentModel } from 'yellowgrid-api-ts';
+
+const instance: AttachmentModel = {
+    id,
+    contentType,
+    size,
+    fileName,
+    attachmentUrl,
+};
+```
+
+[[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/AttributeSetEnum.md

@@ -0,0 +1,23 @@
+# AttributeSetEnum
+
+Attribute Set
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Attribute Set ID | [optional] [default to undefined]
+**name** | **string** | Attribute Set Name | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AttributeSetEnum } from 'yellowgrid-api-ts';
+
+const instance: AttributeSetEnum = {
+    id,
+    name,
+};
+```
+
+[[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/AuthCodeResponseModel.md

@@ -0,0 +1,25 @@
+# AuthCodeResponseModel
+
+OAuth Auth Code Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** | Auth Code | [optional] [default to undefined]
+**state** | **string** | State | [optional] [default to undefined]
+**redirect_uri** | **string** | Redirect URI | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthCodeResponseModel } from 'yellowgrid-api-ts';
+
+const instance: AuthCodeResponseModel = {
+    code,
+    state,
+    redirect_uri,
+};
+```
+
+[[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/BatchEntity.md

@@ -0,0 +1,53 @@
+# BatchEntity
+
+BatchesEntity
+
+## 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]
+
+## Example
+
+```typescript
+import { BatchEntity } from 'yellowgrid-api-ts';
+
+const instance: BatchEntity = {
+    id,
+    orderId,
+    supplierId,
+    poNumber,
+    carriage,
+    courier,
+    courierService,
+    courierReference,
+    courierUnique,
+    notes,
+    ordered,
+    carriagePaid,
+    carriageRefunded,
+    carriageRefundedDue,
+    netdespatchLabel,
+    courierBoxes,
+    mac,
+};
+```
+
+[[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/CallBarringModel.md

@@ -0,0 +1,29 @@
+# CallBarringModel
+
+Call Barring
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**blockPremiumCalls** | **boolean** | Block Premium Calls | [optional] [default to true]
+**blockMobileCalls** | **boolean** | Block Mobile Calls | [optional] [default to false]
+**blockInternationalCalls** | **boolean** | Block International Calls | [optional] [default to false]
+**block084Calls** | **boolean** | Block 084 Calls | [optional] [default to false]
+**block087Calls** | **boolean** | Block 087 Calls | [optional] [default to false]
+
+## Example
+
+```typescript
+import { CallBarringModel } from 'yellowgrid-api-ts';
+
+const instance: CallBarringModel = {
+    blockPremiumCalls,
+    blockMobileCalls,
+    blockInternationalCalls,
+    block084Calls,
+    block087Calls,
+};
+```
+
+[[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/Class3CXApi.md

@@ -0,0 +1,172 @@
+# Class3CXApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
+|[**getGetPasswordHash**](#getgetpasswordhash) | **GET** /tcx/pwd2hash | Convert a password to a hashed 3CX password|
+|[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
+
+# **getGetLicenceDetails**
+> TcxLicenceDetailsModel getGetLicenceDetails()
+
+Get 3CX Licence Details
+
+### Example
+
+```typescript
+import {
+    Class3CXApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXApi(configuration);
+
+let key: string; //3CX Licence Key (default to undefined)
+
+const { status, data } = await apiInstance.getGetLicenceDetails(
+    key
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **key** | [**string**] | 3CX Licence Key | defaults to undefined|
+
+
+### Return type
+
+**TcxLicenceDetailsModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Licence 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)
+
+# **getGetPasswordHash**
+> GetGetPasswordHash200Response getGetPasswordHash()
+
+Generate a 3CX hashed password for 3CX installation
+
+### Example
+
+```typescript
+import {
+    Class3CXApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXApi(configuration);
+
+let password: string; //Desired 3CX web access password (default to undefined)
+
+const { status, data } = await apiInstance.getGetPasswordHash(
+    password
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **password** | [**string**] | Desired 3CX web access password | defaults to undefined|
+
+
+### Return type
+
+**GetGetPasswordHash200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Password Hash |  -  |
+|**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)
+
+# **postGetBulkLicenceDetails**
+> TcxBulkLicenceDetailsModel postGetBulkLicenceDetails()
+
+Get Bulk 3CX Licence Details
+
+### Example
+
+```typescript
+import {
+    Class3CXApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXApi(configuration);
+
+let requestBody: Array<string>; //Licence Lookup Request (optional)
+
+const { status, data } = await apiInstance.postGetBulkLicenceDetails(
+    requestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **requestBody** | **Array<string>**| Licence Lookup Request | |
+
+
+### Return type
+
+**TcxBulkLicenceDetailsModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Licence 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)
+