yellowgrid-api-ts 3.2.88-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/.openapi-generator/FILES
CHANGED
|
@@ -49,6 +49,7 @@ docs/CreditNoteDTO.md
|
|
|
49
49
|
docs/CreditNoteEntity.md
|
|
50
50
|
docs/CreditNoteItemDTO.md
|
|
51
51
|
docs/CreditNoteItemEntity.md
|
|
52
|
+
docs/CreditNoteItemModel.md
|
|
52
53
|
docs/CreditNoteModel.md
|
|
53
54
|
docs/CrmContactDTO.md
|
|
54
55
|
docs/CustomerInformationModel.md
|
|
@@ -174,7 +175,9 @@ docs/SipTrunkChangeResponseModel.md
|
|
|
174
175
|
docs/SipTrunkCreationRequestModel.md
|
|
175
176
|
docs/SipTrunkEntity.md
|
|
176
177
|
docs/SipTrunksResponseModel.md
|
|
178
|
+
docs/SmsAccountDTO.md
|
|
177
179
|
docs/SmsAccountEntity.md
|
|
180
|
+
docs/SmsAccountRequestDTO.md
|
|
178
181
|
docs/SmsDataModel.md
|
|
179
182
|
docs/SmsMessageModel.md
|
|
180
183
|
docs/SmsNumbersEntity.md
|
package/README.md
CHANGED
|
@@ -47,7 +47,7 @@ npm install PATH_TO_GENERATED_PACKAGE --save
|
|
|
47
47
|
|
|
48
48
|
### Documentation for API Endpoints
|
|
49
49
|
|
|
50
|
-
All URIs are relative to *https://api.yellowgrid.
|
|
50
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
51
51
|
|
|
52
52
|
Class | Method | HTTP request | Description
|
|
53
53
|
------------ | ------------- | ------------- | -------------
|
|
@@ -218,6 +218,7 @@ Class | Method | HTTP request | Description
|
|
|
218
218
|
*SIPTrunksApi* | [**postTrackChange**](docs/SIPTrunksApi.md#posttrackchange) | **POST** /sip/trunks/changes/track | Track SIP Trunk Change Request
|
|
219
219
|
*SIPTrunksApi* | [**putGetAddress**](docs/SIPTrunksApi.md#putgetaddress) | **PUT** /sip/trunks/{id}/address | Update SIP Trunk Address
|
|
220
220
|
*SIPTrunksApi* | [**putGetDiverts**](docs/SIPTrunksApi.md#putgetdiverts) | **PUT** /sip/trunks/{id}/diverts | Update SIP Trunk Diverts
|
|
221
|
+
*SMSApi* | [**postCreateSmsAccount**](docs/SMSApi.md#postcreatesmsaccount) | **POST** /messaging/sms/account | Create SMS Account
|
|
221
222
|
*SMSApi* | [**postSendSms**](docs/SMSApi.md#postsendsms) | **POST** /messaging/sms/send |
|
|
222
223
|
*ServicesApi* | [**deleteUnsubscribe**](docs/ServicesApi.md#deleteunsubscribe) | **DELETE** /services/events/unsubscribe |
|
|
223
224
|
*ServicesApi* | [**getGetServiceHealth**](docs/ServicesApi.md#getgetservicehealth) | **GET** /services/health |
|
|
@@ -301,6 +302,7 @@ Class | Method | HTTP request | Description
|
|
|
301
302
|
- [CreditNoteEntity](docs/CreditNoteEntity.md)
|
|
302
303
|
- [CreditNoteItemDTO](docs/CreditNoteItemDTO.md)
|
|
303
304
|
- [CreditNoteItemEntity](docs/CreditNoteItemEntity.md)
|
|
305
|
+
- [CreditNoteItemModel](docs/CreditNoteItemModel.md)
|
|
304
306
|
- [CreditNoteModel](docs/CreditNoteModel.md)
|
|
305
307
|
- [CrmContactDTO](docs/CrmContactDTO.md)
|
|
306
308
|
- [CustomerInformationModel](docs/CustomerInformationModel.md)
|
|
@@ -415,7 +417,9 @@ Class | Method | HTTP request | Description
|
|
|
415
417
|
- [SipTrunkCreationRequestModel](docs/SipTrunkCreationRequestModel.md)
|
|
416
418
|
- [SipTrunkEntity](docs/SipTrunkEntity.md)
|
|
417
419
|
- [SipTrunksResponseModel](docs/SipTrunksResponseModel.md)
|
|
420
|
+
- [SmsAccountDTO](docs/SmsAccountDTO.md)
|
|
418
421
|
- [SmsAccountEntity](docs/SmsAccountEntity.md)
|
|
422
|
+
- [SmsAccountRequestDTO](docs/SmsAccountRequestDTO.md)
|
|
419
423
|
- [SmsDataModel](docs/SmsDataModel.md)
|
|
420
424
|
- [SmsMessageModel](docs/SmsMessageModel.md)
|
|
421
425
|
- [SmsNumbersEntity](docs/SmsNumbersEntity.md)
|
|
@@ -517,6 +521,8 @@ Authentication schemes defined for the API:
|
|
|
517
521
|
- **products.read**: Products (Read)
|
|
518
522
|
- **provisioning.read**: Provisioning (Read)
|
|
519
523
|
- **provisioning.write**: Provisioning (Write)
|
|
524
|
+
- **sms.read**: Sms (Read)
|
|
525
|
+
- **sms.write**: Sms (Write)
|
|
520
526
|
- **trunks.read**: Trunks (Read)
|
|
521
527
|
- **trunks.write**: Trunks (Write)
|
|
522
528
|
- **tcx_integrations.read**: 3CX Integrations (Read)
|
package/api.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Yellowgrid
|
|
5
|
-
* 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.
|
|
5
|
+
* 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.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 0
|
|
8
8
|
*
|
|
@@ -2141,6 +2141,43 @@ export interface CreditNoteItemEntity {
|
|
|
2141
2141
|
*/
|
|
2142
2142
|
'amount'?: number;
|
|
2143
2143
|
}
|
|
2144
|
+
/**
|
|
2145
|
+
* Credit Note Item
|
|
2146
|
+
* @export
|
|
2147
|
+
* @interface CreditNoteItemModel
|
|
2148
|
+
*/
|
|
2149
|
+
export interface CreditNoteItemModel {
|
|
2150
|
+
/**
|
|
2151
|
+
* id
|
|
2152
|
+
* @type {number}
|
|
2153
|
+
* @memberof CreditNoteItemModel
|
|
2154
|
+
*/
|
|
2155
|
+
'id'?: number;
|
|
2156
|
+
/**
|
|
2157
|
+
* creditNoteId
|
|
2158
|
+
* @type {number}
|
|
2159
|
+
* @memberof CreditNoteItemModel
|
|
2160
|
+
*/
|
|
2161
|
+
'creditNoteId'?: number;
|
|
2162
|
+
/**
|
|
2163
|
+
* orderId
|
|
2164
|
+
* @type {number}
|
|
2165
|
+
* @memberof CreditNoteItemModel
|
|
2166
|
+
*/
|
|
2167
|
+
'orderId'?: number;
|
|
2168
|
+
/**
|
|
2169
|
+
* itemId
|
|
2170
|
+
* @type {number}
|
|
2171
|
+
* @memberof CreditNoteItemModel
|
|
2172
|
+
*/
|
|
2173
|
+
'itemId'?: number;
|
|
2174
|
+
/**
|
|
2175
|
+
* amount
|
|
2176
|
+
* @type {number}
|
|
2177
|
+
* @memberof CreditNoteItemModel
|
|
2178
|
+
*/
|
|
2179
|
+
'amount'?: number;
|
|
2180
|
+
}
|
|
2144
2181
|
/**
|
|
2145
2182
|
* Credit Note Model
|
|
2146
2183
|
* @export
|
|
@@ -2177,6 +2214,12 @@ export interface CreditNoteModel {
|
|
|
2177
2214
|
* @memberof CreditNoteModel
|
|
2178
2215
|
*/
|
|
2179
2216
|
'timestamp'?: string;
|
|
2217
|
+
/**
|
|
2218
|
+
* Credit Note Items
|
|
2219
|
+
* @type {Array<CreditNoteItemModel>}
|
|
2220
|
+
* @memberof CreditNoteModel
|
|
2221
|
+
*/
|
|
2222
|
+
'items'?: Array<CreditNoteItemModel>;
|
|
2180
2223
|
}
|
|
2181
2224
|
/**
|
|
2182
2225
|
* CRM Contact
|
|
@@ -7619,6 +7662,49 @@ export interface SipTrunksResponseModel {
|
|
|
7619
7662
|
*/
|
|
7620
7663
|
'totalResults'?: number;
|
|
7621
7664
|
}
|
|
7665
|
+
/**
|
|
7666
|
+
* SMS Account
|
|
7667
|
+
* @export
|
|
7668
|
+
* @interface SmsAccountDTO
|
|
7669
|
+
*/
|
|
7670
|
+
export interface SmsAccountDTO {
|
|
7671
|
+
/**
|
|
7672
|
+
* Send URL
|
|
7673
|
+
* @type {string}
|
|
7674
|
+
* @memberof SmsAccountDTO
|
|
7675
|
+
*/
|
|
7676
|
+
'sendUrl'?: string;
|
|
7677
|
+
/**
|
|
7678
|
+
* Webhook URL
|
|
7679
|
+
* @type {string}
|
|
7680
|
+
* @memberof SmsAccountDTO
|
|
7681
|
+
*/
|
|
7682
|
+
'webhookUrl'?: string;
|
|
7683
|
+
/**
|
|
7684
|
+
* API Key
|
|
7685
|
+
* @type {string}
|
|
7686
|
+
* @memberof SmsAccountDTO
|
|
7687
|
+
*/
|
|
7688
|
+
'apiKey'?: string;
|
|
7689
|
+
/**
|
|
7690
|
+
* Numbers
|
|
7691
|
+
* @type {Array<SmsNumbersEntity>}
|
|
7692
|
+
* @memberof SmsAccountDTO
|
|
7693
|
+
*/
|
|
7694
|
+
'numbers'?: Array<SmsNumbersEntity>;
|
|
7695
|
+
/**
|
|
7696
|
+
* Name
|
|
7697
|
+
* @type {string}
|
|
7698
|
+
* @memberof SmsAccountDTO
|
|
7699
|
+
*/
|
|
7700
|
+
'name'?: string;
|
|
7701
|
+
/**
|
|
7702
|
+
* Sender Whitelist
|
|
7703
|
+
* @type {Array<SmsWhitelistEntity>}
|
|
7704
|
+
* @memberof SmsAccountDTO
|
|
7705
|
+
*/
|
|
7706
|
+
'whitelist'?: Array<SmsWhitelistEntity>;
|
|
7707
|
+
}
|
|
7622
7708
|
/**
|
|
7623
7709
|
* SmsEntity
|
|
7624
7710
|
* @export
|
|
@@ -7668,6 +7754,59 @@ export interface SmsAccountEntity {
|
|
|
7668
7754
|
*/
|
|
7669
7755
|
'name'?: string;
|
|
7670
7756
|
}
|
|
7757
|
+
/**
|
|
7758
|
+
* SMS Account Request
|
|
7759
|
+
* @export
|
|
7760
|
+
* @interface SmsAccountRequestDTO
|
|
7761
|
+
*/
|
|
7762
|
+
export interface SmsAccountRequestDTO {
|
|
7763
|
+
/**
|
|
7764
|
+
* SMS Provider
|
|
7765
|
+
* @type {number}
|
|
7766
|
+
* @memberof SmsAccountRequestDTO
|
|
7767
|
+
*/
|
|
7768
|
+
'provider'?: SmsAccountRequestDTOProviderEnum;
|
|
7769
|
+
/**
|
|
7770
|
+
* Customer Name
|
|
7771
|
+
* @type {string}
|
|
7772
|
+
* @memberof SmsAccountRequestDTO
|
|
7773
|
+
*/
|
|
7774
|
+
'name'?: string;
|
|
7775
|
+
/**
|
|
7776
|
+
* SMS Webhook
|
|
7777
|
+
* @type {string}
|
|
7778
|
+
* @memberof SmsAccountRequestDTO
|
|
7779
|
+
*/
|
|
7780
|
+
'webhookUrl'?: string;
|
|
7781
|
+
/**
|
|
7782
|
+
* Number Country
|
|
7783
|
+
* @type {string}
|
|
7784
|
+
* @memberof SmsAccountRequestDTO
|
|
7785
|
+
*/
|
|
7786
|
+
'iso'?: string;
|
|
7787
|
+
/**
|
|
7788
|
+
* Number Type
|
|
7789
|
+
* @type {string}
|
|
7790
|
+
* @memberof SmsAccountRequestDTO
|
|
7791
|
+
*/
|
|
7792
|
+
'type'?: SmsAccountRequestDTOTypeEnum;
|
|
7793
|
+
}
|
|
7794
|
+
|
|
7795
|
+
export const SmsAccountRequestDTOProviderEnum = {
|
|
7796
|
+
NUMBER_1: 1
|
|
7797
|
+
} as const;
|
|
7798
|
+
|
|
7799
|
+
export type SmsAccountRequestDTOProviderEnum = typeof SmsAccountRequestDTOProviderEnum[keyof typeof SmsAccountRequestDTOProviderEnum];
|
|
7800
|
+
export const SmsAccountRequestDTOTypeEnum = {
|
|
7801
|
+
Local: 'local',
|
|
7802
|
+
TollFree: 'toll_free',
|
|
7803
|
+
Mobile: 'mobile',
|
|
7804
|
+
National: 'national',
|
|
7805
|
+
SharedCost: 'shared_cost'
|
|
7806
|
+
} as const;
|
|
7807
|
+
|
|
7808
|
+
export type SmsAccountRequestDTOTypeEnum = typeof SmsAccountRequestDTOTypeEnum[keyof typeof SmsAccountRequestDTOTypeEnum];
|
|
7809
|
+
|
|
7671
7810
|
/**
|
|
7672
7811
|
* SMS Data Model
|
|
7673
7812
|
* @export
|
|
@@ -19781,6 +19920,8 @@ export const PostAccessTokenScopeEnum = {
|
|
|
19781
19920
|
ProductsRead: 'products.read',
|
|
19782
19921
|
ProvisioningRead: 'provisioning.read',
|
|
19783
19922
|
ProvisioningWrite: 'provisioning.write',
|
|
19923
|
+
SmsRead: 'sms.read',
|
|
19924
|
+
SmsWrite: 'sms.write',
|
|
19784
19925
|
TrunksRead: 'trunks.read',
|
|
19785
19926
|
TrunksWrite: 'trunks.write',
|
|
19786
19927
|
TcxIntegrationsRead: 'tcx_integrations.read',
|
|
@@ -19821,6 +19962,8 @@ export const PostAuthoriseScopeEnum = {
|
|
|
19821
19962
|
ProductsRead: 'products.read',
|
|
19822
19963
|
ProvisioningRead: 'provisioning.read',
|
|
19823
19964
|
ProvisioningWrite: 'provisioning.write',
|
|
19965
|
+
SmsRead: 'sms.read',
|
|
19966
|
+
SmsWrite: 'sms.write',
|
|
19824
19967
|
TrunksRead: 'trunks.read',
|
|
19825
19968
|
TrunksWrite: 'trunks.write',
|
|
19826
19969
|
TcxIntegrationsRead: 'tcx_integrations.read',
|
|
@@ -25219,6 +25362,40 @@ export class SIPTrunksApi extends BaseAPI {
|
|
|
25219
25362
|
*/
|
|
25220
25363
|
export const SMSApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
25221
25364
|
return {
|
|
25365
|
+
/**
|
|
25366
|
+
* Create SMS Account
|
|
25367
|
+
* @summary Create SMS Account
|
|
25368
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
25369
|
+
* @param {*} [options] Override http request option.
|
|
25370
|
+
* @throws {RequiredError}
|
|
25371
|
+
*/
|
|
25372
|
+
postCreateSmsAccount: async (smsAccountRequestDTO?: SmsAccountRequestDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25373
|
+
const localVarPath = `/messaging/sms/account`;
|
|
25374
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25375
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25376
|
+
let baseOptions;
|
|
25377
|
+
if (configuration) {
|
|
25378
|
+
baseOptions = configuration.baseOptions;
|
|
25379
|
+
}
|
|
25380
|
+
|
|
25381
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
25382
|
+
const localVarHeaderParameter = {} as any;
|
|
25383
|
+
const localVarQueryParameter = {} as any;
|
|
25384
|
+
|
|
25385
|
+
|
|
25386
|
+
|
|
25387
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25388
|
+
|
|
25389
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25390
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25391
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25392
|
+
localVarRequestOptions.data = serializeDataIfNeeded(smsAccountRequestDTO, localVarRequestOptions, configuration)
|
|
25393
|
+
|
|
25394
|
+
return {
|
|
25395
|
+
url: toPathString(localVarUrlObj),
|
|
25396
|
+
options: localVarRequestOptions,
|
|
25397
|
+
};
|
|
25398
|
+
},
|
|
25222
25399
|
/**
|
|
25223
25400
|
* Send SMS
|
|
25224
25401
|
* @param {string} authorization Bearer Token
|
|
@@ -25268,6 +25445,19 @@ export const SMSApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
25268
25445
|
export const SMSApiFp = function(configuration?: Configuration) {
|
|
25269
25446
|
const localVarAxiosParamCreator = SMSApiAxiosParamCreator(configuration)
|
|
25270
25447
|
return {
|
|
25448
|
+
/**
|
|
25449
|
+
* Create SMS Account
|
|
25450
|
+
* @summary Create SMS Account
|
|
25451
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
25452
|
+
* @param {*} [options] Override http request option.
|
|
25453
|
+
* @throws {RequiredError}
|
|
25454
|
+
*/
|
|
25455
|
+
async postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SmsAccountDTO>> {
|
|
25456
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postCreateSmsAccount(smsAccountRequestDTO, options);
|
|
25457
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25458
|
+
const localVarOperationServerBasePath = operationServerMap['SMSApi.postCreateSmsAccount']?.[localVarOperationServerIndex]?.url;
|
|
25459
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25460
|
+
},
|
|
25271
25461
|
/**
|
|
25272
25462
|
* Send SMS
|
|
25273
25463
|
* @param {string} authorization Bearer Token
|
|
@@ -25291,6 +25481,16 @@ export const SMSApiFp = function(configuration?: Configuration) {
|
|
|
25291
25481
|
export const SMSApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
25292
25482
|
const localVarFp = SMSApiFp(configuration)
|
|
25293
25483
|
return {
|
|
25484
|
+
/**
|
|
25485
|
+
* Create SMS Account
|
|
25486
|
+
* @summary Create SMS Account
|
|
25487
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
25488
|
+
* @param {*} [options] Override http request option.
|
|
25489
|
+
* @throws {RequiredError}
|
|
25490
|
+
*/
|
|
25491
|
+
postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<SmsAccountDTO> {
|
|
25492
|
+
return localVarFp.postCreateSmsAccount(smsAccountRequestDTO, options).then((request) => request(axios, basePath));
|
|
25493
|
+
},
|
|
25294
25494
|
/**
|
|
25295
25495
|
* Send SMS
|
|
25296
25496
|
* @param {string} authorization Bearer Token
|
|
@@ -25311,6 +25511,18 @@ export const SMSApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
25311
25511
|
* @extends {BaseAPI}
|
|
25312
25512
|
*/
|
|
25313
25513
|
export class SMSApi extends BaseAPI {
|
|
25514
|
+
/**
|
|
25515
|
+
* Create SMS Account
|
|
25516
|
+
* @summary Create SMS Account
|
|
25517
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
25518
|
+
* @param {*} [options] Override http request option.
|
|
25519
|
+
* @throws {RequiredError}
|
|
25520
|
+
* @memberof SMSApi
|
|
25521
|
+
*/
|
|
25522
|
+
public postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig) {
|
|
25523
|
+
return SMSApiFp(this.configuration).postCreateSmsAccount(smsAccountRequestDTO, options).then((request) => request(this.axios, this.basePath));
|
|
25524
|
+
}
|
|
25525
|
+
|
|
25314
25526
|
/**
|
|
25315
25527
|
* Send SMS
|
|
25316
25528
|
* @param {string} authorization Bearer Token
|
package/base.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Yellowgrid
|
|
5
|
-
* 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.
|
|
5
|
+
* 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.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 0
|
|
8
8
|
*
|
|
@@ -19,7 +19,7 @@ import type { Configuration } from './configuration';
|
|
|
19
19
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
20
20
|
import globalAxios from 'axios';
|
|
21
21
|
|
|
22
|
-
export const BASE_PATH = "https://api.yellowgrid.
|
|
22
|
+
export const BASE_PATH = "https://api.local.yellowgrid.co.uk".replace(/\/+$/, "");
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
25
|
*
|
package/common.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Yellowgrid
|
|
5
|
-
* 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.
|
|
5
|
+
* 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.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 0
|
|
8
8
|
*
|
package/configuration.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Yellowgrid
|
|
5
|
-
* 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.
|
|
5
|
+
* 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.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 0
|
|
8
8
|
*
|
package/dist/api.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
|
*
|
|
@@ -2124,6 +2124,43 @@ export interface CreditNoteItemEntity {
|
|
|
2124
2124
|
*/
|
|
2125
2125
|
'amount'?: number;
|
|
2126
2126
|
}
|
|
2127
|
+
/**
|
|
2128
|
+
* Credit Note Item
|
|
2129
|
+
* @export
|
|
2130
|
+
* @interface CreditNoteItemModel
|
|
2131
|
+
*/
|
|
2132
|
+
export interface CreditNoteItemModel {
|
|
2133
|
+
/**
|
|
2134
|
+
* id
|
|
2135
|
+
* @type {number}
|
|
2136
|
+
* @memberof CreditNoteItemModel
|
|
2137
|
+
*/
|
|
2138
|
+
'id'?: number;
|
|
2139
|
+
/**
|
|
2140
|
+
* creditNoteId
|
|
2141
|
+
* @type {number}
|
|
2142
|
+
* @memberof CreditNoteItemModel
|
|
2143
|
+
*/
|
|
2144
|
+
'creditNoteId'?: number;
|
|
2145
|
+
/**
|
|
2146
|
+
* orderId
|
|
2147
|
+
* @type {number}
|
|
2148
|
+
* @memberof CreditNoteItemModel
|
|
2149
|
+
*/
|
|
2150
|
+
'orderId'?: number;
|
|
2151
|
+
/**
|
|
2152
|
+
* itemId
|
|
2153
|
+
* @type {number}
|
|
2154
|
+
* @memberof CreditNoteItemModel
|
|
2155
|
+
*/
|
|
2156
|
+
'itemId'?: number;
|
|
2157
|
+
/**
|
|
2158
|
+
* amount
|
|
2159
|
+
* @type {number}
|
|
2160
|
+
* @memberof CreditNoteItemModel
|
|
2161
|
+
*/
|
|
2162
|
+
'amount'?: number;
|
|
2163
|
+
}
|
|
2127
2164
|
/**
|
|
2128
2165
|
* Credit Note Model
|
|
2129
2166
|
* @export
|
|
@@ -2160,6 +2197,12 @@ export interface CreditNoteModel {
|
|
|
2160
2197
|
* @memberof CreditNoteModel
|
|
2161
2198
|
*/
|
|
2162
2199
|
'timestamp'?: string;
|
|
2200
|
+
/**
|
|
2201
|
+
* Credit Note Items
|
|
2202
|
+
* @type {Array<CreditNoteItemModel>}
|
|
2203
|
+
* @memberof CreditNoteModel
|
|
2204
|
+
*/
|
|
2205
|
+
'items'?: Array<CreditNoteItemModel>;
|
|
2163
2206
|
}
|
|
2164
2207
|
/**
|
|
2165
2208
|
* CRM Contact
|
|
@@ -7552,6 +7595,49 @@ export interface SipTrunksResponseModel {
|
|
|
7552
7595
|
*/
|
|
7553
7596
|
'totalResults'?: number;
|
|
7554
7597
|
}
|
|
7598
|
+
/**
|
|
7599
|
+
* SMS Account
|
|
7600
|
+
* @export
|
|
7601
|
+
* @interface SmsAccountDTO
|
|
7602
|
+
*/
|
|
7603
|
+
export interface SmsAccountDTO {
|
|
7604
|
+
/**
|
|
7605
|
+
* Send URL
|
|
7606
|
+
* @type {string}
|
|
7607
|
+
* @memberof SmsAccountDTO
|
|
7608
|
+
*/
|
|
7609
|
+
'sendUrl'?: string;
|
|
7610
|
+
/**
|
|
7611
|
+
* Webhook URL
|
|
7612
|
+
* @type {string}
|
|
7613
|
+
* @memberof SmsAccountDTO
|
|
7614
|
+
*/
|
|
7615
|
+
'webhookUrl'?: string;
|
|
7616
|
+
/**
|
|
7617
|
+
* API Key
|
|
7618
|
+
* @type {string}
|
|
7619
|
+
* @memberof SmsAccountDTO
|
|
7620
|
+
*/
|
|
7621
|
+
'apiKey'?: string;
|
|
7622
|
+
/**
|
|
7623
|
+
* Numbers
|
|
7624
|
+
* @type {Array<SmsNumbersEntity>}
|
|
7625
|
+
* @memberof SmsAccountDTO
|
|
7626
|
+
*/
|
|
7627
|
+
'numbers'?: Array<SmsNumbersEntity>;
|
|
7628
|
+
/**
|
|
7629
|
+
* Name
|
|
7630
|
+
* @type {string}
|
|
7631
|
+
* @memberof SmsAccountDTO
|
|
7632
|
+
*/
|
|
7633
|
+
'name'?: string;
|
|
7634
|
+
/**
|
|
7635
|
+
* Sender Whitelist
|
|
7636
|
+
* @type {Array<SmsWhitelistEntity>}
|
|
7637
|
+
* @memberof SmsAccountDTO
|
|
7638
|
+
*/
|
|
7639
|
+
'whitelist'?: Array<SmsWhitelistEntity>;
|
|
7640
|
+
}
|
|
7555
7641
|
/**
|
|
7556
7642
|
* SmsEntity
|
|
7557
7643
|
* @export
|
|
@@ -7601,6 +7687,55 @@ export interface SmsAccountEntity {
|
|
|
7601
7687
|
*/
|
|
7602
7688
|
'name'?: string;
|
|
7603
7689
|
}
|
|
7690
|
+
/**
|
|
7691
|
+
* SMS Account Request
|
|
7692
|
+
* @export
|
|
7693
|
+
* @interface SmsAccountRequestDTO
|
|
7694
|
+
*/
|
|
7695
|
+
export interface SmsAccountRequestDTO {
|
|
7696
|
+
/**
|
|
7697
|
+
* SMS Provider
|
|
7698
|
+
* @type {number}
|
|
7699
|
+
* @memberof SmsAccountRequestDTO
|
|
7700
|
+
*/
|
|
7701
|
+
'provider'?: SmsAccountRequestDTOProviderEnum;
|
|
7702
|
+
/**
|
|
7703
|
+
* Customer Name
|
|
7704
|
+
* @type {string}
|
|
7705
|
+
* @memberof SmsAccountRequestDTO
|
|
7706
|
+
*/
|
|
7707
|
+
'name'?: string;
|
|
7708
|
+
/**
|
|
7709
|
+
* SMS Webhook
|
|
7710
|
+
* @type {string}
|
|
7711
|
+
* @memberof SmsAccountRequestDTO
|
|
7712
|
+
*/
|
|
7713
|
+
'webhookUrl'?: string;
|
|
7714
|
+
/**
|
|
7715
|
+
* Number Country
|
|
7716
|
+
* @type {string}
|
|
7717
|
+
* @memberof SmsAccountRequestDTO
|
|
7718
|
+
*/
|
|
7719
|
+
'iso'?: string;
|
|
7720
|
+
/**
|
|
7721
|
+
* Number Type
|
|
7722
|
+
* @type {string}
|
|
7723
|
+
* @memberof SmsAccountRequestDTO
|
|
7724
|
+
*/
|
|
7725
|
+
'type'?: SmsAccountRequestDTOTypeEnum;
|
|
7726
|
+
}
|
|
7727
|
+
export declare const SmsAccountRequestDTOProviderEnum: {
|
|
7728
|
+
readonly NUMBER_1: 1;
|
|
7729
|
+
};
|
|
7730
|
+
export type SmsAccountRequestDTOProviderEnum = typeof SmsAccountRequestDTOProviderEnum[keyof typeof SmsAccountRequestDTOProviderEnum];
|
|
7731
|
+
export declare const SmsAccountRequestDTOTypeEnum: {
|
|
7732
|
+
readonly Local: "local";
|
|
7733
|
+
readonly TollFree: "toll_free";
|
|
7734
|
+
readonly Mobile: "mobile";
|
|
7735
|
+
readonly National: "national";
|
|
7736
|
+
readonly SharedCost: "shared_cost";
|
|
7737
|
+
};
|
|
7738
|
+
export type SmsAccountRequestDTOTypeEnum = typeof SmsAccountRequestDTOTypeEnum[keyof typeof SmsAccountRequestDTOTypeEnum];
|
|
7604
7739
|
/**
|
|
7605
7740
|
* SMS Data Model
|
|
7606
7741
|
* @export
|
|
@@ -15455,6 +15590,8 @@ export declare const PostAccessTokenScopeEnum: {
|
|
|
15455
15590
|
readonly ProductsRead: "products.read";
|
|
15456
15591
|
readonly ProvisioningRead: "provisioning.read";
|
|
15457
15592
|
readonly ProvisioningWrite: "provisioning.write";
|
|
15593
|
+
readonly SmsRead: "sms.read";
|
|
15594
|
+
readonly SmsWrite: "sms.write";
|
|
15458
15595
|
readonly TrunksRead: "trunks.read";
|
|
15459
15596
|
readonly TrunksWrite: "trunks.write";
|
|
15460
15597
|
readonly TcxIntegrationsRead: "tcx_integrations.read";
|
|
@@ -15495,6 +15632,8 @@ export declare const PostAuthoriseScopeEnum: {
|
|
|
15495
15632
|
readonly ProductsRead: "products.read";
|
|
15496
15633
|
readonly ProvisioningRead: "provisioning.read";
|
|
15497
15634
|
readonly ProvisioningWrite: "provisioning.write";
|
|
15635
|
+
readonly SmsRead: "sms.read";
|
|
15636
|
+
readonly SmsWrite: "sms.write";
|
|
15498
15637
|
readonly TrunksRead: "trunks.read";
|
|
15499
15638
|
readonly TrunksWrite: "trunks.write";
|
|
15500
15639
|
readonly TcxIntegrationsRead: "tcx_integrations.read";
|
|
@@ -18190,6 +18329,14 @@ export declare class SIPTrunksApi extends BaseAPI {
|
|
|
18190
18329
|
* @export
|
|
18191
18330
|
*/
|
|
18192
18331
|
export declare const SMSApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
18332
|
+
/**
|
|
18333
|
+
* Create SMS Account
|
|
18334
|
+
* @summary Create SMS Account
|
|
18335
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
18336
|
+
* @param {*} [options] Override http request option.
|
|
18337
|
+
* @throws {RequiredError}
|
|
18338
|
+
*/
|
|
18339
|
+
postCreateSmsAccount: (smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18193
18340
|
/**
|
|
18194
18341
|
* Send SMS
|
|
18195
18342
|
* @param {string} authorization Bearer Token
|
|
@@ -18204,6 +18351,14 @@ export declare const SMSApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
18204
18351
|
* @export
|
|
18205
18352
|
*/
|
|
18206
18353
|
export declare const SMSApiFp: (configuration?: Configuration) => {
|
|
18354
|
+
/**
|
|
18355
|
+
* Create SMS Account
|
|
18356
|
+
* @summary Create SMS Account
|
|
18357
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
18358
|
+
* @param {*} [options] Override http request option.
|
|
18359
|
+
* @throws {RequiredError}
|
|
18360
|
+
*/
|
|
18361
|
+
postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SmsAccountDTO>>;
|
|
18207
18362
|
/**
|
|
18208
18363
|
* Send SMS
|
|
18209
18364
|
* @param {string} authorization Bearer Token
|
|
@@ -18218,6 +18373,14 @@ export declare const SMSApiFp: (configuration?: Configuration) => {
|
|
|
18218
18373
|
* @export
|
|
18219
18374
|
*/
|
|
18220
18375
|
export declare const SMSApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
18376
|
+
/**
|
|
18377
|
+
* Create SMS Account
|
|
18378
|
+
* @summary Create SMS Account
|
|
18379
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
18380
|
+
* @param {*} [options] Override http request option.
|
|
18381
|
+
* @throws {RequiredError}
|
|
18382
|
+
*/
|
|
18383
|
+
postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<SmsAccountDTO>;
|
|
18221
18384
|
/**
|
|
18222
18385
|
* Send SMS
|
|
18223
18386
|
* @param {string} authorization Bearer Token
|
|
@@ -18234,6 +18397,15 @@ export declare const SMSApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
18234
18397
|
* @extends {BaseAPI}
|
|
18235
18398
|
*/
|
|
18236
18399
|
export declare class SMSApi extends BaseAPI {
|
|
18400
|
+
/**
|
|
18401
|
+
* Create SMS Account
|
|
18402
|
+
* @summary Create SMS Account
|
|
18403
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
18404
|
+
* @param {*} [options] Override http request option.
|
|
18405
|
+
* @throws {RequiredError}
|
|
18406
|
+
* @memberof SMSApi
|
|
18407
|
+
*/
|
|
18408
|
+
postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SmsAccountDTO, any, {}>>;
|
|
18237
18409
|
/**
|
|
18238
18410
|
* Send SMS
|
|
18239
18411
|
* @param {string} authorization Bearer Token
|