yellowgrid-api-ts 3.2.193-dev.0 → 3.2.194-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 +6 -0
- package/README.md +7 -0
- package/api.ts +522 -6
- package/dist/api.d.ts +382 -6
- package/dist/api.js +363 -4
- package/docs/AccountsApi.md +55 -0
- package/docs/CrmActivityDTO.md +2 -2
- package/docs/MiscApi.md +63 -0
- package/docs/PasswordSenderDTO.md +37 -0
- package/docs/PasswordSenderEntity.md +33 -0
- package/docs/ReportsApi.md +52 -0
- package/docs/StockReportItemModel.md +31 -0
- package/docs/StockReportModel.md +29 -0
- package/docs/TcxInstallationModel.md +2 -0
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -84,10 +84,10 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
|
84
84
|
return to.concat(ar || Array.prototype.slice.call(from));
|
|
85
85
|
};
|
|
86
86
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
87
|
-
exports.
|
|
88
|
-
exports.
|
|
89
|
-
exports.
|
|
90
|
-
exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.SuppliersApi = exports.SuppliersApiFactory = exports.SuppliersApiFp = exports.SuppliersApiAxiosParamCreator = void 0;
|
|
87
|
+
exports.BillingApiAxiosParamCreator = exports.PatchSetPrizePromoStateEnum = exports.PatchSetPortalAccessStateEnum = exports.PatchSetOnHoldStateEnum = exports.PatchSetAccountStatusStateEnum = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.UpgradeRequestModelSchoolTypeEnum = exports.UpgradeRequestModelLicenceTypeEnum = exports.TcxWizardModelInstallationStatusEnum = exports.TcxWizardModelInstallTypeEnum = exports.TcxSetupEntityRegionEnum = exports.TcxSetupEntityInstallTypeEnum = exports.TcxMultiTenantModelPackageEnum = exports.StockReportItemModelCurrencyEnum = exports.StockOrderModelPaidEnum = exports.StockOrderModelDeliveryMethodEnum = exports.SmsResponseModelEventTypeEnum = exports.SmsPhoneNumberModelStatusEnum = exports.SmsAccountRequestDTOTypeEnum = exports.SmsAccountRequestDTOProviderEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.ShippingServiceModelCourierEnum = exports.ShippingServiceDTOCourierEnum = exports.ShippingRequestDTOPrinterEnum = exports.ShippingRequestDTOCourierEnum = exports.ShipmentRequestDTOCourierEnum = exports.ShipmentDTOCourierEnum = exports.ServiceStatusDTOStatusEnum = exports.ServiceHealthDTOGlobalStatusEnum = exports.ProspectDTOStatusEnum = exports.PatchUpdateTcxHostingPriceListRequestPriceListEnum = exports.PatchUpdatePriceListRequestPriceListEnum = exports.PasswordSenderDTOIntervalTypeEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.ItemDiscountEntityTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.EventDTOStatusEnum = exports.DivertResponseModelStatusEnum = exports.AuditLogEntityTypeEnum = exports.AuditLogEntityActionEnum = exports.AdminUserModelPermissionsEnum = exports.AdminUserModelRoleEnum = exports.AdminOrderRequestDTOPaymentMethodEnum = void 0;
|
|
88
|
+
exports.OAuth20ApiFp = exports.OAuth20ApiAxiosParamCreator = exports.NumberPortingApi = exports.NumberPortingApiFactory = exports.NumberPortingApiFp = exports.NumberPortingApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.MiscApi = exports.MiscApiFactory = exports.MiscApiFp = exports.MiscApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = exports.Class3CXIntegrationsApiFactory = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.GetGetCrmActivitiesTypeEnum = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.BillingApi = exports.BillingApiFactory = exports.BillingApiFp = void 0;
|
|
89
|
+
exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = exports.SMSApiAxiosParamCreator = exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ReportsApi = exports.ReportsApiFactory = exports.ReportsApiFp = exports.ReportsApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.ProspectsApi = exports.ProspectsApiFactory = exports.ProspectsApiFp = exports.ProspectsApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.PostPrintShippingLabelPrinterEnum = exports.GetGetOrdersFilterEnum = exports.GetGetOrdersStatusEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.PostAuthoriseScopeEnum = exports.PostAccessTokenTokenExchangeTypeEnum = exports.PostAccessTokenScopeEnum = exports.PostAccessTokenGrantTypeEnum = exports.OAuth20Api = exports.OAuth20ApiFactory = void 0;
|
|
90
|
+
exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.SuppliersApi = exports.SuppliersApiFactory = exports.SuppliersApiFp = exports.SuppliersApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = exports.ServicesApiFactory = void 0;
|
|
91
91
|
var axios_1 = require("axios");
|
|
92
92
|
// Some imports not used depending on template conditions
|
|
93
93
|
// @ts-ignore
|
|
@@ -156,6 +156,7 @@ exports.AuditLogEntityTypeEnum = {
|
|
|
156
156
|
NumberPortNotes: 'number_port_notes',
|
|
157
157
|
PopsOfflineInstances: 'pops_offline_instances',
|
|
158
158
|
PopsOrderedItems: 'pops_ordered_items',
|
|
159
|
+
PopsPasswordSender: 'pops_password_sender',
|
|
159
160
|
PopsPrizes: 'pops_prizes',
|
|
160
161
|
PopsPrinters: 'pops_printers',
|
|
161
162
|
PopsPromoCodes: 'pops_promo_codes',
|
|
@@ -287,6 +288,11 @@ exports.OrderTotalModelCurrencyEnum = {
|
|
|
287
288
|
Thb: 'THB',
|
|
288
289
|
Zar: 'ZAR'
|
|
289
290
|
};
|
|
291
|
+
exports.PasswordSenderDTOIntervalTypeEnum = {
|
|
292
|
+
Minute: 'Minute',
|
|
293
|
+
Hour: 'Hour',
|
|
294
|
+
Day: 'Day'
|
|
295
|
+
};
|
|
290
296
|
exports.PatchUpdatePriceListRequestPriceListEnum = {
|
|
291
297
|
Rrp: 'RRP',
|
|
292
298
|
Trade: 'Trade',
|
|
@@ -409,6 +415,39 @@ exports.StockOrderModelPaidEnum = {
|
|
|
409
415
|
NUMBER_1: 1,
|
|
410
416
|
NUMBER_2: 2
|
|
411
417
|
};
|
|
418
|
+
exports.StockReportItemModelCurrencyEnum = {
|
|
419
|
+
Eur: 'EUR',
|
|
420
|
+
Usd: 'USD',
|
|
421
|
+
Jpy: 'JPY',
|
|
422
|
+
Bgn: 'BGN',
|
|
423
|
+
Czk: 'CZK',
|
|
424
|
+
Dkk: 'DKK',
|
|
425
|
+
Gbp: 'GBP',
|
|
426
|
+
Huf: 'HUF',
|
|
427
|
+
Pln: 'PLN',
|
|
428
|
+
Ron: 'RON',
|
|
429
|
+
Sek: 'SEK',
|
|
430
|
+
Chf: 'CHF',
|
|
431
|
+
Isk: 'ISK',
|
|
432
|
+
Nok: 'NOK',
|
|
433
|
+
Try: 'TRY',
|
|
434
|
+
Aud: 'AUD',
|
|
435
|
+
Brl: 'BRL',
|
|
436
|
+
Cad: 'CAD',
|
|
437
|
+
Cny: 'CNY',
|
|
438
|
+
Hkd: 'HKD',
|
|
439
|
+
Idr: 'IDR',
|
|
440
|
+
Ils: 'ILS',
|
|
441
|
+
Inr: 'INR',
|
|
442
|
+
Krw: 'KRW',
|
|
443
|
+
Mxn: 'MXN',
|
|
444
|
+
Myr: 'MYR',
|
|
445
|
+
Nzd: 'NZD',
|
|
446
|
+
Php: 'PHP',
|
|
447
|
+
Sgd: 'SGD',
|
|
448
|
+
Thb: 'THB',
|
|
449
|
+
Zar: 'ZAR'
|
|
450
|
+
};
|
|
412
451
|
exports.TcxMultiTenantModelPackageEnum = {
|
|
413
452
|
_3CxStarterBundle: '3CX Starter Bundle'
|
|
414
453
|
};
|
|
@@ -1012,6 +1051,45 @@ var AccountsApiAxiosParamCreator = function (configuration) {
|
|
|
1012
1051
|
});
|
|
1013
1052
|
});
|
|
1014
1053
|
},
|
|
1054
|
+
/**
|
|
1055
|
+
* Download New Price List
|
|
1056
|
+
* @summary Download New Price List
|
|
1057
|
+
* @param {string} id Xero ID
|
|
1058
|
+
* @param {*} [options] Override http request option.
|
|
1059
|
+
* @throws {RequiredError}
|
|
1060
|
+
*/
|
|
1061
|
+
getGetNewPriceList: function (id_1) {
|
|
1062
|
+
var args_1 = [];
|
|
1063
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
1064
|
+
args_1[_i - 1] = arguments[_i];
|
|
1065
|
+
}
|
|
1066
|
+
return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
|
|
1067
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
1068
|
+
if (options === void 0) { options = {}; }
|
|
1069
|
+
return __generator(this, function (_a) {
|
|
1070
|
+
// verify required parameter 'id' is not null or undefined
|
|
1071
|
+
(0, common_1.assertParamExists)('getGetNewPriceList', 'id', id);
|
|
1072
|
+
localVarPath = "/admin/accounts/priceList/new";
|
|
1073
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1074
|
+
if (configuration) {
|
|
1075
|
+
baseOptions = configuration.baseOptions;
|
|
1076
|
+
}
|
|
1077
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
1078
|
+
localVarHeaderParameter = {};
|
|
1079
|
+
localVarQueryParameter = {};
|
|
1080
|
+
if (id !== undefined) {
|
|
1081
|
+
localVarQueryParameter['id'] = id;
|
|
1082
|
+
}
|
|
1083
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1084
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1085
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1086
|
+
return [2 /*return*/, {
|
|
1087
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1088
|
+
options: localVarRequestOptions,
|
|
1089
|
+
}];
|
|
1090
|
+
});
|
|
1091
|
+
});
|
|
1092
|
+
},
|
|
1015
1093
|
/**
|
|
1016
1094
|
* Get Account 3CX Details
|
|
1017
1095
|
* @param {string} id Xero ID
|
|
@@ -2563,6 +2641,29 @@ var AccountsApiFp = function (configuration) {
|
|
|
2563
2641
|
});
|
|
2564
2642
|
});
|
|
2565
2643
|
},
|
|
2644
|
+
/**
|
|
2645
|
+
* Download New Price List
|
|
2646
|
+
* @summary Download New Price List
|
|
2647
|
+
* @param {string} id Xero ID
|
|
2648
|
+
* @param {*} [options] Override http request option.
|
|
2649
|
+
* @throws {RequiredError}
|
|
2650
|
+
*/
|
|
2651
|
+
getGetNewPriceList: function (id, options) {
|
|
2652
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
2653
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
2654
|
+
var _a, _b, _c;
|
|
2655
|
+
return __generator(this, function (_d) {
|
|
2656
|
+
switch (_d.label) {
|
|
2657
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetNewPriceList(id, options)];
|
|
2658
|
+
case 1:
|
|
2659
|
+
localVarAxiosArgs = _d.sent();
|
|
2660
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2661
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AccountsApi.getGetNewPriceList']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2662
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
2663
|
+
}
|
|
2664
|
+
});
|
|
2665
|
+
});
|
|
2666
|
+
},
|
|
2566
2667
|
/**
|
|
2567
2668
|
* Get Account 3CX Details
|
|
2568
2669
|
* @param {string} id Xero ID
|
|
@@ -3431,6 +3532,16 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
3431
3532
|
getGetLastAccount: function (options) {
|
|
3432
3533
|
return localVarFp.getGetLastAccount(options).then(function (request) { return request(axios, basePath); });
|
|
3433
3534
|
},
|
|
3535
|
+
/**
|
|
3536
|
+
* Download New Price List
|
|
3537
|
+
* @summary Download New Price List
|
|
3538
|
+
* @param {string} id Xero ID
|
|
3539
|
+
* @param {*} [options] Override http request option.
|
|
3540
|
+
* @throws {RequiredError}
|
|
3541
|
+
*/
|
|
3542
|
+
getGetNewPriceList: function (id, options) {
|
|
3543
|
+
return localVarFp.getGetNewPriceList(id, options).then(function (request) { return request(axios, basePath); });
|
|
3544
|
+
},
|
|
3434
3545
|
/**
|
|
3435
3546
|
* Get Account 3CX Details
|
|
3436
3547
|
* @param {string} id Xero ID
|
|
@@ -3930,6 +4041,18 @@ var AccountsApi = /** @class */ (function (_super) {
|
|
|
3930
4041
|
var _this = this;
|
|
3931
4042
|
return (0, exports.AccountsApiFp)(this.configuration).getGetLastAccount(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
3932
4043
|
};
|
|
4044
|
+
/**
|
|
4045
|
+
* Download New Price List
|
|
4046
|
+
* @summary Download New Price List
|
|
4047
|
+
* @param {string} id Xero ID
|
|
4048
|
+
* @param {*} [options] Override http request option.
|
|
4049
|
+
* @throws {RequiredError}
|
|
4050
|
+
* @memberof AccountsApi
|
|
4051
|
+
*/
|
|
4052
|
+
AccountsApi.prototype.getGetNewPriceList = function (id, options) {
|
|
4053
|
+
var _this = this;
|
|
4054
|
+
return (0, exports.AccountsApiFp)(this.configuration).getGetNewPriceList(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
4055
|
+
};
|
|
3933
4056
|
/**
|
|
3934
4057
|
* Get Account 3CX Details
|
|
3935
4058
|
* @param {string} id Xero ID
|
|
@@ -11409,6 +11532,127 @@ exports.GetGetTenantsStatusEnum = {
|
|
|
11409
11532
|
Offline: 'Offline',
|
|
11410
11533
|
FailedOver: 'Failed Over'
|
|
11411
11534
|
};
|
|
11535
|
+
/**
|
|
11536
|
+
* MiscApi - axios parameter creator
|
|
11537
|
+
* @export
|
|
11538
|
+
*/
|
|
11539
|
+
var MiscApiAxiosParamCreator = function (configuration) {
|
|
11540
|
+
var _this = this;
|
|
11541
|
+
return {
|
|
11542
|
+
/**
|
|
11543
|
+
* Share Credentials
|
|
11544
|
+
* @param {PasswordSenderDTO} [passwordSenderDTO] Password Sender Request
|
|
11545
|
+
* @param {*} [options] Override http request option.
|
|
11546
|
+
* @throws {RequiredError}
|
|
11547
|
+
*/
|
|
11548
|
+
postSendPassword: function (passwordSenderDTO_1) {
|
|
11549
|
+
var args_1 = [];
|
|
11550
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
11551
|
+
args_1[_i - 1] = arguments[_i];
|
|
11552
|
+
}
|
|
11553
|
+
return __awaiter(_this, __spreadArray([passwordSenderDTO_1], args_1, true), void 0, function (passwordSenderDTO, options) {
|
|
11554
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
11555
|
+
if (options === void 0) { options = {}; }
|
|
11556
|
+
return __generator(this, function (_a) {
|
|
11557
|
+
localVarPath = "/admin/password/send";
|
|
11558
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
11559
|
+
if (configuration) {
|
|
11560
|
+
baseOptions = configuration.baseOptions;
|
|
11561
|
+
}
|
|
11562
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
11563
|
+
localVarHeaderParameter = {};
|
|
11564
|
+
localVarQueryParameter = {};
|
|
11565
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
11566
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
11567
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11568
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
11569
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(passwordSenderDTO, localVarRequestOptions, configuration);
|
|
11570
|
+
return [2 /*return*/, {
|
|
11571
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
11572
|
+
options: localVarRequestOptions,
|
|
11573
|
+
}];
|
|
11574
|
+
});
|
|
11575
|
+
});
|
|
11576
|
+
},
|
|
11577
|
+
};
|
|
11578
|
+
};
|
|
11579
|
+
exports.MiscApiAxiosParamCreator = MiscApiAxiosParamCreator;
|
|
11580
|
+
/**
|
|
11581
|
+
* MiscApi - functional programming interface
|
|
11582
|
+
* @export
|
|
11583
|
+
*/
|
|
11584
|
+
var MiscApiFp = function (configuration) {
|
|
11585
|
+
var localVarAxiosParamCreator = (0, exports.MiscApiAxiosParamCreator)(configuration);
|
|
11586
|
+
return {
|
|
11587
|
+
/**
|
|
11588
|
+
* Share Credentials
|
|
11589
|
+
* @param {PasswordSenderDTO} [passwordSenderDTO] Password Sender Request
|
|
11590
|
+
* @param {*} [options] Override http request option.
|
|
11591
|
+
* @throws {RequiredError}
|
|
11592
|
+
*/
|
|
11593
|
+
postSendPassword: function (passwordSenderDTO, options) {
|
|
11594
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
11595
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
11596
|
+
var _a, _b, _c;
|
|
11597
|
+
return __generator(this, function (_d) {
|
|
11598
|
+
switch (_d.label) {
|
|
11599
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postSendPassword(passwordSenderDTO, options)];
|
|
11600
|
+
case 1:
|
|
11601
|
+
localVarAxiosArgs = _d.sent();
|
|
11602
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
11603
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MiscApi.postSendPassword']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11604
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
11605
|
+
}
|
|
11606
|
+
});
|
|
11607
|
+
});
|
|
11608
|
+
},
|
|
11609
|
+
};
|
|
11610
|
+
};
|
|
11611
|
+
exports.MiscApiFp = MiscApiFp;
|
|
11612
|
+
/**
|
|
11613
|
+
* MiscApi - factory interface
|
|
11614
|
+
* @export
|
|
11615
|
+
*/
|
|
11616
|
+
var MiscApiFactory = function (configuration, basePath, axios) {
|
|
11617
|
+
var localVarFp = (0, exports.MiscApiFp)(configuration);
|
|
11618
|
+
return {
|
|
11619
|
+
/**
|
|
11620
|
+
* Share Credentials
|
|
11621
|
+
* @param {PasswordSenderDTO} [passwordSenderDTO] Password Sender Request
|
|
11622
|
+
* @param {*} [options] Override http request option.
|
|
11623
|
+
* @throws {RequiredError}
|
|
11624
|
+
*/
|
|
11625
|
+
postSendPassword: function (passwordSenderDTO, options) {
|
|
11626
|
+
return localVarFp.postSendPassword(passwordSenderDTO, options).then(function (request) { return request(axios, basePath); });
|
|
11627
|
+
},
|
|
11628
|
+
};
|
|
11629
|
+
};
|
|
11630
|
+
exports.MiscApiFactory = MiscApiFactory;
|
|
11631
|
+
/**
|
|
11632
|
+
* MiscApi - object-oriented interface
|
|
11633
|
+
* @export
|
|
11634
|
+
* @class MiscApi
|
|
11635
|
+
* @extends {BaseAPI}
|
|
11636
|
+
*/
|
|
11637
|
+
var MiscApi = /** @class */ (function (_super) {
|
|
11638
|
+
__extends(MiscApi, _super);
|
|
11639
|
+
function MiscApi() {
|
|
11640
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
11641
|
+
}
|
|
11642
|
+
/**
|
|
11643
|
+
* Share Credentials
|
|
11644
|
+
* @param {PasswordSenderDTO} [passwordSenderDTO] Password Sender Request
|
|
11645
|
+
* @param {*} [options] Override http request option.
|
|
11646
|
+
* @throws {RequiredError}
|
|
11647
|
+
* @memberof MiscApi
|
|
11648
|
+
*/
|
|
11649
|
+
MiscApi.prototype.postSendPassword = function (passwordSenderDTO, options) {
|
|
11650
|
+
var _this = this;
|
|
11651
|
+
return (0, exports.MiscApiFp)(this.configuration).postSendPassword(passwordSenderDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
11652
|
+
};
|
|
11653
|
+
return MiscApi;
|
|
11654
|
+
}(base_1.BaseAPI));
|
|
11655
|
+
exports.MiscApi = MiscApi;
|
|
11412
11656
|
/**
|
|
11413
11657
|
* MyPBXToolsApi - axios parameter creator
|
|
11414
11658
|
* @export
|
|
@@ -19057,6 +19301,121 @@ var ProvisioningApi = /** @class */ (function (_super) {
|
|
|
19057
19301
|
return ProvisioningApi;
|
|
19058
19302
|
}(base_1.BaseAPI));
|
|
19059
19303
|
exports.ProvisioningApi = ProvisioningApi;
|
|
19304
|
+
/**
|
|
19305
|
+
* ReportsApi - axios parameter creator
|
|
19306
|
+
* @export
|
|
19307
|
+
*/
|
|
19308
|
+
var ReportsApiAxiosParamCreator = function (configuration) {
|
|
19309
|
+
var _this = this;
|
|
19310
|
+
return {
|
|
19311
|
+
/**
|
|
19312
|
+
*
|
|
19313
|
+
* @param {*} [options] Override http request option.
|
|
19314
|
+
* @throws {RequiredError}
|
|
19315
|
+
*/
|
|
19316
|
+
getGetStockReport: function () {
|
|
19317
|
+
var args_1 = [];
|
|
19318
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
19319
|
+
args_1[_i] = arguments[_i];
|
|
19320
|
+
}
|
|
19321
|
+
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
19322
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
19323
|
+
if (options === void 0) { options = {}; }
|
|
19324
|
+
return __generator(this, function (_a) {
|
|
19325
|
+
localVarPath = "/reports/stock";
|
|
19326
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
19327
|
+
if (configuration) {
|
|
19328
|
+
baseOptions = configuration.baseOptions;
|
|
19329
|
+
}
|
|
19330
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
19331
|
+
localVarHeaderParameter = {};
|
|
19332
|
+
localVarQueryParameter = {};
|
|
19333
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
19334
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
19335
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
19336
|
+
return [2 /*return*/, {
|
|
19337
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
19338
|
+
options: localVarRequestOptions,
|
|
19339
|
+
}];
|
|
19340
|
+
});
|
|
19341
|
+
});
|
|
19342
|
+
},
|
|
19343
|
+
};
|
|
19344
|
+
};
|
|
19345
|
+
exports.ReportsApiAxiosParamCreator = ReportsApiAxiosParamCreator;
|
|
19346
|
+
/**
|
|
19347
|
+
* ReportsApi - functional programming interface
|
|
19348
|
+
* @export
|
|
19349
|
+
*/
|
|
19350
|
+
var ReportsApiFp = function (configuration) {
|
|
19351
|
+
var localVarAxiosParamCreator = (0, exports.ReportsApiAxiosParamCreator)(configuration);
|
|
19352
|
+
return {
|
|
19353
|
+
/**
|
|
19354
|
+
*
|
|
19355
|
+
* @param {*} [options] Override http request option.
|
|
19356
|
+
* @throws {RequiredError}
|
|
19357
|
+
*/
|
|
19358
|
+
getGetStockReport: function (options) {
|
|
19359
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
19360
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
19361
|
+
var _a, _b, _c;
|
|
19362
|
+
return __generator(this, function (_d) {
|
|
19363
|
+
switch (_d.label) {
|
|
19364
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetStockReport(options)];
|
|
19365
|
+
case 1:
|
|
19366
|
+
localVarAxiosArgs = _d.sent();
|
|
19367
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
19368
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReportsApi.getGetStockReport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
19369
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
19370
|
+
}
|
|
19371
|
+
});
|
|
19372
|
+
});
|
|
19373
|
+
},
|
|
19374
|
+
};
|
|
19375
|
+
};
|
|
19376
|
+
exports.ReportsApiFp = ReportsApiFp;
|
|
19377
|
+
/**
|
|
19378
|
+
* ReportsApi - factory interface
|
|
19379
|
+
* @export
|
|
19380
|
+
*/
|
|
19381
|
+
var ReportsApiFactory = function (configuration, basePath, axios) {
|
|
19382
|
+
var localVarFp = (0, exports.ReportsApiFp)(configuration);
|
|
19383
|
+
return {
|
|
19384
|
+
/**
|
|
19385
|
+
*
|
|
19386
|
+
* @param {*} [options] Override http request option.
|
|
19387
|
+
* @throws {RequiredError}
|
|
19388
|
+
*/
|
|
19389
|
+
getGetStockReport: function (options) {
|
|
19390
|
+
return localVarFp.getGetStockReport(options).then(function (request) { return request(axios, basePath); });
|
|
19391
|
+
},
|
|
19392
|
+
};
|
|
19393
|
+
};
|
|
19394
|
+
exports.ReportsApiFactory = ReportsApiFactory;
|
|
19395
|
+
/**
|
|
19396
|
+
* ReportsApi - object-oriented interface
|
|
19397
|
+
* @export
|
|
19398
|
+
* @class ReportsApi
|
|
19399
|
+
* @extends {BaseAPI}
|
|
19400
|
+
*/
|
|
19401
|
+
var ReportsApi = /** @class */ (function (_super) {
|
|
19402
|
+
__extends(ReportsApi, _super);
|
|
19403
|
+
function ReportsApi() {
|
|
19404
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
19405
|
+
}
|
|
19406
|
+
/**
|
|
19407
|
+
*
|
|
19408
|
+
* @param {*} [options] Override http request option.
|
|
19409
|
+
* @throws {RequiredError}
|
|
19410
|
+
* @memberof ReportsApi
|
|
19411
|
+
*/
|
|
19412
|
+
ReportsApi.prototype.getGetStockReport = function (options) {
|
|
19413
|
+
var _this = this;
|
|
19414
|
+
return (0, exports.ReportsApiFp)(this.configuration).getGetStockReport(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
19415
|
+
};
|
|
19416
|
+
return ReportsApi;
|
|
19417
|
+
}(base_1.BaseAPI));
|
|
19418
|
+
exports.ReportsApi = ReportsApi;
|
|
19060
19419
|
/**
|
|
19061
19420
|
* SIPTrunksApi - axios parameter creator
|
|
19062
19421
|
* @export
|
package/docs/AccountsApi.md
CHANGED
|
@@ -19,6 +19,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
19
19
|
|[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
|
|
20
20
|
|[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
|
|
21
21
|
|[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
|
|
22
|
+
|[**getGetNewPriceList**](#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List|
|
|
22
23
|
|[**getGetTcxPartnerDetails**](#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner | |
|
|
23
24
|
|[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
|
|
24
25
|
|[**patchSetAccountStatus**](#patchsetaccountstatus) | **PATCH** /admin/accounts/{id}/status/{state} | |
|
|
@@ -838,6 +839,60 @@ No authorization required
|
|
|
838
839
|
|
|
839
840
|
[[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)
|
|
840
841
|
|
|
842
|
+
# **getGetNewPriceList**
|
|
843
|
+
> string getGetNewPriceList()
|
|
844
|
+
|
|
845
|
+
Download New Price List
|
|
846
|
+
|
|
847
|
+
### Example
|
|
848
|
+
|
|
849
|
+
```typescript
|
|
850
|
+
import {
|
|
851
|
+
AccountsApi,
|
|
852
|
+
Configuration
|
|
853
|
+
} from 'yellowgrid-api-ts';
|
|
854
|
+
|
|
855
|
+
const configuration = new Configuration();
|
|
856
|
+
const apiInstance = new AccountsApi(configuration);
|
|
857
|
+
|
|
858
|
+
let id: string; //Xero ID (default to undefined)
|
|
859
|
+
|
|
860
|
+
const { status, data } = await apiInstance.getGetNewPriceList(
|
|
861
|
+
id
|
|
862
|
+
);
|
|
863
|
+
```
|
|
864
|
+
|
|
865
|
+
### Parameters
|
|
866
|
+
|
|
867
|
+
|Name | Type | Description | Notes|
|
|
868
|
+
|------------- | ------------- | ------------- | -------------|
|
|
869
|
+
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
### Return type
|
|
873
|
+
|
|
874
|
+
**string**
|
|
875
|
+
|
|
876
|
+
### Authorization
|
|
877
|
+
|
|
878
|
+
No authorization required
|
|
879
|
+
|
|
880
|
+
### HTTP request headers
|
|
881
|
+
|
|
882
|
+
- **Content-Type**: Not defined
|
|
883
|
+
- **Accept**: text/csv
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
### HTTP response details
|
|
887
|
+
| Status code | Description | Response headers |
|
|
888
|
+
|-------------|-------------|------------------|
|
|
889
|
+
|**200** | Price List | - |
|
|
890
|
+
|**400** | Bad Request | - |
|
|
891
|
+
|**401** | Unauthorised | - |
|
|
892
|
+
|**403** | Access Denied | - |
|
|
893
|
+
|
|
894
|
+
[[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)
|
|
895
|
+
|
|
841
896
|
# **getGetTcxPartnerDetails**
|
|
842
897
|
> PartnerDTO getGetTcxPartnerDetails()
|
|
843
898
|
|
package/docs/CrmActivityDTO.md
CHANGED
|
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**timestamp** | **string** | Date Time | [optional] [default to undefined]
|
|
11
11
|
**title** | **string** | Activity Title | [optional] [default to undefined]
|
|
12
12
|
**description** | **string** | Activity Description | [optional] [default to undefined]
|
|
13
|
-
**url** | **string** | Activity URL | [optional] [default to undefined]
|
|
14
13
|
**user** | **string** | Activity User Name | [optional] [default to undefined]
|
|
15
14
|
**contact** | **string** | Activity Contact Name | [optional] [default to undefined]
|
|
15
|
+
**orderId** | **number** | Activity Order ID | [optional] [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -24,9 +24,9 @@ const instance: CrmActivityDTO = {
|
|
|
24
24
|
timestamp,
|
|
25
25
|
title,
|
|
26
26
|
description,
|
|
27
|
-
url,
|
|
28
27
|
user,
|
|
29
28
|
contact,
|
|
29
|
+
orderId,
|
|
30
30
|
};
|
|
31
31
|
```
|
|
32
32
|
|
package/docs/MiscApi.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# MiscApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**postSendPassword**](#postsendpassword) | **POST** /admin/password/send | |
|
|
8
|
+
|
|
9
|
+
# **postSendPassword**
|
|
10
|
+
> PasswordSenderDTO postSendPassword()
|
|
11
|
+
|
|
12
|
+
Share Credentials
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
MiscApi,
|
|
19
|
+
Configuration,
|
|
20
|
+
PasswordSenderDTO
|
|
21
|
+
} from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new MiscApi(configuration);
|
|
25
|
+
|
|
26
|
+
let passwordSenderDTO: PasswordSenderDTO; //Password Sender Request (optional)
|
|
27
|
+
|
|
28
|
+
const { status, data } = await apiInstance.postSendPassword(
|
|
29
|
+
passwordSenderDTO
|
|
30
|
+
);
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
|Name | Type | Description | Notes|
|
|
36
|
+
|------------- | ------------- | ------------- | -------------|
|
|
37
|
+
| **passwordSenderDTO** | **PasswordSenderDTO**| Password Sender Request | |
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### Return type
|
|
41
|
+
|
|
42
|
+
**PasswordSenderDTO**
|
|
43
|
+
|
|
44
|
+
### Authorization
|
|
45
|
+
|
|
46
|
+
No authorization required
|
|
47
|
+
|
|
48
|
+
### HTTP request headers
|
|
49
|
+
|
|
50
|
+
- **Content-Type**: application/json
|
|
51
|
+
- **Accept**: application/json
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### HTTP response details
|
|
55
|
+
| Status code | Description | Response headers |
|
|
56
|
+
|-------------|-------------|------------------|
|
|
57
|
+
|**200** | Password Sender Response | - |
|
|
58
|
+
|**400** | Bad Request | - |
|
|
59
|
+
|**401** | Unauthorised | - |
|
|
60
|
+
|**403** | Access Denied | - |
|
|
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)
|
|
63
|
+
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# PasswordSenderDTO
|
|
2
|
+
|
|
3
|
+
Password Sender Request
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**username** | **string** | Username | [optional] [default to undefined]
|
|
10
|
+
**password** | **string** | Password | [optional] [default to undefined]
|
|
11
|
+
**expiryInterval** | **number** | Expiry Interval | [optional] [default to undefined]
|
|
12
|
+
**intervalType** | **string** | Interval Type | [optional] [default to undefined]
|
|
13
|
+
**expiry** | **string** | Date Time | [optional] [default to undefined]
|
|
14
|
+
**recipient** | **string** | Recipient | [optional] [default to undefined]
|
|
15
|
+
**url** | **string** | URL | [optional] [default to undefined]
|
|
16
|
+
**description** | **string** | Description | [optional] [default to undefined]
|
|
17
|
+
**passwordUrl** | **string** | Password URL | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { PasswordSenderDTO } from 'yellowgrid-api-ts';
|
|
23
|
+
|
|
24
|
+
const instance: PasswordSenderDTO = {
|
|
25
|
+
username,
|
|
26
|
+
password,
|
|
27
|
+
expiryInterval,
|
|
28
|
+
intervalType,
|
|
29
|
+
expiry,
|
|
30
|
+
recipient,
|
|
31
|
+
url,
|
|
32
|
+
description,
|
|
33
|
+
passwordUrl,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# PasswordSenderEntity
|
|
2
|
+
|
|
3
|
+
PasswordSenderEntity
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**uniqueId** | **string** | uniqueId | [optional] [default to undefined]
|
|
10
|
+
**url** | **string** | url | [optional] [default to undefined]
|
|
11
|
+
**username** | **string** | username | [optional] [default to undefined]
|
|
12
|
+
**password** | **string** | password | [optional] [default to undefined]
|
|
13
|
+
**expiryTime** | **string** | expiryTime | [optional] [default to undefined]
|
|
14
|
+
**emailRecipient** | **string** | emailRecipient | [optional] [default to undefined]
|
|
15
|
+
**description** | **string** | description | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { PasswordSenderEntity } from 'yellowgrid-api-ts';
|
|
21
|
+
|
|
22
|
+
const instance: PasswordSenderEntity = {
|
|
23
|
+
uniqueId,
|
|
24
|
+
url,
|
|
25
|
+
username,
|
|
26
|
+
password,
|
|
27
|
+
expiryTime,
|
|
28
|
+
emailRecipient,
|
|
29
|
+
description,
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|