yellowgrid-api-ts 3.2.6-dev.0 → 3.2.7-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/README.md +4 -3
- package/api.ts +73 -8
- package/dist/api.d.ts +40 -8
- package/dist/api.js +82 -8
- package/docs/AccountsApi.md +1 -1
- package/docs/AdminOrderRequestDTO.md +2 -0
- package/docs/OAuth20Api.md +3 -3
- package/docs/ProductsApi.md +48 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -63,7 +63,7 @@ Class | Method | HTTP request | Description
|
|
|
63
63
|
*AccountsApi* | [**patchSetTcxWizardCname**](docs/AccountsApi.md#patchsettcxwizardcname) | **PATCH** /accounts/me/cname |
|
|
64
64
|
*AccountsApi* | [**patchUpdateAccountContactPassword**](docs/AccountsApi.md#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password
|
|
65
65
|
*AccountsApi* | [**postGetAccountContacts**](docs/AccountsApi.md#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact
|
|
66
|
-
*AccountsApi* | [**postGetAccounts**](docs/AccountsApi.md#postgetaccounts) | **POST** /accounts | Create new customer account
|
|
66
|
+
*AccountsApi* | [**postGetAccounts**](docs/AccountsApi.md#postgetaccounts) | **POST** /accounts | Create a new customer account
|
|
67
67
|
*AccountsApi* | [**postGetAdminAccount**](docs/AccountsApi.md#postgetadminaccount) | **POST** /admin/me | Get Admin Account
|
|
68
68
|
*AccountsApi* | [**postGetClientCredentials**](docs/AccountsApi.md#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials
|
|
69
69
|
*AccountsApi* | [**postSendEmailVerificationEmail**](docs/AccountsApi.md#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email
|
|
@@ -157,6 +157,7 @@ Class | Method | HTTP request | Description
|
|
|
157
157
|
*PricingApi* | [**getGetPriceList**](docs/PricingApi.md#getgetpricelist) | **GET** /finance/pricing/lists | Get Price List
|
|
158
158
|
*PricingApi* | [**postSendPriceList**](docs/PricingApi.md#postsendpricelist) | **POST** /finance/pricing/lists/send | Send Price List
|
|
159
159
|
*ProductsApi* | [**getGetAttributeSets**](docs/ProductsApi.md#getgetattributesets) | **GET** /products/attributes | Get Attribute Sets
|
|
160
|
+
*ProductsApi* | [**getGetCustomerPriceLists**](docs/ProductsApi.md#getgetcustomerpricelists) | **GET** /products/prices/lists | Get Customer Price Lists
|
|
160
161
|
*ProductsApi* | [**getGetLegacyStockList**](docs/ProductsApi.md#getgetlegacystocklist) | **GET** /products/stock/legacy | Get Current Stock & Pricing
|
|
161
162
|
*ProductsApi* | [**getGetProducts**](docs/ProductsApi.md#getgetproducts) | **GET** /products | Get Products
|
|
162
163
|
*ProductsApi* | [**getGetStockList**](docs/ProductsApi.md#getgetstocklist) | **GET** /products/stock | Get Current Stock & Pricing
|
|
@@ -446,8 +447,8 @@ Authentication schemes defined for the API:
|
|
|
446
447
|
- **tcx_wizard**: 3CX Installation Wizard
|
|
447
448
|
- **accounts.read**: Accounts (Read)
|
|
448
449
|
- **accounts.write**: Accounts (Write)
|
|
449
|
-
- **
|
|
450
|
-
- **
|
|
450
|
+
- **number_porting.read**: Number Porting (Read)
|
|
451
|
+
- **number_porting.write**: Number Porting (Write)
|
|
451
452
|
- **pricing.read**: Pricing (Read)
|
|
452
453
|
- **orders.read**: Orders (Read)
|
|
453
454
|
- **orders.write**: Orders (Write)
|
package/api.ts
CHANGED
|
@@ -490,6 +490,10 @@ export interface AdminOrderRequestDTO {
|
|
|
490
490
|
* Carriage Charge
|
|
491
491
|
*/
|
|
492
492
|
'carriageCharge'?: number;
|
|
493
|
+
/**
|
|
494
|
+
* Send Order Email
|
|
495
|
+
*/
|
|
496
|
+
'sendOrderEmail'?: boolean | null;
|
|
493
497
|
}
|
|
494
498
|
/**
|
|
495
499
|
* Admin User
|
|
@@ -7056,7 +7060,7 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
7056
7060
|
},
|
|
7057
7061
|
/**
|
|
7058
7062
|
* Create new customer account
|
|
7059
|
-
* @summary Create new customer account
|
|
7063
|
+
* @summary Create a new customer account
|
|
7060
7064
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
7061
7065
|
* @param {*} [options] Override http request option.
|
|
7062
7066
|
* @throws {RequiredError}
|
|
@@ -7473,7 +7477,7 @@ export const AccountsApiFp = function(configuration?: Configuration) {
|
|
|
7473
7477
|
},
|
|
7474
7478
|
/**
|
|
7475
7479
|
* Create new customer account
|
|
7476
|
-
* @summary Create new customer account
|
|
7480
|
+
* @summary Create a new customer account
|
|
7477
7481
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
7478
7482
|
* @param {*} [options] Override http request option.
|
|
7479
7483
|
* @throws {RequiredError}
|
|
@@ -7695,7 +7699,7 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
|
|
|
7695
7699
|
},
|
|
7696
7700
|
/**
|
|
7697
7701
|
* Create new customer account
|
|
7698
|
-
* @summary Create new customer account
|
|
7702
|
+
* @summary Create a new customer account
|
|
7699
7703
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
7700
7704
|
* @param {*} [options] Override http request option.
|
|
7701
7705
|
* @throws {RequiredError}
|
|
@@ -7906,7 +7910,7 @@ export class AccountsApi extends BaseAPI {
|
|
|
7906
7910
|
|
|
7907
7911
|
/**
|
|
7908
7912
|
* Create new customer account
|
|
7909
|
-
* @summary Create new customer account
|
|
7913
|
+
* @summary Create a new customer account
|
|
7910
7914
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
7911
7915
|
* @param {*} [options] Override http request option.
|
|
7912
7916
|
* @throws {RequiredError}
|
|
@@ -14314,8 +14318,8 @@ export const PostAccessTokenScopeEnum = {
|
|
|
14314
14318
|
TcxWizard: 'tcx_wizard',
|
|
14315
14319
|
AccountsRead: 'accounts.read',
|
|
14316
14320
|
AccountsWrite: 'accounts.write',
|
|
14317
|
-
|
|
14318
|
-
|
|
14321
|
+
NumberPortingRead: 'number_porting.read',
|
|
14322
|
+
NumberPortingWrite: 'number_porting.write',
|
|
14319
14323
|
PricingRead: 'pricing.read',
|
|
14320
14324
|
OrdersRead: 'orders.read',
|
|
14321
14325
|
OrdersWrite: 'orders.write',
|
|
@@ -14348,8 +14352,8 @@ export const PostAuthoriseScopeEnum = {
|
|
|
14348
14352
|
TcxWizard: 'tcx_wizard',
|
|
14349
14353
|
AccountsRead: 'accounts.read',
|
|
14350
14354
|
AccountsWrite: 'accounts.write',
|
|
14351
|
-
|
|
14352
|
-
|
|
14355
|
+
NumberPortingRead: 'number_porting.read',
|
|
14356
|
+
NumberPortingWrite: 'number_porting.write',
|
|
14353
14357
|
PricingRead: 'pricing.read',
|
|
14354
14358
|
OrdersRead: 'orders.read',
|
|
14355
14359
|
OrdersWrite: 'orders.write',
|
|
@@ -15406,6 +15410,36 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
15406
15410
|
|
|
15407
15411
|
|
|
15408
15412
|
|
|
15413
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15414
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15415
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
15416
|
+
|
|
15417
|
+
return {
|
|
15418
|
+
url: toPathString(localVarUrlObj),
|
|
15419
|
+
options: localVarRequestOptions,
|
|
15420
|
+
};
|
|
15421
|
+
},
|
|
15422
|
+
/**
|
|
15423
|
+
* Get Customer Price Lists
|
|
15424
|
+
* @summary Get Customer Price Lists
|
|
15425
|
+
* @param {*} [options] Override http request option.
|
|
15426
|
+
* @throws {RequiredError}
|
|
15427
|
+
*/
|
|
15428
|
+
getGetCustomerPriceLists: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
15429
|
+
const localVarPath = `/products/prices/lists`;
|
|
15430
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15431
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15432
|
+
let baseOptions;
|
|
15433
|
+
if (configuration) {
|
|
15434
|
+
baseOptions = configuration.baseOptions;
|
|
15435
|
+
}
|
|
15436
|
+
|
|
15437
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
15438
|
+
const localVarHeaderParameter = {} as any;
|
|
15439
|
+
const localVarQueryParameter = {} as any;
|
|
15440
|
+
|
|
15441
|
+
|
|
15442
|
+
|
|
15409
15443
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15410
15444
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15411
15445
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -15696,6 +15730,18 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
15696
15730
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.getGetAttributeSets']?.[localVarOperationServerIndex]?.url;
|
|
15697
15731
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15698
15732
|
},
|
|
15733
|
+
/**
|
|
15734
|
+
* Get Customer Price Lists
|
|
15735
|
+
* @summary Get Customer Price Lists
|
|
15736
|
+
* @param {*} [options] Override http request option.
|
|
15737
|
+
* @throws {RequiredError}
|
|
15738
|
+
*/
|
|
15739
|
+
async getGetCustomerPriceLists(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CustomerPriceListEnum>>> {
|
|
15740
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCustomerPriceLists(options);
|
|
15741
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
15742
|
+
const localVarOperationServerBasePath = operationServerMap['ProductsApi.getGetCustomerPriceLists']?.[localVarOperationServerIndex]?.url;
|
|
15743
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15744
|
+
},
|
|
15699
15745
|
/**
|
|
15700
15746
|
* Get Current Stock & Pricing
|
|
15701
15747
|
* @summary Get Current Stock & Pricing
|
|
@@ -15808,6 +15854,15 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
15808
15854
|
getGetAttributeSets(options?: RawAxiosRequestConfig): AxiosPromise<Array<AttributeSetEnum>> {
|
|
15809
15855
|
return localVarFp.getGetAttributeSets(options).then((request) => request(axios, basePath));
|
|
15810
15856
|
},
|
|
15857
|
+
/**
|
|
15858
|
+
* Get Customer Price Lists
|
|
15859
|
+
* @summary Get Customer Price Lists
|
|
15860
|
+
* @param {*} [options] Override http request option.
|
|
15861
|
+
* @throws {RequiredError}
|
|
15862
|
+
*/
|
|
15863
|
+
getGetCustomerPriceLists(options?: RawAxiosRequestConfig): AxiosPromise<Array<CustomerPriceListEnum>> {
|
|
15864
|
+
return localVarFp.getGetCustomerPriceLists(options).then((request) => request(axios, basePath));
|
|
15865
|
+
},
|
|
15811
15866
|
/**
|
|
15812
15867
|
* Get Current Stock & Pricing
|
|
15813
15868
|
* @summary Get Current Stock & Pricing
|
|
@@ -15898,6 +15953,16 @@ export class ProductsApi extends BaseAPI {
|
|
|
15898
15953
|
return ProductsApiFp(this.configuration).getGetAttributeSets(options).then((request) => request(this.axios, this.basePath));
|
|
15899
15954
|
}
|
|
15900
15955
|
|
|
15956
|
+
/**
|
|
15957
|
+
* Get Customer Price Lists
|
|
15958
|
+
* @summary Get Customer Price Lists
|
|
15959
|
+
* @param {*} [options] Override http request option.
|
|
15960
|
+
* @throws {RequiredError}
|
|
15961
|
+
*/
|
|
15962
|
+
public getGetCustomerPriceLists(options?: RawAxiosRequestConfig) {
|
|
15963
|
+
return ProductsApiFp(this.configuration).getGetCustomerPriceLists(options).then((request) => request(this.axios, this.basePath));
|
|
15964
|
+
}
|
|
15965
|
+
|
|
15901
15966
|
/**
|
|
15902
15967
|
* Get Current Stock & Pricing
|
|
15903
15968
|
* @summary Get Current Stock & Pricing
|
package/dist/api.d.ts
CHANGED
|
@@ -480,6 +480,10 @@ export interface AdminOrderRequestDTO {
|
|
|
480
480
|
* Carriage Charge
|
|
481
481
|
*/
|
|
482
482
|
'carriageCharge'?: number;
|
|
483
|
+
/**
|
|
484
|
+
* Send Order Email
|
|
485
|
+
*/
|
|
486
|
+
'sendOrderEmail'?: boolean | null;
|
|
483
487
|
}
|
|
484
488
|
/**
|
|
485
489
|
* Admin User
|
|
@@ -6655,7 +6659,7 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
6655
6659
|
postGetAccountContacts: (accountContactRequestModel?: AccountContactRequestModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6656
6660
|
/**
|
|
6657
6661
|
* Create new customer account
|
|
6658
|
-
* @summary Create new customer account
|
|
6662
|
+
* @summary Create a new customer account
|
|
6659
6663
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
6660
6664
|
* @param {*} [options] Override http request option.
|
|
6661
6665
|
* @throws {RequiredError}
|
|
@@ -6814,7 +6818,7 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
6814
6818
|
postGetAccountContacts(accountContactRequestModel?: AccountContactRequestModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
6815
6819
|
/**
|
|
6816
6820
|
* Create new customer account
|
|
6817
|
-
* @summary Create new customer account
|
|
6821
|
+
* @summary Create a new customer account
|
|
6818
6822
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
6819
6823
|
* @param {*} [options] Override http request option.
|
|
6820
6824
|
* @throws {RequiredError}
|
|
@@ -6973,7 +6977,7 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
6973
6977
|
postGetAccountContacts(accountContactRequestModel?: AccountContactRequestModel, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
6974
6978
|
/**
|
|
6975
6979
|
* Create new customer account
|
|
6976
|
-
* @summary Create new customer account
|
|
6980
|
+
* @summary Create a new customer account
|
|
6977
6981
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
6978
6982
|
* @param {*} [options] Override http request option.
|
|
6979
6983
|
* @throws {RequiredError}
|
|
@@ -7132,7 +7136,7 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
7132
7136
|
postGetAccountContacts(accountContactRequestModel?: AccountContactRequestModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7133
7137
|
/**
|
|
7134
7138
|
* Create new customer account
|
|
7135
|
-
* @summary Create new customer account
|
|
7139
|
+
* @summary Create a new customer account
|
|
7136
7140
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
7137
7141
|
* @param {*} [options] Override http request option.
|
|
7138
7142
|
* @throws {RequiredError}
|
|
@@ -10184,8 +10188,8 @@ export declare const PostAccessTokenScopeEnum: {
|
|
|
10184
10188
|
readonly TcxWizard: "tcx_wizard";
|
|
10185
10189
|
readonly AccountsRead: "accounts.read";
|
|
10186
10190
|
readonly AccountsWrite: "accounts.write";
|
|
10187
|
-
readonly
|
|
10188
|
-
readonly
|
|
10191
|
+
readonly NumberPortingRead: "number_porting.read";
|
|
10192
|
+
readonly NumberPortingWrite: "number_porting.write";
|
|
10189
10193
|
readonly PricingRead: "pricing.read";
|
|
10190
10194
|
readonly OrdersRead: "orders.read";
|
|
10191
10195
|
readonly OrdersWrite: "orders.write";
|
|
@@ -10218,8 +10222,8 @@ export declare const PostAuthoriseScopeEnum: {
|
|
|
10218
10222
|
readonly TcxWizard: "tcx_wizard";
|
|
10219
10223
|
readonly AccountsRead: "accounts.read";
|
|
10220
10224
|
readonly AccountsWrite: "accounts.write";
|
|
10221
|
-
readonly
|
|
10222
|
-
readonly
|
|
10225
|
+
readonly NumberPortingRead: "number_porting.read";
|
|
10226
|
+
readonly NumberPortingWrite: "number_porting.write";
|
|
10223
10227
|
readonly PricingRead: "pricing.read";
|
|
10224
10228
|
readonly OrdersRead: "orders.read";
|
|
10225
10229
|
readonly OrdersWrite: "orders.write";
|
|
@@ -10784,6 +10788,13 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
10784
10788
|
* @throws {RequiredError}
|
|
10785
10789
|
*/
|
|
10786
10790
|
getGetAttributeSets: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10791
|
+
/**
|
|
10792
|
+
* Get Customer Price Lists
|
|
10793
|
+
* @summary Get Customer Price Lists
|
|
10794
|
+
* @param {*} [options] Override http request option.
|
|
10795
|
+
* @throws {RequiredError}
|
|
10796
|
+
*/
|
|
10797
|
+
getGetCustomerPriceLists: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10787
10798
|
/**
|
|
10788
10799
|
* Get Current Stock & Pricing
|
|
10789
10800
|
* @summary Get Current Stock & Pricing
|
|
@@ -10855,6 +10866,13 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
10855
10866
|
* @throws {RequiredError}
|
|
10856
10867
|
*/
|
|
10857
10868
|
getGetAttributeSets(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AttributeSetEnum>>>;
|
|
10869
|
+
/**
|
|
10870
|
+
* Get Customer Price Lists
|
|
10871
|
+
* @summary Get Customer Price Lists
|
|
10872
|
+
* @param {*} [options] Override http request option.
|
|
10873
|
+
* @throws {RequiredError}
|
|
10874
|
+
*/
|
|
10875
|
+
getGetCustomerPriceLists(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CustomerPriceListEnum>>>;
|
|
10858
10876
|
/**
|
|
10859
10877
|
* Get Current Stock & Pricing
|
|
10860
10878
|
* @summary Get Current Stock & Pricing
|
|
@@ -10926,6 +10944,13 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
10926
10944
|
* @throws {RequiredError}
|
|
10927
10945
|
*/
|
|
10928
10946
|
getGetAttributeSets(options?: RawAxiosRequestConfig): AxiosPromise<Array<AttributeSetEnum>>;
|
|
10947
|
+
/**
|
|
10948
|
+
* Get Customer Price Lists
|
|
10949
|
+
* @summary Get Customer Price Lists
|
|
10950
|
+
* @param {*} [options] Override http request option.
|
|
10951
|
+
* @throws {RequiredError}
|
|
10952
|
+
*/
|
|
10953
|
+
getGetCustomerPriceLists(options?: RawAxiosRequestConfig): AxiosPromise<Array<CustomerPriceListEnum>>;
|
|
10929
10954
|
/**
|
|
10930
10955
|
* Get Current Stock & Pricing
|
|
10931
10956
|
* @summary Get Current Stock & Pricing
|
|
@@ -10997,6 +11022,13 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
10997
11022
|
* @throws {RequiredError}
|
|
10998
11023
|
*/
|
|
10999
11024
|
getGetAttributeSets(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AttributeSetEnum[], any, {}>>;
|
|
11025
|
+
/**
|
|
11026
|
+
* Get Customer Price Lists
|
|
11027
|
+
* @summary Get Customer Price Lists
|
|
11028
|
+
* @param {*} [options] Override http request option.
|
|
11029
|
+
* @throws {RequiredError}
|
|
11030
|
+
*/
|
|
11031
|
+
getGetCustomerPriceLists(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomerPriceListEnum[], any, {}>>;
|
|
11000
11032
|
/**
|
|
11001
11033
|
* Get Current Stock & Pricing
|
|
11002
11034
|
* @summary Get Current Stock & Pricing
|
package/dist/api.js
CHANGED
|
@@ -740,7 +740,7 @@ var AccountsApiAxiosParamCreator = function (configuration) {
|
|
|
740
740
|
},
|
|
741
741
|
/**
|
|
742
742
|
* Create new customer account
|
|
743
|
-
* @summary Create new customer account
|
|
743
|
+
* @summary Create a new customer account
|
|
744
744
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
745
745
|
* @param {*} [options] Override http request option.
|
|
746
746
|
* @throws {RequiredError}
|
|
@@ -1291,7 +1291,7 @@ var AccountsApiFp = function (configuration) {
|
|
|
1291
1291
|
},
|
|
1292
1292
|
/**
|
|
1293
1293
|
* Create new customer account
|
|
1294
|
-
* @summary Create new customer account
|
|
1294
|
+
* @summary Create a new customer account
|
|
1295
1295
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
1296
1296
|
* @param {*} [options] Override http request option.
|
|
1297
1297
|
* @throws {RequiredError}
|
|
@@ -1583,7 +1583,7 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
1583
1583
|
},
|
|
1584
1584
|
/**
|
|
1585
1585
|
* Create new customer account
|
|
1586
|
-
* @summary Create new customer account
|
|
1586
|
+
* @summary Create a new customer account
|
|
1587
1587
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
1588
1588
|
* @param {*} [options] Override http request option.
|
|
1589
1589
|
* @throws {RequiredError}
|
|
@@ -1798,7 +1798,7 @@ var AccountsApi = /** @class */ (function (_super) {
|
|
|
1798
1798
|
};
|
|
1799
1799
|
/**
|
|
1800
1800
|
* Create new customer account
|
|
1801
|
-
* @summary Create new customer account
|
|
1801
|
+
* @summary Create a new customer account
|
|
1802
1802
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
1803
1803
|
* @param {*} [options] Override http request option.
|
|
1804
1804
|
* @throws {RequiredError}
|
|
@@ -9080,8 +9080,8 @@ exports.PostAccessTokenScopeEnum = {
|
|
|
9080
9080
|
TcxWizard: 'tcx_wizard',
|
|
9081
9081
|
AccountsRead: 'accounts.read',
|
|
9082
9082
|
AccountsWrite: 'accounts.write',
|
|
9083
|
-
|
|
9084
|
-
|
|
9083
|
+
NumberPortingRead: 'number_porting.read',
|
|
9084
|
+
NumberPortingWrite: 'number_porting.write',
|
|
9085
9085
|
PricingRead: 'pricing.read',
|
|
9086
9086
|
OrdersRead: 'orders.read',
|
|
9087
9087
|
OrdersWrite: 'orders.write',
|
|
@@ -9112,8 +9112,8 @@ exports.PostAuthoriseScopeEnum = {
|
|
|
9112
9112
|
TcxWizard: 'tcx_wizard',
|
|
9113
9113
|
AccountsRead: 'accounts.read',
|
|
9114
9114
|
AccountsWrite: 'accounts.write',
|
|
9115
|
-
|
|
9116
|
-
|
|
9115
|
+
NumberPortingRead: 'number_porting.read',
|
|
9116
|
+
NumberPortingWrite: 'number_porting.write',
|
|
9117
9117
|
PricingRead: 'pricing.read',
|
|
9118
9118
|
OrdersRead: 'orders.read',
|
|
9119
9119
|
OrdersWrite: 'orders.write',
|
|
@@ -10288,6 +10288,39 @@ var ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
10288
10288
|
});
|
|
10289
10289
|
});
|
|
10290
10290
|
},
|
|
10291
|
+
/**
|
|
10292
|
+
* Get Customer Price Lists
|
|
10293
|
+
* @summary Get Customer Price Lists
|
|
10294
|
+
* @param {*} [options] Override http request option.
|
|
10295
|
+
* @throws {RequiredError}
|
|
10296
|
+
*/
|
|
10297
|
+
getGetCustomerPriceLists: function () {
|
|
10298
|
+
var args_1 = [];
|
|
10299
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
10300
|
+
args_1[_i] = arguments[_i];
|
|
10301
|
+
}
|
|
10302
|
+
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
10303
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
10304
|
+
if (options === void 0) { options = {}; }
|
|
10305
|
+
return __generator(this, function (_a) {
|
|
10306
|
+
localVarPath = "/products/prices/lists";
|
|
10307
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
10308
|
+
if (configuration) {
|
|
10309
|
+
baseOptions = configuration.baseOptions;
|
|
10310
|
+
}
|
|
10311
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
10312
|
+
localVarHeaderParameter = {};
|
|
10313
|
+
localVarQueryParameter = {};
|
|
10314
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
10315
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10316
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
10317
|
+
return [2 /*return*/, {
|
|
10318
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
10319
|
+
options: localVarRequestOptions,
|
|
10320
|
+
}];
|
|
10321
|
+
});
|
|
10322
|
+
});
|
|
10323
|
+
},
|
|
10291
10324
|
/**
|
|
10292
10325
|
* Get Current Stock & Pricing
|
|
10293
10326
|
* @summary Get Current Stock & Pricing
|
|
@@ -10593,6 +10626,28 @@ var ProductsApiFp = function (configuration) {
|
|
|
10593
10626
|
});
|
|
10594
10627
|
});
|
|
10595
10628
|
},
|
|
10629
|
+
/**
|
|
10630
|
+
* Get Customer Price Lists
|
|
10631
|
+
* @summary Get Customer Price Lists
|
|
10632
|
+
* @param {*} [options] Override http request option.
|
|
10633
|
+
* @throws {RequiredError}
|
|
10634
|
+
*/
|
|
10635
|
+
getGetCustomerPriceLists: function (options) {
|
|
10636
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
10637
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
10638
|
+
var _a, _b, _c;
|
|
10639
|
+
return __generator(this, function (_d) {
|
|
10640
|
+
switch (_d.label) {
|
|
10641
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetCustomerPriceLists(options)];
|
|
10642
|
+
case 1:
|
|
10643
|
+
localVarAxiosArgs = _d.sent();
|
|
10644
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
10645
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.getGetCustomerPriceLists']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
10646
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
10647
|
+
}
|
|
10648
|
+
});
|
|
10649
|
+
});
|
|
10650
|
+
},
|
|
10596
10651
|
/**
|
|
10597
10652
|
* Get Current Stock & Pricing
|
|
10598
10653
|
* @summary Get Current Stock & Pricing
|
|
@@ -10775,6 +10830,15 @@ var ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
10775
10830
|
getGetAttributeSets: function (options) {
|
|
10776
10831
|
return localVarFp.getGetAttributeSets(options).then(function (request) { return request(axios, basePath); });
|
|
10777
10832
|
},
|
|
10833
|
+
/**
|
|
10834
|
+
* Get Customer Price Lists
|
|
10835
|
+
* @summary Get Customer Price Lists
|
|
10836
|
+
* @param {*} [options] Override http request option.
|
|
10837
|
+
* @throws {RequiredError}
|
|
10838
|
+
*/
|
|
10839
|
+
getGetCustomerPriceLists: function (options) {
|
|
10840
|
+
return localVarFp.getGetCustomerPriceLists(options).then(function (request) { return request(axios, basePath); });
|
|
10841
|
+
},
|
|
10778
10842
|
/**
|
|
10779
10843
|
* Get Current Stock & Pricing
|
|
10780
10844
|
* @summary Get Current Stock & Pricing
|
|
@@ -10869,6 +10933,16 @@ var ProductsApi = /** @class */ (function (_super) {
|
|
|
10869
10933
|
var _this = this;
|
|
10870
10934
|
return (0, exports.ProductsApiFp)(this.configuration).getGetAttributeSets(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
10871
10935
|
};
|
|
10936
|
+
/**
|
|
10937
|
+
* Get Customer Price Lists
|
|
10938
|
+
* @summary Get Customer Price Lists
|
|
10939
|
+
* @param {*} [options] Override http request option.
|
|
10940
|
+
* @throws {RequiredError}
|
|
10941
|
+
*/
|
|
10942
|
+
ProductsApi.prototype.getGetCustomerPriceLists = function (options) {
|
|
10943
|
+
var _this = this;
|
|
10944
|
+
return (0, exports.ProductsApiFp)(this.configuration).getGetCustomerPriceLists(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
10945
|
+
};
|
|
10872
10946
|
/**
|
|
10873
10947
|
* Get Current Stock & Pricing
|
|
10874
10948
|
* @summary Get Current Stock & Pricing
|
package/docs/AccountsApi.md
CHANGED
|
@@ -16,7 +16,7 @@ All URIs are relative to *http://api.yellowgrid.local*
|
|
|
16
16
|
|[**patchSetTcxWizardCname**](#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | |
|
|
17
17
|
|[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
|
|
18
18
|
|[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
|
|
19
|
-
|[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create new customer account|
|
|
19
|
+
|[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
|
|
20
20
|
|[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
|
|
21
21
|
|[**postGetClientCredentials**](#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials|
|
|
22
22
|
|[**postSendEmailVerificationEmail**](#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email|
|
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**ignoreCreditLimit** | **boolean** | Ignore Customer Credit Limit | [optional] [default to false]
|
|
20
20
|
**includeNfrPromos** | **boolean** | Include NFR Promos | [optional] [default to false]
|
|
21
21
|
**carriageCharge** | **number** | Carriage Charge | [optional] [default to undefined]
|
|
22
|
+
**sendOrderEmail** | **boolean** | Send Order Email | [optional] [default to undefined]
|
|
22
23
|
|
|
23
24
|
## Example
|
|
24
25
|
|
|
@@ -39,6 +40,7 @@ const instance: AdminOrderRequestDTO = {
|
|
|
39
40
|
ignoreCreditLimit,
|
|
40
41
|
includeNfrPromos,
|
|
41
42
|
carriageCharge,
|
|
43
|
+
sendOrderEmail,
|
|
42
44
|
};
|
|
43
45
|
```
|
|
44
46
|
|
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' | 'accounts.read' | 'accounts.write' | '
|
|
160
|
+
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.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' | 'accounts.read' | 'accounts.write' | '
|
|
213
|
+
let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.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' | 'accounts.read' | 'accounts.write' | '
|
|
236
|
+
| **scope** | [**'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.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' | 'number_porting.read' | 'number_porting.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|
|
package/docs/ProductsApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *http://api.yellowgrid.local*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getGetAttributeSets**](#getgetattributesets) | **GET** /products/attributes | Get Attribute Sets|
|
|
8
|
+
|[**getGetCustomerPriceLists**](#getgetcustomerpricelists) | **GET** /products/prices/lists | Get Customer Price Lists|
|
|
8
9
|
|[**getGetLegacyStockList**](#getgetlegacystocklist) | **GET** /products/stock/legacy | Get Current Stock & Pricing|
|
|
9
10
|
|[**getGetProducts**](#getgetproducts) | **GET** /products | Get Products|
|
|
10
11
|
|[**getGetStockList**](#getgetstocklist) | **GET** /products/stock | Get Current Stock & Pricing|
|
|
@@ -60,6 +61,53 @@ No authorization required
|
|
|
60
61
|
|
|
61
62
|
[[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)
|
|
62
63
|
|
|
64
|
+
# **getGetCustomerPriceLists**
|
|
65
|
+
> Array<CustomerPriceListEnum> getGetCustomerPriceLists()
|
|
66
|
+
|
|
67
|
+
Get Customer Price Lists
|
|
68
|
+
|
|
69
|
+
### Example
|
|
70
|
+
|
|
71
|
+
```typescript
|
|
72
|
+
import {
|
|
73
|
+
ProductsApi,
|
|
74
|
+
Configuration
|
|
75
|
+
} from 'yellowgrid-api-ts';
|
|
76
|
+
|
|
77
|
+
const configuration = new Configuration();
|
|
78
|
+
const apiInstance = new ProductsApi(configuration);
|
|
79
|
+
|
|
80
|
+
const { status, data } = await apiInstance.getGetCustomerPriceLists();
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Parameters
|
|
84
|
+
This endpoint does not have any parameters.
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
### Return type
|
|
88
|
+
|
|
89
|
+
**Array<CustomerPriceListEnum>**
|
|
90
|
+
|
|
91
|
+
### Authorization
|
|
92
|
+
|
|
93
|
+
No authorization required
|
|
94
|
+
|
|
95
|
+
### HTTP request headers
|
|
96
|
+
|
|
97
|
+
- **Content-Type**: Not defined
|
|
98
|
+
- **Accept**: application/json
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
### HTTP response details
|
|
102
|
+
| Status code | Description | Response headers |
|
|
103
|
+
|-------------|-------------|------------------|
|
|
104
|
+
|**200** | Price Lists | - |
|
|
105
|
+
|**400** | Bad Request | - |
|
|
106
|
+
|**401** | Unauthorised | - |
|
|
107
|
+
|**403** | Access Denied | - |
|
|
108
|
+
|
|
109
|
+
[[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)
|
|
110
|
+
|
|
63
111
|
# **getGetLegacyStockList**
|
|
64
112
|
> string getGetLegacyStockList()
|
|
65
113
|
|