yellowgrid-api-ts 3.2.172 → 3.2.173

package/.openapi-generator/FILES

@@ -57,6 +57,7 @@ docs/CreditNoteItemDTO.md
 docs/CreditNoteItemEntity.md
 docs/CreditNoteItemModel.md
 docs/CreditNoteModel.md
+docs/CreditStatusDTO.md
 docs/CrmActivitiesResponseDTO.md
 docs/CrmActivityDTO.md
 docs/CrmContactDTO.md

package/README.md

@@ -102,6 +102,7 @@ Class | Method | HTTP request | Description
 *CRMApi* | [**getSearchByPhone**](docs/CRMApi.md#getsearchbyphone) | **GET** /crm/contact/search | 
 *CRMApi* | [**postCreateCrmNote**](docs/CRMApi.md#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | 
 *Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
+*Class3CXApi* | [**getGetTcxCreditStatus**](docs/Class3CXApi.md#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status
 *Class3CXApi* | [**getGetTcxExpiringKeys**](docs/Class3CXApi.md#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys
 *Class3CXApi* | [**postGetBulkLicenceDetails**](docs/Class3CXApi.md#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details
 *Class3CXInstallationWizardApi* | [**deleteAddExtensions**](docs/Class3CXInstallationWizardApi.md#deleteaddextensions) | **DELETE** /tcx/wizards/extensions | Delete 3CX Installation Wizard Extensions
@@ -359,6 +360,7 @@ Class | Method | HTTP request | Description
  - [CreditNoteItemEntity](docs/CreditNoteItemEntity.md)
  - [CreditNoteItemModel](docs/CreditNoteItemModel.md)
  - [CreditNoteModel](docs/CreditNoteModel.md)
+ - [CreditStatusDTO](docs/CreditStatusDTO.md)
  - [CrmActivitiesResponseDTO](docs/CrmActivitiesResponseDTO.md)
  - [CrmActivityDTO](docs/CrmActivityDTO.md)
  - [CrmContactDTO](docs/CrmContactDTO.md)

package/api.ts

@@ -1666,6 +1666,23 @@ export interface CreditNoteModel {
      */
     'items'?: Array<CreditNoteItemModel>;
 }
+/**
+ * 3CX Credit Status
+ */
+export interface CreditStatusDTO {
+    /**
+     * Currency Code
+     */
+    'CurrencyCode'?: string | null;
+    /**
+     * Credit Limit
+     */
+    'CreditLimit'?: number | null;
+    /**
+     * Credit
+     */
+    'Credit'?: number | null;
+}
 /**
  * CRM Activities Response
  */
@@ -12214,6 +12231,36 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get 3CX Credit Status
+         * @summary Get 3CX Credit Status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetTcxCreditStatus: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/tcx/admin/credit`;
+            // 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;
+
+            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 3CX Expiring Keys
          * @summary Get 3CX Expiring Keys
@@ -12299,6 +12346,18 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetLicenceDetails']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get 3CX Credit Status
+         * @summary Get 3CX Credit Status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetTcxCreditStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreditStatusDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetTcxCreditStatus(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetTcxCreditStatus']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get 3CX Expiring Keys
          * @summary Get 3CX Expiring Keys
@@ -12343,6 +12402,15 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
         getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxLicenceDetailsModel> {
             return localVarFp.getGetLicenceDetails(key, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get 3CX Credit Status
+         * @summary Get 3CX Credit Status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetTcxCreditStatus(options?: RawAxiosRequestConfig): AxiosPromise<CreditStatusDTO> {
+            return localVarFp.getGetTcxCreditStatus(options).then((request) => request(axios, basePath));
+        },
         /**
          * Get 3CX Expiring Keys
          * @summary Get 3CX Expiring Keys
@@ -12380,6 +12448,16 @@ export class Class3CXApi extends BaseAPI {
         return Class3CXApiFp(this.configuration).getGetLicenceDetails(key, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get 3CX Credit Status
+     * @summary Get 3CX Credit Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getGetTcxCreditStatus(options?: RawAxiosRequestConfig) {
+        return Class3CXApiFp(this.configuration).getGetTcxCreditStatus(options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get 3CX Expiring Keys
      * @summary Get 3CX Expiring Keys

package/dist/api.d.ts

@@ -1643,6 +1643,23 @@ export interface CreditNoteModel {
      */
     'items'?: Array<CreditNoteItemModel>;
 }
+/**
+ * 3CX Credit Status
+ */
+export interface CreditStatusDTO {
+    /**
+     * Currency Code
+     */
+    'CurrencyCode'?: string | null;
+    /**
+     * Credit Limit
+     */
+    'CreditLimit'?: number | null;
+    /**
+     * Credit
+     */
+    'Credit'?: number | null;
+}
 /**
  * CRM Activities Response
  */
@@ -10188,6 +10205,13 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getGetLicenceDetails: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get 3CX Credit Status
+     * @summary Get 3CX Credit Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetTcxCreditStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get 3CX Expiring Keys
      * @summary Get 3CX Expiring Keys
@@ -10216,6 +10240,13 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxLicenceDetailsModel>>;
+    /**
+     * Get 3CX Credit Status
+     * @summary Get 3CX Credit Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetTcxCreditStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreditStatusDTO>>;
     /**
      * Get 3CX Expiring Keys
      * @summary Get 3CX Expiring Keys
@@ -10244,6 +10275,13 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxLicenceDetailsModel>;
+    /**
+     * Get 3CX Credit Status
+     * @summary Get 3CX Credit Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetTcxCreditStatus(options?: RawAxiosRequestConfig): AxiosPromise<CreditStatusDTO>;
     /**
      * Get 3CX Expiring Keys
      * @summary Get 3CX Expiring Keys
@@ -10272,6 +10310,13 @@ export declare class Class3CXApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxLicenceDetailsModel, any, {}>>;
+    /**
+     * Get 3CX Credit Status
+     * @summary Get 3CX Credit Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetTcxCreditStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreditStatusDTO, any, {}>>;
     /**
      * Get 3CX Expiring Keys
      * @summary Get 3CX Expiring Keys

package/dist/api.js

@@ -4760,6 +4760,40 @@ var Class3CXApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Get 3CX Credit Status
+         * @summary Get 3CX Credit Status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetTcxCreditStatus: function () {
+            var args_1 = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args_1[_i] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    localVarPath = "/tcx/admin/credit";
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    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 3CX Expiring Keys
          * @summary Get 3CX Expiring Keys
@@ -4863,6 +4897,28 @@ var Class3CXApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Get 3CX Credit Status
+         * @summary Get 3CX Credit Status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetTcxCreditStatus: function (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.getGetTcxCreditStatus(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['Class3CXApi.getGetTcxCreditStatus']) === 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 3CX Expiring Keys
          * @summary Get 3CX Expiring Keys
@@ -4927,6 +4983,15 @@ var Class3CXApiFactory = function (configuration, basePath, axios) {
         getGetLicenceDetails: function (key, options) {
             return localVarFp.getGetLicenceDetails(key, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Get 3CX Credit Status
+         * @summary Get 3CX Credit Status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetTcxCreditStatus: function (options) {
+            return localVarFp.getGetTcxCreditStatus(options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Get 3CX Expiring Keys
          * @summary Get 3CX Expiring Keys
@@ -4968,6 +5033,16 @@ var Class3CXApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.Class3CXApiFp)(this.configuration).getGetLicenceDetails(key, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Get 3CX Credit Status
+     * @summary Get 3CX Credit Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    Class3CXApi.prototype.getGetTcxCreditStatus = function (options) {
+        var _this = this;
+        return (0, exports.Class3CXApiFp)(this.configuration).getGetTcxCreditStatus(options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Get 3CX Expiring Keys
      * @summary Get 3CX Expiring Keys

package/docs/Class3CXApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://bitbucket.org*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
+|[**getGetTcxCreditStatus**](#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status|
 |[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
 |[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
 
@@ -62,6 +63,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)
 
+# **getGetTcxCreditStatus**
+> CreditStatusDTO getGetTcxCreditStatus()
+
+Get 3CX Credit Status
+
+### Example
+
+```typescript
+import {
+    Class3CXApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXApi(configuration);
+
+const { status, data } = await apiInstance.getGetTcxCreditStatus();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**CreditStatusDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Expiring Key CSV |  -  |
+|**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)
+
 # **getGetTcxExpiringKeys**
 > string getGetTcxExpiringKeys()
 

package/docs/CreditStatusDTO.md

@@ -0,0 +1,25 @@
+# CreditStatusDTO
+
+3CX Credit Status
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**CurrencyCode** | **string** | Currency Code | [optional] [default to undefined]
+**CreditLimit** | **number** | Credit Limit | [optional] [default to undefined]
+**Credit** | **number** | Credit | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditStatusDTO } from 'yellowgrid-api-ts';
+
+const instance: CreditStatusDTO = {
+    CurrencyCode,
+    CreditLimit,
+    Credit,
+};
+```
+
+[[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.172",
+  "version": "3.2.173",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {