yellowgrid-api-ts 3.2.89-dev.0 → 3.2.91-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 +8 -1
- package/api.ts +292 -1
- package/base.ts +2 -2
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +210 -1
- package/dist/api.js +190 -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 +59 -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
|
------------ | ------------- | ------------- | -------------
|
|
@@ -162,6 +162,7 @@ Class | Method | HTTP request | Description
|
|
|
162
162
|
*OrdersApi* | [**getGetOrderPdf**](docs/OrdersApi.md#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF
|
|
163
163
|
*OrdersApi* | [**getGetOrderSummary**](docs/OrdersApi.md#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)
|
|
164
164
|
*OrdersApi* | [**getGetOrders**](docs/OrdersApi.md#getgetorders) | **GET** /orders | Get Orders (Beta)
|
|
165
|
+
*OrdersApi* | [**getUpdatePaymentStatus**](docs/OrdersApi.md#getupdatepaymentstatus) | **GET** /admin/orders/{id}/paid | Change Payment Status (Admin)
|
|
165
166
|
*OrdersApi* | [**postAddOrderNote**](docs/OrdersApi.md#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note
|
|
166
167
|
*OrdersApi* | [**postCreateAdminOrder**](docs/OrdersApi.md#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)
|
|
167
168
|
*OrdersApi* | [**postCreateConsignment**](docs/OrdersApi.md#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment
|
|
@@ -218,6 +219,7 @@ Class | Method | HTTP request | Description
|
|
|
218
219
|
*SIPTrunksApi* | [**postTrackChange**](docs/SIPTrunksApi.md#posttrackchange) | **POST** /sip/trunks/changes/track | Track SIP Trunk Change Request
|
|
219
220
|
*SIPTrunksApi* | [**putGetAddress**](docs/SIPTrunksApi.md#putgetaddress) | **PUT** /sip/trunks/{id}/address | Update SIP Trunk Address
|
|
220
221
|
*SIPTrunksApi* | [**putGetDiverts**](docs/SIPTrunksApi.md#putgetdiverts) | **PUT** /sip/trunks/{id}/diverts | Update SIP Trunk Diverts
|
|
222
|
+
*SMSApi* | [**postCreateSmsAccount**](docs/SMSApi.md#postcreatesmsaccount) | **POST** /messaging/sms/account | Create SMS Account
|
|
221
223
|
*SMSApi* | [**postSendSms**](docs/SMSApi.md#postsendsms) | **POST** /messaging/sms/send |
|
|
222
224
|
*ServicesApi* | [**deleteUnsubscribe**](docs/ServicesApi.md#deleteunsubscribe) | **DELETE** /services/events/unsubscribe |
|
|
223
225
|
*ServicesApi* | [**getGetServiceHealth**](docs/ServicesApi.md#getgetservicehealth) | **GET** /services/health |
|
|
@@ -301,6 +303,7 @@ Class | Method | HTTP request | Description
|
|
|
301
303
|
- [CreditNoteEntity](docs/CreditNoteEntity.md)
|
|
302
304
|
- [CreditNoteItemDTO](docs/CreditNoteItemDTO.md)
|
|
303
305
|
- [CreditNoteItemEntity](docs/CreditNoteItemEntity.md)
|
|
306
|
+
- [CreditNoteItemModel](docs/CreditNoteItemModel.md)
|
|
304
307
|
- [CreditNoteModel](docs/CreditNoteModel.md)
|
|
305
308
|
- [CrmContactDTO](docs/CrmContactDTO.md)
|
|
306
309
|
- [CustomerInformationModel](docs/CustomerInformationModel.md)
|
|
@@ -415,7 +418,9 @@ Class | Method | HTTP request | Description
|
|
|
415
418
|
- [SipTrunkCreationRequestModel](docs/SipTrunkCreationRequestModel.md)
|
|
416
419
|
- [SipTrunkEntity](docs/SipTrunkEntity.md)
|
|
417
420
|
- [SipTrunksResponseModel](docs/SipTrunksResponseModel.md)
|
|
421
|
+
- [SmsAccountDTO](docs/SmsAccountDTO.md)
|
|
418
422
|
- [SmsAccountEntity](docs/SmsAccountEntity.md)
|
|
423
|
+
- [SmsAccountRequestDTO](docs/SmsAccountRequestDTO.md)
|
|
419
424
|
- [SmsDataModel](docs/SmsDataModel.md)
|
|
420
425
|
- [SmsMessageModel](docs/SmsMessageModel.md)
|
|
421
426
|
- [SmsNumbersEntity](docs/SmsNumbersEntity.md)
|
|
@@ -517,6 +522,8 @@ Authentication schemes defined for the API:
|
|
|
517
522
|
- **products.read**: Products (Read)
|
|
518
523
|
- **provisioning.read**: Provisioning (Read)
|
|
519
524
|
- **provisioning.write**: Provisioning (Write)
|
|
525
|
+
- **sms.read**: Sms (Read)
|
|
526
|
+
- **sms.write**: Sms (Write)
|
|
520
527
|
- **trunks.read**: Trunks (Read)
|
|
521
528
|
- **trunks.write**: Trunks (Write)
|
|
522
529
|
- **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',
|
|
@@ -20219,6 +20362,47 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
20219
20362
|
|
|
20220
20363
|
|
|
20221
20364
|
|
|
20365
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20366
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20367
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20368
|
+
|
|
20369
|
+
return {
|
|
20370
|
+
url: toPathString(localVarUrlObj),
|
|
20371
|
+
options: localVarRequestOptions,
|
|
20372
|
+
};
|
|
20373
|
+
},
|
|
20374
|
+
/**
|
|
20375
|
+
* Change Payment Status (Admin)
|
|
20376
|
+
* @summary Change Payment Status (Admin)
|
|
20377
|
+
* @param {number} id Order ID
|
|
20378
|
+
* @param {boolean} id2 Paid
|
|
20379
|
+
* @param {*} [options] Override http request option.
|
|
20380
|
+
* @throws {RequiredError}
|
|
20381
|
+
*/
|
|
20382
|
+
getUpdatePaymentStatus: async (id: number, id2: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20383
|
+
// verify required parameter 'id' is not null or undefined
|
|
20384
|
+
assertParamExists('getUpdatePaymentStatus', 'id', id)
|
|
20385
|
+
// verify required parameter 'id2' is not null or undefined
|
|
20386
|
+
assertParamExists('getUpdatePaymentStatus', 'id2', id2)
|
|
20387
|
+
const localVarPath = `/admin/orders/{id}/paid`
|
|
20388
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
20389
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20390
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20391
|
+
let baseOptions;
|
|
20392
|
+
if (configuration) {
|
|
20393
|
+
baseOptions = configuration.baseOptions;
|
|
20394
|
+
}
|
|
20395
|
+
|
|
20396
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
20397
|
+
const localVarHeaderParameter = {} as any;
|
|
20398
|
+
const localVarQueryParameter = {} as any;
|
|
20399
|
+
|
|
20400
|
+
if (id2 !== undefined) {
|
|
20401
|
+
localVarQueryParameter['id'] = id2;
|
|
20402
|
+
}
|
|
20403
|
+
|
|
20404
|
+
|
|
20405
|
+
|
|
20222
20406
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20223
20407
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20224
20408
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -21003,6 +21187,20 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
21003
21187
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetOrders']?.[localVarOperationServerIndex]?.url;
|
|
21004
21188
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21005
21189
|
},
|
|
21190
|
+
/**
|
|
21191
|
+
* Change Payment Status (Admin)
|
|
21192
|
+
* @summary Change Payment Status (Admin)
|
|
21193
|
+
* @param {number} id Order ID
|
|
21194
|
+
* @param {boolean} id2 Paid
|
|
21195
|
+
* @param {*} [options] Override http request option.
|
|
21196
|
+
* @throws {RequiredError}
|
|
21197
|
+
*/
|
|
21198
|
+
async getUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>> {
|
|
21199
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getUpdatePaymentStatus(id, id2, options);
|
|
21200
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21201
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getUpdatePaymentStatus']?.[localVarOperationServerIndex]?.url;
|
|
21202
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21203
|
+
},
|
|
21006
21204
|
/**
|
|
21007
21205
|
* Add Order Note
|
|
21008
21206
|
* @summary Add Order Note
|
|
@@ -21342,6 +21540,17 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
21342
21540
|
getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummariesModel> {
|
|
21343
21541
|
return localVarFp.getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, options).then((request) => request(axios, basePath));
|
|
21344
21542
|
},
|
|
21543
|
+
/**
|
|
21544
|
+
* Change Payment Status (Admin)
|
|
21545
|
+
* @summary Change Payment Status (Admin)
|
|
21546
|
+
* @param {number} id Order ID
|
|
21547
|
+
* @param {boolean} id2 Paid
|
|
21548
|
+
* @param {*} [options] Override http request option.
|
|
21549
|
+
* @throws {RequiredError}
|
|
21550
|
+
*/
|
|
21551
|
+
getUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO> {
|
|
21552
|
+
return localVarFp.getUpdatePaymentStatus(id, id2, options).then((request) => request(axios, basePath));
|
|
21553
|
+
},
|
|
21345
21554
|
/**
|
|
21346
21555
|
* Add Order Note
|
|
21347
21556
|
* @summary Add Order Note
|
|
@@ -21656,6 +21865,19 @@ export class OrdersApi extends BaseAPI {
|
|
|
21656
21865
|
return OrdersApiFp(this.configuration).getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, options).then((request) => request(this.axios, this.basePath));
|
|
21657
21866
|
}
|
|
21658
21867
|
|
|
21868
|
+
/**
|
|
21869
|
+
* Change Payment Status (Admin)
|
|
21870
|
+
* @summary Change Payment Status (Admin)
|
|
21871
|
+
* @param {number} id Order ID
|
|
21872
|
+
* @param {boolean} id2 Paid
|
|
21873
|
+
* @param {*} [options] Override http request option.
|
|
21874
|
+
* @throws {RequiredError}
|
|
21875
|
+
* @memberof OrdersApi
|
|
21876
|
+
*/
|
|
21877
|
+
public getUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig) {
|
|
21878
|
+
return OrdersApiFp(this.configuration).getUpdatePaymentStatus(id, id2, options).then((request) => request(this.axios, this.basePath));
|
|
21879
|
+
}
|
|
21880
|
+
|
|
21659
21881
|
/**
|
|
21660
21882
|
* Add Order Note
|
|
21661
21883
|
* @summary Add Order Note
|
|
@@ -25219,6 +25441,40 @@ export class SIPTrunksApi extends BaseAPI {
|
|
|
25219
25441
|
*/
|
|
25220
25442
|
export const SMSApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
25221
25443
|
return {
|
|
25444
|
+
/**
|
|
25445
|
+
* Create SMS Account
|
|
25446
|
+
* @summary Create SMS Account
|
|
25447
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
25448
|
+
* @param {*} [options] Override http request option.
|
|
25449
|
+
* @throws {RequiredError}
|
|
25450
|
+
*/
|
|
25451
|
+
postCreateSmsAccount: async (smsAccountRequestDTO?: SmsAccountRequestDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25452
|
+
const localVarPath = `/messaging/sms/account`;
|
|
25453
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25454
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25455
|
+
let baseOptions;
|
|
25456
|
+
if (configuration) {
|
|
25457
|
+
baseOptions = configuration.baseOptions;
|
|
25458
|
+
}
|
|
25459
|
+
|
|
25460
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
25461
|
+
const localVarHeaderParameter = {} as any;
|
|
25462
|
+
const localVarQueryParameter = {} as any;
|
|
25463
|
+
|
|
25464
|
+
|
|
25465
|
+
|
|
25466
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25467
|
+
|
|
25468
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25469
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25470
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25471
|
+
localVarRequestOptions.data = serializeDataIfNeeded(smsAccountRequestDTO, localVarRequestOptions, configuration)
|
|
25472
|
+
|
|
25473
|
+
return {
|
|
25474
|
+
url: toPathString(localVarUrlObj),
|
|
25475
|
+
options: localVarRequestOptions,
|
|
25476
|
+
};
|
|
25477
|
+
},
|
|
25222
25478
|
/**
|
|
25223
25479
|
* Send SMS
|
|
25224
25480
|
* @param {string} authorization Bearer Token
|
|
@@ -25268,6 +25524,19 @@ export const SMSApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
25268
25524
|
export const SMSApiFp = function(configuration?: Configuration) {
|
|
25269
25525
|
const localVarAxiosParamCreator = SMSApiAxiosParamCreator(configuration)
|
|
25270
25526
|
return {
|
|
25527
|
+
/**
|
|
25528
|
+
* Create SMS Account
|
|
25529
|
+
* @summary Create SMS Account
|
|
25530
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
25531
|
+
* @param {*} [options] Override http request option.
|
|
25532
|
+
* @throws {RequiredError}
|
|
25533
|
+
*/
|
|
25534
|
+
async postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SmsAccountDTO>> {
|
|
25535
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postCreateSmsAccount(smsAccountRequestDTO, options);
|
|
25536
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25537
|
+
const localVarOperationServerBasePath = operationServerMap['SMSApi.postCreateSmsAccount']?.[localVarOperationServerIndex]?.url;
|
|
25538
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25539
|
+
},
|
|
25271
25540
|
/**
|
|
25272
25541
|
* Send SMS
|
|
25273
25542
|
* @param {string} authorization Bearer Token
|
|
@@ -25291,6 +25560,16 @@ export const SMSApiFp = function(configuration?: Configuration) {
|
|
|
25291
25560
|
export const SMSApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
25292
25561
|
const localVarFp = SMSApiFp(configuration)
|
|
25293
25562
|
return {
|
|
25563
|
+
/**
|
|
25564
|
+
* Create SMS Account
|
|
25565
|
+
* @summary Create SMS Account
|
|
25566
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
25567
|
+
* @param {*} [options] Override http request option.
|
|
25568
|
+
* @throws {RequiredError}
|
|
25569
|
+
*/
|
|
25570
|
+
postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<SmsAccountDTO> {
|
|
25571
|
+
return localVarFp.postCreateSmsAccount(smsAccountRequestDTO, options).then((request) => request(axios, basePath));
|
|
25572
|
+
},
|
|
25294
25573
|
/**
|
|
25295
25574
|
* Send SMS
|
|
25296
25575
|
* @param {string} authorization Bearer Token
|
|
@@ -25311,6 +25590,18 @@ export const SMSApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
25311
25590
|
* @extends {BaseAPI}
|
|
25312
25591
|
*/
|
|
25313
25592
|
export class SMSApi extends BaseAPI {
|
|
25593
|
+
/**
|
|
25594
|
+
* Create SMS Account
|
|
25595
|
+
* @summary Create SMS Account
|
|
25596
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
25597
|
+
* @param {*} [options] Override http request option.
|
|
25598
|
+
* @throws {RequiredError}
|
|
25599
|
+
* @memberof SMSApi
|
|
25600
|
+
*/
|
|
25601
|
+
public postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig) {
|
|
25602
|
+
return SMSApiFp(this.configuration).postCreateSmsAccount(smsAccountRequestDTO, options).then((request) => request(this.axios, this.basePath));
|
|
25603
|
+
}
|
|
25604
|
+
|
|
25314
25605
|
/**
|
|
25315
25606
|
* Send SMS
|
|
25316
25607
|
* @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
|
*
|