yellowgrid-api-ts 3.1.18-dev.0 → 3.2.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 +220 -218
- package/README.md +20 -1
- package/api.ts +84 -17
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/config.json +3 -3
- package/configuration.ts +1 -1
- package/dist/api.d.ts +78 -11
- package/dist/api.js +54 -18
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- 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/OAuth20Api.md +3 -3
- package/docs/PostGetProductForCustomerRequest.md +2 -0
- package/docs/PostGetProductRequest.md +24 -0
- package/docs/ProductsApi.md +5 -5
- package/index.ts +1 -1
- package/package.json +1 -1
- package/docs/AdminItemRequestDTO.md +0 -43
- package/hs_err_pid58424.log +0 -247
package/.openapi-generator/FILES
CHANGED
|
@@ -1,218 +1,220 @@
|
|
|
1
|
-
.gitignore
|
|
2
|
-
.npmignore
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
docs/
|
|
10
|
-
docs/
|
|
11
|
-
docs/
|
|
12
|
-
docs/
|
|
13
|
-
docs/
|
|
14
|
-
docs/
|
|
15
|
-
docs/
|
|
16
|
-
docs/
|
|
17
|
-
docs/
|
|
18
|
-
docs/
|
|
19
|
-
docs/
|
|
20
|
-
docs/
|
|
21
|
-
docs/
|
|
22
|
-
docs/
|
|
23
|
-
docs/
|
|
24
|
-
docs/
|
|
25
|
-
docs/
|
|
26
|
-
docs/
|
|
27
|
-
docs/
|
|
28
|
-
docs/
|
|
29
|
-
docs/
|
|
30
|
-
docs/
|
|
31
|
-
docs/
|
|
32
|
-
docs/
|
|
33
|
-
docs/
|
|
34
|
-
docs/
|
|
35
|
-
docs/
|
|
36
|
-
docs/
|
|
37
|
-
docs/
|
|
38
|
-
docs/
|
|
39
|
-
docs/
|
|
40
|
-
docs/
|
|
41
|
-
docs/
|
|
42
|
-
docs/
|
|
43
|
-
docs/
|
|
44
|
-
docs/
|
|
45
|
-
docs/
|
|
46
|
-
docs/
|
|
47
|
-
docs/
|
|
48
|
-
docs/
|
|
49
|
-
docs/
|
|
50
|
-
docs/
|
|
51
|
-
docs/
|
|
52
|
-
docs/
|
|
53
|
-
docs/
|
|
54
|
-
docs/
|
|
55
|
-
docs/
|
|
56
|
-
docs/
|
|
57
|
-
docs/
|
|
58
|
-
docs/
|
|
59
|
-
docs/
|
|
60
|
-
docs/
|
|
61
|
-
docs/
|
|
62
|
-
docs/
|
|
63
|
-
docs/
|
|
64
|
-
docs/
|
|
65
|
-
docs/
|
|
66
|
-
docs/
|
|
67
|
-
docs/
|
|
68
|
-
docs/
|
|
69
|
-
docs/
|
|
70
|
-
docs/
|
|
71
|
-
docs/
|
|
72
|
-
docs/
|
|
73
|
-
docs/
|
|
74
|
-
docs/
|
|
75
|
-
docs/
|
|
76
|
-
docs/
|
|
77
|
-
docs/
|
|
78
|
-
docs/
|
|
79
|
-
docs/
|
|
80
|
-
docs/
|
|
81
|
-
docs/
|
|
82
|
-
docs/
|
|
83
|
-
docs/
|
|
84
|
-
docs/
|
|
85
|
-
docs/
|
|
86
|
-
docs/
|
|
87
|
-
docs/
|
|
88
|
-
docs/
|
|
89
|
-
docs/
|
|
90
|
-
docs/
|
|
91
|
-
docs/
|
|
92
|
-
docs/
|
|
93
|
-
docs/
|
|
94
|
-
docs/
|
|
95
|
-
docs/
|
|
96
|
-
docs/
|
|
97
|
-
docs/
|
|
98
|
-
docs/
|
|
99
|
-
docs/
|
|
100
|
-
docs/
|
|
101
|
-
docs/
|
|
102
|
-
docs/
|
|
103
|
-
docs/
|
|
104
|
-
docs/
|
|
105
|
-
docs/
|
|
106
|
-
docs/
|
|
107
|
-
docs/
|
|
108
|
-
docs/
|
|
109
|
-
docs/
|
|
110
|
-
docs/
|
|
111
|
-
docs/
|
|
112
|
-
docs/
|
|
113
|
-
docs/
|
|
114
|
-
docs/
|
|
115
|
-
docs/
|
|
116
|
-
docs/
|
|
117
|
-
docs/
|
|
118
|
-
docs/
|
|
119
|
-
docs/
|
|
120
|
-
docs/
|
|
121
|
-
docs/
|
|
122
|
-
docs/
|
|
123
|
-
docs/
|
|
124
|
-
docs/
|
|
125
|
-
docs/
|
|
126
|
-
docs/
|
|
127
|
-
docs/
|
|
128
|
-
docs/
|
|
129
|
-
docs/
|
|
130
|
-
docs/
|
|
131
|
-
docs/
|
|
132
|
-
docs/
|
|
133
|
-
docs/
|
|
134
|
-
docs/
|
|
135
|
-
docs/
|
|
136
|
-
docs/
|
|
137
|
-
docs/
|
|
138
|
-
docs/
|
|
139
|
-
docs/
|
|
140
|
-
docs/
|
|
141
|
-
docs/
|
|
142
|
-
docs/
|
|
143
|
-
docs/
|
|
144
|
-
docs/
|
|
145
|
-
docs/
|
|
146
|
-
docs/
|
|
147
|
-
docs/
|
|
148
|
-
docs/
|
|
149
|
-
docs/
|
|
150
|
-
docs/
|
|
151
|
-
docs/
|
|
152
|
-
docs/
|
|
153
|
-
docs/
|
|
154
|
-
docs/
|
|
155
|
-
docs/
|
|
156
|
-
docs/
|
|
157
|
-
docs/
|
|
158
|
-
docs/
|
|
159
|
-
docs/
|
|
160
|
-
docs/
|
|
161
|
-
docs/
|
|
162
|
-
docs/
|
|
163
|
-
docs/
|
|
164
|
-
docs/
|
|
165
|
-
docs/
|
|
166
|
-
docs/
|
|
167
|
-
docs/
|
|
168
|
-
docs/
|
|
169
|
-
docs/
|
|
170
|
-
docs/
|
|
171
|
-
docs/
|
|
172
|
-
docs/
|
|
173
|
-
docs/
|
|
174
|
-
docs/
|
|
175
|
-
docs/
|
|
176
|
-
docs/
|
|
177
|
-
docs/
|
|
178
|
-
docs/
|
|
179
|
-
docs/
|
|
180
|
-
docs/
|
|
181
|
-
docs/
|
|
182
|
-
docs/
|
|
183
|
-
docs/
|
|
184
|
-
docs/
|
|
185
|
-
docs/
|
|
186
|
-
docs/
|
|
187
|
-
docs/
|
|
188
|
-
docs/
|
|
189
|
-
docs/
|
|
190
|
-
docs/
|
|
191
|
-
docs/
|
|
192
|
-
docs/
|
|
193
|
-
docs/
|
|
194
|
-
docs/
|
|
195
|
-
docs/
|
|
196
|
-
docs/
|
|
197
|
-
docs/
|
|
198
|
-
docs/
|
|
199
|
-
docs/
|
|
200
|
-
docs/
|
|
201
|
-
docs/
|
|
202
|
-
docs/
|
|
203
|
-
docs/
|
|
204
|
-
docs/
|
|
205
|
-
docs/
|
|
206
|
-
docs/
|
|
207
|
-
docs/
|
|
208
|
-
docs/
|
|
209
|
-
docs/
|
|
210
|
-
docs/
|
|
211
|
-
docs/
|
|
212
|
-
docs/
|
|
213
|
-
docs/
|
|
214
|
-
docs/
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
1
|
+
.gitignore
|
|
2
|
+
.npmignore
|
|
3
|
+
.openapi-generator-ignore
|
|
4
|
+
README.md
|
|
5
|
+
api.ts
|
|
6
|
+
base.ts
|
|
7
|
+
common.ts
|
|
8
|
+
configuration.ts
|
|
9
|
+
docs/AbstractOrderRequestDTO.md
|
|
10
|
+
docs/AccountContactEntity.md
|
|
11
|
+
docs/AccountContactModel.md
|
|
12
|
+
docs/AccountContactRequestModel.md
|
|
13
|
+
docs/AccountDetailedSummaryDTO.md
|
|
14
|
+
docs/AccountRequestModel.md
|
|
15
|
+
docs/AccountSummaryDTO.md
|
|
16
|
+
docs/AccountsApi.md
|
|
17
|
+
docs/AccountsResponseModel.md
|
|
18
|
+
docs/AddressModel.md
|
|
19
|
+
docs/AddressRequestModel.md
|
|
20
|
+
docs/AdminOrderRequestDTO.md
|
|
21
|
+
docs/AdminUserModel.md
|
|
22
|
+
docs/AgentHoursGraphModel.md
|
|
23
|
+
docs/AgentHoursGraphMonthModel.md
|
|
24
|
+
docs/ApiLogEntity.md
|
|
25
|
+
docs/AreaCodeModel.md
|
|
26
|
+
docs/AttachmentModel.md
|
|
27
|
+
docs/AttributeSetEnum.md
|
|
28
|
+
docs/AuditLogEntity.md
|
|
29
|
+
docs/AuthCodeResponseModel.md
|
|
30
|
+
docs/BasicItemDTO.md
|
|
31
|
+
docs/BasicProductDTO.md
|
|
32
|
+
docs/BatchEntity.md
|
|
33
|
+
docs/CRMApi.md
|
|
34
|
+
docs/CallBarringModel.md
|
|
35
|
+
docs/Class3CXApi.md
|
|
36
|
+
docs/Class3CXInstallationWizardApi.md
|
|
37
|
+
docs/Class3CXInstallationsApi.md
|
|
38
|
+
docs/Class3CXIntegrationsApi.md
|
|
39
|
+
docs/Class3CXMultiTenantApi.md
|
|
40
|
+
docs/ClientDetailsModel.md
|
|
41
|
+
docs/ClientModel.md
|
|
42
|
+
docs/CompanyContractModel.md
|
|
43
|
+
docs/ContactInfoModel.md
|
|
44
|
+
docs/ConversationModel.md
|
|
45
|
+
docs/CourierPriceEntity.md
|
|
46
|
+
docs/CreditAccountEntity.md
|
|
47
|
+
docs/CrmContactDTO.md
|
|
48
|
+
docs/CustomerInformationModel.md
|
|
49
|
+
docs/CustomerItemRequestDTO.md
|
|
50
|
+
docs/CustomerOrderRequestDTO.md
|
|
51
|
+
docs/CustomerPriceListEnum.md
|
|
52
|
+
docs/CustomerSummaryReportDTO.md
|
|
53
|
+
docs/DdiRangeRequestModel.md
|
|
54
|
+
docs/DdiRangesRequestModel.md
|
|
55
|
+
docs/DetailedItemRequestDTO.md
|
|
56
|
+
docs/DetailedOrderRequestDTO.md
|
|
57
|
+
docs/DivertRequestModel.md
|
|
58
|
+
docs/DivertResponseModel.md
|
|
59
|
+
docs/EdTechProClientEntity.md
|
|
60
|
+
docs/EdTechProSchoolModel.md
|
|
61
|
+
docs/EdTechProSchoolsModel.md
|
|
62
|
+
docs/EdTechProSetupModel.md
|
|
63
|
+
docs/FraudManagementModel.md
|
|
64
|
+
docs/FreshdeskCompanyTicketsModel.md
|
|
65
|
+
docs/FreshdeskTicketEntity.md
|
|
66
|
+
docs/FtpAccountsEntity.md
|
|
67
|
+
docs/GenericFileModel.md
|
|
68
|
+
docs/GetGetPrice200Response.md
|
|
69
|
+
docs/GetGetRecording200Response.md
|
|
70
|
+
docs/HostingChangeResponseModel.md
|
|
71
|
+
docs/HostingRegionDTO.md
|
|
72
|
+
docs/InstanceAutoFailoverEntity.md
|
|
73
|
+
docs/InstanceDeletionScheduleEntity.md
|
|
74
|
+
docs/InstanceEntity.md
|
|
75
|
+
docs/InstanceFailoverEntity.md
|
|
76
|
+
docs/InstanceMonitoringEntity.md
|
|
77
|
+
docs/InstanceMonitoringLogEntity.md
|
|
78
|
+
docs/InstanceScheduledTasksEntity.md
|
|
79
|
+
docs/InstanceTcxDetailsEntity.md
|
|
80
|
+
docs/InstanceUserCredentialsEntity.md
|
|
81
|
+
docs/ItemDTO.md
|
|
82
|
+
docs/ItemDiscountEntity.md
|
|
83
|
+
docs/ItemEntity.md
|
|
84
|
+
docs/LinkedOrderEntity.md
|
|
85
|
+
docs/MFARequiredModel.md
|
|
86
|
+
docs/MonthlyUsageModel.md
|
|
87
|
+
docs/MultiTenantChangeResponseModel.md
|
|
88
|
+
docs/MyPBXToolsApi.md
|
|
89
|
+
docs/NavigationModel.md
|
|
90
|
+
docs/OAuth20Api.md
|
|
91
|
+
docs/OfflineInstancesEntity.md
|
|
92
|
+
docs/OrderEntity.md
|
|
93
|
+
docs/OrderRequestModel.md
|
|
94
|
+
docs/OrderSummariesModel.md
|
|
95
|
+
docs/OrderSummaryDTO.md
|
|
96
|
+
docs/OrderTotalModel.md
|
|
97
|
+
docs/OrderedItemEntity.md
|
|
98
|
+
docs/OrdersApi.md
|
|
99
|
+
docs/PatchSetTcxWizardCnameRequest.md
|
|
100
|
+
docs/PatchUpdateAccountContactPasswordRequest.md
|
|
101
|
+
docs/PortalAccountModel.md
|
|
102
|
+
docs/PortalLoginModel.md
|
|
103
|
+
docs/PostAddWebhook200Response.md
|
|
104
|
+
docs/PostGetClientCredentialsRequest.md
|
|
105
|
+
docs/PostGetProductForCustomerRequest.md
|
|
106
|
+
docs/PostGetProductRequest.md
|
|
107
|
+
docs/PriceListItemModel.md
|
|
108
|
+
docs/PricingApi.md
|
|
109
|
+
docs/PrizesEntity.md
|
|
110
|
+
docs/ProductPriceListItemModel.md
|
|
111
|
+
docs/ProductSearchResultsModel.md
|
|
112
|
+
docs/ProductSerialInfoModel.md
|
|
113
|
+
docs/ProductSummaryDTO.md
|
|
114
|
+
docs/ProductsApi.md
|
|
115
|
+
docs/PromoCodesEntity.md
|
|
116
|
+
docs/PromoItemsEntity.md
|
|
117
|
+
docs/ProvisioningApi.md
|
|
118
|
+
docs/ProvisioningModel.md
|
|
119
|
+
docs/ProvisioningRequestEntity.md
|
|
120
|
+
docs/RecordingBackupAzureModel.md
|
|
121
|
+
docs/RecordingsBackupInfoDTO.md
|
|
122
|
+
docs/ResourceNotReadyException.md
|
|
123
|
+
docs/RootAccessModel.md
|
|
124
|
+
docs/S3BucketEntity.md
|
|
125
|
+
docs/SIPTrunksApi.md
|
|
126
|
+
docs/SMSApi.md
|
|
127
|
+
docs/ScannedItemModel.md
|
|
128
|
+
docs/ScopeModel.md
|
|
129
|
+
docs/ShipmentAddressEntity.md
|
|
130
|
+
docs/ShipmentEntity.md
|
|
131
|
+
docs/ShipmentItemEntity.md
|
|
132
|
+
docs/ShippingApi.md
|
|
133
|
+
docs/ShippingConsignmentModel.md
|
|
134
|
+
docs/ShippingInformationDTO.md
|
|
135
|
+
docs/ShippingServiceDTO.md
|
|
136
|
+
docs/ShippingServiceModel.md
|
|
137
|
+
docs/ShippingServicesModel.md
|
|
138
|
+
docs/SipTrunkChangeResponseModel.md
|
|
139
|
+
docs/SipTrunkCreationRequestModel.md
|
|
140
|
+
docs/SipTrunkEntity.md
|
|
141
|
+
docs/SipTrunksResponseModel.md
|
|
142
|
+
docs/SmsAccountEntity.md
|
|
143
|
+
docs/SmsDataModel.md
|
|
144
|
+
docs/SmsMessageModel.md
|
|
145
|
+
docs/SmsNumbersEntity.md
|
|
146
|
+
docs/SmsPayloadModel.md
|
|
147
|
+
docs/SmsPhoneNumberModel.md
|
|
148
|
+
docs/SmsResponseModel.md
|
|
149
|
+
docs/SmsWhitelistEntity.md
|
|
150
|
+
docs/StockManagementApi.md
|
|
151
|
+
docs/StockOrderCourierEntity.md
|
|
152
|
+
docs/StockOrderDeductionModel.md
|
|
153
|
+
docs/StockOrderDeductionRequestModel.md
|
|
154
|
+
docs/StockOrderDeductionsEntity.md
|
|
155
|
+
docs/StockOrderEntity.md
|
|
156
|
+
docs/StockOrderItemEntity.md
|
|
157
|
+
docs/StockOrderItemModel.md
|
|
158
|
+
docs/StockOrderItemRequestModel.md
|
|
159
|
+
docs/StockOrderModel.md
|
|
160
|
+
docs/StockOrderProductEntity.md
|
|
161
|
+
docs/StockOrderRequestModel.md
|
|
162
|
+
docs/StockOrderSupplierEntity.md
|
|
163
|
+
docs/StockOrderSupplierModel.md
|
|
164
|
+
docs/StockOrdersModel.md
|
|
165
|
+
docs/StockProductModel.md
|
|
166
|
+
docs/StockProductPriceModel.md
|
|
167
|
+
docs/StockProductSummariesModel.md
|
|
168
|
+
docs/StockProductSummaryModel.md
|
|
169
|
+
docs/StockTransactionsEntity.md
|
|
170
|
+
docs/SupplierEntity.md
|
|
171
|
+
docs/SupplierItemEntity.md
|
|
172
|
+
docs/SystemApi.md
|
|
173
|
+
docs/TcxBackupEntity.md
|
|
174
|
+
docs/TcxBackupModel.md
|
|
175
|
+
docs/TcxBillingEntity.md
|
|
176
|
+
docs/TcxBulkLicenceDetailsModel.md
|
|
177
|
+
docs/TcxDeadLicenceEntity.md
|
|
178
|
+
docs/TcxExtsEntity.md
|
|
179
|
+
docs/TcxHostingPricingEntity.md
|
|
180
|
+
docs/TcxInstallationDetailsModel.md
|
|
181
|
+
docs/TcxInstallationModel.md
|
|
182
|
+
docs/TcxInstallationsModel.md
|
|
183
|
+
docs/TcxKeySummaryDTO.md
|
|
184
|
+
docs/TcxKeysEntity.md
|
|
185
|
+
docs/TcxLicenceDetailsErrorModel.md
|
|
186
|
+
docs/TcxLicenceDetailsModel.md
|
|
187
|
+
docs/TcxMacsEntity.md
|
|
188
|
+
docs/TcxMultiTenantModel.md
|
|
189
|
+
docs/TcxMultiTenantUserModel.md
|
|
190
|
+
docs/TcxMultiTenantsModel.md
|
|
191
|
+
docs/TcxNumbersEntity.md
|
|
192
|
+
docs/TcxOfficeHoursEntity.md
|
|
193
|
+
docs/TcxPhoneModel.md
|
|
194
|
+
docs/TcxPhonesEntity.md
|
|
195
|
+
docs/TcxRemoteStorageModel.md
|
|
196
|
+
docs/TcxSbcDTO.md
|
|
197
|
+
docs/TcxSbcEntity.md
|
|
198
|
+
docs/TcxSbcModel.md
|
|
199
|
+
docs/TcxSetupEntity.md
|
|
200
|
+
docs/TcxSetupsModel.md
|
|
201
|
+
docs/TcxSipTrunksEntity.md
|
|
202
|
+
docs/TcxTemplateXmlEnum.md
|
|
203
|
+
docs/TcxUsersEntity.md
|
|
204
|
+
docs/TcxWizardConfigModel.md
|
|
205
|
+
docs/TcxWizardModel.md
|
|
206
|
+
docs/TechSupportCompanySummaryDTO.md
|
|
207
|
+
docs/TelephonySupportTicketModel.md
|
|
208
|
+
docs/TicketSummaryModel.md
|
|
209
|
+
docs/TicketTimeDTO.md
|
|
210
|
+
docs/TicketsApi.md
|
|
211
|
+
docs/TokenResponseModel.md
|
|
212
|
+
docs/UpgradeOrderResponseModel.md
|
|
213
|
+
docs/UpgradeRequestModel.md
|
|
214
|
+
docs/UserEntity.md
|
|
215
|
+
docs/WebhooksApi.md
|
|
216
|
+
docs/XeroLogEntity.md
|
|
217
|
+
git_push.sh
|
|
218
|
+
index.ts
|
|
219
|
+
package.json
|
|
220
|
+
tsconfig.json
|
package/README.md
CHANGED
|
@@ -310,6 +310,7 @@ Class | Method | HTTP request | Description
|
|
|
310
310
|
- [PostAddWebhook200Response](docs/PostAddWebhook200Response.md)
|
|
311
311
|
- [PostGetClientCredentialsRequest](docs/PostGetClientCredentialsRequest.md)
|
|
312
312
|
- [PostGetProductForCustomerRequest](docs/PostGetProductForCustomerRequest.md)
|
|
313
|
+
- [PostGetProductRequest](docs/PostGetProductRequest.md)
|
|
313
314
|
- [PriceListItemModel](docs/PriceListItemModel.md)
|
|
314
315
|
- [PrizesEntity](docs/PrizesEntity.md)
|
|
315
316
|
- [ProductPriceListItemModel](docs/ProductPriceListItemModel.md)
|
|
@@ -429,5 +430,23 @@ Authentication schemes defined for the API:
|
|
|
429
430
|
- **scope**: A Test Scope
|
|
430
431
|
- **portal**: Yellowgrid Portal Endpoints
|
|
431
432
|
- **tcx_wizard**: 3CX Installation Wizard
|
|
432
|
-
- **
|
|
433
|
+
- **accounts.read**: Accounts (Read)
|
|
434
|
+
- **accounts.write**: Accounts (Write)
|
|
435
|
+
- **pricing.read**: Pricing (Read)
|
|
436
|
+
- **orders.read**: Orders (Read)
|
|
437
|
+
- **orders.write**: Orders (Write)
|
|
438
|
+
- **products.read**: Products (Read)
|
|
439
|
+
- **provisioning.read**: Provisioning (Read)
|
|
440
|
+
- **provisioning.write**: Provisioning (Write)
|
|
441
|
+
- **trunks.read**: Trunks (Read)
|
|
442
|
+
- **trunks.write**: Trunks (Write)
|
|
443
|
+
- **tcx_integrations.read**: 3CX Integrations (Read)
|
|
444
|
+
- **tcx_integrations.write**: 3CX Integrations (Write)
|
|
445
|
+
- **tcx_licence_details.read**: 3CX Licence Details (Read)
|
|
446
|
+
- **tcx_installations.read**: 3CX Installations (Read)
|
|
447
|
+
- **tcx_installations.write**: 3CX Installations (Write)
|
|
448
|
+
- **tcx_mt.read**: 3CX Multi-Tenant (Read)
|
|
449
|
+
- **tcx_mt.write**: 3CX Multi-Tenant (Write)
|
|
450
|
+
- **tickets.read**: Tickets (Read)
|
|
451
|
+
- **tickets.write**: Tickets (Write)
|
|
433
452
|
|
package/api.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Yellowgrid
|
|
5
|
-
* Welcome to the Yellowgrid API documentation.
|
|
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 0
|
|
8
8
|
*
|
|
@@ -4641,6 +4641,37 @@ export interface PostGetProductForCustomerRequest {
|
|
|
4641
4641
|
* @memberof PostGetProductForCustomerRequest
|
|
4642
4642
|
*/
|
|
4643
4643
|
'hosting'?: boolean | null;
|
|
4644
|
+
/**
|
|
4645
|
+
* 3CX Sales Code
|
|
4646
|
+
* @type {string}
|
|
4647
|
+
* @memberof PostGetProductForCustomerRequest
|
|
4648
|
+
*/
|
|
4649
|
+
'tcxSalesCode'?: string | null;
|
|
4650
|
+
}
|
|
4651
|
+
/**
|
|
4652
|
+
*
|
|
4653
|
+
* @export
|
|
4654
|
+
* @interface PostGetProductRequest
|
|
4655
|
+
*/
|
|
4656
|
+
export interface PostGetProductRequest {
|
|
4657
|
+
/**
|
|
4658
|
+
* Quantity
|
|
4659
|
+
* @type {number}
|
|
4660
|
+
* @memberof PostGetProductRequest
|
|
4661
|
+
*/
|
|
4662
|
+
'quantity'?: number | null;
|
|
4663
|
+
/**
|
|
4664
|
+
* 3CX Licence Key
|
|
4665
|
+
* @type {string}
|
|
4666
|
+
* @memberof PostGetProductRequest
|
|
4667
|
+
*/
|
|
4668
|
+
'licenceKey'?: string | null;
|
|
4669
|
+
/**
|
|
4670
|
+
* 3CX Hosting
|
|
4671
|
+
* @type {boolean}
|
|
4672
|
+
* @memberof PostGetProductRequest
|
|
4673
|
+
*/
|
|
4674
|
+
'hosting'?: boolean | null;
|
|
4644
4675
|
}
|
|
4645
4676
|
/**
|
|
4646
4677
|
* Price & Stock List
|
|
@@ -16425,7 +16456,25 @@ export const PostAccessTokenScopeEnum = {
|
|
|
16425
16456
|
Scope: 'scope',
|
|
16426
16457
|
Portal: 'portal',
|
|
16427
16458
|
TcxWizard: 'tcx_wizard',
|
|
16428
|
-
|
|
16459
|
+
AccountsRead: 'accounts.read',
|
|
16460
|
+
AccountsWrite: 'accounts.write',
|
|
16461
|
+
PricingRead: 'pricing.read',
|
|
16462
|
+
OrdersRead: 'orders.read',
|
|
16463
|
+
OrdersWrite: 'orders.write',
|
|
16464
|
+
ProductsRead: 'products.read',
|
|
16465
|
+
ProvisioningRead: 'provisioning.read',
|
|
16466
|
+
ProvisioningWrite: 'provisioning.write',
|
|
16467
|
+
TrunksRead: 'trunks.read',
|
|
16468
|
+
TrunksWrite: 'trunks.write',
|
|
16469
|
+
TcxIntegrationsRead: 'tcx_integrations.read',
|
|
16470
|
+
TcxIntegrationsWrite: 'tcx_integrations.write',
|
|
16471
|
+
TcxLicenceDetailsRead: 'tcx_licence_details.read',
|
|
16472
|
+
TcxInstallationsRead: 'tcx_installations.read',
|
|
16473
|
+
TcxInstallationsWrite: 'tcx_installations.write',
|
|
16474
|
+
TcxMtRead: 'tcx_mt.read',
|
|
16475
|
+
TcxMtWrite: 'tcx_mt.write',
|
|
16476
|
+
TicketsRead: 'tickets.read',
|
|
16477
|
+
TicketsWrite: 'tickets.write'
|
|
16429
16478
|
} as const;
|
|
16430
16479
|
export type PostAccessTokenScopeEnum = typeof PostAccessTokenScopeEnum[keyof typeof PostAccessTokenScopeEnum];
|
|
16431
16480
|
/**
|
|
@@ -16445,7 +16494,25 @@ export const PostAuthoriseScopeEnum = {
|
|
|
16445
16494
|
Scope: 'scope',
|
|
16446
16495
|
Portal: 'portal',
|
|
16447
16496
|
TcxWizard: 'tcx_wizard',
|
|
16448
|
-
|
|
16497
|
+
AccountsRead: 'accounts.read',
|
|
16498
|
+
AccountsWrite: 'accounts.write',
|
|
16499
|
+
PricingRead: 'pricing.read',
|
|
16500
|
+
OrdersRead: 'orders.read',
|
|
16501
|
+
OrdersWrite: 'orders.write',
|
|
16502
|
+
ProductsRead: 'products.read',
|
|
16503
|
+
ProvisioningRead: 'provisioning.read',
|
|
16504
|
+
ProvisioningWrite: 'provisioning.write',
|
|
16505
|
+
TrunksRead: 'trunks.read',
|
|
16506
|
+
TrunksWrite: 'trunks.write',
|
|
16507
|
+
TcxIntegrationsRead: 'tcx_integrations.read',
|
|
16508
|
+
TcxIntegrationsWrite: 'tcx_integrations.write',
|
|
16509
|
+
TcxLicenceDetailsRead: 'tcx_licence_details.read',
|
|
16510
|
+
TcxInstallationsRead: 'tcx_installations.read',
|
|
16511
|
+
TcxInstallationsWrite: 'tcx_installations.write',
|
|
16512
|
+
TcxMtRead: 'tcx_mt.read',
|
|
16513
|
+
TcxMtWrite: 'tcx_mt.write',
|
|
16514
|
+
TicketsRead: 'tickets.read',
|
|
16515
|
+
TicketsWrite: 'tickets.write'
|
|
16449
16516
|
} as const;
|
|
16450
16517
|
export type PostAuthoriseScopeEnum = typeof PostAuthoriseScopeEnum[keyof typeof PostAuthoriseScopeEnum];
|
|
16451
16518
|
|
|
@@ -17718,15 +17785,15 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
17718
17785
|
* Get Product
|
|
17719
17786
|
* @summary Get Product
|
|
17720
17787
|
* @param {string} sku Product SKU
|
|
17721
|
-
* @param {
|
|
17788
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
17722
17789
|
* @param {*} [options] Override http request option.
|
|
17723
17790
|
* @throws {RequiredError}
|
|
17724
17791
|
*/
|
|
17725
|
-
postGetProduct: async (sku: string,
|
|
17792
|
+
postGetProduct: async (sku: string, postGetProductRequest: PostGetProductRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
17726
17793
|
// verify required parameter 'sku' is not null or undefined
|
|
17727
17794
|
assertParamExists('postGetProduct', 'sku', sku)
|
|
17728
|
-
// verify required parameter '
|
|
17729
|
-
assertParamExists('postGetProduct', '
|
|
17795
|
+
// verify required parameter 'postGetProductRequest' is not null or undefined
|
|
17796
|
+
assertParamExists('postGetProduct', 'postGetProductRequest', postGetProductRequest)
|
|
17730
17797
|
const localVarPath = `/products/{sku}`
|
|
17731
17798
|
.replace(`{${"sku"}}`, encodeURIComponent(String(sku)));
|
|
17732
17799
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -17747,7 +17814,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
17747
17814
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17748
17815
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17749
17816
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
17750
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
17817
|
+
localVarRequestOptions.data = serializeDataIfNeeded(postGetProductRequest, localVarRequestOptions, configuration)
|
|
17751
17818
|
|
|
17752
17819
|
return {
|
|
17753
17820
|
url: toPathString(localVarUrlObj),
|
|
@@ -17892,12 +17959,12 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
17892
17959
|
* Get Product
|
|
17893
17960
|
* @summary Get Product
|
|
17894
17961
|
* @param {string} sku Product SKU
|
|
17895
|
-
* @param {
|
|
17962
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
17896
17963
|
* @param {*} [options] Override http request option.
|
|
17897
17964
|
* @throws {RequiredError}
|
|
17898
17965
|
*/
|
|
17899
|
-
async postGetProduct(sku: string,
|
|
17900
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postGetProduct(sku,
|
|
17966
|
+
async postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>> {
|
|
17967
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postGetProduct(sku, postGetProductRequest, options);
|
|
17901
17968
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
17902
17969
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.postGetProduct']?.[localVarOperationServerIndex]?.url;
|
|
17903
17970
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -17990,12 +18057,12 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
17990
18057
|
* Get Product
|
|
17991
18058
|
* @summary Get Product
|
|
17992
18059
|
* @param {string} sku Product SKU
|
|
17993
|
-
* @param {
|
|
18060
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
17994
18061
|
* @param {*} [options] Override http request option.
|
|
17995
18062
|
* @throws {RequiredError}
|
|
17996
18063
|
*/
|
|
17997
|
-
postGetProduct(sku: string,
|
|
17998
|
-
return localVarFp.postGetProduct(sku,
|
|
18064
|
+
postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO> {
|
|
18065
|
+
return localVarFp.postGetProduct(sku, postGetProductRequest, options).then((request) => request(axios, basePath));
|
|
17999
18066
|
},
|
|
18000
18067
|
/**
|
|
18001
18068
|
* Get Product For Customer
|
|
@@ -18094,13 +18161,13 @@ export class ProductsApi extends BaseAPI {
|
|
|
18094
18161
|
* Get Product
|
|
18095
18162
|
* @summary Get Product
|
|
18096
18163
|
* @param {string} sku Product SKU
|
|
18097
|
-
* @param {
|
|
18164
|
+
* @param {PostGetProductRequest} postGetProductRequest Product search criteria
|
|
18098
18165
|
* @param {*} [options] Override http request option.
|
|
18099
18166
|
* @throws {RequiredError}
|
|
18100
18167
|
* @memberof ProductsApi
|
|
18101
18168
|
*/
|
|
18102
|
-
public postGetProduct(sku: string,
|
|
18103
|
-
return ProductsApiFp(this.configuration).postGetProduct(sku,
|
|
18169
|
+
public postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig) {
|
|
18170
|
+
return ProductsApiFp(this.configuration).postGetProduct(sku, postGetProductRequest, options).then((request) => request(this.axios, this.basePath));
|
|
18104
18171
|
}
|
|
18105
18172
|
|
|
18106
18173
|
/**
|