yellowgrid-api-ts 3.0.79

package/docs/Class3CXMultiTenantApi.md

@@ -0,0 +1,404 @@
+# Class3CXMultiTenantApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteGetTenant**](#deletegettenant) | **DELETE** /tcx/mt/tenants/{reference} | Delete 3CX MT Tenant|
+|[**getGetTenant**](#getgettenant) | **GET** /tcx/mt/tenants/{reference} | Get 3CX MT Tenant|
+|[**getGetTenants**](#getgettenants) | **GET** /tcx/mt/tenants | Get 3CX MT Tenants|
+|[**postAddMtDdi**](#postaddmtddi) | **POST** /tcx/mt/ddis | Add 3CX MT DDI|
+|[**postGetMtNewDdis**](#postgetmtnewddis) | **POST** /tcx/mt/changes/ddis | Get 3CX MT New DDIs|
+|[**postGetTenants**](#postgettenants) | **POST** /tcx/mt/tenants | Add 3CX MT Tenant|
+|[**postTrackMtChange**](#posttrackmtchange) | **POST** /tcx/mt/changes/track | Track 3CX MT Change|
+
+# **deleteGetTenant**
+> deleteGetTenant()
+
+Delete 3CX Starter Bundle Tenant
+
+### Example
+
+```typescript
+import {
+    Class3CXMultiTenantApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXMultiTenantApi(configuration);
+
+let reference: string; //Tenant Reference (default to undefined)
+
+const { status, data } = await apiInstance.deleteGetTenant(
+    reference
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reference** | [**string**] | Tenant Reference | 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 |
+|-------------|-------------|------------------|
+|**200** | 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)
+
+# **getGetTenant**
+> TcxMultiTenantModel getGetTenant()
+
+Get 3CX Starter Bundle Tenant
+
+### Example
+
+```typescript
+import {
+    Class3CXMultiTenantApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXMultiTenantApi(configuration);
+
+let reference: string; //Tenant Reference (default to undefined)
+
+const { status, data } = await apiInstance.getGetTenant(
+    reference
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reference** | [**string**] | Tenant Reference | defaults to undefined|
+
+
+### Return type
+
+**TcxMultiTenantModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Starter Bundle Tenant |  -  |
+|**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)
+
+# **getGetTenants**
+> TcxMultiTenantsModel getGetTenants()
+
+Get 3CX Starter Bundle Tenants
+
+### Example
+
+```typescript
+import {
+    Class3CXMultiTenantApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXMultiTenantApi(configuration);
+
+let pageSize: number; //Number Of Results (optional) (default to 20)
+let page: number; //Page Number (optional) (default to 1)
+let search: string; //Search (optional) (default to undefined)
+let status: 'Completed' | 'Outstanding' | 'Offline' | 'Failed Over'; //Status (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetTenants(
+    pageSize,
+    page,
+    search,
+    status
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
+| **page** | [**number**] | Page Number | (optional) defaults to 1|
+| **search** | [**string**] | Search | (optional) defaults to undefined|
+| **status** | [**&#39;Completed&#39; | &#39;Outstanding&#39; | &#39;Offline&#39; | &#39;Failed Over&#39;**]**Array<&#39;Completed&#39; &#124; &#39;Outstanding&#39; &#124; &#39;Offline&#39; &#124; &#39;Failed Over&#39;>** | Status | (optional) defaults to undefined|
+
+
+### Return type
+
+**TcxMultiTenantsModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Starter Bundle Tenant |  -  |
+|**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)
+
+# **postAddMtDdi**
+> MultiTenantChangeResponseModel postAddMtDdi()
+
+Add 3CX MT DDI
+
+### Example
+
+```typescript
+import {
+    Class3CXMultiTenantApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXMultiTenantApi(configuration);
+
+let areacode: string; //Area Code (default to undefined)
+
+const { status, data } = await apiInstance.postAddMtDdi(
+    areacode
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **areacode** | [**string**] | Area Code | defaults to undefined|
+
+
+### Return type
+
+**MultiTenantChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Multi-Tenant Change 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)
+
+# **postGetMtNewDdis**
+> Array<string> postGetMtNewDdis()
+
+Get 3CX MT New DDIs
+
+### Example
+
+```typescript
+import {
+    Class3CXMultiTenantApi,
+    Configuration,
+    MultiTenantChangeResponseModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXMultiTenantApi(configuration);
+
+let multiTenantChangeResponseModel: MultiTenantChangeResponseModel; //Multi-Tenant Change Request (optional)
+
+const { status, data } = await apiInstance.postGetMtNewDdis(
+    multiTenantChangeResponseModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **multiTenantChangeResponseModel** | **MultiTenantChangeResponseModel**| Multi-Tenant Change Request | |
+
+
+### Return type
+
+**Array<string>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | [string] |  -  |
+|**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)
+
+# **postGetTenants**
+> TcxMultiTenantModel postGetTenants()
+
+Add 3CX Starter Bundle Tenant
+
+### Example
+
+```typescript
+import {
+    Class3CXMultiTenantApi,
+    Configuration,
+    TcxMultiTenantModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXMultiTenantApi(configuration);
+
+let tcxMultiTenantModel: TcxMultiTenantModel; //New 3CX Starter Bundle Request (optional)
+
+const { status, data } = await apiInstance.postGetTenants(
+    tcxMultiTenantModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxMultiTenantModel** | **TcxMultiTenantModel**| New 3CX Starter Bundle Request | |
+
+
+### Return type
+
+**TcxMultiTenantModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Starter Bundle Tenant |  -  |
+|**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)
+
+# **postTrackMtChange**
+> MultiTenantChangeResponseModel postTrackMtChange()
+
+Track 3CX MT Change
+
+### Example
+
+```typescript
+import {
+    Class3CXMultiTenantApi,
+    Configuration,
+    MultiTenantChangeResponseModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXMultiTenantApi(configuration);
+
+let multiTenantChangeResponseModel: MultiTenantChangeResponseModel; //Multi-Tenant Change Request (optional)
+
+const { status, data } = await apiInstance.postTrackMtChange(
+    multiTenantChangeResponseModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **multiTenantChangeResponseModel** | **MultiTenantChangeResponseModel**| Multi-Tenant Change Request | |
+
+
+### Return type
+
+**MultiTenantChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Multi-Tenant Change 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/ClientDetailsModel.md

@@ -0,0 +1,35 @@
+# ClientDetailsModel
+
+Client Details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clientId** | **string** | Client ID | [optional] [default to undefined]
+**userId** | **number** | User ID | [optional] [default to undefined]
+**email** | **string** | Email Address | [optional] [default to undefined]
+**customerId** | **number** | Customer ID | [optional] [default to undefined]
+**xeroId** | **string** | Xero ID | [optional] [default to undefined]
+**firstName** | **string** | User First Name | [optional] [default to undefined]
+**lastName** | **string** | User Last Name | [optional] [default to undefined]
+**image** | **string** | User Profile Picture | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ClientDetailsModel } from 'yellowgrid-api-ts';
+
+const instance: ClientDetailsModel = {
+    clientId,
+    userId,
+    email,
+    customerId,
+    xeroId,
+    firstName,
+    lastName,
+    image,
+};
+```
+
+[[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/ClientModel.md

@@ -0,0 +1,27 @@
+# ClientModel
+
+OAuth client details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scopes** | **Array<string>** | OAuth 2.0 Scopes | [optional] [default to undefined]
+**client_id** | **string** | OAuth 2.0 Client ID | [optional] [default to undefined]
+**client_secret** | **string** | OAuth 2.0 Client Secret | [optional] [default to undefined]
+**created** | **string** | Creation Date | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ClientModel } from 'yellowgrid-api-ts';
+
+const instance: ClientModel = {
+    scopes,
+    client_id,
+    client_secret,
+    created,
+};
+```
+
+[[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/CompanyContractModel.md

@@ -0,0 +1,29 @@
+# CompanyContractModel
+
+Company Tech Support Contract
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contractStartDate** | **string** | Contract Start Date | [optional] [default to undefined]
+**contractEndDate** | **string** | Contract End Date | [optional] [default to undefined]
+**supportBankTime** | **string** | Contract Support Bank Hours | [optional] [default to undefined]
+**timeUsed** | **string** | Time Used | [optional] [default to undefined]
+**timeRemaining** | **string** | Time Remaining | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CompanyContractModel } from 'yellowgrid-api-ts';
+
+const instance: CompanyContractModel = {
+    contractStartDate,
+    contractEndDate,
+    supportBankTime,
+    timeUsed,
+    timeRemaining,
+};
+```
+
+[[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/ContactInfoModel.md

@@ -0,0 +1,29 @@
+# ContactInfoModel
+
+Order Contact Info
+
+## 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]
+
+## Example
+
+```typescript
+import { ContactInfoModel } from 'yellowgrid-api-ts';
+
+const instance: ContactInfoModel = {
+    firstName,
+    lastName,
+    fullName,
+    telephone,
+    vatNumber,
+};
+```
+
+[[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/ConversationModel.md

@@ -0,0 +1,35 @@
+# ConversationModel
+
+Freshdesk Ticket Conversation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **string** | Conversation Body | [optional] [default to undefined]
+**fromCustomer** | **boolean** | From Customer | [optional] [default to undefined]
+**targetEmails** | **Array<string>** | Target Email | [optional] [default to undefined]
+**senderEmail** | **string** | Sender Email | [optional] [default to undefined]
+**sender** | **string** | Sender | [optional] [default to undefined]
+**ccEmails** | **Array<string>** | CC Emails | [optional] [default to undefined]
+**createdAt** | **string** | Conversation Creation Time | [optional] [default to undefined]
+**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ConversationModel } from 'yellowgrid-api-ts';
+
+const instance: ConversationModel = {
+    body,
+    fromCustomer,
+    targetEmails,
+    senderEmail,
+    sender,
+    ccEmails,
+    createdAt,
+    attachments,
+};
+```
+
+[[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/CreditAccountEntity.md

@@ -0,0 +1,61 @@
+# CreditAccountEntity
+
+Credit Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**name** | **string** | Contact Name | [optional] [default to undefined]
+**email** | **string** | Email | [optional] [default to undefined]
+**phone** | **string** | Phone Number | [optional] [default to undefined]
+**company** | **string** | Company Name | [optional] [default to undefined]
+**companyNumber** | **string** | Company Registration Number | [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]
+**city** | **string** | City | [optional] [default to undefined]
+**county** | **string** | County | [optional] [default to undefined]
+**iso** | **string** | Country ISO Code | [optional] [default to undefined]
+**postalCode** | **string** | Post Code | [optional] [default to undefined]
+**accountNumber** | **string** | Account Number | [optional] [default to undefined]
+**xeroId** | **string** | Xero Contact ID | [optional] [default to undefined]
+**creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
+**paymentMethod** | **string** | Payment Method | [optional] [default to undefined]
+**servicePaymentMethod** | **string** | Service Payment Method | [optional] [default to undefined]
+**resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
+**creationDate** | **string** | Creation Date | [optional] [default to undefined]
+**prizePromo** | **boolean** | Prize Promo Enabled | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditAccountEntity } from 'yellowgrid-api-ts';
+
+const instance: CreditAccountEntity = {
+    id,
+    name,
+    email,
+    phone,
+    company,
+    companyNumber,
+    vatNumber,
+    addressLine1,
+    addressLine2,
+    city,
+    county,
+    iso,
+    postalCode,
+    accountNumber,
+    xeroId,
+    creditLimit,
+    paymentMethod,
+    servicePaymentMethod,
+    resellerId,
+    creationDate,
+    prizePromo,
+};
+```
+
+[[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/CustomerInformationModel.md

@@ -0,0 +1,33 @@
+# CustomerInformationModel
+
+SIP Trunk Customer
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**addressLine1** | **string** | End User Address Line 1 | [optional] [default to undefined]
+**addressLine2** | **string** | End User Address Line 2 | [optional] [default to undefined]
+**addressCity** | **string** | End User Town/City | [optional] [default to undefined]
+**addressPostcode** | **string** | End User Postal Code | [optional] [default to undefined]
+**companyName** | **string** | End User Company Name | [optional] [default to undefined]
+**contactFirstName** | **string** | End User Contact First Name | [optional] [default to undefined]
+**contactLastName** | **string** | End User Contact Surname | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomerInformationModel } from 'yellowgrid-api-ts';
+
+const instance: CustomerInformationModel = {
+    addressLine1,
+    addressLine2,
+    addressCity,
+    addressPostcode,
+    companyName,
+    contactFirstName,
+    contactLastName,
+};
+```
+
+[[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/CustomerPriceListEnum.md

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