yellowgrid-api-ts 3.2.220-dev.0 → 3.2.221-dev.0

package/docs/BillingApi.md

@@ -26,13 +26,16 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**getGetBundleCallsWithCost**](#getgetbundlecallswithcost) | **GET** /billing/admin/bundleCallsWithCost | |
 |[**getGetCallTariffPlan**](#getgetcalltariffplan) | **GET** /billing/admin/callTariffPlan | |
 |[**getGetCallTariffs**](#getgetcalltariffs) | **GET** /billing/admin/callTariffs | |
+|[**getGetCallTariffsDetails**](#getgetcalltariffsdetails) | **GET** /billing/admin/callTariffs/details | |
 |[**getGetChildren**](#getgetchildren) | **GET** /billing/customer/children | |
 |[**getGetConnections**](#getgetconnections) | **GET** /billing/customer/connections | |
 |[**getGetCustomer**](#getgetcustomer) | **GET** /billing/admin/customer | |
 |[**getGetInboundTariffs**](#getgetinboundtariffs) | **GET** /billing/admin/inboundTariffs | |
+|[**getGetInboundTariffsDetails**](#getgetinboundtariffsdetails) | **GET** /billing/admin/inboundTariffs/details | |
 |[**getGetPriceGroups**](#getgetpricegroups) | **GET** /billing/admin/priceGroups | |
 |[**getGetServicePlan**](#getgetserviceplan) | **GET** /billing/admin/servicePlan | |
 |[**getGetServicePlans**](#getgetserviceplans) | **GET** /billing/admin/servicePlans | |
+|[**getGetServicesPlanDetails**](#getgetservicesplandetails) | **GET** /billing/admin/servicePlans/details | |
 |[**getGetSipTrunkList**](#getgetsiptrunklist) | **GET** /billing/customer/list/sipTrunks | |
 |[**getGetSipTrunksBilling**](#getgetsiptrunksbilling) | **GET** /billing/customer/sipTrunks | |
 |[**getGetUnconnectedCalls**](#getgetunconnectedcalls) | **GET** /billing/admin/unconnectedCalls | |
@@ -47,6 +50,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**postAddSipTrunkDDIs**](#postaddsiptrunkddis) | **POST** /billing/customer/sipTrunkDDIs | |
 |[**postGetBaseServices**](#postgetbaseservices) | **POST** /billing/admin/baseServices | |
 |[**postGetCallTariffPlan**](#postgetcalltariffplan) | **POST** /billing/admin/callTariffPlan | |
+|[**postGetConnections**](#postgetconnections) | **POST** /billing/customer/connections | |
 |[**postGetPriceGroups**](#postgetpricegroups) | **POST** /billing/admin/priceGroups | |
 |[**postGetServicePlans**](#postgetserviceplans) | **POST** /billing/admin/servicePlans | |
 |[**postGetSipTrunksBilling**](#postgetsiptrunksbilling) | **POST** /billing/customer/sipTrunks | |
@@ -63,6 +67,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**putEnableDdiBilling**](#putenableddibilling) | **PUT** /billing/customer/enableDdiBilling | |
 |[**putGetBaseServices**](#putgetbaseservices) | **PUT** /billing/admin/baseServices | |
 |[**putGetCallTariffPlan**](#putgetcalltariffplan) | **PUT** /billing/admin/callTariffPlan | |
+|[**putGetConnections**](#putgetconnections) | **PUT** /billing/customer/connections | |
 |[**putGetPriceGroups**](#putgetpricegroups) | **PUT** /billing/admin/priceGroups | |
 
 # **deleteAddCallTariffToCallTariffPlan**
@@ -1218,6 +1223,53 @@ const { status, data } = await apiInstance.getGetCallTariffs();
 This endpoint does not have any parameters.
 
 
+### Return type
+
+**Array<CallTariffPlan>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Call Tariff Plan |  -  |
+|**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)
+
+# **getGetCallTariffsDetails**
+> Array<CallTariffPlan> getGetCallTariffsDetails()
+
+Get Call Tariffs Detailed
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+const { status, data } = await apiInstance.getGetCallTariffsDetails();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
 ### Return type
 
 **Array<CallTariffPlan>**
@@ -1460,6 +1512,53 @@ 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)
 
+# **getGetInboundTariffsDetails**
+> Array<InboundTariffPlanResponse> getGetInboundTariffsDetails()
+
+Get Inbound Tariffs Detailed
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+const { status, data } = await apiInstance.getGetInboundTariffsDetails();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<InboundTariffPlanResponse>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Inbound Tariff |  -  |
+|**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)
+
 # **getGetPriceGroups**
 > Array<PriceGroup> getGetPriceGroups()
 
@@ -1584,6 +1683,53 @@ const { status, data } = await apiInstance.getGetServicePlans();
 This endpoint does not have any parameters.
 
 
+### Return type
+
+**Array<ServicePlan>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Service Plan |  -  |
+|**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)
+
+# **getGetServicesPlanDetails**
+> Array<ServicePlan> getGetServicesPlanDetails()
+
+Get Service Plans Detailed
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+const { status, data } = await apiInstance.getGetServicesPlanDetails();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
 ### Return type
 
 **Array<ServicePlan>**
@@ -2377,6 +2523,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)
 
+# **postGetConnections**
+> OutboundCli postGetConnections()
+
+Add Connection
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration,
+    ConnectionRequest
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+let billCustomerId: number; //Customer ID (optional) (default to undefined)
+let connectionRequest: ConnectionRequest; // (optional)
+
+const { status, data } = await apiInstance.postGetConnections(
+    billCustomerId,
+    connectionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **connectionRequest** | **ConnectionRequest**|  | |
+| **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**OutboundCli**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Connection |  -  |
+|**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)
+
 # **postGetPriceGroups**
 > PriceGroup postGetPriceGroups(postGetPriceGroupsRequest)
 
@@ -3280,6 +3484,67 @@ 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)
 
+# **putGetConnections**
+> OutboundCli putGetConnections()
+
+Update Connection
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration,
+    ConnectionRequest
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+let connectionId: number; //Connection ID (default to undefined)
+let billCustomerId: number; //Customer ID (optional) (default to undefined)
+let connectionRequest: ConnectionRequest; // (optional)
+
+const { status, data } = await apiInstance.putGetConnections(
+    connectionId,
+    billCustomerId,
+    connectionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **connectionRequest** | **ConnectionRequest**|  | |
+| **connectionId** | [**number**] | Connection ID | defaults to undefined|
+| **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**OutboundCli**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Connection |  -  |
+|**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)
+
 # **putGetPriceGroups**
 > PriceGroup putGetPriceGroups(putGetPriceGroupsRequest)
 

package/docs/CallTariffResponse.md

@@ -0,0 +1,26 @@
+# CallTariffResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**priceGroupId** | **number** |  | [optional] [default to undefined]
+**priceGroup** | [**PriceGroupResponse**](PriceGroupResponse.md) |  | [optional] [default to undefined]
+**tariffRate** | [**TariffRate**](TariffRate.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CallTariffResponse } from 'yellowgrid-api-ts';
+
+const instance: CallTariffResponse = {
+    id,
+    priceGroupId,
+    priceGroup,
+    tariffRate,
+};
+```
+
+[[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/ConnectionRequest.md

@@ -0,0 +1,36 @@
+# ConnectionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerId** | **number** |  | [default to undefined]
+**reference** | **string** |  | [default to undefined]
+**connectionDate** | **string** |  | [default to undefined]
+**servicePlanId** | **number** |  | [default to undefined]
+**zeroRated** | **boolean** |  | [optional] [default to undefined]
+**callTariffPlanId** | **number** |  | [optional] [default to undefined]
+**inboundTariffPlanId** | **number** |  | [optional] [default to undefined]
+**invoiceDescription** | **string** |  | [optional] [default to undefined]
+**mtSipTrunkRequest** | [**MultiTenantSipTrunkRequest**](MultiTenantSipTrunkRequest.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ConnectionRequest } from 'yellowgrid-api-ts';
+
+const instance: ConnectionRequest = {
+    customerId,
+    reference,
+    connectionDate,
+    servicePlanId,
+    zeroRated,
+    callTariffPlanId,
+    inboundTariffPlanId,
+    invoiceDescription,
+    mtSipTrunkRequest,
+};
+```
+
+[[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/InboundTariffPlanResponse.md

@@ -0,0 +1,28 @@
+# InboundTariffPlanResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**rate** | [**TariffRate**](TariffRate.md) |  | [optional] [default to undefined]
+**callTariffs** | [**Array<CallTariffResponse>**](CallTariffResponse.md) |  | [optional] [default to undefined]
+**closed** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InboundTariffPlanResponse } from 'yellowgrid-api-ts';
+
+const instance: InboundTariffPlanResponse = {
+    id,
+    name,
+    rate,
+    callTariffs,
+    closed,
+};
+```
+
+[[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/MultiTenantSipTrunkRequest.md

@@ -0,0 +1,22 @@
+# MultiTenantSipTrunkRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**isPrimary** | **boolean** |  | [default to undefined]
+**mtPrimarySipTrunkId** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MultiTenantSipTrunkRequest } from 'yellowgrid-api-ts';
+
+const instance: MultiTenantSipTrunkRequest = {
+    isPrimary,
+    mtPrimarySipTrunkId,
+};
+```
+
+[[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/PriceGroupResponse.md

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

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.220-dev.0",
+  "version": "3.2.221-dev.0",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {