yellowgrid-api-ts 3.2.89-dev.0 → 3.2.90-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 +3 -0
- package/README.md +7 -1
- package/api.ts +213 -1
- package/base.ts +2 -2
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +173 -1
- package/dist/api.js +99 -4
- package/dist/base.d.ts +1 -1
- package/dist/base.js +2 -2
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/AccountsApi.md +1 -1
- package/docs/CRMApi.md +1 -1
- package/docs/Class3CXApi.md +1 -1
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/CreditNoteItemModel.md +29 -0
- package/docs/CreditNoteModel.md +2 -0
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NumberPortingApi.md +1 -1
- package/docs/OAuth20Api.md +4 -4
- package/docs/OrdersApi.md +1 -1
- package/docs/PricingApi.md +1 -1
- package/docs/ProductsApi.md +1 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +57 -1
- package/docs/ServicesApi.md +1 -1
- package/docs/ShippingApi.md +1 -1
- package/docs/SmsAccountDTO.md +31 -0
- package/docs/SmsAccountRequestDTO.md +29 -0
- package/docs/StockManagementApi.md +1 -1
- package/docs/SystemApi.md +1 -1
- package/docs/TicketsApi.md +1 -1
- package/docs/WebhooksApi.md +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Yellowgrid
|
|
6
|
-
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.yellowgrid.
|
|
6
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.local.yellowgrid.co.uk` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 0
|
|
9
9
|
*
|
|
@@ -84,9 +84,9 @@ 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.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.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = exports.SMSApiAxiosParamCreator = exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = void 0;
|
|
87
|
+
exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.UpgradeRequestModelSchoolTypeEnum = exports.UpgradeRequestModelLicenceTypeEnum = exports.TcxWizardModelInstallationStatusEnum = exports.TcxWizardModelInstallTypeEnum = exports.TcxSetupEntityRegionEnum = exports.TcxSetupEntityInstallTypeEnum = exports.TcxMultiTenantModelPackageEnum = 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.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.ItemDiscountEntityTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.EventDTOStatusEnum = exports.DivertResponseModelStatusEnum = exports.AuditLogEntityTypeEnum = exports.AuditLogEntityActionEnum = exports.AdminUserModelRoleEnum = void 0;
|
|
88
|
+
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 = exports.OAuth20ApiFp = exports.OAuth20ApiAxiosParamCreator = exports.NumberPortingApi = exports.NumberPortingApiFactory = exports.NumberPortingApiFp = exports.NumberPortingApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = 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 = void 0;
|
|
89
|
+
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.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = exports.SMSApiAxiosParamCreator = exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = void 0;
|
|
90
90
|
var axios_1 = require("axios");
|
|
91
91
|
// Some imports not used depending on template conditions
|
|
92
92
|
// @ts-ignore
|
|
@@ -326,6 +326,16 @@ exports.SipTrunkChangeResponseModelTypeEnum = {
|
|
|
326
326
|
Fraud: 'Fraud',
|
|
327
327
|
CallBarring: 'Call Barring'
|
|
328
328
|
};
|
|
329
|
+
exports.SmsAccountRequestDTOProviderEnum = {
|
|
330
|
+
NUMBER_1: 1
|
|
331
|
+
};
|
|
332
|
+
exports.SmsAccountRequestDTOTypeEnum = {
|
|
333
|
+
Local: 'local',
|
|
334
|
+
TollFree: 'toll_free',
|
|
335
|
+
Mobile: 'mobile',
|
|
336
|
+
National: 'national',
|
|
337
|
+
SharedCost: 'shared_cost'
|
|
338
|
+
};
|
|
329
339
|
exports.SmsPhoneNumberModelStatusEnum = {
|
|
330
340
|
Queued: 'queued',
|
|
331
341
|
Sending: 'sending',
|
|
@@ -9798,6 +9808,8 @@ exports.PostAccessTokenScopeEnum = {
|
|
|
9798
9808
|
ProductsRead: 'products.read',
|
|
9799
9809
|
ProvisioningRead: 'provisioning.read',
|
|
9800
9810
|
ProvisioningWrite: 'provisioning.write',
|
|
9811
|
+
SmsRead: 'sms.read',
|
|
9812
|
+
SmsWrite: 'sms.write',
|
|
9801
9813
|
TrunksRead: 'trunks.read',
|
|
9802
9814
|
TrunksWrite: 'trunks.write',
|
|
9803
9815
|
TcxIntegrationsRead: 'tcx_integrations.read',
|
|
@@ -9836,6 +9848,8 @@ exports.PostAuthoriseScopeEnum = {
|
|
|
9836
9848
|
ProductsRead: 'products.read',
|
|
9837
9849
|
ProvisioningRead: 'provisioning.read',
|
|
9838
9850
|
ProvisioningWrite: 'provisioning.write',
|
|
9851
|
+
SmsRead: 'sms.read',
|
|
9852
|
+
SmsWrite: 'sms.write',
|
|
9839
9853
|
TrunksRead: 'trunks.read',
|
|
9840
9854
|
TrunksWrite: 'trunks.write',
|
|
9841
9855
|
TcxIntegrationsRead: 'tcx_integrations.read',
|
|
@@ -16042,6 +16056,42 @@ exports.SIPTrunksApi = SIPTrunksApi;
|
|
|
16042
16056
|
var SMSApiAxiosParamCreator = function (configuration) {
|
|
16043
16057
|
var _this = this;
|
|
16044
16058
|
return {
|
|
16059
|
+
/**
|
|
16060
|
+
* Create SMS Account
|
|
16061
|
+
* @summary Create SMS Account
|
|
16062
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
16063
|
+
* @param {*} [options] Override http request option.
|
|
16064
|
+
* @throws {RequiredError}
|
|
16065
|
+
*/
|
|
16066
|
+
postCreateSmsAccount: function (smsAccountRequestDTO_1) {
|
|
16067
|
+
var args_1 = [];
|
|
16068
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
16069
|
+
args_1[_i - 1] = arguments[_i];
|
|
16070
|
+
}
|
|
16071
|
+
return __awaiter(_this, __spreadArray([smsAccountRequestDTO_1], args_1, true), void 0, function (smsAccountRequestDTO, options) {
|
|
16072
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
16073
|
+
if (options === void 0) { options = {}; }
|
|
16074
|
+
return __generator(this, function (_a) {
|
|
16075
|
+
localVarPath = "/messaging/sms/account";
|
|
16076
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
16077
|
+
if (configuration) {
|
|
16078
|
+
baseOptions = configuration.baseOptions;
|
|
16079
|
+
}
|
|
16080
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
16081
|
+
localVarHeaderParameter = {};
|
|
16082
|
+
localVarQueryParameter = {};
|
|
16083
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
16084
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
16085
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16086
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16087
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(smsAccountRequestDTO, localVarRequestOptions, configuration);
|
|
16088
|
+
return [2 /*return*/, {
|
|
16089
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
16090
|
+
options: localVarRequestOptions,
|
|
16091
|
+
}];
|
|
16092
|
+
});
|
|
16093
|
+
});
|
|
16094
|
+
},
|
|
16045
16095
|
/**
|
|
16046
16096
|
* Send SMS
|
|
16047
16097
|
* @param {string} authorization Bearer Token
|
|
@@ -16093,6 +16143,29 @@ exports.SMSApiAxiosParamCreator = SMSApiAxiosParamCreator;
|
|
|
16093
16143
|
var SMSApiFp = function (configuration) {
|
|
16094
16144
|
var localVarAxiosParamCreator = (0, exports.SMSApiAxiosParamCreator)(configuration);
|
|
16095
16145
|
return {
|
|
16146
|
+
/**
|
|
16147
|
+
* Create SMS Account
|
|
16148
|
+
* @summary Create SMS Account
|
|
16149
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
16150
|
+
* @param {*} [options] Override http request option.
|
|
16151
|
+
* @throws {RequiredError}
|
|
16152
|
+
*/
|
|
16153
|
+
postCreateSmsAccount: function (smsAccountRequestDTO, options) {
|
|
16154
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
16155
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
16156
|
+
var _a, _b, _c;
|
|
16157
|
+
return __generator(this, function (_d) {
|
|
16158
|
+
switch (_d.label) {
|
|
16159
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postCreateSmsAccount(smsAccountRequestDTO, options)];
|
|
16160
|
+
case 1:
|
|
16161
|
+
localVarAxiosArgs = _d.sent();
|
|
16162
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
16163
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['SMSApi.postCreateSmsAccount']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
16164
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
16165
|
+
}
|
|
16166
|
+
});
|
|
16167
|
+
});
|
|
16168
|
+
},
|
|
16096
16169
|
/**
|
|
16097
16170
|
* Send SMS
|
|
16098
16171
|
* @param {string} authorization Bearer Token
|
|
@@ -16126,6 +16199,16 @@ exports.SMSApiFp = SMSApiFp;
|
|
|
16126
16199
|
var SMSApiFactory = function (configuration, basePath, axios) {
|
|
16127
16200
|
var localVarFp = (0, exports.SMSApiFp)(configuration);
|
|
16128
16201
|
return {
|
|
16202
|
+
/**
|
|
16203
|
+
* Create SMS Account
|
|
16204
|
+
* @summary Create SMS Account
|
|
16205
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
16206
|
+
* @param {*} [options] Override http request option.
|
|
16207
|
+
* @throws {RequiredError}
|
|
16208
|
+
*/
|
|
16209
|
+
postCreateSmsAccount: function (smsAccountRequestDTO, options) {
|
|
16210
|
+
return localVarFp.postCreateSmsAccount(smsAccountRequestDTO, options).then(function (request) { return request(axios, basePath); });
|
|
16211
|
+
},
|
|
16129
16212
|
/**
|
|
16130
16213
|
* Send SMS
|
|
16131
16214
|
* @param {string} authorization Bearer Token
|
|
@@ -16150,6 +16233,18 @@ var SMSApi = /** @class */ (function (_super) {
|
|
|
16150
16233
|
function SMSApi() {
|
|
16151
16234
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
16152
16235
|
}
|
|
16236
|
+
/**
|
|
16237
|
+
* Create SMS Account
|
|
16238
|
+
* @summary Create SMS Account
|
|
16239
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
16240
|
+
* @param {*} [options] Override http request option.
|
|
16241
|
+
* @throws {RequiredError}
|
|
16242
|
+
* @memberof SMSApi
|
|
16243
|
+
*/
|
|
16244
|
+
SMSApi.prototype.postCreateSmsAccount = function (smsAccountRequestDTO, options) {
|
|
16245
|
+
var _this = this;
|
|
16246
|
+
return (0, exports.SMSApiFp)(this.configuration).postCreateSmsAccount(smsAccountRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
16247
|
+
};
|
|
16153
16248
|
/**
|
|
16154
16249
|
* Send SMS
|
|
16155
16250
|
* @param {string} authorization Bearer Token
|
package/dist/base.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Yellowgrid
|
|
3
|
-
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.yellowgrid.
|
|
3
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.local.yellowgrid.co.uk` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 0
|
|
6
6
|
*
|
package/dist/base.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Yellowgrid
|
|
6
|
-
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.yellowgrid.
|
|
6
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.local.yellowgrid.co.uk` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 0
|
|
9
9
|
*
|
|
@@ -30,7 +30,7 @@ var __extends = (this && this.__extends) || (function () {
|
|
|
30
30
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
31
31
|
exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
|
|
32
32
|
var axios_1 = require("axios");
|
|
33
|
-
exports.BASE_PATH = "https://api.yellowgrid.
|
|
33
|
+
exports.BASE_PATH = "https://api.local.yellowgrid.co.uk".replace(/\/+$/, "");
|
|
34
34
|
/**
|
|
35
35
|
*
|
|
36
36
|
* @export
|
package/dist/common.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Yellowgrid
|
|
3
|
-
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.yellowgrid.
|
|
3
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.local.yellowgrid.co.uk` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 0
|
|
6
6
|
*
|
package/dist/common.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Yellowgrid
|
|
6
|
-
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.yellowgrid.
|
|
6
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.local.yellowgrid.co.uk` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 0
|
|
9
9
|
*
|
package/dist/configuration.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Yellowgrid
|
|
3
|
-
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.yellowgrid.
|
|
3
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.local.yellowgrid.co.uk` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 0
|
|
6
6
|
*
|
package/dist/configuration.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Yellowgrid
|
|
6
|
-
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.yellowgrid.
|
|
6
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.local.yellowgrid.co.uk` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 0
|
|
9
9
|
*
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Yellowgrid
|
|
3
|
-
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.yellowgrid.
|
|
3
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.local.yellowgrid.co.uk` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 0
|
|
6
6
|
*
|
package/dist/index.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Yellowgrid
|
|
6
|
-
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.yellowgrid.
|
|
6
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.local.yellowgrid.co.uk` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 0
|
|
9
9
|
*
|
package/docs/AccountsApi.md
CHANGED
package/docs/CRMApi.md
CHANGED
package/docs/Class3CXApi.md
CHANGED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# CreditNoteItemModel
|
|
2
|
+
|
|
3
|
+
Credit Note Item
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | id | [optional] [default to undefined]
|
|
10
|
+
**creditNoteId** | **number** | creditNoteId | [optional] [default to undefined]
|
|
11
|
+
**orderId** | **number** | orderId | [optional] [default to undefined]
|
|
12
|
+
**itemId** | **number** | itemId | [optional] [default to undefined]
|
|
13
|
+
**amount** | **number** | amount | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { CreditNoteItemModel } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: CreditNoteItemModel = {
|
|
21
|
+
id,
|
|
22
|
+
creditNoteId,
|
|
23
|
+
orderId,
|
|
24
|
+
itemId,
|
|
25
|
+
amount,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[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/CreditNoteModel.md
CHANGED
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**transactionId** | **string** | transactionId | [optional] [default to undefined]
|
|
12
12
|
**amount** | **number** | amount | [optional] [default to undefined]
|
|
13
13
|
**timestamp** | **string** | timestamp | [optional] [default to undefined]
|
|
14
|
+
**items** | [**Array<CreditNoteItemModel>**](CreditNoteItemModel.md) | Credit Note Items | [optional] [default to undefined]
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -23,6 +24,7 @@ const instance: CreditNoteModel = {
|
|
|
23
24
|
transactionId,
|
|
24
25
|
amount,
|
|
25
26
|
timestamp,
|
|
27
|
+
items,
|
|
26
28
|
};
|
|
27
29
|
```
|
|
28
30
|
|
package/docs/MyPBXToolsApi.md
CHANGED
package/docs/NumberPortingApi.md
CHANGED
package/docs/OAuth20Api.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OAuth20Api
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://api.yellowgrid.
|
|
3
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -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' | '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|
|
|
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' | 'sms.read' | 'sms.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' | '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)
|
|
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' | 'sms.read' | 'sms.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' | '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|
|
|
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' | 'sms.read' | 'sms.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' | 'sms.read' | 'sms.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/OrdersApi.md
CHANGED
package/docs/PricingApi.md
CHANGED
package/docs/ProductsApi.md
CHANGED
package/docs/ProvisioningApi.md
CHANGED
package/docs/SIPTrunksApi.md
CHANGED
package/docs/SMSApi.md
CHANGED
|
@@ -1,11 +1,67 @@
|
|
|
1
1
|
# SMSApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://api.yellowgrid.
|
|
3
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**postCreateSmsAccount**](#postcreatesmsaccount) | **POST** /messaging/sms/account | Create SMS Account|
|
|
7
8
|
|[**postSendSms**](#postsendsms) | **POST** /messaging/sms/send | |
|
|
8
9
|
|
|
10
|
+
# **postCreateSmsAccount**
|
|
11
|
+
> SmsAccountDTO postCreateSmsAccount()
|
|
12
|
+
|
|
13
|
+
Create SMS Account
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
SMSApi,
|
|
20
|
+
Configuration,
|
|
21
|
+
SmsAccountRequestDTO
|
|
22
|
+
} from 'yellowgrid-api-ts';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new SMSApi(configuration);
|
|
26
|
+
|
|
27
|
+
let smsAccountRequestDTO: SmsAccountRequestDTO; //SMS Account Request (optional)
|
|
28
|
+
|
|
29
|
+
const { status, data } = await apiInstance.postCreateSmsAccount(
|
|
30
|
+
smsAccountRequestDTO
|
|
31
|
+
);
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Parameters
|
|
35
|
+
|
|
36
|
+
|Name | Type | Description | Notes|
|
|
37
|
+
|------------- | ------------- | ------------- | -------------|
|
|
38
|
+
| **smsAccountRequestDTO** | **SmsAccountRequestDTO**| SMS Account Request | |
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
### Return type
|
|
42
|
+
|
|
43
|
+
**SmsAccountDTO**
|
|
44
|
+
|
|
45
|
+
### Authorization
|
|
46
|
+
|
|
47
|
+
No authorization required
|
|
48
|
+
|
|
49
|
+
### HTTP request headers
|
|
50
|
+
|
|
51
|
+
- **Content-Type**: application/json
|
|
52
|
+
- **Accept**: application/json
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
### HTTP response details
|
|
56
|
+
| Status code | Description | Response headers |
|
|
57
|
+
|-------------|-------------|------------------|
|
|
58
|
+
|**200** | SMS Account | - |
|
|
59
|
+
|**400** | Bad Request | - |
|
|
60
|
+
|**401** | Unauthorised | - |
|
|
61
|
+
|**403** | Access Denied | - |
|
|
62
|
+
|
|
63
|
+
[[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)
|
|
64
|
+
|
|
9
65
|
# **postSendSms**
|
|
10
66
|
> SmsDataModel postSendSms()
|
|
11
67
|
|
package/docs/ServicesApi.md
CHANGED