yellowgrid-api-ts 3.2.256 → 3.2.258

package/README.md

@@ -121,6 +121,7 @@ Class | Method | HTTP request | Description
 *BillingApi* | [**getGetCallTariffs**](docs/BillingApi.md#getgetcalltariffs) | **GET** /billing/admin/callTariffs | 
 *BillingApi* | [**getGetCallTariffsDetails**](docs/BillingApi.md#getgetcalltariffsdetails) | **GET** /billing/admin/callTariffs/details | 
 *BillingApi* | [**getGetChildren**](docs/BillingApi.md#getgetchildren) | **GET** /billing/customer/children | 
+*BillingApi* | [**getGetConnection**](docs/BillingApi.md#getgetconnection) | **GET** /billing/customer/connections/{id} | 
 *BillingApi* | [**getGetConnections**](docs/BillingApi.md#getgetconnections) | **GET** /billing/customer/connections | 
 *BillingApi* | [**getGetCustomer**](docs/BillingApi.md#getgetcustomer) | **GET** /billing/admin/customer | 
 *BillingApi* | [**getGetInboundTariffs**](docs/BillingApi.md#getgetinboundtariffs) | **GET** /billing/admin/inboundTariffs | 

package/api.ts

@@ -13851,6 +13851,44 @@ export const BillingApiAxiosParamCreator = function (configuration?: Configurati
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get Connection
+         * @param {number} id Connection ID
+         * @param {number} [billCustomerId] Customer ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetConnection: async (id: number, billCustomerId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getGetConnection', 'id', id)
+            const localVarPath = `/billing/customer/connections/{id}`
+                .replace('{id}', encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            if (billCustomerId !== undefined) {
+                localVarQueryParameter['billCustomerId'] = billCustomerId;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Get Connections
          * @param {GetGetConnectionsTypeEnum} [type] Connection Type
@@ -15697,6 +15735,19 @@ export const BillingApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['BillingApi.getGetChildren']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get Connection
+         * @param {number} id Connection ID
+         * @param {number} [billCustomerId] Customer ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetConnection(id: number, billCustomerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OutboundCli>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetConnection(id, billCustomerId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BillingApi.getGetConnection']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get Connections
          * @param {GetGetConnectionsTypeEnum} [type] Connection Type
@@ -16439,6 +16490,16 @@ export const BillingApiFactory = function (configuration?: Configuration, basePa
         getGetChildren(billCustomerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<object>> {
             return localVarFp.getGetChildren(billCustomerId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Connection
+         * @param {number} id Connection ID
+         * @param {number} [billCustomerId] Customer ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetConnection(id: number, billCustomerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<OutboundCli> {
+            return localVarFp.getGetConnection(id, billCustomerId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get Connections
          * @param {GetGetConnectionsTypeEnum} [type] Connection Type
@@ -17072,6 +17133,17 @@ export class BillingApi extends BaseAPI {
         return BillingApiFp(this.configuration).getGetChildren(billCustomerId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get Connection
+     * @param {number} id Connection ID
+     * @param {number} [billCustomerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getGetConnection(id: number, billCustomerId?: number, options?: RawAxiosRequestConfig) {
+        return BillingApiFp(this.configuration).getGetConnection(id, billCustomerId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get Connections
      * @param {GetGetConnectionsTypeEnum} [type] Connection Type

package/dist/api.d.ts

@@ -11311,6 +11311,14 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getGetChildren: (billCustomerId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Connection
+     * @param {number} id Connection ID
+     * @param {number} [billCustomerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetConnection: (id: number, billCustomerId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Connections
      * @param {GetGetConnectionsTypeEnum} [type] Connection Type
@@ -11794,6 +11802,14 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetChildren(billCustomerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<object>>>;
+    /**
+     * Get Connection
+     * @param {number} id Connection ID
+     * @param {number} [billCustomerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetConnection(id: number, billCustomerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OutboundCli>>;
     /**
      * Get Connections
      * @param {GetGetConnectionsTypeEnum} [type] Connection Type
@@ -12277,6 +12293,14 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getGetChildren(billCustomerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<object>>;
+    /**
+     * Get Connection
+     * @param {number} id Connection ID
+     * @param {number} [billCustomerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetConnection(id: number, billCustomerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<OutboundCli>;
     /**
      * Get Connections
      * @param {GetGetConnectionsTypeEnum} [type] Connection Type
@@ -12760,6 +12784,14 @@ export declare class BillingApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getGetChildren(billCustomerId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object[], any, {}>>;
+    /**
+     * Get Connection
+     * @param {number} id Connection ID
+     * @param {number} [billCustomerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetConnection(id: number, billCustomerId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OutboundCli, any, {}>>;
     /**
      * Get Connections
      * @param {GetGetConnectionsTypeEnum} [type] Connection Type

package/dist/api.js

@@ -5410,6 +5410,47 @@ var BillingApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Connection
+         * @param {number} id Connection ID
+         * @param {number} [billCustomerId] Customer ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetConnection: function (id_1, billCustomerId_1) {
+            var args_1 = [];
+            for (var _i = 2; _i < arguments.length; _i++) {
+                args_1[_i - 2] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([id_1, billCustomerId_1], args_1, true), void 0, function (id, billCustomerId, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    // verify required parameter 'id' is not null or undefined
+                    (0, common_1.assertParamExists)('getGetConnection', 'id', id);
+                    localVarPath = "/billing/customer/connections/{id}"
+                        .replace('{id}', encodeURIComponent(String(id)));
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    if (billCustomerId !== undefined) {
+                        localVarQueryParameter['billCustomerId'] = billCustomerId;
+                    }
+                    localVarHeaderParameter['Accept'] = 'application/json';
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Get Connections
          * @param {GetGetConnectionsTypeEnum} [type] Connection Type
@@ -7609,6 +7650,29 @@ var BillingApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Connection
+         * @param {number} id Connection ID
+         * @param {number} [billCustomerId] Customer ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetConnection: function (id, billCustomerId, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
+                var _a, _b, _c;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetConnection(id, billCustomerId, options)];
+                        case 1:
+                            localVarAxiosArgs = _d.sent();
+                            localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                            localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['BillingApi.getGetConnection']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
+                    }
+                });
+            });
+        },
         /**
          * Get Connections
          * @param {GetGetConnectionsTypeEnum} [type] Connection Type
@@ -8781,6 +8845,16 @@ var BillingApiFactory = function (configuration, basePath, axios) {
         getGetChildren: function (billCustomerId, options) {
             return localVarFp.getGetChildren(billCustomerId, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Get Connection
+         * @param {number} id Connection ID
+         * @param {number} [billCustomerId] Customer ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetConnection: function (id, billCustomerId, options) {
+            return localVarFp.getGetConnection(id, billCustomerId, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Get Connections
          * @param {GetGetConnectionsTypeEnum} [type] Connection Type
@@ -9418,6 +9492,17 @@ var BillingApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.BillingApiFp)(this.configuration).getGetChildren(billCustomerId, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Get Connection
+     * @param {number} id Connection ID
+     * @param {number} [billCustomerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    BillingApi.prototype.getGetConnection = function (id, billCustomerId, options) {
+        var _this = this;
+        return (0, exports.BillingApiFp)(this.configuration).getGetConnection(id, billCustomerId, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Get Connections
      * @param {GetGetConnectionsTypeEnum} [type] Connection Type

package/dist/models/ConnectionTypeEnum.d.ts

@@ -0,0 +1,63 @@
+export declare const ConnectionTypeEnum: {
+    readonly SIP_TRUNK: {
+        readonly name: "SIP_TRUNK";
+        readonly value: "SIP Trunks";
+        readonly publicValue: "SIP Trunks";
+    };
+    readonly BROADBAND: {
+        readonly name: "BROADBAND";
+        readonly value: "Broadband";
+        readonly publicValue: "Broadband";
+    };
+    readonly ETHERNET: {
+        readonly name: "ETHERNET";
+        readonly value: "Ethernet";
+        readonly publicValue: "Ethernet";
+    };
+    readonly MOBILE: {
+        readonly name: "MOBILE";
+        readonly value: "Mobile";
+        readonly publicValue: "Mobile";
+    };
+    readonly WLR: {
+        readonly name: "WLR";
+        readonly value: "WLR";
+        readonly publicValue: "WLR";
+    };
+    readonly HZN: {
+        readonly name: "HZN";
+        readonly value: "Horizon";
+        readonly publicValue: "Horizon";
+    };
+    readonly NTS: {
+        readonly name: "NTS";
+        readonly value: "NTS";
+        readonly publicValue: "NTS";
+    };
+    readonly HOSTING: {
+        readonly name: "HOSTING";
+        readonly value: "Hosting";
+        readonly publicValue: "Hosting";
+    };
+    readonly CRM: {
+        readonly name: "CRM";
+        readonly value: "CRM";
+        readonly publicValue: "CRM";
+    };
+    readonly TCX_MULTITENANT: {
+        readonly name: "TCX_MULTITENANT";
+        readonly value: "Starter Bundle";
+        readonly publicValue: "Starter Bundle";
+    };
+    readonly OTHER: {
+        readonly name: "OTHER";
+        readonly value: "Other";
+        readonly publicValue: "Other";
+    };
+    readonly RECURRING_CHARGES: {
+        readonly name: "RECURRING_CHARGES";
+        readonly value: "Recurring Charges";
+        readonly publicValue: "Recurring Charges";
+    };
+};
+export type ConnectionTypeEnum = typeof ConnectionTypeEnum;

package/dist/models/ConnectionTypeEnum.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionTypeEnum = void 0;
+exports.ConnectionTypeEnum = {
+    "SIP_TRUNK": {
+        "name": "SIP_TRUNK",
+        "value": "SIP Trunks",
+        "publicValue": "SIP Trunks"
+    },
+    "BROADBAND": {
+        "name": "BROADBAND",
+        "value": "Broadband",
+        "publicValue": "Broadband"
+    },
+    "ETHERNET": {
+        "name": "ETHERNET",
+        "value": "Ethernet",
+        "publicValue": "Ethernet"
+    },
+    "MOBILE": {
+        "name": "MOBILE",
+        "value": "Mobile",
+        "publicValue": "Mobile"
+    },
+    "WLR": {
+        "name": "WLR",
+        "value": "WLR",
+        "publicValue": "WLR"
+    },
+    "HZN": {
+        "name": "HZN",
+        "value": "Horizon",
+        "publicValue": "Horizon"
+    },
+    "NTS": {
+        "name": "NTS",
+        "value": "NTS",
+        "publicValue": "NTS"
+    },
+    "HOSTING": {
+        "name": "HOSTING",
+        "value": "Hosting",
+        "publicValue": "Hosting"
+    },
+    "CRM": {
+        "name": "CRM",
+        "value": "CRM",
+        "publicValue": "CRM"
+    },
+    "TCX_MULTITENANT": {
+        "name": "TCX_MULTITENANT",
+        "value": "Starter Bundle",
+        "publicValue": "Starter Bundle"
+    },
+    "OTHER": {
+        "name": "OTHER",
+        "value": "Other",
+        "publicValue": "Other"
+    },
+    "RECURRING_CHARGES": {
+        "name": "RECURRING_CHARGES",
+        "value": "Recurring Charges",
+        "publicValue": "Recurring Charges"
+    }
+};

package/docs/BillingApi.md

@@ -26,6 +26,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**getGetCallTariffs**](#getgetcalltariffs) | **GET** /billing/admin/callTariffs | |
 |[**getGetCallTariffsDetails**](#getgetcalltariffsdetails) | **GET** /billing/admin/callTariffs/details | |
 |[**getGetChildren**](#getgetchildren) | **GET** /billing/customer/children | |
+|[**getGetConnection**](#getgetconnection) | **GET** /billing/customer/connections/{id} | |
 |[**getGetConnections**](#getgetconnections) | **GET** /billing/customer/connections | |
 |[**getGetCustomer**](#getgetcustomer) | **GET** /billing/admin/customer | |
 |[**getGetInboundTariffs**](#getgetinboundtariffs) | **GET** /billing/admin/inboundTariffs | |
@@ -1232,6 +1233,63 @@ 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)
 
+# **getGetConnection**
+> OutboundCli getGetConnection()
+
+Get Connection
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+let id: number; //Connection ID (default to undefined)
+let billCustomerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetConnection(
+    id,
+    billCustomerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**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**: Not defined
+ - **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)
+
 # **getGetConnections**
 > Array<OutboundCli> getGetConnections()
 

package/models/ConnectionTypeEnum.ts

@@ -0,0 +1,64 @@
+export const ConnectionTypeEnum = {
+    "SIP_TRUNK": {
+        "name": "SIP_TRUNK",
+        "value": "SIP Trunks",
+        "publicValue": "SIP Trunks"
+    },
+    "BROADBAND": {
+        "name": "BROADBAND",
+        "value": "Broadband",
+        "publicValue": "Broadband"
+    },
+    "ETHERNET": {
+        "name": "ETHERNET",
+        "value": "Ethernet",
+        "publicValue": "Ethernet"
+    },
+    "MOBILE": {
+        "name": "MOBILE",
+        "value": "Mobile",
+        "publicValue": "Mobile"
+    },
+    "WLR": {
+        "name": "WLR",
+        "value": "WLR",
+        "publicValue": "WLR"
+    },
+    "HZN": {
+        "name": "HZN",
+        "value": "Horizon",
+        "publicValue": "Horizon"
+    },
+    "NTS": {
+        "name": "NTS",
+        "value": "NTS",
+        "publicValue": "NTS"
+    },
+    "HOSTING": {
+        "name": "HOSTING",
+        "value": "Hosting",
+        "publicValue": "Hosting"
+    },
+    "CRM": {
+        "name": "CRM",
+        "value": "CRM",
+        "publicValue": "CRM"
+    },
+    "TCX_MULTITENANT": {
+        "name": "TCX_MULTITENANT",
+        "value": "Starter Bundle",
+        "publicValue": "Starter Bundle"
+    },
+    "OTHER": {
+        "name": "OTHER",
+        "value": "Other",
+        "publicValue": "Other"
+    },
+    "RECURRING_CHARGES": {
+        "name": "RECURRING_CHARGES",
+        "value": "Recurring Charges",
+        "publicValue": "Recurring Charges"
+    }
+} as const;
+
+ export type ConnectionTypeEnum = typeof ConnectionTypeEnum;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.256",
+  "version": "3.2.258",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {