yellowgrid-api-ts 3.2.36 → 3.2.38-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.
Files changed (241) hide show
  1. package/.openapi-generator/FILES +9 -0
  2. package/.openapi-generator/VERSION +0 -0
  3. package/.openapi-generator-ignore +0 -0
  4. package/README.md +14 -0
  5. package/api.ts +703 -1
  6. package/base.ts +1 -1
  7. package/common.ts +1 -1
  8. package/config.json +3 -3
  9. package/configuration.ts +1 -1
  10. package/dist/api.d.ts +459 -1
  11. package/dist/api.js +536 -4
  12. package/dist/base.d.ts +1 -1
  13. package/dist/base.js +1 -1
  14. package/dist/common.d.ts +1 -1
  15. package/dist/common.js +1 -1
  16. package/dist/configuration.d.ts +1 -1
  17. package/dist/configuration.js +1 -1
  18. package/dist/index.d.ts +1 -1
  19. package/dist/index.js +1 -1
  20. package/docs/AbstractOrderRequestDTO.md +0 -0
  21. package/docs/AccountContactEntity.md +0 -0
  22. package/docs/AccountContactModel.md +0 -0
  23. package/docs/AccountContactRequestModel.md +0 -0
  24. package/docs/AccountDetailedSummaryDTO.md +0 -0
  25. package/docs/AccountRequestModel.md +0 -0
  26. package/docs/AccountSummaryDTO.md +0 -0
  27. package/docs/AccountsApi.md +0 -0
  28. package/docs/AccountsResponseModel.md +0 -0
  29. package/docs/AddressModel.md +0 -0
  30. package/docs/AddressRequestModel.md +0 -0
  31. package/docs/AdminOrderRequestDTO.md +0 -0
  32. package/docs/AdminUserModel.md +0 -0
  33. package/docs/AgentHoursGraphModel.md +0 -0
  34. package/docs/AgentHoursGraphMonthModel.md +0 -0
  35. package/docs/ApiLogEntity.md +0 -0
  36. package/docs/AreaCodeModel.md +0 -0
  37. package/docs/AttachmentModel.md +0 -0
  38. package/docs/AttributeSetEnum.md +0 -0
  39. package/docs/AuditLogEntity.md +0 -0
  40. package/docs/AuthCodeResponseModel.md +0 -0
  41. package/docs/BasicItemDTO.md +0 -0
  42. package/docs/BasicProductDTO.md +0 -0
  43. package/docs/BatchEntity.md +0 -0
  44. package/docs/CRMApi.md +0 -0
  45. package/docs/CallBarringModel.md +0 -0
  46. package/docs/Class3CXApi.md +0 -0
  47. package/docs/Class3CXInstallationWizardApi.md +0 -0
  48. package/docs/Class3CXInstallationsApi.md +0 -0
  49. package/docs/Class3CXIntegrationsApi.md +0 -0
  50. package/docs/Class3CXMultiTenantApi.md +0 -0
  51. package/docs/ClientDetailsModel.md +0 -0
  52. package/docs/ClientModel.md +0 -0
  53. package/docs/CompanyContractModel.md +0 -0
  54. package/docs/ContactInfoModel.md +0 -0
  55. package/docs/ConversationModel.md +0 -0
  56. package/docs/CourierPriceEntity.md +0 -0
  57. package/docs/CreditAccountEntity.md +0 -0
  58. package/docs/CrmContactDTO.md +0 -0
  59. package/docs/CustomerInformationModel.md +0 -0
  60. package/docs/CustomerItemRequestDTO.md +0 -0
  61. package/docs/CustomerOrderRequestDTO.md +0 -0
  62. package/docs/CustomerPriceListEnum.md +0 -0
  63. package/docs/CustomerSummaryReportDTO.md +0 -0
  64. package/docs/DdiRangeRequestModel.md +0 -0
  65. package/docs/DdiRangesRequestModel.md +0 -0
  66. package/docs/DetailedItemRequestDTO.md +0 -0
  67. package/docs/DetailedOrderRequestDTO.md +0 -0
  68. package/docs/DivertRequestModel.md +0 -0
  69. package/docs/DivertResponseModel.md +0 -0
  70. package/docs/EdTechProClientEntity.md +0 -0
  71. package/docs/EdTechProSchoolModel.md +0 -0
  72. package/docs/EdTechProSchoolsModel.md +0 -0
  73. package/docs/EdTechProSetupModel.md +0 -0
  74. package/docs/EventDTO.md +35 -0
  75. package/docs/EventRequestDTO.md +25 -0
  76. package/docs/EventSubscriptionModel.md +23 -0
  77. package/docs/EventUpdateDTO.md +27 -0
  78. package/docs/EventUpdateEntity.md +29 -0
  79. package/docs/EventUpdateRequestDTO.md +23 -0
  80. package/docs/FraudManagementModel.md +0 -0
  81. package/docs/FreshdeskCompanyTicketsModel.md +0 -0
  82. package/docs/FreshdeskTicketEntity.md +0 -0
  83. package/docs/FtpAccountsEntity.md +0 -0
  84. package/docs/GenericFileModel.md +0 -0
  85. package/docs/GetGetPrice200Response.md +0 -0
  86. package/docs/GetGetRecording200Response.md +0 -0
  87. package/docs/HostingChangeResponseModel.md +0 -0
  88. package/docs/HostingRegionDTO.md +0 -0
  89. package/docs/InstanceAutoFailoverEntity.md +0 -0
  90. package/docs/InstanceDeletionScheduleEntity.md +0 -0
  91. package/docs/InstanceEntity.md +0 -0
  92. package/docs/InstanceFailoverEntity.md +0 -0
  93. package/docs/InstanceMonitoringEntity.md +0 -0
  94. package/docs/InstanceMonitoringLogEntity.md +0 -0
  95. package/docs/InstanceScheduledTasksEntity.md +0 -0
  96. package/docs/InstanceTcxDetailsEntity.md +0 -0
  97. package/docs/InstanceUserCredentialsEntity.md +0 -0
  98. package/docs/ItemDTO.md +0 -0
  99. package/docs/ItemDiscountEntity.md +0 -0
  100. package/docs/ItemEntity.md +0 -0
  101. package/docs/LinkedOrderEntity.md +0 -0
  102. package/docs/MFARequiredModel.md +0 -0
  103. package/docs/MonthlyUsageModel.md +0 -0
  104. package/docs/MultiTenantChangeResponseModel.md +0 -0
  105. package/docs/MyPBXToolsApi.md +0 -0
  106. package/docs/NavigationModel.md +0 -0
  107. package/docs/OAuth20Api.md +0 -0
  108. package/docs/OfflineInstancesEntity.md +0 -0
  109. package/docs/OrderEntity.md +0 -0
  110. package/docs/OrderRequestModel.md +0 -0
  111. package/docs/OrderSummariesModel.md +0 -0
  112. package/docs/OrderSummaryDTO.md +0 -0
  113. package/docs/OrderTotalModel.md +0 -0
  114. package/docs/OrderedItemEntity.md +0 -0
  115. package/docs/OrdersApi.md +0 -0
  116. package/docs/PatchSetTcxWizardCnameRequest.md +0 -0
  117. package/docs/PatchUpdateAccountContactPasswordRequest.md +0 -0
  118. package/docs/PortalAccountModel.md +0 -0
  119. package/docs/PortalLoginModel.md +0 -0
  120. package/docs/PostAddWebhook200Response.md +0 -0
  121. package/docs/PostGetClientCredentialsRequest.md +0 -0
  122. package/docs/PostGetProductForCustomerRequest.md +0 -0
  123. package/docs/PostGetProductRequest.md +0 -0
  124. package/docs/PriceListItemModel.md +0 -0
  125. package/docs/PricingApi.md +0 -0
  126. package/docs/PrizesEntity.md +0 -0
  127. package/docs/ProductPriceListItemModel.md +0 -0
  128. package/docs/ProductSearchResultsModel.md +0 -0
  129. package/docs/ProductSerialInfoModel.md +0 -0
  130. package/docs/ProductSummaryDTO.md +0 -0
  131. package/docs/ProductsApi.md +0 -0
  132. package/docs/PromoCodesEntity.md +0 -0
  133. package/docs/PromoItemsEntity.md +0 -0
  134. package/docs/ProvisioningApi.md +0 -0
  135. package/docs/ProvisioningModel.md +0 -0
  136. package/docs/ProvisioningRequestEntity.md +0 -0
  137. package/docs/RecordingBackupAzureModel.md +0 -0
  138. package/docs/RecordingsBackupInfoDTO.md +0 -0
  139. package/docs/ResourceNotReadyException.md +0 -0
  140. package/docs/RootAccessModel.md +0 -0
  141. package/docs/S3BucketEntity.md +0 -0
  142. package/docs/SIPTrunksApi.md +0 -0
  143. package/docs/SMSApi.md +0 -0
  144. package/docs/ScannedItemModel.md +0 -0
  145. package/docs/ScopeModel.md +0 -0
  146. package/docs/ServiceHealthDTO.md +23 -0
  147. package/docs/ServiceStatusDTO.md +27 -0
  148. package/docs/ServicesApi.md +330 -0
  149. package/docs/ShipmentAddressEntity.md +0 -0
  150. package/docs/ShipmentEntity.md +0 -0
  151. package/docs/ShipmentItemEntity.md +0 -0
  152. package/docs/ShippingApi.md +0 -0
  153. package/docs/ShippingConsignmentModel.md +0 -0
  154. package/docs/ShippingInformationDTO.md +0 -0
  155. package/docs/ShippingServiceDTO.md +0 -0
  156. package/docs/ShippingServiceModel.md +0 -0
  157. package/docs/ShippingServicesModel.md +0 -0
  158. package/docs/SipTrunkChangeResponseModel.md +0 -0
  159. package/docs/SipTrunkCreationRequestModel.md +0 -0
  160. package/docs/SipTrunkEntity.md +0 -0
  161. package/docs/SipTrunksResponseModel.md +0 -0
  162. package/docs/SmsAccountEntity.md +0 -0
  163. package/docs/SmsDataModel.md +0 -0
  164. package/docs/SmsMessageModel.md +0 -0
  165. package/docs/SmsNumbersEntity.md +0 -0
  166. package/docs/SmsPayloadModel.md +0 -0
  167. package/docs/SmsPhoneNumberModel.md +0 -0
  168. package/docs/SmsResponseModel.md +0 -0
  169. package/docs/SmsWhitelistEntity.md +0 -0
  170. package/docs/StockManagementApi.md +0 -0
  171. package/docs/StockOrderCourierEntity.md +0 -0
  172. package/docs/StockOrderDeductionModel.md +0 -0
  173. package/docs/StockOrderDeductionRequestModel.md +0 -0
  174. package/docs/StockOrderDeductionsEntity.md +0 -0
  175. package/docs/StockOrderEntity.md +0 -0
  176. package/docs/StockOrderItemEntity.md +0 -0
  177. package/docs/StockOrderItemModel.md +0 -0
  178. package/docs/StockOrderItemRequestModel.md +0 -0
  179. package/docs/StockOrderModel.md +0 -0
  180. package/docs/StockOrderProductEntity.md +0 -0
  181. package/docs/StockOrderRequestModel.md +0 -0
  182. package/docs/StockOrderSupplierEntity.md +0 -0
  183. package/docs/StockOrderSupplierModel.md +0 -0
  184. package/docs/StockOrdersModel.md +0 -0
  185. package/docs/StockProductModel.md +0 -0
  186. package/docs/StockProductPriceModel.md +0 -0
  187. package/docs/StockProductSummariesModel.md +0 -0
  188. package/docs/StockProductSummaryModel.md +0 -0
  189. package/docs/StockTransactionsEntity.md +0 -0
  190. package/docs/SupplierEntity.md +0 -0
  191. package/docs/SupplierItemEntity.md +0 -0
  192. package/docs/SystemApi.md +0 -0
  193. package/docs/TcxBackupEntity.md +0 -0
  194. package/docs/TcxBackupModel.md +0 -0
  195. package/docs/TcxBillingEntity.md +0 -0
  196. package/docs/TcxBulkLicenceDetailsModel.md +0 -0
  197. package/docs/TcxDeadLicenceEntity.md +0 -0
  198. package/docs/TcxExtsEntity.md +0 -0
  199. package/docs/TcxHostingPricingEntity.md +0 -0
  200. package/docs/TcxInstallationDetailsModel.md +0 -0
  201. package/docs/TcxInstallationModel.md +0 -0
  202. package/docs/TcxInstallationsModel.md +0 -0
  203. package/docs/TcxKeySummaryDTO.md +0 -0
  204. package/docs/TcxKeysEntity.md +0 -0
  205. package/docs/TcxLicenceDetailsErrorModel.md +0 -0
  206. package/docs/TcxLicenceDetailsModel.md +0 -0
  207. package/docs/TcxMacsEntity.md +0 -0
  208. package/docs/TcxMultiTenantModel.md +0 -0
  209. package/docs/TcxMultiTenantUserModel.md +0 -0
  210. package/docs/TcxMultiTenantsModel.md +0 -0
  211. package/docs/TcxNumbersEntity.md +0 -0
  212. package/docs/TcxOfficeHoursEntity.md +0 -0
  213. package/docs/TcxPhoneModel.md +0 -0
  214. package/docs/TcxPhonesEntity.md +0 -0
  215. package/docs/TcxRemoteStorageModel.md +0 -0
  216. package/docs/TcxSbcDTO.md +0 -0
  217. package/docs/TcxSbcEntity.md +0 -0
  218. package/docs/TcxSbcModel.md +0 -0
  219. package/docs/TcxSetupEntity.md +0 -0
  220. package/docs/TcxSetupsModel.md +0 -0
  221. package/docs/TcxSipTrunksEntity.md +0 -0
  222. package/docs/TcxTemplateXmlEnum.md +0 -0
  223. package/docs/TcxUsersEntity.md +0 -0
  224. package/docs/TcxWizardConfigModel.md +0 -0
  225. package/docs/TcxWizardModel.md +0 -0
  226. package/docs/TechSupportCompanySummaryDTO.md +0 -0
  227. package/docs/TelephonySupportTicketModel.md +0 -0
  228. package/docs/TicketSummaryModel.md +0 -0
  229. package/docs/TicketTimeDTO.md +0 -0
  230. package/docs/TicketsApi.md +0 -0
  231. package/docs/TokenResponseModel.md +0 -0
  232. package/docs/UpgradeOrderResponseModel.md +0 -0
  233. package/docs/UpgradeRequestModel.md +0 -0
  234. package/docs/UserEntity.md +0 -0
  235. package/docs/WebhooksApi.md +0 -0
  236. package/docs/XeroLogEntity.md +0 -0
  237. package/git_push.sh +0 -0
  238. package/index.ts +1 -1
  239. package/openapitools.json +0 -0
  240. package/package.json +1 -1
  241. package/tsconfig.json +0 -0
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
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
  *
@@ -2375,6 +2375,201 @@ export interface EdTechProSetupModel {
2375
2375
  */
2376
2376
  'installed'?: boolean;
2377
2377
  }
2378
+ /**
2379
+ * Service Event DTO
2380
+ * @export
2381
+ * @interface EventDTO
2382
+ */
2383
+ export interface EventDTO {
2384
+ /**
2385
+ * Service Event Title
2386
+ * @type {string}
2387
+ * @memberof EventDTO
2388
+ */
2389
+ 'title'?: string;
2390
+ /**
2391
+ * Service Event Type
2392
+ * @type {number}
2393
+ * @memberof EventDTO
2394
+ */
2395
+ 'type'?: number;
2396
+ /**
2397
+ * Service Impacted
2398
+ * @type {number}
2399
+ * @memberof EventDTO
2400
+ */
2401
+ 'service'?: number;
2402
+ /**
2403
+ * Event Status Description
2404
+ * @type {string}
2405
+ * @memberof EventDTO
2406
+ */
2407
+ 'statusName'?: string;
2408
+ /**
2409
+ * Event Type Description
2410
+ * @type {string}
2411
+ * @memberof EventDTO
2412
+ */
2413
+ 'typeName'?: string;
2414
+ /**
2415
+ * Service Event ID
2416
+ * @type {number}
2417
+ * @memberof EventDTO
2418
+ */
2419
+ 'id'?: number;
2420
+ /**
2421
+ * Service Event Status
2422
+ * @type {number}
2423
+ * @memberof EventDTO
2424
+ */
2425
+ 'status'?: EventDTOStatusEnum;
2426
+ /**
2427
+ * Service Event Updates
2428
+ * @type {Array<EventUpdateDTO>}
2429
+ * @memberof EventDTO
2430
+ */
2431
+ 'updates'?: Array<EventUpdateDTO>;
2432
+ }
2433
+
2434
+ export const EventDTOStatusEnum = {
2435
+ NUMBER_0: 0,
2436
+ NUMBER_1: 1,
2437
+ NUMBER_2: 2
2438
+ } as const;
2439
+
2440
+ export type EventDTOStatusEnum = typeof EventDTOStatusEnum[keyof typeof EventDTOStatusEnum];
2441
+
2442
+ /**
2443
+ * Service Event Request DTO
2444
+ * @export
2445
+ * @interface EventRequestDTO
2446
+ */
2447
+ export interface EventRequestDTO {
2448
+ /**
2449
+ * Service Event Title
2450
+ * @type {string}
2451
+ * @memberof EventRequestDTO
2452
+ */
2453
+ 'title'?: string;
2454
+ /**
2455
+ * Service Event Type
2456
+ * @type {number}
2457
+ * @memberof EventRequestDTO
2458
+ */
2459
+ 'type'?: number;
2460
+ /**
2461
+ * Service Impacted
2462
+ * @type {number}
2463
+ * @memberof EventRequestDTO
2464
+ */
2465
+ 'service'?: number;
2466
+ }
2467
+ /**
2468
+ * Service Event Subscribption Model
2469
+ * @export
2470
+ * @interface EventSubscriptionModel
2471
+ */
2472
+ export interface EventSubscriptionModel {
2473
+ /**
2474
+ * id
2475
+ * @type {string}
2476
+ * @memberof EventSubscriptionModel
2477
+ */
2478
+ 'id'?: string;
2479
+ /**
2480
+ * email
2481
+ * @type {string}
2482
+ * @memberof EventSubscriptionModel
2483
+ */
2484
+ 'email'?: string;
2485
+ }
2486
+ /**
2487
+ * Service Event Update DTO
2488
+ * @export
2489
+ * @interface EventUpdateDTO
2490
+ */
2491
+ export interface EventUpdateDTO {
2492
+ /**
2493
+ * Service Event Update Message
2494
+ * @type {string}
2495
+ * @memberof EventUpdateDTO
2496
+ */
2497
+ 'message'?: string;
2498
+ /**
2499
+ * Service Event Update Type
2500
+ * @type {number}
2501
+ * @memberof EventUpdateDTO
2502
+ */
2503
+ 'type'?: number;
2504
+ /**
2505
+ * Service Event Update Type Description
2506
+ * @type {string}
2507
+ * @memberof EventUpdateDTO
2508
+ */
2509
+ 'typeName'?: string;
2510
+ /**
2511
+ * Date Time
2512
+ * @type {string}
2513
+ * @memberof EventUpdateDTO
2514
+ */
2515
+ 'createdAt'?: string;
2516
+ }
2517
+ /**
2518
+ * Event Update Entity
2519
+ * @export
2520
+ * @interface EventUpdateEntity
2521
+ */
2522
+ export interface EventUpdateEntity {
2523
+ /**
2524
+ * id
2525
+ * @type {number}
2526
+ * @memberof EventUpdateEntity
2527
+ */
2528
+ 'id'?: number;
2529
+ /**
2530
+ * eventId
2531
+ * @type {number}
2532
+ * @memberof EventUpdateEntity
2533
+ */
2534
+ 'eventId'?: number;
2535
+ /**
2536
+ * message
2537
+ * @type {string}
2538
+ * @memberof EventUpdateEntity
2539
+ */
2540
+ 'message'?: string;
2541
+ /**
2542
+ * type
2543
+ * @type {number}
2544
+ * @memberof EventUpdateEntity
2545
+ */
2546
+ 'type'?: number;
2547
+ /**
2548
+ * createdAt
2549
+ * @type {string}
2550
+ * @memberof EventUpdateEntity
2551
+ */
2552
+ 'createdAt'?: string;
2553
+ }
2554
+ /**
2555
+ * Service Event Update Request DTO
2556
+ * @export
2557
+ * @interface EventUpdateRequestDTO
2558
+ */
2559
+ export interface EventUpdateRequestDTO {
2560
+ /**
2561
+ * Service Event Update Message
2562
+ * @type {string}
2563
+ * @memberof EventUpdateRequestDTO
2564
+ */
2565
+ 'message'?: string;
2566
+ /**
2567
+ * Service Event Update Type
2568
+ * @type {number}
2569
+ * @memberof EventUpdateRequestDTO
2570
+ */
2571
+ 'type'?: number;
2572
+ }
2378
2573
  /**
2379
2574
  * Fraud Management
2380
2575
  * @export
@@ -5296,6 +5491,74 @@ export interface ScopeModel {
5296
5491
  */
5297
5492
  'description'?: string;
5298
5493
  }
5494
+ /**
5495
+ * Service Health DTO
5496
+ * @export
5497
+ * @interface ServiceHealthDTO
5498
+ */
5499
+ export interface ServiceHealthDTO {
5500
+ /**
5501
+ *
5502
+ * @type {Array<ServiceStatusDTO>}
5503
+ * @memberof ServiceHealthDTO
5504
+ */
5505
+ 'services'?: Array<ServiceStatusDTO>;
5506
+ /**
5507
+ *
5508
+ * @type {number}
5509
+ * @memberof ServiceHealthDTO
5510
+ */
5511
+ 'globalStatus'?: ServiceHealthDTOGlobalStatusEnum;
5512
+ }
5513
+
5514
+ export const ServiceHealthDTOGlobalStatusEnum = {
5515
+ NUMBER_0: 0,
5516
+ NUMBER_1: 1,
5517
+ NUMBER_2: 2
5518
+ } as const;
5519
+
5520
+ export type ServiceHealthDTOGlobalStatusEnum = typeof ServiceHealthDTOGlobalStatusEnum[keyof typeof ServiceHealthDTOGlobalStatusEnum];
5521
+
5522
+ /**
5523
+ * Service Status DTO
5524
+ * @export
5525
+ * @interface ServiceStatusDTO
5526
+ */
5527
+ export interface ServiceStatusDTO {
5528
+ /**
5529
+ * Service Status Description
5530
+ * @type {string}
5531
+ * @memberof ServiceStatusDTO
5532
+ */
5533
+ 'statusName'?: string;
5534
+ /**
5535
+ * Service Name
5536
+ * @type {string}
5537
+ * @memberof ServiceStatusDTO
5538
+ */
5539
+ 'name'?: string;
5540
+ /**
5541
+ * Service Status
5542
+ * @type {number}
5543
+ * @memberof ServiceStatusDTO
5544
+ */
5545
+ 'status'?: ServiceStatusDTOStatusEnum;
5546
+ /**
5547
+ * Service Events
5548
+ * @type {Array<EventDTO>}
5549
+ * @memberof ServiceStatusDTO
5550
+ */
5551
+ 'events'?: Array<EventDTO>;
5552
+ }
5553
+
5554
+ export const ServiceStatusDTOStatusEnum = {
5555
+ NUMBER_0: 0,
5556
+ NUMBER_1: 1,
5557
+ NUMBER_2: 2
5558
+ } as const;
5559
+
5560
+ export type ServiceStatusDTOStatusEnum = typeof ServiceStatusDTOStatusEnum[keyof typeof ServiceStatusDTOStatusEnum];
5561
+
5299
5562
  /**
5300
5563
  * ShipmentAddressEntity
5301
5564
  * @export
@@ -20843,6 +21106,445 @@ export class SMSApi extends BaseAPI {
20843
21106
 
20844
21107
 
20845
21108
 
21109
+ /**
21110
+ * ServicesApi - axios parameter creator
21111
+ * @export
21112
+ */
21113
+ export const ServicesApiAxiosParamCreator = function (configuration?: Configuration) {
21114
+ return {
21115
+ /**
21116
+ *
21117
+ * @param {string} [id] Unsubscribe Email ID
21118
+ * @param {string} [email] Unsubscribe Email Address
21119
+ * @param {*} [options] Override http request option.
21120
+ * @throws {RequiredError}
21121
+ */
21122
+ deleteUnsubscribe: async (id?: string, email?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
21123
+ const localVarPath = `/services/events/unsubscribe`;
21124
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
21125
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
21126
+ let baseOptions;
21127
+ if (configuration) {
21128
+ baseOptions = configuration.baseOptions;
21129
+ }
21130
+
21131
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
21132
+ const localVarHeaderParameter = {} as any;
21133
+ const localVarQueryParameter = {} as any;
21134
+
21135
+ if (id !== undefined) {
21136
+ localVarQueryParameter['id'] = id;
21137
+ }
21138
+
21139
+ if (email !== undefined) {
21140
+ localVarQueryParameter['email'] = email;
21141
+ }
21142
+
21143
+
21144
+
21145
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
21146
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21147
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21148
+
21149
+ return {
21150
+ url: toPathString(localVarUrlObj),
21151
+ options: localVarRequestOptions,
21152
+ };
21153
+ },
21154
+ /**
21155
+ *
21156
+ * @param {*} [options] Override http request option.
21157
+ * @throws {RequiredError}
21158
+ */
21159
+ getGetServiceHealth: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
21160
+ const localVarPath = `/services/health`;
21161
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
21162
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
21163
+ let baseOptions;
21164
+ if (configuration) {
21165
+ baseOptions = configuration.baseOptions;
21166
+ }
21167
+
21168
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
21169
+ const localVarHeaderParameter = {} as any;
21170
+ const localVarQueryParameter = {} as any;
21171
+
21172
+
21173
+
21174
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
21175
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21176
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21177
+
21178
+ return {
21179
+ url: toPathString(localVarUrlObj),
21180
+ options: localVarRequestOptions,
21181
+ };
21182
+ },
21183
+ /**
21184
+ *
21185
+ * @param {number} id Group ID
21186
+ * @param {*} [options] Override http request option.
21187
+ * @throws {RequiredError}
21188
+ */
21189
+ patchArchiveEvent: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
21190
+ // verify required parameter 'id' is not null or undefined
21191
+ assertParamExists('patchArchiveEvent', 'id', id)
21192
+ const localVarPath = `/services/events/{id}/archive`
21193
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
21194
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
21195
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
21196
+ let baseOptions;
21197
+ if (configuration) {
21198
+ baseOptions = configuration.baseOptions;
21199
+ }
21200
+
21201
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
21202
+ const localVarHeaderParameter = {} as any;
21203
+ const localVarQueryParameter = {} as any;
21204
+
21205
+
21206
+
21207
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
21208
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21209
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21210
+
21211
+ return {
21212
+ url: toPathString(localVarUrlObj),
21213
+ options: localVarRequestOptions,
21214
+ };
21215
+ },
21216
+ /**
21217
+ *
21218
+ * @param {EventRequestDTO} [eventRequestDTO]
21219
+ * @param {*} [options] Override http request option.
21220
+ * @throws {RequiredError}
21221
+ */
21222
+ postCreateEvent: async (eventRequestDTO?: EventRequestDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
21223
+ const localVarPath = `/services/events`;
21224
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
21225
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
21226
+ let baseOptions;
21227
+ if (configuration) {
21228
+ baseOptions = configuration.baseOptions;
21229
+ }
21230
+
21231
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
21232
+ const localVarHeaderParameter = {} as any;
21233
+ const localVarQueryParameter = {} as any;
21234
+
21235
+
21236
+
21237
+ localVarHeaderParameter['Content-Type'] = 'application/json';
21238
+
21239
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
21240
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21241
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21242
+ localVarRequestOptions.data = serializeDataIfNeeded(eventRequestDTO, localVarRequestOptions, configuration)
21243
+
21244
+ return {
21245
+ url: toPathString(localVarUrlObj),
21246
+ options: localVarRequestOptions,
21247
+ };
21248
+ },
21249
+ /**
21250
+ *
21251
+ * @param {number} id Group ID
21252
+ * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
21253
+ * @param {*} [options] Override http request option.
21254
+ * @throws {RequiredError}
21255
+ */
21256
+ postCreateEventUpdate: async (id: number, eventUpdateRequestDTO?: EventUpdateRequestDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
21257
+ // verify required parameter 'id' is not null or undefined
21258
+ assertParamExists('postCreateEventUpdate', 'id', id)
21259
+ const localVarPath = `/services/events/{id}/updates`
21260
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
21261
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
21262
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
21263
+ let baseOptions;
21264
+ if (configuration) {
21265
+ baseOptions = configuration.baseOptions;
21266
+ }
21267
+
21268
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
21269
+ const localVarHeaderParameter = {} as any;
21270
+ const localVarQueryParameter = {} as any;
21271
+
21272
+
21273
+
21274
+ localVarHeaderParameter['Content-Type'] = 'application/json';
21275
+
21276
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
21277
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21278
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21279
+ localVarRequestOptions.data = serializeDataIfNeeded(eventUpdateRequestDTO, localVarRequestOptions, configuration)
21280
+
21281
+ return {
21282
+ url: toPathString(localVarUrlObj),
21283
+ options: localVarRequestOptions,
21284
+ };
21285
+ },
21286
+ /**
21287
+ *
21288
+ * @param {string} [email] Subscription Email Address
21289
+ * @param {*} [options] Override http request option.
21290
+ * @throws {RequiredError}
21291
+ */
21292
+ postSubscribe: async (email?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
21293
+ const localVarPath = `/services/events/subscribe`;
21294
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
21295
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
21296
+ let baseOptions;
21297
+ if (configuration) {
21298
+ baseOptions = configuration.baseOptions;
21299
+ }
21300
+
21301
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
21302
+ const localVarHeaderParameter = {} as any;
21303
+ const localVarQueryParameter = {} as any;
21304
+
21305
+ if (email !== undefined) {
21306
+ localVarQueryParameter['email'] = email;
21307
+ }
21308
+
21309
+
21310
+
21311
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
21312
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21313
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21314
+
21315
+ return {
21316
+ url: toPathString(localVarUrlObj),
21317
+ options: localVarRequestOptions,
21318
+ };
21319
+ },
21320
+ }
21321
+ };
21322
+
21323
+ /**
21324
+ * ServicesApi - functional programming interface
21325
+ * @export
21326
+ */
21327
+ export const ServicesApiFp = function(configuration?: Configuration) {
21328
+ const localVarAxiosParamCreator = ServicesApiAxiosParamCreator(configuration)
21329
+ return {
21330
+ /**
21331
+ *
21332
+ * @param {string} [id] Unsubscribe Email ID
21333
+ * @param {string} [email] Unsubscribe Email Address
21334
+ * @param {*} [options] Override http request option.
21335
+ * @throws {RequiredError}
21336
+ */
21337
+ async deleteUnsubscribe(id?: string, email?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
21338
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUnsubscribe(id, email, options);
21339
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21340
+ const localVarOperationServerBasePath = operationServerMap['ServicesApi.deleteUnsubscribe']?.[localVarOperationServerIndex]?.url;
21341
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21342
+ },
21343
+ /**
21344
+ *
21345
+ * @param {*} [options] Override http request option.
21346
+ * @throws {RequiredError}
21347
+ */
21348
+ async getGetServiceHealth(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceHealthDTO>> {
21349
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGetServiceHealth(options);
21350
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21351
+ const localVarOperationServerBasePath = operationServerMap['ServicesApi.getGetServiceHealth']?.[localVarOperationServerIndex]?.url;
21352
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21353
+ },
21354
+ /**
21355
+ *
21356
+ * @param {number} id Group ID
21357
+ * @param {*} [options] Override http request option.
21358
+ * @throws {RequiredError}
21359
+ */
21360
+ async patchArchiveEvent(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>> {
21361
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchArchiveEvent(id, options);
21362
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21363
+ const localVarOperationServerBasePath = operationServerMap['ServicesApi.patchArchiveEvent']?.[localVarOperationServerIndex]?.url;
21364
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21365
+ },
21366
+ /**
21367
+ *
21368
+ * @param {EventRequestDTO} [eventRequestDTO]
21369
+ * @param {*} [options] Override http request option.
21370
+ * @throws {RequiredError}
21371
+ */
21372
+ async postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>> {
21373
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postCreateEvent(eventRequestDTO, options);
21374
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21375
+ const localVarOperationServerBasePath = operationServerMap['ServicesApi.postCreateEvent']?.[localVarOperationServerIndex]?.url;
21376
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21377
+ },
21378
+ /**
21379
+ *
21380
+ * @param {number} id Group ID
21381
+ * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
21382
+ * @param {*} [options] Override http request option.
21383
+ * @throws {RequiredError}
21384
+ */
21385
+ async postCreateEventUpdate(id: number, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>> {
21386
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postCreateEventUpdate(id, eventUpdateRequestDTO, options);
21387
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21388
+ const localVarOperationServerBasePath = operationServerMap['ServicesApi.postCreateEventUpdate']?.[localVarOperationServerIndex]?.url;
21389
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21390
+ },
21391
+ /**
21392
+ *
21393
+ * @param {string} [email] Subscription Email Address
21394
+ * @param {*} [options] Override http request option.
21395
+ * @throws {RequiredError}
21396
+ */
21397
+ async postSubscribe(email?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
21398
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postSubscribe(email, options);
21399
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21400
+ const localVarOperationServerBasePath = operationServerMap['ServicesApi.postSubscribe']?.[localVarOperationServerIndex]?.url;
21401
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21402
+ },
21403
+ }
21404
+ };
21405
+
21406
+ /**
21407
+ * ServicesApi - factory interface
21408
+ * @export
21409
+ */
21410
+ export const ServicesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
21411
+ const localVarFp = ServicesApiFp(configuration)
21412
+ return {
21413
+ /**
21414
+ *
21415
+ * @param {string} [id] Unsubscribe Email ID
21416
+ * @param {string} [email] Unsubscribe Email Address
21417
+ * @param {*} [options] Override http request option.
21418
+ * @throws {RequiredError}
21419
+ */
21420
+ deleteUnsubscribe(id?: string, email?: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
21421
+ return localVarFp.deleteUnsubscribe(id, email, options).then((request) => request(axios, basePath));
21422
+ },
21423
+ /**
21424
+ *
21425
+ * @param {*} [options] Override http request option.
21426
+ * @throws {RequiredError}
21427
+ */
21428
+ getGetServiceHealth(options?: RawAxiosRequestConfig): AxiosPromise<ServiceHealthDTO> {
21429
+ return localVarFp.getGetServiceHealth(options).then((request) => request(axios, basePath));
21430
+ },
21431
+ /**
21432
+ *
21433
+ * @param {number} id Group ID
21434
+ * @param {*} [options] Override http request option.
21435
+ * @throws {RequiredError}
21436
+ */
21437
+ patchArchiveEvent(id: number, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO> {
21438
+ return localVarFp.patchArchiveEvent(id, options).then((request) => request(axios, basePath));
21439
+ },
21440
+ /**
21441
+ *
21442
+ * @param {EventRequestDTO} [eventRequestDTO]
21443
+ * @param {*} [options] Override http request option.
21444
+ * @throws {RequiredError}
21445
+ */
21446
+ postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO> {
21447
+ return localVarFp.postCreateEvent(eventRequestDTO, options).then((request) => request(axios, basePath));
21448
+ },
21449
+ /**
21450
+ *
21451
+ * @param {number} id Group ID
21452
+ * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
21453
+ * @param {*} [options] Override http request option.
21454
+ * @throws {RequiredError}
21455
+ */
21456
+ postCreateEventUpdate(id: number, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO> {
21457
+ return localVarFp.postCreateEventUpdate(id, eventUpdateRequestDTO, options).then((request) => request(axios, basePath));
21458
+ },
21459
+ /**
21460
+ *
21461
+ * @param {string} [email] Subscription Email Address
21462
+ * @param {*} [options] Override http request option.
21463
+ * @throws {RequiredError}
21464
+ */
21465
+ postSubscribe(email?: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
21466
+ return localVarFp.postSubscribe(email, options).then((request) => request(axios, basePath));
21467
+ },
21468
+ };
21469
+ };
21470
+
21471
+ /**
21472
+ * ServicesApi - object-oriented interface
21473
+ * @export
21474
+ * @class ServicesApi
21475
+ * @extends {BaseAPI}
21476
+ */
21477
+ export class ServicesApi extends BaseAPI {
21478
+ /**
21479
+ *
21480
+ * @param {string} [id] Unsubscribe Email ID
21481
+ * @param {string} [email] Unsubscribe Email Address
21482
+ * @param {*} [options] Override http request option.
21483
+ * @throws {RequiredError}
21484
+ * @memberof ServicesApi
21485
+ */
21486
+ public deleteUnsubscribe(id?: string, email?: string, options?: RawAxiosRequestConfig) {
21487
+ return ServicesApiFp(this.configuration).deleteUnsubscribe(id, email, options).then((request) => request(this.axios, this.basePath));
21488
+ }
21489
+
21490
+ /**
21491
+ *
21492
+ * @param {*} [options] Override http request option.
21493
+ * @throws {RequiredError}
21494
+ * @memberof ServicesApi
21495
+ */
21496
+ public getGetServiceHealth(options?: RawAxiosRequestConfig) {
21497
+ return ServicesApiFp(this.configuration).getGetServiceHealth(options).then((request) => request(this.axios, this.basePath));
21498
+ }
21499
+
21500
+ /**
21501
+ *
21502
+ * @param {number} id Group ID
21503
+ * @param {*} [options] Override http request option.
21504
+ * @throws {RequiredError}
21505
+ * @memberof ServicesApi
21506
+ */
21507
+ public patchArchiveEvent(id: number, options?: RawAxiosRequestConfig) {
21508
+ return ServicesApiFp(this.configuration).patchArchiveEvent(id, options).then((request) => request(this.axios, this.basePath));
21509
+ }
21510
+
21511
+ /**
21512
+ *
21513
+ * @param {EventRequestDTO} [eventRequestDTO]
21514
+ * @param {*} [options] Override http request option.
21515
+ * @throws {RequiredError}
21516
+ * @memberof ServicesApi
21517
+ */
21518
+ public postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig) {
21519
+ return ServicesApiFp(this.configuration).postCreateEvent(eventRequestDTO, options).then((request) => request(this.axios, this.basePath));
21520
+ }
21521
+
21522
+ /**
21523
+ *
21524
+ * @param {number} id Group ID
21525
+ * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
21526
+ * @param {*} [options] Override http request option.
21527
+ * @throws {RequiredError}
21528
+ * @memberof ServicesApi
21529
+ */
21530
+ public postCreateEventUpdate(id: number, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig) {
21531
+ return ServicesApiFp(this.configuration).postCreateEventUpdate(id, eventUpdateRequestDTO, options).then((request) => request(this.axios, this.basePath));
21532
+ }
21533
+
21534
+ /**
21535
+ *
21536
+ * @param {string} [email] Subscription Email Address
21537
+ * @param {*} [options] Override http request option.
21538
+ * @throws {RequiredError}
21539
+ * @memberof ServicesApi
21540
+ */
21541
+ public postSubscribe(email?: string, options?: RawAxiosRequestConfig) {
21542
+ return ServicesApiFp(this.configuration).postSubscribe(email, options).then((request) => request(this.axios, this.basePath));
21543
+ }
21544
+ }
21545
+
21546
+
21547
+
20846
21548
  /**
20847
21549
  * ShippingApi - axios parameter creator
20848
21550
  * @export