yellowgrid-api-ts 3.2.202 → 3.2.203

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/.openapi-generator/FILES +1 -0
  2. package/README.md +1 -0
  3. package/api.ts +53 -12
  4. package/dist/api.d.ts +55 -14
  5. package/docs/ProductDetailedSummaryDTO.md +41 -0
  6. package/docs/ProductSummaryDTO.md +0 -4
  7. package/docs/ProductsApi.md +4 -4
  8. package/package.json +1 -1
package/.openapi-generator/FILES CHANGED
@@ -162,6 +162,7 @@ docs/PriceListItemModel.md
162
162
  docs/PricingApi.md
163
163
  docs/PrinterEntity.md
164
164
  docs/PrizesEntity.md
165
+ docs/ProductDetailedSummaryDTO.md
165
166
  docs/ProductPriceListItemModel.md
166
167
  docs/ProductSearchResultsModel.md
167
168
  docs/ProductSerialInfoModel.md
package/README.md CHANGED
@@ -465,6 +465,7 @@ Class | Method | HTTP request | Description
465
465
  - [PriceListItemModel](docs/PriceListItemModel.md)
466
466
  - [PrinterEntity](docs/PrinterEntity.md)
467
467
  - [PrizesEntity](docs/PrizesEntity.md)
468
+ - [ProductDetailedSummaryDTO](docs/ProductDetailedSummaryDTO.md)
468
469
  - [ProductPriceListItemModel](docs/ProductPriceListItemModel.md)
469
470
  - [ProductSearchResultsModel](docs/ProductSearchResultsModel.md)
470
471
  - [ProductSerialInfoModel](docs/ProductSerialInfoModel.md)
package/api.ts CHANGED
@@ -4791,6 +4791,55 @@ export interface PrizesEntity {
4791
4791
  */
4792
4792
  'image'?: string;
4793
4793
  }
4794
+ /**
4795
+ * Product Detailed Summary
4796
+ */
4797
+ export interface ProductDetailedSummaryDTO {
4798
+ /**
4799
+ * SKU
4800
+ */
4801
+ 'sku'?: string;
4802
+ /**
4803
+ * Title
4804
+ */
4805
+ 'title'?: string;
4806
+ /**
4807
+ * Stock Quantity
4808
+ */
4809
+ 'quantity'?: number | null;
4810
+ /**
4811
+ * Stock Product
4812
+ */
4813
+ 'stockProduct'?: boolean;
4814
+ /**
4815
+ * Price
4816
+ */
4817
+ 'price'?: number | null;
4818
+ /**
4819
+ * Carton Size
4820
+ */
4821
+ 'cartonSize'?: number | null;
4822
+ /**
4823
+ * RRP Price
4824
+ */
4825
+ 'rrp'?: number | null;
4826
+ /**
4827
+ * 3CX Licence Details
4828
+ */
4829
+ 'licenceDetails'?: TcxLicenceDetailsModel | null;
4830
+ /**
4831
+ * 3CX Hosting
4832
+ */
4833
+ 'hosting'?: boolean | null;
4834
+ /**
4835
+ * Due Date
4836
+ */
4837
+ 'dueDate'?: string | null;
4838
+ /**
4839
+ * On Order
4840
+ */
4841
+ 'onOrder'?: number | null;
4842
+ }
4794
4843
  /**
4795
4844
  * Product Price List Item
4796
4845
  */
@@ -4870,14 +4919,6 @@ export interface ProductSummaryDTO {
4870
4919
  * Stock Product
4871
4920
  */
4872
4921
  'stockProduct'?: boolean;
4873
- /**
4874
- * Due Date
4875
- */
4876
- 'dueDate'?: string | null;
4877
- /**
4878
- * On Order
4879
- */
4880
- 'onOrder'?: number | null;
4881
4922
  /**
4882
4923
  * Price
4883
4924
  */
@@ -22983,7 +23024,7 @@ export const ProductsApiFp = function(configuration?: Configuration) {
22983
23024
  * @param {*} [options] Override http request option.
22984
23025
  * @throws {RequiredError}
22985
23026
  */
22986
- async postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>> {
23027
+ async postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductDetailedSummaryDTO>> {
22987
23028
  const localVarAxiosArgs = await localVarAxiosParamCreator.postGetProduct(sku, postGetProductForCustomerRequest, orderId, options);
22988
23029
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
22989
23030
  const localVarOperationServerBasePath = operationServerMap['ProductsApi.postGetProduct']?.[localVarOperationServerIndex]?.url;
@@ -22999,7 +23040,7 @@ export const ProductsApiFp = function(configuration?: Configuration) {
22999
23040
  * @param {*} [options] Override http request option.
23000
23041
  * @throws {RequiredError}
23001
23042
  */
23002
- async postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>> {
23043
+ async postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductDetailedSummaryDTO>> {
23003
23044
  const localVarAxiosArgs = await localVarAxiosParamCreator.postGetProductForCustomer(customerId, sku, postGetProductForCustomerRequest, orderId, options);
23004
23045
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
23005
23046
  const localVarOperationServerBasePath = operationServerMap['ProductsApi.postGetProductForCustomer']?.[localVarOperationServerIndex]?.url;
@@ -23102,7 +23143,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
23102
23143
  * @param {*} [options] Override http request option.
23103
23144
  * @throws {RequiredError}
23104
23145
  */
23105
- postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO> {
23146
+ postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductDetailedSummaryDTO> {
23106
23147
  return localVarFp.postGetProduct(sku, postGetProductForCustomerRequest, orderId, options).then((request) => request(axios, basePath));
23107
23148
  },
23108
23149
  /**
@@ -23115,7 +23156,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
23115
23156
  * @param {*} [options] Override http request option.
23116
23157
  * @throws {RequiredError}
23117
23158
  */
23118
- postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO> {
23159
+ postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductDetailedSummaryDTO> {
23119
23160
  return localVarFp.postGetProductForCustomer(customerId, sku, postGetProductForCustomerRequest, orderId, options).then((request) => request(axios, basePath));
23120
23161
  },
23121
23162
  };
package/dist/api.d.ts CHANGED
@@ -4737,6 +4737,55 @@ export interface PrizesEntity {
4737
4737
  */
4738
4738
  'image'?: string;
4739
4739
  }
4740
+ /**
4741
+ * Product Detailed Summary
4742
+ */
4743
+ export interface ProductDetailedSummaryDTO {
4744
+ /**
4745
+ * SKU
4746
+ */
4747
+ 'sku'?: string;
4748
+ /**
4749
+ * Title
4750
+ */
4751
+ 'title'?: string;
4752
+ /**
4753
+ * Stock Quantity
4754
+ */
4755
+ 'quantity'?: number | null;
4756
+ /**
4757
+ * Stock Product
4758
+ */
4759
+ 'stockProduct'?: boolean;
4760
+ /**
4761
+ * Price
4762
+ */
4763
+ 'price'?: number | null;
4764
+ /**
4765
+ * Carton Size
4766
+ */
4767
+ 'cartonSize'?: number | null;
4768
+ /**
4769
+ * RRP Price
4770
+ */
4771
+ 'rrp'?: number | null;
4772
+ /**
4773
+ * 3CX Licence Details
4774
+ */
4775
+ 'licenceDetails'?: TcxLicenceDetailsModel | null;
4776
+ /**
4777
+ * 3CX Hosting
4778
+ */
4779
+ 'hosting'?: boolean | null;
4780
+ /**
4781
+ * Due Date
4782
+ */
4783
+ 'dueDate'?: string | null;
4784
+ /**
4785
+ * On Order
4786
+ */
4787
+ 'onOrder'?: number | null;
4788
+ }
4740
4789
  /**
4741
4790
  * Product Price List Item
4742
4791
  */
@@ -4816,14 +4865,6 @@ export interface ProductSummaryDTO {
4816
4865
  * Stock Product
4817
4866
  */
4818
4867
  'stockProduct'?: boolean;
4819
- /**
4820
- * Due Date
4821
- */
4822
- 'dueDate'?: string | null;
4823
- /**
4824
- * On Order
4825
- */
4826
- 'onOrder'?: number | null;
4827
4868
  /**
4828
4869
  * Price
4829
4870
  */
@@ -15390,7 +15431,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
15390
15431
  * @param {*} [options] Override http request option.
15391
15432
  * @throws {RequiredError}
15392
15433
  */
15393
- postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>>;
15434
+ postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductDetailedSummaryDTO>>;
15394
15435
  /**
15395
15436
  * Get Product For Customer
15396
15437
  * @summary Get Product For Customer
@@ -15401,7 +15442,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
15401
15442
  * @param {*} [options] Override http request option.
15402
15443
  * @throws {RequiredError}
15403
15444
  */
15404
- postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>>;
15445
+ postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductDetailedSummaryDTO>>;
15405
15446
  };
15406
15447
  /**
15407
15448
  * ProductsApi - factory interface
@@ -15479,7 +15520,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
15479
15520
  * @param {*} [options] Override http request option.
15480
15521
  * @throws {RequiredError}
15481
15522
  */
15482
- postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO>;
15523
+ postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductDetailedSummaryDTO>;
15483
15524
  /**
15484
15525
  * Get Product For Customer
15485
15526
  * @summary Get Product For Customer
@@ -15490,7 +15531,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
15490
15531
  * @param {*} [options] Override http request option.
15491
15532
  * @throws {RequiredError}
15492
15533
  */
15493
- postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO>;
15534
+ postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductDetailedSummaryDTO>;
15494
15535
  };
15495
15536
  /**
15496
15537
  * ProductsApi - object-oriented interface
@@ -15568,7 +15609,7 @@ export declare class ProductsApi extends BaseAPI {
15568
15609
  * @param {*} [options] Override http request option.
15569
15610
  * @throws {RequiredError}
15570
15611
  */
15571
- postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSummaryDTO, any, {}>>;
15612
+ postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductDetailedSummaryDTO, any, {}>>;
15572
15613
  /**
15573
15614
  * Get Product For Customer
15574
15615
  * @summary Get Product For Customer
@@ -15579,7 +15620,7 @@ export declare class ProductsApi extends BaseAPI {
15579
15620
  * @param {*} [options] Override http request option.
15580
15621
  * @throws {RequiredError}
15581
15622
  */
15582
- postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSummaryDTO, any, {}>>;
15623
+ postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductDetailedSummaryDTO, any, {}>>;
15583
15624
  }
15584
15625
  export declare const GetGetLegacyStockListFormatEnum: {
15585
15626
  readonly Xml: "XML";
package/docs/ProductDetailedSummaryDTO.md ADDED
@@ -0,0 +1,41 @@
1
+ # ProductDetailedSummaryDTO
2
+
3
+ Product Detailed Summary
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **sku** | **string** | SKU | [optional] [default to undefined]
10
+ **title** | **string** | Title | [optional] [default to undefined]
11
+ **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
12
+ **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
13
+ **price** | **number** | Price | [optional] [default to undefined]
14
+ **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
15
+ **rrp** | **number** | RRP Price | [optional] [default to undefined]
16
+ **licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | 3CX Licence Details | [optional] [default to undefined]
17
+ **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
18
+ **dueDate** | **string** | Due Date | [optional] [default to undefined]
19
+ **onOrder** | **number** | On Order | [optional] [default to undefined]
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import { ProductDetailedSummaryDTO } from 'yellowgrid-api-ts';
25
+
26
+ const instance: ProductDetailedSummaryDTO = {
27
+ sku,
28
+ title,
29
+ quantity,
30
+ stockProduct,
31
+ price,
32
+ cartonSize,
33
+ rrp,
34
+ licenceDetails,
35
+ hosting,
36
+ dueDate,
37
+ onOrder,
38
+ };
39
+ ```
40
+
41
+ [[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/ProductSummaryDTO.md CHANGED
@@ -10,8 +10,6 @@ Name | Type | Description | Notes
10
10
  **title** | **string** | Title | [optional] [default to undefined]
11
11
  **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
12
12
  **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
13
- **dueDate** | **string** | Due Date | [optional] [default to undefined]
14
- **onOrder** | **number** | On Order | [optional] [default to undefined]
15
13
  **price** | **number** | Price | [optional] [default to undefined]
16
14
  **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
17
15
  **rrp** | **number** | RRP Price | [optional] [default to undefined]
@@ -28,8 +26,6 @@ const instance: ProductSummaryDTO = {
28
26
  title,
29
27
  quantity,
30
28
  stockProduct,
31
- dueDate,
32
- onOrder,
33
29
  price,
34
30
  cartonSize,
35
31
  rrp,
package/docs/ProductsApi.md CHANGED
@@ -422,7 +422,7 @@ No authorization required
422
422
  [[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)
423
423
 
424
424
  # **postGetProduct**
425
- > ProductSummaryDTO postGetProduct(postGetProductForCustomerRequest)
425
+ > ProductDetailedSummaryDTO postGetProduct(postGetProductForCustomerRequest)
426
426
 
427
427
  Get Product
428
428
 
@@ -460,7 +460,7 @@ const { status, data } = await apiInstance.postGetProduct(
460
460
 
461
461
  ### Return type
462
462
 
463
- **ProductSummaryDTO**
463
+ **ProductDetailedSummaryDTO**
464
464
 
465
465
  ### Authorization
466
466
 
@@ -483,7 +483,7 @@ No authorization required
483
483
  [[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)
484
484
 
485
485
  # **postGetProductForCustomer**
486
- > ProductSummaryDTO postGetProductForCustomer(postGetProductForCustomerRequest)
486
+ > ProductDetailedSummaryDTO postGetProductForCustomer(postGetProductForCustomerRequest)
487
487
 
488
488
  Get Product For Customer
489
489
 
@@ -524,7 +524,7 @@ const { status, data } = await apiInstance.postGetProductForCustomer(
524
524
 
525
525
  ### Return type
526
526
 
527
- **ProductSummaryDTO**
527
+ **ProductDetailedSummaryDTO**
528
528
 
529
529
  ### Authorization
530
530
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.202",
3
+ "version": "3.2.203",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {