yellowgrid-api-ts 3.2.143-dev.0 → 3.2.145-dev.0

package/docs/AccountsApi.md

@@ -17,6 +17,7 @@ All URIs are relative to *https://localhost*
 |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
 |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
 |[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
+|[**getGetTcxPartnerDetails**](#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner | |
 |[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
 |[**patchSetPortalAccess**](#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | |
 |[**patchSetPrizePromo**](#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | |
@@ -29,6 +30,8 @@ All URIs are relative to *https://localhost*
 |[**patchUpdateCreditLimit**](#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit | |
 |[**patchUpdatePriceList**](#patchupdatepricelist) | **PATCH** /admin/accounts/{id}/priceList | |
 |[**patchUpdateSipChannelCost**](#patchupdatesipchannelcost) | **PATCH** /admin/accounts/{id}/channelCost | |
+|[**patchUpdateTcxHostingPriceList**](#patchupdatetcxhostingpricelist) | **PATCH** /admin/accounts/{id}/tcx/hosting/priceList | |
+|[**patchUpdateTcxPartnerId**](#patchupdatetcxpartnerid) | **PATCH** /admin/accounts{id}/tcx/partner/id | |
 |[**postAdminCreateAccountContact**](#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts | |
 |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
 |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
@@ -736,6 +739,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)
 
+# **getGetTcxPartnerDetails**
+> PartnerDTO getGetTcxPartnerDetails()
+
+Get Account 3CX 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.getGetTcxPartnerDetails(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Xero ID | defaults to undefined|
+
+
+### Return type
+
+**PartnerDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Account 3CX Partner 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)
+
 # **getVerifyEmailAddress**
 > getVerifyEmailAddress()
 
@@ -1423,6 +1480,122 @@ 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)
 
+# **patchUpdateTcxHostingPriceList**
+> PartnerDTO patchUpdateTcxHostingPriceList()
+
+Set Account 3CX Hosting Price List
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration,
+    PatchUpdateTcxHostingPriceListRequest
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Xero ID (default to undefined)
+let patchUpdateTcxHostingPriceListRequest: PatchUpdateTcxHostingPriceListRequest; //3CX Hosting Price List Request (optional)
+
+const { status, data } = await apiInstance.patchUpdateTcxHostingPriceList(
+    id,
+    patchUpdateTcxHostingPriceListRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **patchUpdateTcxHostingPriceListRequest** | **PatchUpdateTcxHostingPriceListRequest**| 3CX Hosting Price List Request | |
+| **id** | [**string**] | Xero ID | defaults to undefined|
+
+
+### Return type
+
+**PartnerDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Account 3CX Partner 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)
+
+# **patchUpdateTcxPartnerId**
+> PartnerDTO patchUpdateTcxPartnerId()
+
+Set Account 3CX Partner ID
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration,
+    PatchUpdateTcxPartnerIdRequest
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Xero ID (default to undefined)
+let patchUpdateTcxPartnerIdRequest: PatchUpdateTcxPartnerIdRequest; //Set Account 3CX Partner ID (optional)
+
+const { status, data } = await apiInstance.patchUpdateTcxPartnerId(
+    id,
+    patchUpdateTcxPartnerIdRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **patchUpdateTcxPartnerIdRequest** | **PatchUpdateTcxPartnerIdRequest**| Set Account 3CX Partner ID | |
+| **id** | [**string**] | Xero ID | defaults to undefined|
+
+
+### Return type
+
+**PartnerDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Account 3CX Partner 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)
+
 # **postAdminCreateAccountContact**
 > postAdminCreateAccountContact()
 

package/docs/PartnerDTO.md

@@ -0,0 +1,39 @@
+# PartnerDTO
+
+3CX Partner Details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**partnerId** | **string** | 3CX Partner ID | [optional] [default to undefined]
+**companyName** | **string** | 3CX Partner Company Name | [optional] [default to undefined]
+**contactName** | **string** | 3CX Partner Contact Name | [optional] [default to undefined]
+**contactPhone** | **string** | 3CX Partner Contact Phone | [optional] [default to undefined]
+**contactEmail** | **string** | 3CX Partner Contact Email | [optional] [default to undefined]
+**partnerLevel** | **string** | 3CX Partner Level | [optional] [default to undefined]
+**licenceDiscountPercent** | **number** | 3CX Partner Licence Discount Percent | [optional] [default to undefined]
+**hostingDisountPercent** | **number** | 3CX Partner Hosting Discount Percent | [optional] [default to undefined]
+**hostingPriceList** | **string** | 3CX Hosting Price List | [optional] [default to undefined]
+**installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PartnerDTO } from 'yellowgrid-api-ts';
+
+const instance: PartnerDTO = {
+    partnerId,
+    companyName,
+    contactName,
+    contactPhone,
+    contactEmail,
+    partnerLevel,
+    licenceDiscountPercent,
+    hostingDisountPercent,
+    hostingPriceList,
+    installationUrl,
+};
+```
+
+[[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/PatchUpdateTcxHostingPriceListRequest.md

@@ -0,0 +1,20 @@
+# PatchUpdateTcxHostingPriceListRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**priceList** | **string** | Price List | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdateTcxHostingPriceListRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdateTcxHostingPriceListRequest = {
+    priceList,
+};
+```
+
+[[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/PatchUpdateTcxPartnerIdRequest.md

@@ -0,0 +1,20 @@
+# PatchUpdateTcxPartnerIdRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**partnerId** | **string** | Set Account 3CX Partner ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdateTcxPartnerIdRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdateTcxPartnerIdRequest = {
+    partnerId,
+};
+```
+
+[[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/PostGetProductForCustomerRequest.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
 **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
+**renewalYears** | **number** | 3CX Renewal Years (Upgrade Only) | [optional] [default to undefined]
 
 ## Example
 
@@ -20,6 +21,7 @@ const instance: PostGetProductForCustomerRequest = {
     licenceKey,
     hosting,
     tcxSalesCode,
+    renewalYears,
 };
 ```