yellowgrid-api-ts 3.2.106 → 3.2.107

package/.openapi-generator/FILES

@@ -129,7 +129,6 @@ docs/PostAddOrderNoteRequest.md
 docs/PostAddWebhook200Response.md
 docs/PostGetClientCredentialsRequest.md
 docs/PostGetProductForCustomerRequest.md
-docs/PostGetProductRequest.md
 docs/PostSplitOrderRequest.md
 docs/PriceListItemModel.md
 docs/PricingApi.md

package/README.md

@@ -394,7 +394,6 @@ Class | Method | HTTP request | Description
  - [PostAddWebhook200Response](docs/PostAddWebhook200Response.md)
  - [PostGetClientCredentialsRequest](docs/PostGetClientCredentialsRequest.md)
  - [PostGetProductForCustomerRequest](docs/PostGetProductForCustomerRequest.md)
- - [PostGetProductRequest](docs/PostGetProductRequest.md)
  - [PostSplitOrderRequest](docs/PostSplitOrderRequest.md)
  - [PriceListItemModel](docs/PriceListItemModel.md)
  - [PrinterEntity](docs/PrinterEntity.md)

package/api.ts

@@ -4105,20 +4105,10 @@ export interface PostGetProductForCustomerRequest {
      * 3CX Sales Code
      */
     'tcxSalesCode'?: string | null;
-}
-export interface PostGetProductRequest {
-    /**
-     * Quantity
-     */
-    'quantity'?: number | null;
-    /**
-     * 3CX Licence Key
-     */
-    'licenceKey'?: string | null;
     /**
-     * 3CX Hosting
+     * 3CX Renewal Years (Upgrade Only)
      */
-    'hosting'?: boolean | null;
+    'renewalYears'?: number | null;
 }
 export interface PostSplitOrderRequest {
     /**
@@ -19454,15 +19444,15 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
          * Get Product
          * @summary Get Product
          * @param {string} sku Product SKU
-         * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+         * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        postGetProduct: async (sku: string, postGetProductRequest: PostGetProductRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        postGetProduct: async (sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'sku' is not null or undefined
             assertParamExists('postGetProduct', 'sku', sku)
-            // verify required parameter 'postGetProductRequest' is not null or undefined
-            assertParamExists('postGetProduct', 'postGetProductRequest', postGetProductRequest)
+            // verify required parameter 'postGetProductForCustomerRequest' is not null or undefined
+            assertParamExists('postGetProduct', 'postGetProductForCustomerRequest', postGetProductForCustomerRequest)
             const localVarPath = `/products/{sku}`
                 .replace(`{${"sku"}}`, encodeURIComponent(String(sku)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -19482,7 +19472,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(postGetProductRequest, localVarRequestOptions, configuration)
+            localVarRequestOptions.data = serializeDataIfNeeded(postGetProductForCustomerRequest, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -19651,12 +19641,12 @@ export const ProductsApiFp = function(configuration?: Configuration) {
          * Get Product
          * @summary Get Product
          * @param {string} sku Product SKU
-         * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+         * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.postGetProduct(sku, postGetProductRequest, options);
+        async postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postGetProduct(sku, postGetProductForCustomerRequest, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['ProductsApi.postGetProduct']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -19768,12 +19758,12 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
          * Get Product
          * @summary Get Product
          * @param {string} sku Product SKU
-         * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+         * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO> {
-            return localVarFp.postGetProduct(sku, postGetProductRequest, options).then((request) => request(axios, basePath));
+        postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO> {
+            return localVarFp.postGetProduct(sku, postGetProductForCustomerRequest, options).then((request) => request(axios, basePath));
         },
         /**
          * Get Product For Customer
@@ -19885,12 +19875,12 @@ export class ProductsApi extends BaseAPI {
      * Get Product
      * @summary Get Product
      * @param {string} sku Product SKU
-     * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+     * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig) {
-        return ProductsApiFp(this.configuration).postGetProduct(sku, postGetProductRequest, options).then((request) => request(this.axios, this.basePath));
+    public postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig) {
+        return ProductsApiFp(this.configuration).postGetProduct(sku, postGetProductForCustomerRequest, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/dist/api.d.ts

@@ -4063,20 +4063,10 @@ export interface PostGetProductForCustomerRequest {
      * 3CX Sales Code
      */
     'tcxSalesCode'?: string | null;
-}
-export interface PostGetProductRequest {
-    /**
-     * Quantity
-     */
-    'quantity'?: number | null;
-    /**
-     * 3CX Licence Key
-     */
-    'licenceKey'?: string | null;
     /**
-     * 3CX Hosting
+     * 3CX Renewal Years (Upgrade Only)
      */
-    'hosting'?: boolean | null;
+    'renewalYears'?: number | null;
 }
 export interface PostSplitOrderRequest {
     /**
@@ -13359,11 +13349,11 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * Get Product
      * @summary Get Product
      * @param {string} sku Product SKU
-     * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+     * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postGetProduct: (sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    postGetProduct: (sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Product For Customer
      * @summary Get Product For Customer
@@ -13446,11 +13436,11 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * Get Product
      * @summary Get Product
      * @param {string} sku Product SKU
-     * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+     * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>>;
+    postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>>;
     /**
      * Get Product For Customer
      * @summary Get Product For Customer
@@ -13533,11 +13523,11 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * Get Product
      * @summary Get Product
      * @param {string} sku Product SKU
-     * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+     * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO>;
+    postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO>;
     /**
      * Get Product For Customer
      * @summary Get Product For Customer
@@ -13620,11 +13610,11 @@ export declare class ProductsApi extends BaseAPI {
      * Get Product
      * @summary Get Product
      * @param {string} sku Product SKU
-     * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+     * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSummaryDTO, any, {}>>;
+    postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSummaryDTO, any, {}>>;
     /**
      * Get Product For Customer
      * @summary Get Product For Customer

package/dist/api.js

@@ -13787,23 +13787,23 @@ var ProductsApiAxiosParamCreator = function (configuration) {
          * Get Product
          * @summary Get Product
          * @param {string} sku Product SKU
-         * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+         * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        postGetProduct: function (sku_1, postGetProductRequest_1) {
+        postGetProduct: function (sku_1, postGetProductForCustomerRequest_1) {
             var args_1 = [];
             for (var _i = 2; _i < arguments.length; _i++) {
                 args_1[_i - 2] = arguments[_i];
             }
-            return __awaiter(_this, __spreadArray([sku_1, postGetProductRequest_1], args_1, true), void 0, function (sku, postGetProductRequest, options) {
+            return __awaiter(_this, __spreadArray([sku_1, postGetProductForCustomerRequest_1], args_1, true), void 0, function (sku, postGetProductForCustomerRequest, options) {
                 var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
                 if (options === void 0) { options = {}; }
                 return __generator(this, function (_a) {
                     // verify required parameter 'sku' is not null or undefined
                     (0, common_1.assertParamExists)('postGetProduct', 'sku', sku);
-                    // verify required parameter 'postGetProductRequest' is not null or undefined
-                    (0, common_1.assertParamExists)('postGetProduct', 'postGetProductRequest', postGetProductRequest);
+                    // verify required parameter 'postGetProductForCustomerRequest' is not null or undefined
+                    (0, common_1.assertParamExists)('postGetProduct', 'postGetProductForCustomerRequest', postGetProductForCustomerRequest);
                     localVarPath = "/products/{sku}"
                         .replace("{".concat("sku", "}"), encodeURIComponent(String(sku)));
                     localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -13818,7 +13818,7 @@ var ProductsApiAxiosParamCreator = function (configuration) {
                     (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
                     headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
                     localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
-                    localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(postGetProductRequest, localVarRequestOptions, configuration);
+                    localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(postGetProductForCustomerRequest, localVarRequestOptions, configuration);
                     return [2 /*return*/, {
                             url: (0, common_1.toPathString)(localVarUrlObj),
                             options: localVarRequestOptions,
@@ -14071,17 +14071,17 @@ var ProductsApiFp = function (configuration) {
          * Get Product
          * @summary Get Product
          * @param {string} sku Product SKU
-         * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+         * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        postGetProduct: function (sku, postGetProductRequest, options) {
+        postGetProduct: function (sku, postGetProductForCustomerRequest, 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.postGetProduct(sku, postGetProductRequest, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.postGetProduct(sku, postGetProductForCustomerRequest, options)];
                         case 1:
                             localVarAxiosArgs = _d.sent();
                             localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
@@ -14208,12 +14208,12 @@ var ProductsApiFactory = function (configuration, basePath, axios) {
          * Get Product
          * @summary Get Product
          * @param {string} sku Product SKU
-         * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+         * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        postGetProduct: function (sku, postGetProductRequest, options) {
-            return localVarFp.postGetProduct(sku, postGetProductRequest, options).then(function (request) { return request(axios, basePath); });
+        postGetProduct: function (sku, postGetProductForCustomerRequest, options) {
+            return localVarFp.postGetProduct(sku, postGetProductForCustomerRequest, options).then(function (request) { return request(axios, basePath); });
         },
         /**
          * Get Product For Customer
@@ -14329,13 +14329,13 @@ var ProductsApi = /** @class */ (function (_super) {
      * Get Product
      * @summary Get Product
      * @param {string} sku Product SKU
-     * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+     * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    ProductsApi.prototype.postGetProduct = function (sku, postGetProductRequest, options) {
+    ProductsApi.prototype.postGetProduct = function (sku, postGetProductForCustomerRequest, options) {
         var _this = this;
-        return (0, exports.ProductsApiFp)(this.configuration).postGetProduct(sku, postGetProductRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.ProductsApiFp)(this.configuration).postGetProduct(sku, postGetProductForCustomerRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
      * Get Product For Customer

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,
 };
 ```
 

package/docs/ProductsApi.md

@@ -422,7 +422,7 @@ 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)
 
 # **postGetProduct**
-> ProductSummaryDTO postGetProduct(postGetProductRequest)
+> ProductSummaryDTO postGetProduct(postGetProductForCustomerRequest)
 
 Get Product
 
@@ -432,18 +432,18 @@ Get Product
 import {
     ProductsApi,
     Configuration,
-    PostGetProductRequest
+    PostGetProductForCustomerRequest
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new ProductsApi(configuration);
 
 let sku: string; //Product SKU (default to undefined)
-let postGetProductRequest: PostGetProductRequest; //Product search criteria
+let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
 
 const { status, data } = await apiInstance.postGetProduct(
     sku,
-    postGetProductRequest
+    postGetProductForCustomerRequest
 );
 ```
 
@@ -451,7 +451,7 @@ const { status, data } = await apiInstance.postGetProduct(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **postGetProductRequest** | **PostGetProductRequest**| Product search criteria | |
+| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
 | **sku** | [**string**] | Product SKU | defaults to undefined|
 
 

package/package.json

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

package/docs/PostGetProductRequest.md

@@ -1,24 +0,0 @@
-# PostGetProductRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**quantity** | **number** | Quantity | [optional] [default to undefined]
-**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
-**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PostGetProductRequest } from 'yellowgrid-api-ts';
-
-const instance: PostGetProductRequest = {
-    quantity,
-    licenceKey,
-    hosting,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)