yellowgrid-api-ts 3.1.18-dev.0 → 3.1.19-dev.0
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.
- package/.openapi-generator/FILES +1 -0
- package/README.md +20 -1
- package/api.ts +83 -16
- package/dist/api.d.ts +77 -10
- package/dist/api.js +53 -17
- package/docs/OAuth20Api.md +3 -3
- package/docs/PostGetProductForCustomerRequest.md +2 -0
- package/docs/PostGetProductRequest.md +24 -0
- package/docs/ProductsApi.md +5 -5
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -102,6 +102,7 @@ docs/PortalLoginModel.md
|
|
|
102
102
|
docs/PostAddWebhook200Response.md
|
|
103
103
|
docs/PostGetClientCredentialsRequest.md
|
|
104
104
|
docs/PostGetProductForCustomerRequest.md
|
|
105
|
+
docs/PostGetProductRequest.md
|
|
105
106
|
docs/PriceListItemModel.md
|
|
106
107
|
docs/PricingApi.md
|
|
107
108
|
docs/PrizesEntity.md
|
package/README.md
CHANGED
|
@@ -310,6 +310,7 @@ Class | Method | HTTP request | Description
|
|
|
310
310
|
- [PostAddWebhook200Response](docs/PostAddWebhook200Response.md)
|
|
311
311
|
- [PostGetClientCredentialsRequest](docs/PostGetClientCredentialsRequest.md)
|
|
312
312
|
- [PostGetProductForCustomerRequest](docs/PostGetProductForCustomerRequest.md)
|
|
313
|
+
- [PostGetProductRequest](docs/PostGetProductRequest.md)
|
|
313
314
|
- [PriceListItemModel](docs/PriceListItemModel.md)
|
|
314
315
|
- [PrizesEntity](docs/PrizesEntity.md)
|
|
315
316
|
- [ProductPriceListItemModel](docs/ProductPriceListItemModel.md)
|
|
@@ -429,5 +430,23 @@ Authentication schemes defined for the API:
|
|
|
429
430
|
- **scope**: A Test Scope
|
|
430
431
|
- **portal**: Yellowgrid Portal Endpoints
|
|
431
432
|
- **tcx_wizard**: 3CX Installation Wizard
|
|
432
|
-
- **
|
|
433
|
+
- **accounts.read**: Accounts (Read)
|
|
434
|
+
- **accounts.write**: Accounts (Write)
|
|
435
|
+
- **pricing.read**: Pricing (Read)
|
|
436
|
+
- **orders.read**: Orders (Read)
|
|
437
|
+
- **orders.write**: Orders (Write)
|
|
438
|
+
- **products.read**: Products (Read)
|
|
439
|
+
- **provisioning.read**: Provisioning (Read)
|
|
440
|
+
- **provisioning.write**: Provisioning (Write)
|
|
441
|
+
- **trunks.read**: Trunks (Read)
|
|
442
|
+
- **trunks.write**: Trunks (Write)
|
|
443
|
+
- **tcx_integrations.read**: 3CX Integrations (Read)
|
|
444
|
+
- **tcx_integrations.write**: 3CX Integrations (Write)
|
|
445
|
+
- **tcx_licence_details.read**: 3CX Licence Details (Read)
|
|
446
|
+
- **tcx_installations.read**: 3CX Installations (Read)
|
|
447
|
+
- **tcx_installations.write**: 3CX Installations (Write)
|
|
448
|
+
- **tcx_mt.read**: 3CX Multi-Tenant (Read)
|
|
449
|
+
- **tcx_mt.write**: 3CX Multi-Tenant (Write)
|
|
450
|
+
- **tickets.read**: Tickets (Read)
|
|
451
|
+
- **tickets.write**: Tickets (Write)
|
|
433
452
|
|
package/api.ts
CHANGED
|
@@ -4641,6 +4641,37 @@ export interface PostGetProductForCustomerRequest {
|
|
|
4641
4641
|
* @memberof PostGetProductForCustomerRequest
|
|
4642
4642
|
*/
|
|
4643
4643
|
'hosting'?: boolean | null;
|
|
4644
|
+
/**
|
|
4645
|
+
* 3CX Sales Code
|
|
4646
|
+
* @type {string}
|
|
4647
|
+
* @memberof PostGetProductForCustomerRequest
|
|
4648
|
+
*/
|
|
4649
|
+
'tcxSalesCode'?: string | null;
|
|
4650
|
+
}
|
|
4651
|
+
/**
|
|
4652
|
+
*
|
|
4653
|
+
* @export
|
|
4654
|
+
* @interface PostGetProductRequest
|
|
4655
|
+
*/
|
|
4656
|
+
export interface PostGetProductRequest {
|
|
4657
|
+
/**
|
|
4658
|
+
* Quantity
|
|
4659
|
+
* @type {number}
|
|
4660
|
+
* @memberof PostGetProductRequest
|
|
4661
|
+
*/
|
|
4662
|
+
'quantity'?: number | null;
|
|
4663
|
+
/**
|
|
4664
|
+
* 3CX Licence Key
|
|
4665
|
+
* @type {string}
|
|
4666
|
+
* @memberof PostGetProductRequest
|
|
4667
|
+
*/
|
|
4668
|
+
'licenceKey'?: string | null;
|
|
4669
|
+
/**
|
|
4670
|
+
* 3CX Hosting
|
|
4671
|
+
* @type {boolean}
|
|
4672
|
+
* @memberof PostGetProductRequest
|
|
4673
|
+
*/
|
|
4674
|
+
'hosting'?: boolean | null;
|
|
4644
4675
|
}
|
|
4645
4676
|
/**
|
|
4646
4677
|
* Price & Stock List
|
|
@@ -16425,7 +16456,25 @@ export const PostAccessTokenScopeEnum = {
|
|
|
16425
16456
|
Scope: 'scope',
|
|
16426
16457
|
Portal: 'portal',
|
|
16427
16458
|
TcxWizard: 'tcx_wizard',
|
|
16428
|
-
|
|
16459
|
+
AccountsRead: 'accounts.read',
|
|
16460
|
+
AccountsWrite: 'accounts.write',
|
|
16461
|
+
PricingRead: 'pricing.read',
|
|
16462
|
+
OrdersRead: 'orders.read',
|
|
16463
|
+
OrdersWrite: 'orders.write',
|
|
16464
|
+
ProductsRead: 'products.read',
|
|
16465
|
+
ProvisioningRead: 'provisioning.read',
|
|
16466
|
+
ProvisioningWrite: 'provisioning.write',
|
|
16467
|
+
TrunksRead: 'trunks.read',
|
|
16468
|
+
TrunksWrite: 'trunks.write',
|
|
16469
|
+
TcxIntegrationsRead: 'tcx_integrations.read',
|
|
16470
|
+
TcxIntegrationsWrite: 'tcx_integrations.write',
|
|
16471
|
+
TcxLicenceDetailsRead: 'tcx_licence_details.read',
|
|
16472
|
+
TcxInstallationsRead: 'tcx_installations.read',
|
|
16473
|
+
TcxInstallationsWrite: 'tcx_installations.write',
|
|
16474
|
+
TcxMtRead: 'tcx_mt.read',
|
|
16475
|
+
TcxMtWrite: 'tcx_mt.write',
|
|
16476
|
+
TicketsRead: 'tickets.read',
|
|
16477
|
+
TicketsWrite: 'tickets.write'
|
|
16429
16478
|
} as const;
|
|
16430
16479
|
export type PostAccessTokenScopeEnum = typeof PostAccessTokenScopeEnum[keyof typeof PostAccessTokenScopeEnum];
|
|
16431
16480
|
/**
|
|
@@ -16445,7 +16494,25 @@ export const PostAuthoriseScopeEnum = {
|
|
|
16445
16494
|
Scope: 'scope',
|
|
16446
16495
|
Portal: 'portal',
|
|
16447
16496
|
TcxWizard: 'tcx_wizard',
|
|
16448
|
-
|
|
16497
|
+
AccountsRead: 'accounts.read',
|
|
16498
|
+
AccountsWrite: 'accounts.write',
|
|
16499
|
+
PricingRead: 'pricing.read',
|
|
16500
|
+
OrdersRead: 'orders.read',
|
|
16501
|
+
OrdersWrite: 'orders.write',
|
|
16502
|
+
ProductsRead: 'products.read',
|
|
16503
|
+
ProvisioningRead: 'provisioning.read',
|
|
16504
|
+
ProvisioningWrite: 'provisioning.write',
|
|
16505
|
+
TrunksRead: 'trunks.read',
|
|
16506
|
+
TrunksWrite: 'trunks.write',
|
|
16507
|
+
TcxIntegrationsRead: 'tcx_integrations.read',
|
|
16508
|
+
TcxIntegrationsWrite: 'tcx_integrations.write',
|
|
16509
|
+
TcxLicenceDetailsRead: 'tcx_licence_details.read',
|
|
16510
|
+
TcxInstallationsRead: 'tcx_installations.read',
|
|
16511
|
+
TcxInstallationsWrite: 'tcx_installations.write',
|
|
16512
|
+
TcxMtRead: 'tcx_mt.read',
|
|
16513
|
+
TcxMtWrite: 'tcx_mt.write',
|
|
16514
|
+
TicketsRead: 'tickets.read',
|
|
16515
|
+
TicketsWrite: 'tickets.write'
|
|
16449
16516
|
} as const;
|
|
16450
16517
|
export type PostAuthoriseScopeEnum = typeof PostAuthoriseScopeEnum[keyof typeof PostAuthoriseScopeEnum];
|
|
16451
16518
|
|
|
@@ -17718,15 +17785,15 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
17718
17785
|
* Get Product
|
|
17719
17786
|
* @summary Get Product
|
|
17720
17787
|
* @param {string} sku Product SKU
|
|
17721
|
-
* @param {
|
|
17788
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
17722
17789
|
* @param {*} [options] Override http request option.
|
|
17723
17790
|
* @throws {RequiredError}
|
|
17724
17791
|
*/
|
|
17725
|
-
postGetProduct: async (sku: string,
|
|
17792
|
+
postGetProduct: async (sku: string, postGetProductRequest: PostGetProductRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
17726
17793
|
// verify required parameter 'sku' is not null or undefined
|
|
17727
17794
|
assertParamExists('postGetProduct', 'sku', sku)
|
|
17728
|
-
// verify required parameter '
|
|
17729
|
-
assertParamExists('postGetProduct', '
|
|
17795
|
+
// verify required parameter 'postGetProductRequest' is not null or undefined
|
|
17796
|
+
assertParamExists('postGetProduct', 'postGetProductRequest', postGetProductRequest)
|
|
17730
17797
|
const localVarPath = `/products/{sku}`
|
|
17731
17798
|
.replace(`{${"sku"}}`, encodeURIComponent(String(sku)));
|
|
17732
17799
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -17747,7 +17814,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
17747
17814
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17748
17815
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17749
17816
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
17750
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
17817
|
+
localVarRequestOptions.data = serializeDataIfNeeded(postGetProductRequest, localVarRequestOptions, configuration)
|
|
17751
17818
|
|
|
17752
17819
|
return {
|
|
17753
17820
|
url: toPathString(localVarUrlObj),
|
|
@@ -17892,12 +17959,12 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
17892
17959
|
* Get Product
|
|
17893
17960
|
* @summary Get Product
|
|
17894
17961
|
* @param {string} sku Product SKU
|
|
17895
|
-
* @param {
|
|
17962
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
17896
17963
|
* @param {*} [options] Override http request option.
|
|
17897
17964
|
* @throws {RequiredError}
|
|
17898
17965
|
*/
|
|
17899
|
-
async postGetProduct(sku: string,
|
|
17900
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postGetProduct(sku,
|
|
17966
|
+
async postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>> {
|
|
17967
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postGetProduct(sku, postGetProductRequest, options);
|
|
17901
17968
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
17902
17969
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.postGetProduct']?.[localVarOperationServerIndex]?.url;
|
|
17903
17970
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -17990,12 +18057,12 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
17990
18057
|
* Get Product
|
|
17991
18058
|
* @summary Get Product
|
|
17992
18059
|
* @param {string} sku Product SKU
|
|
17993
|
-
* @param {
|
|
18060
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
17994
18061
|
* @param {*} [options] Override http request option.
|
|
17995
18062
|
* @throws {RequiredError}
|
|
17996
18063
|
*/
|
|
17997
|
-
postGetProduct(sku: string,
|
|
17998
|
-
return localVarFp.postGetProduct(sku,
|
|
18064
|
+
postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO> {
|
|
18065
|
+
return localVarFp.postGetProduct(sku, postGetProductRequest, options).then((request) => request(axios, basePath));
|
|
17999
18066
|
},
|
|
18000
18067
|
/**
|
|
18001
18068
|
* Get Product For Customer
|
|
@@ -18094,13 +18161,13 @@ export class ProductsApi extends BaseAPI {
|
|
|
18094
18161
|
* Get Product
|
|
18095
18162
|
* @summary Get Product
|
|
18096
18163
|
* @param {string} sku Product SKU
|
|
18097
|
-
* @param {
|
|
18164
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
18098
18165
|
* @param {*} [options] Override http request option.
|
|
18099
18166
|
* @throws {RequiredError}
|
|
18100
18167
|
* @memberof ProductsApi
|
|
18101
18168
|
*/
|
|
18102
|
-
public postGetProduct(sku: string,
|
|
18103
|
-
return ProductsApiFp(this.configuration).postGetProduct(sku,
|
|
18169
|
+
public postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig) {
|
|
18170
|
+
return ProductsApiFp(this.configuration).postGetProduct(sku, postGetProductRequest, options).then((request) => request(this.axios, this.basePath));
|
|
18104
18171
|
}
|
|
18105
18172
|
|
|
18106
18173
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -4606,6 +4606,37 @@ export interface PostGetProductForCustomerRequest {
|
|
|
4606
4606
|
* @memberof PostGetProductForCustomerRequest
|
|
4607
4607
|
*/
|
|
4608
4608
|
'hosting'?: boolean | null;
|
|
4609
|
+
/**
|
|
4610
|
+
* 3CX Sales Code
|
|
4611
|
+
* @type {string}
|
|
4612
|
+
* @memberof PostGetProductForCustomerRequest
|
|
4613
|
+
*/
|
|
4614
|
+
'tcxSalesCode'?: string | null;
|
|
4615
|
+
}
|
|
4616
|
+
/**
|
|
4617
|
+
*
|
|
4618
|
+
* @export
|
|
4619
|
+
* @interface PostGetProductRequest
|
|
4620
|
+
*/
|
|
4621
|
+
export interface PostGetProductRequest {
|
|
4622
|
+
/**
|
|
4623
|
+
* Quantity
|
|
4624
|
+
* @type {number}
|
|
4625
|
+
* @memberof PostGetProductRequest
|
|
4626
|
+
*/
|
|
4627
|
+
'quantity'?: number | null;
|
|
4628
|
+
/**
|
|
4629
|
+
* 3CX Licence Key
|
|
4630
|
+
* @type {string}
|
|
4631
|
+
* @memberof PostGetProductRequest
|
|
4632
|
+
*/
|
|
4633
|
+
'licenceKey'?: string | null;
|
|
4634
|
+
/**
|
|
4635
|
+
* 3CX Hosting
|
|
4636
|
+
* @type {boolean}
|
|
4637
|
+
* @memberof PostGetProductRequest
|
|
4638
|
+
*/
|
|
4639
|
+
'hosting'?: boolean | null;
|
|
4609
4640
|
}
|
|
4610
4641
|
/**
|
|
4611
4642
|
* Price & Stock List
|
|
@@ -12871,7 +12902,25 @@ export declare const PostAccessTokenScopeEnum: {
|
|
|
12871
12902
|
readonly Scope: "scope";
|
|
12872
12903
|
readonly Portal: "portal";
|
|
12873
12904
|
readonly TcxWizard: "tcx_wizard";
|
|
12874
|
-
readonly
|
|
12905
|
+
readonly AccountsRead: "accounts.read";
|
|
12906
|
+
readonly AccountsWrite: "accounts.write";
|
|
12907
|
+
readonly PricingRead: "pricing.read";
|
|
12908
|
+
readonly OrdersRead: "orders.read";
|
|
12909
|
+
readonly OrdersWrite: "orders.write";
|
|
12910
|
+
readonly ProductsRead: "products.read";
|
|
12911
|
+
readonly ProvisioningRead: "provisioning.read";
|
|
12912
|
+
readonly ProvisioningWrite: "provisioning.write";
|
|
12913
|
+
readonly TrunksRead: "trunks.read";
|
|
12914
|
+
readonly TrunksWrite: "trunks.write";
|
|
12915
|
+
readonly TcxIntegrationsRead: "tcx_integrations.read";
|
|
12916
|
+
readonly TcxIntegrationsWrite: "tcx_integrations.write";
|
|
12917
|
+
readonly TcxLicenceDetailsRead: "tcx_licence_details.read";
|
|
12918
|
+
readonly TcxInstallationsRead: "tcx_installations.read";
|
|
12919
|
+
readonly TcxInstallationsWrite: "tcx_installations.write";
|
|
12920
|
+
readonly TcxMtRead: "tcx_mt.read";
|
|
12921
|
+
readonly TcxMtWrite: "tcx_mt.write";
|
|
12922
|
+
readonly TicketsRead: "tickets.read";
|
|
12923
|
+
readonly TicketsWrite: "tickets.write";
|
|
12875
12924
|
};
|
|
12876
12925
|
export type PostAccessTokenScopeEnum = typeof PostAccessTokenScopeEnum[keyof typeof PostAccessTokenScopeEnum];
|
|
12877
12926
|
/**
|
|
@@ -12891,7 +12940,25 @@ export declare const PostAuthoriseScopeEnum: {
|
|
|
12891
12940
|
readonly Scope: "scope";
|
|
12892
12941
|
readonly Portal: "portal";
|
|
12893
12942
|
readonly TcxWizard: "tcx_wizard";
|
|
12894
|
-
readonly
|
|
12943
|
+
readonly AccountsRead: "accounts.read";
|
|
12944
|
+
readonly AccountsWrite: "accounts.write";
|
|
12945
|
+
readonly PricingRead: "pricing.read";
|
|
12946
|
+
readonly OrdersRead: "orders.read";
|
|
12947
|
+
readonly OrdersWrite: "orders.write";
|
|
12948
|
+
readonly ProductsRead: "products.read";
|
|
12949
|
+
readonly ProvisioningRead: "provisioning.read";
|
|
12950
|
+
readonly ProvisioningWrite: "provisioning.write";
|
|
12951
|
+
readonly TrunksRead: "trunks.read";
|
|
12952
|
+
readonly TrunksWrite: "trunks.write";
|
|
12953
|
+
readonly TcxIntegrationsRead: "tcx_integrations.read";
|
|
12954
|
+
readonly TcxIntegrationsWrite: "tcx_integrations.write";
|
|
12955
|
+
readonly TcxLicenceDetailsRead: "tcx_licence_details.read";
|
|
12956
|
+
readonly TcxInstallationsRead: "tcx_installations.read";
|
|
12957
|
+
readonly TcxInstallationsWrite: "tcx_installations.write";
|
|
12958
|
+
readonly TcxMtRead: "tcx_mt.read";
|
|
12959
|
+
readonly TcxMtWrite: "tcx_mt.write";
|
|
12960
|
+
readonly TicketsRead: "tickets.read";
|
|
12961
|
+
readonly TicketsWrite: "tickets.write";
|
|
12895
12962
|
};
|
|
12896
12963
|
export type PostAuthoriseScopeEnum = typeof PostAuthoriseScopeEnum[keyof typeof PostAuthoriseScopeEnum];
|
|
12897
12964
|
/**
|
|
@@ -13530,11 +13597,11 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
13530
13597
|
* Get Product
|
|
13531
13598
|
* @summary Get Product
|
|
13532
13599
|
* @param {string} sku Product SKU
|
|
13533
|
-
* @param {
|
|
13600
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
13534
13601
|
* @param {*} [options] Override http request option.
|
|
13535
13602
|
* @throws {RequiredError}
|
|
13536
13603
|
*/
|
|
13537
|
-
postGetProduct: (sku: string,
|
|
13604
|
+
postGetProduct: (sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13538
13605
|
/**
|
|
13539
13606
|
* Get Product For Customer
|
|
13540
13607
|
* @summary Get Product For Customer
|
|
@@ -13602,11 +13669,11 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
13602
13669
|
* Get Product
|
|
13603
13670
|
* @summary Get Product
|
|
13604
13671
|
* @param {string} sku Product SKU
|
|
13605
|
-
* @param {
|
|
13672
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
13606
13673
|
* @param {*} [options] Override http request option.
|
|
13607
13674
|
* @throws {RequiredError}
|
|
13608
13675
|
*/
|
|
13609
|
-
postGetProduct(sku: string,
|
|
13676
|
+
postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>>;
|
|
13610
13677
|
/**
|
|
13611
13678
|
* Get Product For Customer
|
|
13612
13679
|
* @summary Get Product For Customer
|
|
@@ -13674,11 +13741,11 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
13674
13741
|
* Get Product
|
|
13675
13742
|
* @summary Get Product
|
|
13676
13743
|
* @param {string} sku Product SKU
|
|
13677
|
-
* @param {
|
|
13744
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
13678
13745
|
* @param {*} [options] Override http request option.
|
|
13679
13746
|
* @throws {RequiredError}
|
|
13680
13747
|
*/
|
|
13681
|
-
postGetProduct(sku: string,
|
|
13748
|
+
postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO>;
|
|
13682
13749
|
/**
|
|
13683
13750
|
* Get Product For Customer
|
|
13684
13751
|
* @summary Get Product For Customer
|
|
@@ -13754,12 +13821,12 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
13754
13821
|
* Get Product
|
|
13755
13822
|
* @summary Get Product
|
|
13756
13823
|
* @param {string} sku Product SKU
|
|
13757
|
-
* @param {
|
|
13824
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
13758
13825
|
* @param {*} [options] Override http request option.
|
|
13759
13826
|
* @throws {RequiredError}
|
|
13760
13827
|
* @memberof ProductsApi
|
|
13761
13828
|
*/
|
|
13762
|
-
postGetProduct(sku: string,
|
|
13829
|
+
postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSummaryDTO, any, {}>>;
|
|
13763
13830
|
/**
|
|
13764
13831
|
* Get Product For Customer
|
|
13765
13832
|
* @summary Get Product For Customer
|
package/dist/api.js
CHANGED
|
@@ -8120,7 +8120,25 @@ exports.PostAccessTokenScopeEnum = {
|
|
|
8120
8120
|
Scope: 'scope',
|
|
8121
8121
|
Portal: 'portal',
|
|
8122
8122
|
TcxWizard: 'tcx_wizard',
|
|
8123
|
-
|
|
8123
|
+
AccountsRead: 'accounts.read',
|
|
8124
|
+
AccountsWrite: 'accounts.write',
|
|
8125
|
+
PricingRead: 'pricing.read',
|
|
8126
|
+
OrdersRead: 'orders.read',
|
|
8127
|
+
OrdersWrite: 'orders.write',
|
|
8128
|
+
ProductsRead: 'products.read',
|
|
8129
|
+
ProvisioningRead: 'provisioning.read',
|
|
8130
|
+
ProvisioningWrite: 'provisioning.write',
|
|
8131
|
+
TrunksRead: 'trunks.read',
|
|
8132
|
+
TrunksWrite: 'trunks.write',
|
|
8133
|
+
TcxIntegrationsRead: 'tcx_integrations.read',
|
|
8134
|
+
TcxIntegrationsWrite: 'tcx_integrations.write',
|
|
8135
|
+
TcxLicenceDetailsRead: 'tcx_licence_details.read',
|
|
8136
|
+
TcxInstallationsRead: 'tcx_installations.read',
|
|
8137
|
+
TcxInstallationsWrite: 'tcx_installations.write',
|
|
8138
|
+
TcxMtRead: 'tcx_mt.read',
|
|
8139
|
+
TcxMtWrite: 'tcx_mt.write',
|
|
8140
|
+
TicketsRead: 'tickets.read',
|
|
8141
|
+
TicketsWrite: 'tickets.write'
|
|
8124
8142
|
};
|
|
8125
8143
|
/**
|
|
8126
8144
|
* @export
|
|
@@ -8138,7 +8156,25 @@ exports.PostAuthoriseScopeEnum = {
|
|
|
8138
8156
|
Scope: 'scope',
|
|
8139
8157
|
Portal: 'portal',
|
|
8140
8158
|
TcxWizard: 'tcx_wizard',
|
|
8141
|
-
|
|
8159
|
+
AccountsRead: 'accounts.read',
|
|
8160
|
+
AccountsWrite: 'accounts.write',
|
|
8161
|
+
PricingRead: 'pricing.read',
|
|
8162
|
+
OrdersRead: 'orders.read',
|
|
8163
|
+
OrdersWrite: 'orders.write',
|
|
8164
|
+
ProductsRead: 'products.read',
|
|
8165
|
+
ProvisioningRead: 'provisioning.read',
|
|
8166
|
+
ProvisioningWrite: 'provisioning.write',
|
|
8167
|
+
TrunksRead: 'trunks.read',
|
|
8168
|
+
TrunksWrite: 'trunks.write',
|
|
8169
|
+
TcxIntegrationsRead: 'tcx_integrations.read',
|
|
8170
|
+
TcxIntegrationsWrite: 'tcx_integrations.write',
|
|
8171
|
+
TcxLicenceDetailsRead: 'tcx_licence_details.read',
|
|
8172
|
+
TcxInstallationsRead: 'tcx_installations.read',
|
|
8173
|
+
TcxInstallationsWrite: 'tcx_installations.write',
|
|
8174
|
+
TcxMtRead: 'tcx_mt.read',
|
|
8175
|
+
TcxMtWrite: 'tcx_mt.write',
|
|
8176
|
+
TicketsRead: 'tickets.read',
|
|
8177
|
+
TicketsWrite: 'tickets.write'
|
|
8142
8178
|
};
|
|
8143
8179
|
/**
|
|
8144
8180
|
* OrdersApi - axios parameter creator
|
|
@@ -9531,23 +9567,23 @@ var ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
9531
9567
|
* Get Product
|
|
9532
9568
|
* @summary Get Product
|
|
9533
9569
|
* @param {string} sku Product SKU
|
|
9534
|
-
* @param {
|
|
9570
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
9535
9571
|
* @param {*} [options] Override http request option.
|
|
9536
9572
|
* @throws {RequiredError}
|
|
9537
9573
|
*/
|
|
9538
|
-
postGetProduct: function (sku_1,
|
|
9574
|
+
postGetProduct: function (sku_1, postGetProductRequest_1) {
|
|
9539
9575
|
var args_1 = [];
|
|
9540
9576
|
for (var _i = 2; _i < arguments.length; _i++) {
|
|
9541
9577
|
args_1[_i - 2] = arguments[_i];
|
|
9542
9578
|
}
|
|
9543
|
-
return __awaiter(_this, __spreadArray([sku_1,
|
|
9579
|
+
return __awaiter(_this, __spreadArray([sku_1, postGetProductRequest_1], args_1, true), void 0, function (sku, postGetProductRequest, options) {
|
|
9544
9580
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
9545
9581
|
if (options === void 0) { options = {}; }
|
|
9546
9582
|
return __generator(this, function (_a) {
|
|
9547
9583
|
// verify required parameter 'sku' is not null or undefined
|
|
9548
9584
|
(0, common_1.assertParamExists)('postGetProduct', 'sku', sku);
|
|
9549
|
-
// verify required parameter '
|
|
9550
|
-
(0, common_1.assertParamExists)('postGetProduct', '
|
|
9585
|
+
// verify required parameter 'postGetProductRequest' is not null or undefined
|
|
9586
|
+
(0, common_1.assertParamExists)('postGetProduct', 'postGetProductRequest', postGetProductRequest);
|
|
9551
9587
|
localVarPath = "/products/{sku}"
|
|
9552
9588
|
.replace("{".concat("sku", "}"), encodeURIComponent(String(sku)));
|
|
9553
9589
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -9561,7 +9597,7 @@ var ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
9561
9597
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
9562
9598
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9563
9599
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
9564
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
9600
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(postGetProductRequest, localVarRequestOptions, configuration);
|
|
9565
9601
|
return [2 /*return*/, {
|
|
9566
9602
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
9567
9603
|
options: localVarRequestOptions,
|
|
@@ -9768,17 +9804,17 @@ var ProductsApiFp = function (configuration) {
|
|
|
9768
9804
|
* Get Product
|
|
9769
9805
|
* @summary Get Product
|
|
9770
9806
|
* @param {string} sku Product SKU
|
|
9771
|
-
* @param {
|
|
9807
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
9772
9808
|
* @param {*} [options] Override http request option.
|
|
9773
9809
|
* @throws {RequiredError}
|
|
9774
9810
|
*/
|
|
9775
|
-
postGetProduct: function (sku,
|
|
9811
|
+
postGetProduct: function (sku, postGetProductRequest, options) {
|
|
9776
9812
|
return __awaiter(this, void 0, void 0, function () {
|
|
9777
9813
|
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
9778
9814
|
var _a, _b, _c;
|
|
9779
9815
|
return __generator(this, function (_d) {
|
|
9780
9816
|
switch (_d.label) {
|
|
9781
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postGetProduct(sku,
|
|
9817
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postGetProduct(sku, postGetProductRequest, options)];
|
|
9782
9818
|
case 1:
|
|
9783
9819
|
localVarAxiosArgs = _d.sent();
|
|
9784
9820
|
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
@@ -9886,12 +9922,12 @@ var ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
9886
9922
|
* Get Product
|
|
9887
9923
|
* @summary Get Product
|
|
9888
9924
|
* @param {string} sku Product SKU
|
|
9889
|
-
* @param {
|
|
9925
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
9890
9926
|
* @param {*} [options] Override http request option.
|
|
9891
9927
|
* @throws {RequiredError}
|
|
9892
9928
|
*/
|
|
9893
|
-
postGetProduct: function (sku,
|
|
9894
|
-
return localVarFp.postGetProduct(sku,
|
|
9929
|
+
postGetProduct: function (sku, postGetProductRequest, options) {
|
|
9930
|
+
return localVarFp.postGetProduct(sku, postGetProductRequest, options).then(function (request) { return request(axios, basePath); });
|
|
9895
9931
|
},
|
|
9896
9932
|
/**
|
|
9897
9933
|
* Get Product For Customer
|
|
@@ -9994,14 +10030,14 @@ var ProductsApi = /** @class */ (function (_super) {
|
|
|
9994
10030
|
* Get Product
|
|
9995
10031
|
* @summary Get Product
|
|
9996
10032
|
* @param {string} sku Product SKU
|
|
9997
|
-
* @param {
|
|
10033
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
9998
10034
|
* @param {*} [options] Override http request option.
|
|
9999
10035
|
* @throws {RequiredError}
|
|
10000
10036
|
* @memberof ProductsApi
|
|
10001
10037
|
*/
|
|
10002
|
-
ProductsApi.prototype.postGetProduct = function (sku,
|
|
10038
|
+
ProductsApi.prototype.postGetProduct = function (sku, postGetProductRequest, options) {
|
|
10003
10039
|
var _this = this;
|
|
10004
|
-
return (0, exports.ProductsApiFp)(this.configuration).postGetProduct(sku,
|
|
10040
|
+
return (0, exports.ProductsApiFp)(this.configuration).postGetProduct(sku, postGetProductRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
10005
10041
|
};
|
|
10006
10042
|
/**
|
|
10007
10043
|
* Get Product For Customer
|
package/docs/OAuth20Api.md
CHANGED
|
@@ -157,7 +157,7 @@ const { status, data } = await apiInstance.postAccessToken(
|
|
|
157
157
|
| **clientId** | [**string**] | OAuth 2.0 Client ID | (optional) defaults to undefined|
|
|
158
158
|
| **clientSecret** | [**string**] | OAuth 2.0 Client Secret | (optional) defaults to undefined|
|
|
159
159
|
| **grantType** | [**string**]**Array<'client_credentials' | 'code' | 'refresh_token' | 'authorization_code' | 'ms_auth' | 'token_exchange' | 'password'>** | OAuth 2.0 Grant Type | (optional) defaults to undefined|
|
|
160
|
-
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | '
|
|
160
|
+
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | (optional) defaults to undefined|
|
|
161
161
|
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
|
|
162
162
|
| **code** | [**string**] | OAuth 2.0 Auth Code | (optional) defaults to undefined|
|
|
163
163
|
| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
|
|
@@ -210,7 +210,7 @@ const apiInstance = new OAuth20Api(configuration);
|
|
|
210
210
|
|
|
211
211
|
let clientId: string; //OAuth 2.0 Client ID (default to undefined)
|
|
212
212
|
let responseType: string; //OAuth 2.0 Response Type (default to 'code')
|
|
213
|
-
let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | '
|
|
213
|
+
let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
|
|
214
214
|
let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
|
|
215
215
|
let state: string; //OAuth 2.0 State (optional) (default to undefined)
|
|
216
216
|
let codeChallenge: string; //OAuth 2.0 Code Challenge (optional) (default to undefined)
|
|
@@ -233,7 +233,7 @@ const { status, data } = await apiInstance.postAuthorise(
|
|
|
233
233
|
|------------- | ------------- | ------------- | -------------|
|
|
234
234
|
| **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
|
|
235
235
|
| **responseType** | [**string**] | OAuth 2.0 Response Type | defaults to 'code'|
|
|
236
|
-
| **scope** | [**'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | '
|
|
236
|
+
| **scope** | [**'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | defaults to undefined|
|
|
237
237
|
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
|
|
238
238
|
| **state** | [**string**] | OAuth 2.0 State | (optional) defaults to undefined|
|
|
239
239
|
| **codeChallenge** | [**string**] | OAuth 2.0 Code Challenge | (optional) defaults to undefined|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**quantity** | **number** | Quantity | [optional] [default to undefined]
|
|
9
9
|
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
10
10
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
11
|
+
**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: PostGetProductForCustomerRequest = {
|
|
|
18
19
|
quantity,
|
|
19
20
|
licenceKey,
|
|
20
21
|
hosting,
|
|
22
|
+
tcxSalesCode,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PostGetProductRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**quantity** | **number** | Quantity | [optional] [default to undefined]
|
|
9
|
+
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
10
|
+
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PostGetProductRequest } from 'yellowgrid-api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: PostGetProductRequest = {
|
|
18
|
+
quantity,
|
|
19
|
+
licenceKey,
|
|
20
|
+
hosting,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[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/ProductsApi.md
CHANGED
|
@@ -316,7 +316,7 @@ No authorization required
|
|
|
316
316
|
[[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)
|
|
317
317
|
|
|
318
318
|
# **postGetProduct**
|
|
319
|
-
> ProductSummaryDTO postGetProduct(
|
|
319
|
+
> ProductSummaryDTO postGetProduct(postGetProductRequest)
|
|
320
320
|
|
|
321
321
|
Get Product
|
|
322
322
|
|
|
@@ -326,18 +326,18 @@ Get Product
|
|
|
326
326
|
import {
|
|
327
327
|
ProductsApi,
|
|
328
328
|
Configuration,
|
|
329
|
-
|
|
329
|
+
PostGetProductRequest
|
|
330
330
|
} from 'yellowgrid-api-ts';
|
|
331
331
|
|
|
332
332
|
const configuration = new Configuration();
|
|
333
333
|
const apiInstance = new ProductsApi(configuration);
|
|
334
334
|
|
|
335
335
|
let sku: string; //Product SKU (default to undefined)
|
|
336
|
-
let
|
|
336
|
+
let postGetProductRequest: PostGetProductRequest; //Product search criteria
|
|
337
337
|
|
|
338
338
|
const { status, data } = await apiInstance.postGetProduct(
|
|
339
339
|
sku,
|
|
340
|
-
|
|
340
|
+
postGetProductRequest
|
|
341
341
|
);
|
|
342
342
|
```
|
|
343
343
|
|
|
@@ -345,7 +345,7 @@ const { status, data } = await apiInstance.postGetProduct(
|
|
|
345
345
|
|
|
346
346
|
|Name | Type | Description | Notes|
|
|
347
347
|
|------------- | ------------- | ------------- | -------------|
|
|
348
|
-
| **
|
|
348
|
+
| **postGetProductRequest** | **PostGetProductRequest**| Product search criteria | |
|
|
349
349
|
| **sku** | [**string**] | Product SKU | defaults to undefined|
|
|
350
350
|
|
|
351
351
|
|