yellowgrid-api-ts 3.2.31-dev.0 → 3.2.32

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 (242) hide show
  1. package/.openapi-generator/FILES +1 -10
  2. package/.openapi-generator/VERSION +0 -0
  3. package/.openapi-generator-ignore +0 -0
  4. package/README.md +3 -15
  5. package/api.ts +244 -777
  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 +122 -516
  11. package/dist/api.js +271 -569
  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 +56 -0
  48. package/docs/Class3CXInstallationsApi.md +116 -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/FraudManagementModel.md +0 -0
  75. package/docs/FreshdeskCompanyTicketsModel.md +0 -0
  76. package/docs/FreshdeskTicketEntity.md +0 -0
  77. package/docs/FtpAccountsEntity.md +0 -0
  78. package/docs/GenericFileModel.md +0 -0
  79. package/docs/GetGetPrice200Response.md +0 -0
  80. package/docs/GetGetRecording200Response.md +0 -0
  81. package/docs/HostingChangeResponseModel.md +0 -0
  82. package/docs/HostingRegionDTO.md +0 -0
  83. package/docs/InstanceAutoFailoverEntity.md +0 -0
  84. package/docs/InstanceDeletionScheduleEntity.md +0 -0
  85. package/docs/InstanceEntity.md +2 -0
  86. package/docs/InstanceFailoverEntity.md +0 -0
  87. package/docs/InstanceMonitoringEntity.md +0 -0
  88. package/docs/InstanceMonitoringLogEntity.md +0 -0
  89. package/docs/InstanceScheduledTasksEntity.md +0 -0
  90. package/docs/InstanceTcxDetailsEntity.md +0 -0
  91. package/docs/InstanceUserCredentialsEntity.md +0 -0
  92. package/docs/ItemDTO.md +0 -0
  93. package/docs/ItemDiscountEntity.md +0 -0
  94. package/docs/ItemEntity.md +0 -0
  95. package/docs/LinkedOrderEntity.md +0 -0
  96. package/docs/MFARequiredModel.md +0 -0
  97. package/docs/MonthlyUsageModel.md +0 -0
  98. package/docs/MultiTenantChangeResponseModel.md +0 -0
  99. package/docs/MyPBXToolsApi.md +0 -0
  100. package/docs/NavigationModel.md +0 -0
  101. package/docs/OAuth20Api.md +0 -0
  102. package/docs/OfflineInstancesEntity.md +0 -0
  103. package/docs/OrderEntity.md +0 -0
  104. package/docs/OrderRequestModel.md +0 -0
  105. package/docs/OrderSummariesModel.md +0 -0
  106. package/docs/OrderSummaryDTO.md +0 -0
  107. package/docs/OrderTotalModel.md +0 -0
  108. package/docs/OrderedItemEntity.md +0 -0
  109. package/docs/OrdersApi.md +0 -0
  110. package/docs/PatchSetTcxWizardCnameRequest.md +0 -0
  111. package/docs/PatchUpdateAccountContactPasswordRequest.md +0 -0
  112. package/docs/PortalAccountModel.md +0 -0
  113. package/docs/PortalLoginModel.md +0 -0
  114. package/docs/PostAddWebhook200Response.md +0 -0
  115. package/docs/PostGetClientCredentialsRequest.md +0 -0
  116. package/docs/PostGetProductForCustomerRequest.md +0 -0
  117. package/docs/PostGetProductRequest.md +0 -0
  118. package/docs/PriceListItemModel.md +0 -0
  119. package/docs/PricingApi.md +4 -4
  120. package/docs/PrizesEntity.md +0 -0
  121. package/docs/ProductPriceListItemModel.md +0 -0
  122. package/docs/ProductSearchResultsModel.md +0 -0
  123. package/docs/ProductSerialInfoModel.md +0 -0
  124. package/docs/ProductSummaryDTO.md +0 -0
  125. package/docs/ProductsApi.md +0 -0
  126. package/docs/PromoCodesEntity.md +0 -0
  127. package/docs/PromoItemsEntity.md +0 -0
  128. package/docs/ProvisioningApi.md +0 -0
  129. package/docs/ProvisioningModel.md +0 -0
  130. package/docs/ProvisioningRequestEntity.md +0 -0
  131. package/docs/RecordingBackupAzureModel.md +0 -0
  132. package/docs/RecordingsBackupInfoDTO.md +0 -0
  133. package/docs/ResourceNotReadyException.md +0 -0
  134. package/docs/RootAccessModel.md +0 -0
  135. package/docs/S3BucketEntity.md +0 -0
  136. package/docs/SIPTrunksApi.md +0 -0
  137. package/docs/SMSApi.md +0 -0
  138. package/docs/ScannedItemModel.md +0 -0
  139. package/docs/ScopeModel.md +0 -0
  140. package/docs/ShipmentAddressEntity.md +0 -0
  141. package/docs/ShipmentEntity.md +0 -0
  142. package/docs/ShipmentItemEntity.md +0 -0
  143. package/docs/ShippingApi.md +0 -0
  144. package/docs/ShippingConsignmentModel.md +0 -0
  145. package/docs/ShippingInformationDTO.md +0 -0
  146. package/docs/ShippingServiceDTO.md +0 -0
  147. package/docs/ShippingServiceModel.md +0 -0
  148. package/docs/ShippingServicesModel.md +0 -0
  149. package/docs/SipTrunkChangeResponseModel.md +0 -0
  150. package/docs/SipTrunkCreationRequestModel.md +0 -0
  151. package/docs/SipTrunkEntity.md +0 -0
  152. package/docs/SipTrunksResponseModel.md +0 -0
  153. package/docs/SmsAccountEntity.md +0 -0
  154. package/docs/SmsDataModel.md +0 -0
  155. package/docs/SmsMessageModel.md +0 -0
  156. package/docs/SmsNumbersEntity.md +0 -0
  157. package/docs/SmsPayloadModel.md +0 -0
  158. package/docs/SmsPhoneNumberModel.md +0 -0
  159. package/docs/SmsResponseModel.md +0 -0
  160. package/docs/SmsWhitelistEntity.md +0 -0
  161. package/docs/StockManagementApi.md +0 -0
  162. package/docs/StockOrderCourierEntity.md +0 -0
  163. package/docs/StockOrderDeductionModel.md +0 -0
  164. package/docs/StockOrderDeductionRequestModel.md +0 -0
  165. package/docs/StockOrderDeductionsEntity.md +0 -0
  166. package/docs/StockOrderEntity.md +0 -0
  167. package/docs/StockOrderItemEntity.md +0 -0
  168. package/docs/StockOrderItemModel.md +0 -0
  169. package/docs/StockOrderItemRequestModel.md +0 -0
  170. package/docs/StockOrderModel.md +0 -0
  171. package/docs/StockOrderProductEntity.md +0 -0
  172. package/docs/StockOrderRequestModel.md +0 -0
  173. package/docs/StockOrderSupplierEntity.md +0 -0
  174. package/docs/StockOrderSupplierModel.md +0 -0
  175. package/docs/StockOrdersModel.md +0 -0
  176. package/docs/StockProductModel.md +0 -0
  177. package/docs/StockProductPriceModel.md +0 -0
  178. package/docs/StockProductSummariesModel.md +0 -0
  179. package/docs/StockProductSummaryModel.md +0 -0
  180. package/docs/StockTransactionsEntity.md +0 -0
  181. package/docs/SupplierEntity.md +0 -0
  182. package/docs/SupplierItemEntity.md +0 -0
  183. package/docs/SystemApi.md +0 -0
  184. package/docs/TcxBackupEntity.md +0 -0
  185. package/docs/TcxBackupModel.md +0 -0
  186. package/docs/TcxBillingEntity.md +0 -0
  187. package/docs/TcxBulkLicenceDetailsModel.md +0 -0
  188. package/docs/TcxDeadLicenceEntity.md +0 -0
  189. package/docs/TcxExtsEntity.md +0 -0
  190. package/docs/TcxHostingPricingEntity.md +0 -0
  191. package/docs/TcxInstallationDetailsModel.md +0 -0
  192. package/docs/TcxInstallationModel.md +2 -0
  193. package/docs/TcxInstallationsModel.md +0 -0
  194. package/docs/TcxKeySummaryDTO.md +0 -0
  195. package/docs/TcxKeysEntity.md +0 -0
  196. package/docs/TcxLicenceDetailsErrorModel.md +0 -0
  197. package/docs/TcxLicenceDetailsModel.md +0 -0
  198. package/docs/TcxMacsEntity.md +0 -0
  199. package/docs/TcxMultiTenantModel.md +0 -0
  200. package/docs/TcxMultiTenantUserModel.md +0 -0
  201. package/docs/TcxMultiTenantsModel.md +0 -0
  202. package/docs/TcxNumbersEntity.md +0 -0
  203. package/docs/TcxOfficeHoursEntity.md +0 -0
  204. package/docs/TcxPhoneModel.md +0 -0
  205. package/docs/TcxPhonesEntity.md +0 -0
  206. package/docs/TcxRemoteStorageModel.md +0 -0
  207. package/docs/TcxSbcDTO.md +0 -0
  208. package/docs/TcxSbcEntity.md +0 -0
  209. package/docs/TcxSbcModel.md +0 -0
  210. package/docs/TcxSetupEntity.md +0 -0
  211. package/docs/TcxSetupsModel.md +0 -0
  212. package/docs/TcxSipTrunksEntity.md +0 -0
  213. package/docs/TcxTemplateXmlEnum.md +0 -0
  214. package/docs/TcxUsersEntity.md +0 -0
  215. package/docs/TcxWizardConfigModel.md +0 -0
  216. package/docs/TcxWizardModel.md +0 -0
  217. package/docs/TechSupportCompanySummaryDTO.md +0 -0
  218. package/docs/TelephonySupportTicketModel.md +0 -0
  219. package/docs/TicketSummaryModel.md +0 -0
  220. package/docs/TicketTimeDTO.md +0 -0
  221. package/docs/TicketsApi.md +0 -0
  222. package/docs/TokenResponseModel.md +0 -0
  223. package/docs/UpgradeOrderResponseModel.md +0 -0
  224. package/docs/UpgradeRequestModel.md +0 -0
  225. package/docs/UserEntity.md +0 -0
  226. package/docs/WebhooksApi.md +0 -0
  227. package/docs/XeroLogEntity.md +0 -0
  228. package/git_push.sh +0 -0
  229. package/index.ts +1 -1
  230. package/openapitools.json +0 -0
  231. package/package.json +1 -1
  232. package/tsconfig.json +0 -0
  233. package/docs/AbstractEventUpdateDTO.md +0 -23
  234. package/docs/EventDTO.md +0 -35
  235. package/docs/EventRequestDTO.md +0 -25
  236. package/docs/EventSubscriptionModel.md +0 -23
  237. package/docs/EventUpdateDTO.md +0 -27
  238. package/docs/EventUpdateEntity.md +0 -29
  239. package/docs/EventUpdateRequestDTO.md +0 -23
  240. package/docs/ServiceHealthDTO.md +0 -23
  241. package/docs/ServiceStatusDTO.md +0 -27
  242. package/docs/ServicesApi.md +0 -330
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
  *
@@ -23,34 +23,6 @@ import type { RequestArgs } from './base';
23
23
  // @ts-ignore
24
24
  import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
25
25
 
26
- /**
27
- * Abstract Event Update DTO
28
- * @export
29
- * @interface AbstractEventUpdateDTO
30
- */
31
- export interface AbstractEventUpdateDTO {
32
- /**
33
- * Service Event Update Message
34
- * @type {string}
35
- * @memberof AbstractEventUpdateDTO
36
- */
37
- 'message'?: string;
38
- /**
39
- * Service Event Update Type
40
- * @type {number}
41
- * @memberof AbstractEventUpdateDTO
42
- */
43
- 'type'?: AbstractEventUpdateDTOTypeEnum;
44
- }
45
-
46
- export const AbstractEventUpdateDTOTypeEnum = {
47
- NUMBER_0: 0,
48
- NUMBER_1: 1,
49
- NUMBER_2: 2
50
- } as const;
51
-
52
- export type AbstractEventUpdateDTOTypeEnum = typeof AbstractEventUpdateDTOTypeEnum[keyof typeof AbstractEventUpdateDTOTypeEnum];
53
-
54
26
  /**
55
27
  * Order Request
56
28
  * @export
@@ -2403,245 +2375,6 @@ export interface EdTechProSetupModel {
2403
2375
  */
2404
2376
  'installed'?: boolean;
2405
2377
  }
2406
- /**
2407
- * Service Event DTO
2408
- * @export
2409
- * @interface EventDTO
2410
- */
2411
- export interface EventDTO {
2412
- /**
2413
- * Service Event Title
2414
- * @type {string}
2415
- * @memberof EventDTO
2416
- */
2417
- 'title'?: string;
2418
- /**
2419
- * Service Event Type
2420
- * @type {number}
2421
- * @memberof EventDTO
2422
- */
2423
- 'type'?: EventDTOTypeEnum;
2424
- /**
2425
- * Service Impacted
2426
- * @type {number}
2427
- * @memberof EventDTO
2428
- */
2429
- 'service'?: EventDTOServiceEnum;
2430
- /**
2431
- * Event Status Description
2432
- * @type {string}
2433
- * @memberof EventDTO
2434
- */
2435
- 'statusName'?: string;
2436
- /**
2437
- * Event Type Description
2438
- * @type {string}
2439
- * @memberof EventDTO
2440
- */
2441
- 'typeName'?: string;
2442
- /**
2443
- * Service Event ID
2444
- * @type {number}
2445
- * @memberof EventDTO
2446
- */
2447
- 'id'?: number;
2448
- /**
2449
- * Service Event Status
2450
- * @type {number}
2451
- * @memberof EventDTO
2452
- */
2453
- 'status'?: EventDTOStatusEnum;
2454
- /**
2455
- * Service Event Updates
2456
- * @type {Array<EventUpdateDTO>}
2457
- * @memberof EventDTO
2458
- */
2459
- 'updates'?: Array<EventUpdateDTO>;
2460
- }
2461
-
2462
- export const EventDTOTypeEnum = {
2463
- NUMBER_0: 0,
2464
- NUMBER_1: 1
2465
- } as const;
2466
-
2467
- export type EventDTOTypeEnum = typeof EventDTOTypeEnum[keyof typeof EventDTOTypeEnum];
2468
- export const EventDTOServiceEnum = {
2469
- NUMBER_0: 0,
2470
- NUMBER_1: 1
2471
- } as const;
2472
-
2473
- export type EventDTOServiceEnum = typeof EventDTOServiceEnum[keyof typeof EventDTOServiceEnum];
2474
- export const EventDTOStatusEnum = {
2475
- NUMBER_0: 0,
2476
- NUMBER_1: 1,
2477
- NUMBER_2: 2
2478
- } as const;
2479
-
2480
- export type EventDTOStatusEnum = typeof EventDTOStatusEnum[keyof typeof EventDTOStatusEnum];
2481
-
2482
- /**
2483
- * Service Event Request DTO
2484
- * @export
2485
- * @interface EventRequestDTO
2486
- */
2487
- export interface EventRequestDTO {
2488
- /**
2489
- * Service Event Title
2490
- * @type {string}
2491
- * @memberof EventRequestDTO
2492
- */
2493
- 'title'?: string;
2494
- /**
2495
- * Service Event Type
2496
- * @type {number}
2497
- * @memberof EventRequestDTO
2498
- */
2499
- 'type'?: EventRequestDTOTypeEnum;
2500
- /**
2501
- * Service Impacted
2502
- * @type {number}
2503
- * @memberof EventRequestDTO
2504
- */
2505
- 'service'?: EventRequestDTOServiceEnum;
2506
- }
2507
-
2508
- export const EventRequestDTOTypeEnum = {
2509
- NUMBER_0: 0,
2510
- NUMBER_1: 1
2511
- } as const;
2512
-
2513
- export type EventRequestDTOTypeEnum = typeof EventRequestDTOTypeEnum[keyof typeof EventRequestDTOTypeEnum];
2514
- export const EventRequestDTOServiceEnum = {
2515
- NUMBER_0: 0,
2516
- NUMBER_1: 1
2517
- } as const;
2518
-
2519
- export type EventRequestDTOServiceEnum = typeof EventRequestDTOServiceEnum[keyof typeof EventRequestDTOServiceEnum];
2520
-
2521
- /**
2522
- * Service Event Subscribption Model
2523
- * @export
2524
- * @interface EventSubscriptionModel
2525
- */
2526
- export interface EventSubscriptionModel {
2527
- /**
2528
- * id
2529
- * @type {string}
2530
- * @memberof EventSubscriptionModel
2531
- */
2532
- 'id'?: string;
2533
- /**
2534
- * email
2535
- * @type {string}
2536
- * @memberof EventSubscriptionModel
2537
- */
2538
- 'email'?: string;
2539
- }
2540
- /**
2541
- * Service Event Update DTO
2542
- * @export
2543
- * @interface EventUpdateDTO
2544
- */
2545
- export interface EventUpdateDTO {
2546
- /**
2547
- * Service Event Update Message
2548
- * @type {string}
2549
- * @memberof EventUpdateDTO
2550
- */
2551
- 'message'?: string;
2552
- /**
2553
- * Service Event Update Type
2554
- * @type {number}
2555
- * @memberof EventUpdateDTO
2556
- */
2557
- 'type'?: EventUpdateDTOTypeEnum;
2558
- /**
2559
- * Service Event Update Type Description
2560
- * @type {string}
2561
- * @memberof EventUpdateDTO
2562
- */
2563
- 'typeName'?: string;
2564
- /**
2565
- * Date Time
2566
- * @type {string}
2567
- * @memberof EventUpdateDTO
2568
- */
2569
- 'createdAt'?: string;
2570
- }
2571
-
2572
- export const EventUpdateDTOTypeEnum = {
2573
- NUMBER_0: 0,
2574
- NUMBER_1: 1,
2575
- NUMBER_2: 2
2576
- } as const;
2577
-
2578
- export type EventUpdateDTOTypeEnum = typeof EventUpdateDTOTypeEnum[keyof typeof EventUpdateDTOTypeEnum];
2579
-
2580
- /**
2581
- * Event Update Entity
2582
- * @export
2583
- * @interface EventUpdateEntity
2584
- */
2585
- export interface EventUpdateEntity {
2586
- /**
2587
- * id
2588
- * @type {number}
2589
- * @memberof EventUpdateEntity
2590
- */
2591
- 'id'?: number;
2592
- /**
2593
- * eventId
2594
- * @type {number}
2595
- * @memberof EventUpdateEntity
2596
- */
2597
- 'eventId'?: number;
2598
- /**
2599
- * message
2600
- * @type {string}
2601
- * @memberof EventUpdateEntity
2602
- */
2603
- 'message'?: string;
2604
- /**
2605
- * type
2606
- * @type {number}
2607
- * @memberof EventUpdateEntity
2608
- */
2609
- 'type'?: number;
2610
- /**
2611
- * createdAt
2612
- * @type {string}
2613
- * @memberof EventUpdateEntity
2614
- */
2615
- 'createdAt'?: string;
2616
- }
2617
- /**
2618
- * Service Event Update Request DTO
2619
- * @export
2620
- * @interface EventUpdateRequestDTO
2621
- */
2622
- export interface EventUpdateRequestDTO {
2623
- /**
2624
- * Service Event Update Message
2625
- * @type {string}
2626
- * @memberof EventUpdateRequestDTO
2627
- */
2628
- 'message'?: string;
2629
- /**
2630
- * Service Event Update Type
2631
- * @type {number}
2632
- * @memberof EventUpdateRequestDTO
2633
- */
2634
- 'type'?: EventUpdateRequestDTOTypeEnum;
2635
- }
2636
-
2637
- export const EventUpdateRequestDTOTypeEnum = {
2638
- NUMBER_0: 0,
2639
- NUMBER_1: 1,
2640
- NUMBER_2: 2
2641
- } as const;
2642
-
2643
- export type EventUpdateRequestDTOTypeEnum = typeof EventUpdateRequestDTOTypeEnum[keyof typeof EventUpdateRequestDTOTypeEnum];
2644
-
2645
2378
  /**
2646
2379
  * Fraud Management
2647
2380
  * @export
@@ -3108,6 +2841,12 @@ export interface InstanceEntity {
3108
2841
  * @memberof InstanceEntity
3109
2842
  */
3110
2843
  'status'?: string;
2844
+ /**
2845
+ * autoFailover
2846
+ * @type {number}
2847
+ * @memberof InstanceEntity
2848
+ */
2849
+ 'autoFailover'?: number;
3111
2850
  }
3112
2851
  /**
3113
2852
  * InstanceFailoverEntity
@@ -5551,74 +5290,6 @@ export interface ScopeModel {
5551
5290
  */
5552
5291
  'description'?: string;
5553
5292
  }
5554
- /**
5555
- * Service Health DTO
5556
- * @export
5557
- * @interface ServiceHealthDTO
5558
- */
5559
- export interface ServiceHealthDTO {
5560
- /**
5561
- *
5562
- * @type {Array<ServiceStatusDTO>}
5563
- * @memberof ServiceHealthDTO
5564
- */
5565
- 'services'?: Array<ServiceStatusDTO>;
5566
- /**
5567
- *
5568
- * @type {number}
5569
- * @memberof ServiceHealthDTO
5570
- */
5571
- 'globalStatus'?: ServiceHealthDTOGlobalStatusEnum;
5572
- }
5573
-
5574
- export const ServiceHealthDTOGlobalStatusEnum = {
5575
- NUMBER_0: 0,
5576
- NUMBER_1: 1,
5577
- NUMBER_2: 2
5578
- } as const;
5579
-
5580
- export type ServiceHealthDTOGlobalStatusEnum = typeof ServiceHealthDTOGlobalStatusEnum[keyof typeof ServiceHealthDTOGlobalStatusEnum];
5581
-
5582
- /**
5583
- * Service Status DTO
5584
- * @export
5585
- * @interface ServiceStatusDTO
5586
- */
5587
- export interface ServiceStatusDTO {
5588
- /**
5589
- * Service Status Description
5590
- * @type {string}
5591
- * @memberof ServiceStatusDTO
5592
- */
5593
- 'statusName'?: string;
5594
- /**
5595
- * Service Name
5596
- * @type {string}
5597
- * @memberof ServiceStatusDTO
5598
- */
5599
- 'name'?: string;
5600
- /**
5601
- * Service Status
5602
- * @type {number}
5603
- * @memberof ServiceStatusDTO
5604
- */
5605
- 'status'?: ServiceStatusDTOStatusEnum;
5606
- /**
5607
- * Service Events
5608
- * @type {Array<EventDTO>}
5609
- * @memberof ServiceStatusDTO
5610
- */
5611
- 'events'?: Array<EventDTO>;
5612
- }
5613
-
5614
- export const ServiceStatusDTOStatusEnum = {
5615
- NUMBER_0: 0,
5616
- NUMBER_1: 1,
5617
- NUMBER_2: 2
5618
- } as const;
5619
-
5620
- export type ServiceStatusDTOStatusEnum = typeof ServiceStatusDTOStatusEnum[keyof typeof ServiceStatusDTOStatusEnum];
5621
-
5622
5293
  /**
5623
5294
  * ShipmentAddressEntity
5624
5295
  * @export
@@ -8156,6 +7827,12 @@ export interface TcxInstallationModel {
8156
7827
  * @memberof TcxInstallationModel
8157
7828
  */
8158
7829
  'flavour'?: string | null;
7830
+ /**
7831
+ * Auto Failover
7832
+ * @type {boolean}
7833
+ * @memberof TcxInstallationModel
7834
+ */
7835
+ 'autoFailover'?: boolean;
8159
7836
  }
8160
7837
  /**
8161
7838
  * 3CX Installations
@@ -12811,6 +12488,40 @@ export const Class3CXInstallationWizardApiAxiosParamCreator = function (configur
12811
12488
  options: localVarRequestOptions,
12812
12489
  };
12813
12490
  },
12491
+ /**
12492
+ * Track SIP Trunk Change Request
12493
+ * @summary Track SIP Trunk Change Request
12494
+ * @param {SipTrunkChangeResponseModel} [sipTrunkChangeResponseModel] Change Request
12495
+ * @param {*} [options] Override http request option.
12496
+ * @throws {RequiredError}
12497
+ */
12498
+ postTrackChangeTcxWizard: async (sipTrunkChangeResponseModel?: SipTrunkChangeResponseModel, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12499
+ const localVarPath = `/tcx/wizards/sip/trunks/changes/track`;
12500
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
12501
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12502
+ let baseOptions;
12503
+ if (configuration) {
12504
+ baseOptions = configuration.baseOptions;
12505
+ }
12506
+
12507
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
12508
+ const localVarHeaderParameter = {} as any;
12509
+ const localVarQueryParameter = {} as any;
12510
+
12511
+
12512
+
12513
+ localVarHeaderParameter['Content-Type'] = 'application/json';
12514
+
12515
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
12516
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12517
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12518
+ localVarRequestOptions.data = serializeDataIfNeeded(sipTrunkChangeResponseModel, localVarRequestOptions, configuration)
12519
+
12520
+ return {
12521
+ url: toPathString(localVarUrlObj),
12522
+ options: localVarRequestOptions,
12523
+ };
12524
+ },
12814
12525
  /**
12815
12526
  * Upload 3CX Backup File
12816
12527
  * @param {File} backup 3CX Backup ZIP File
@@ -13282,6 +12993,19 @@ export const Class3CXInstallationWizardApiFp = function(configuration?: Configur
13282
12993
  const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationWizardApi.postGetSipTrunksTcxWizard']?.[localVarOperationServerIndex]?.url;
13283
12994
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13284
12995
  },
12996
+ /**
12997
+ * Track SIP Trunk Change Request
12998
+ * @summary Track SIP Trunk Change Request
12999
+ * @param {SipTrunkChangeResponseModel} [sipTrunkChangeResponseModel] Change Request
13000
+ * @param {*} [options] Override http request option.
13001
+ * @throws {RequiredError}
13002
+ */
13003
+ async postTrackChangeTcxWizard(sipTrunkChangeResponseModel?: SipTrunkChangeResponseModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SipTrunkChangeResponseModel>> {
13004
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postTrackChangeTcxWizard(sipTrunkChangeResponseModel, options);
13005
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13006
+ const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationWizardApi.postTrackChangeTcxWizard']?.[localVarOperationServerIndex]?.url;
13007
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13008
+ },
13285
13009
  /**
13286
13010
  * Upload 3CX Backup File
13287
13011
  * @param {File} backup 3CX Backup ZIP File
@@ -13629,6 +13353,16 @@ export const Class3CXInstallationWizardApiFactory = function (configuration?: Co
13629
13353
  postGetSipTrunksTcxWizard(sipTrunkCreationRequestModel?: SipTrunkCreationRequestModel, options?: RawAxiosRequestConfig): AxiosPromise<SipTrunkChangeResponseModel> {
13630
13354
  return localVarFp.postGetSipTrunksTcxWizard(sipTrunkCreationRequestModel, options).then((request) => request(axios, basePath));
13631
13355
  },
13356
+ /**
13357
+ * Track SIP Trunk Change Request
13358
+ * @summary Track SIP Trunk Change Request
13359
+ * @param {SipTrunkChangeResponseModel} [sipTrunkChangeResponseModel] Change Request
13360
+ * @param {*} [options] Override http request option.
13361
+ * @throws {RequiredError}
13362
+ */
13363
+ postTrackChangeTcxWizard(sipTrunkChangeResponseModel?: SipTrunkChangeResponseModel, options?: RawAxiosRequestConfig): AxiosPromise<SipTrunkChangeResponseModel> {
13364
+ return localVarFp.postTrackChangeTcxWizard(sipTrunkChangeResponseModel, options).then((request) => request(axios, basePath));
13365
+ },
13632
13366
  /**
13633
13367
  * Upload 3CX Backup File
13634
13368
  * @param {File} backup 3CX Backup ZIP File
@@ -14037,6 +13771,18 @@ export class Class3CXInstallationWizardApi extends BaseAPI {
14037
13771
  return Class3CXInstallationWizardApiFp(this.configuration).postGetSipTrunksTcxWizard(sipTrunkCreationRequestModel, options).then((request) => request(this.axios, this.basePath));
14038
13772
  }
14039
13773
 
13774
+ /**
13775
+ * Track SIP Trunk Change Request
13776
+ * @summary Track SIP Trunk Change Request
13777
+ * @param {SipTrunkChangeResponseModel} [sipTrunkChangeResponseModel] Change Request
13778
+ * @param {*} [options] Override http request option.
13779
+ * @throws {RequiredError}
13780
+ * @memberof Class3CXInstallationWizardApi
13781
+ */
13782
+ public postTrackChangeTcxWizard(sipTrunkChangeResponseModel?: SipTrunkChangeResponseModel, options?: RawAxiosRequestConfig) {
13783
+ return Class3CXInstallationWizardApiFp(this.configuration).postTrackChangeTcxWizard(sipTrunkChangeResponseModel, options).then((request) => request(this.axios, this.basePath));
13784
+ }
13785
+
14040
13786
  /**
14041
13787
  * Upload 3CX Backup File
14042
13788
  * @param {File} backup 3CX Backup ZIP File
@@ -14147,6 +13893,88 @@ export const Class3CXInstallationsApiAxiosParamCreator = function (configuration
14147
13893
 
14148
13894
 
14149
13895
 
13896
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
13897
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13898
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
13899
+
13900
+ return {
13901
+ url: toPathString(localVarUrlObj),
13902
+ options: localVarRequestOptions,
13903
+ };
13904
+ },
13905
+ /**
13906
+ * Update 3CX Instance Auto Failover
13907
+ * @summary Update 3CX Instance Auto Failover
13908
+ * @param {string} instanceId Instance ID
13909
+ * @param {boolean} enable Enable
13910
+ * @param {*} [options] Override http request option.
13911
+ * @throws {RequiredError}
13912
+ */
13913
+ patchUpdateAutoFailover: async (instanceId: string, enable: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13914
+ // verify required parameter 'instanceId' is not null or undefined
13915
+ assertParamExists('patchUpdateAutoFailover', 'instanceId', instanceId)
13916
+ // verify required parameter 'enable' is not null or undefined
13917
+ assertParamExists('patchUpdateAutoFailover', 'enable', enable)
13918
+ const localVarPath = `/tcx/installations/{instance_id}/failover/auto`
13919
+ .replace(`{${"instance_id"}}`, encodeURIComponent(String(instanceId)));
13920
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
13921
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13922
+ let baseOptions;
13923
+ if (configuration) {
13924
+ baseOptions = configuration.baseOptions;
13925
+ }
13926
+
13927
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
13928
+ const localVarHeaderParameter = {} as any;
13929
+ const localVarQueryParameter = {} as any;
13930
+
13931
+ if (enable !== undefined) {
13932
+ localVarQueryParameter['enable'] = enable;
13933
+ }
13934
+
13935
+
13936
+
13937
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
13938
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13939
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
13940
+
13941
+ return {
13942
+ url: toPathString(localVarUrlObj),
13943
+ options: localVarRequestOptions,
13944
+ };
13945
+ },
13946
+ /**
13947
+ * Add additional disk on 3CX Instance
13948
+ * @summary Add additional disk on 3CX Instance
13949
+ * @param {string} instanceId Instance ID
13950
+ * @param {number} gigabytes Disk Space (GB)
13951
+ * @param {*} [options] Override http request option.
13952
+ * @throws {RequiredError}
13953
+ */
13954
+ postAddDisk: async (instanceId: string, gigabytes: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13955
+ // verify required parameter 'instanceId' is not null or undefined
13956
+ assertParamExists('postAddDisk', 'instanceId', instanceId)
13957
+ // verify required parameter 'gigabytes' is not null or undefined
13958
+ assertParamExists('postAddDisk', 'gigabytes', gigabytes)
13959
+ const localVarPath = `/tcx/installations/{instance_id}/disk`
13960
+ .replace(`{${"instance_id"}}`, encodeURIComponent(String(instanceId)));
13961
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
13962
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13963
+ let baseOptions;
13964
+ if (configuration) {
13965
+ baseOptions = configuration.baseOptions;
13966
+ }
13967
+
13968
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
13969
+ const localVarHeaderParameter = {} as any;
13970
+ const localVarQueryParameter = {} as any;
13971
+
13972
+ if (gigabytes !== undefined) {
13973
+ localVarQueryParameter['gigabytes'] = gigabytes;
13974
+ }
13975
+
13976
+
13977
+
14150
13978
  setSearchParams(localVarUrlObj, localVarQueryParameter);
14151
13979
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14152
13980
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -14563,6 +14391,34 @@ export const Class3CXInstallationsApiFp = function(configuration?: Configuration
14563
14391
  const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationsApi.getGetInstallations']?.[localVarOperationServerIndex]?.url;
14564
14392
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14565
14393
  },
14394
+ /**
14395
+ * Update 3CX Instance Auto Failover
14396
+ * @summary Update 3CX Instance Auto Failover
14397
+ * @param {string} instanceId Instance ID
14398
+ * @param {boolean} enable Enable
14399
+ * @param {*} [options] Override http request option.
14400
+ * @throws {RequiredError}
14401
+ */
14402
+ async patchUpdateAutoFailover(instanceId: string, enable: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
14403
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchUpdateAutoFailover(instanceId, enable, options);
14404
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14405
+ const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationsApi.patchUpdateAutoFailover']?.[localVarOperationServerIndex]?.url;
14406
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14407
+ },
14408
+ /**
14409
+ * Add additional disk on 3CX Instance
14410
+ * @summary Add additional disk on 3CX Instance
14411
+ * @param {string} instanceId Instance ID
14412
+ * @param {number} gigabytes Disk Space (GB)
14413
+ * @param {*} [options] Override http request option.
14414
+ * @throws {RequiredError}
14415
+ */
14416
+ async postAddDisk(instanceId: string, gigabytes: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
14417
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postAddDisk(instanceId, gigabytes, options);
14418
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14419
+ const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationsApi.postAddDisk']?.[localVarOperationServerIndex]?.url;
14420
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14421
+ },
14566
14422
  /**
14567
14423
  * Create a root user
14568
14424
  * @summary Create a root user
@@ -14725,6 +14581,28 @@ export const Class3CXInstallationsApiFactory = function (configuration?: Configu
14725
14581
  getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<TcxInstallationsModel> {
14726
14582
  return localVarFp.getGetInstallations(pageSize, page, customerId, search, status, hosting, installType, options).then((request) => request(axios, basePath));
14727
14583
  },
14584
+ /**
14585
+ * Update 3CX Instance Auto Failover
14586
+ * @summary Update 3CX Instance Auto Failover
14587
+ * @param {string} instanceId Instance ID
14588
+ * @param {boolean} enable Enable
14589
+ * @param {*} [options] Override http request option.
14590
+ * @throws {RequiredError}
14591
+ */
14592
+ patchUpdateAutoFailover(instanceId: string, enable: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void> {
14593
+ return localVarFp.patchUpdateAutoFailover(instanceId, enable, options).then((request) => request(axios, basePath));
14594
+ },
14595
+ /**
14596
+ * Add additional disk on 3CX Instance
14597
+ * @summary Add additional disk on 3CX Instance
14598
+ * @param {string} instanceId Instance ID
14599
+ * @param {number} gigabytes Disk Space (GB)
14600
+ * @param {*} [options] Override http request option.
14601
+ * @throws {RequiredError}
14602
+ */
14603
+ postAddDisk(instanceId: string, gigabytes: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
14604
+ return localVarFp.postAddDisk(instanceId, gigabytes, options).then((request) => request(axios, basePath));
14605
+ },
14728
14606
  /**
14729
14607
  * Create a root user
14730
14608
  * @summary Create a root user
@@ -14864,6 +14742,32 @@ export class Class3CXInstallationsApi extends BaseAPI {
14864
14742
  return Class3CXInstallationsApiFp(this.configuration).getGetInstallations(pageSize, page, customerId, search, status, hosting, installType, options).then((request) => request(this.axios, this.basePath));
14865
14743
  }
14866
14744
 
14745
+ /**
14746
+ * Update 3CX Instance Auto Failover
14747
+ * @summary Update 3CX Instance Auto Failover
14748
+ * @param {string} instanceId Instance ID
14749
+ * @param {boolean} enable Enable
14750
+ * @param {*} [options] Override http request option.
14751
+ * @throws {RequiredError}
14752
+ * @memberof Class3CXInstallationsApi
14753
+ */
14754
+ public patchUpdateAutoFailover(instanceId: string, enable: boolean, options?: RawAxiosRequestConfig) {
14755
+ return Class3CXInstallationsApiFp(this.configuration).patchUpdateAutoFailover(instanceId, enable, options).then((request) => request(this.axios, this.basePath));
14756
+ }
14757
+
14758
+ /**
14759
+ * Add additional disk on 3CX Instance
14760
+ * @summary Add additional disk on 3CX Instance
14761
+ * @param {string} instanceId Instance ID
14762
+ * @param {number} gigabytes Disk Space (GB)
14763
+ * @param {*} [options] Override http request option.
14764
+ * @throws {RequiredError}
14765
+ * @memberof Class3CXInstallationsApi
14766
+ */
14767
+ public postAddDisk(instanceId: string, gigabytes: number, options?: RawAxiosRequestConfig) {
14768
+ return Class3CXInstallationsApiFp(this.configuration).postAddDisk(instanceId, gigabytes, options).then((request) => request(this.axios, this.basePath));
14769
+ }
14770
+
14867
14771
  /**
14868
14772
  * Create a root user
14869
14773
  * @summary Create a root user
@@ -17822,7 +17726,8 @@ export const GetGetPriceListTypeEnum = {
17822
17726
  _3CxStarterBundle: '3CX Starter Bundle',
17823
17727
  EdTechPro: 'EdTechPro',
17824
17728
  Sms: 'SMS',
17825
- SipTrunks: 'SIP Trunks'
17729
+ SipTrunks: 'SIP Trunks',
17730
+ CrmIntegrations: 'CRM Integrations'
17826
17731
  } as const;
17827
17732
  export type GetGetPriceListTypeEnum = typeof GetGetPriceListTypeEnum[keyof typeof GetGetPriceListTypeEnum];
17828
17733
  /**
@@ -17873,7 +17778,8 @@ export const PostSendPriceListTypeEnum = {
17873
17778
  _3CxStarterBundle: '3CX Starter Bundle',
17874
17779
  EdTechPro: 'EdTechPro',
17875
17780
  Sms: 'SMS',
17876
- SipTrunks: 'SIP Trunks'
17781
+ SipTrunks: 'SIP Trunks',
17782
+ CrmIntegrations: 'CRM Integrations'
17877
17783
  } as const;
17878
17784
  export type PostSendPriceListTypeEnum = typeof PostSendPriceListTypeEnum[keyof typeof PostSendPriceListTypeEnum];
17879
17785
  /**
@@ -20931,445 +20837,6 @@ export class SMSApi extends BaseAPI {
20931
20837
 
20932
20838
 
20933
20839
 
20934
- /**
20935
- * ServicesApi - axios parameter creator
20936
- * @export
20937
- */
20938
- export const ServicesApiAxiosParamCreator = function (configuration?: Configuration) {
20939
- return {
20940
- /**
20941
- *
20942
- * @param {string} [id] Unsubscribe Email ID
20943
- * @param {string} [email] Unsubscribe Email Address
20944
- * @param {*} [options] Override http request option.
20945
- * @throws {RequiredError}
20946
- */
20947
- deleteUnsubscribe: async (id?: string, email?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20948
- const localVarPath = `/services/events/unsubscribe`;
20949
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
20950
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
20951
- let baseOptions;
20952
- if (configuration) {
20953
- baseOptions = configuration.baseOptions;
20954
- }
20955
-
20956
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
20957
- const localVarHeaderParameter = {} as any;
20958
- const localVarQueryParameter = {} as any;
20959
-
20960
- if (id !== undefined) {
20961
- localVarQueryParameter['id'] = id;
20962
- }
20963
-
20964
- if (email !== undefined) {
20965
- localVarQueryParameter['email'] = email;
20966
- }
20967
-
20968
-
20969
-
20970
- setSearchParams(localVarUrlObj, localVarQueryParameter);
20971
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20972
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
20973
-
20974
- return {
20975
- url: toPathString(localVarUrlObj),
20976
- options: localVarRequestOptions,
20977
- };
20978
- },
20979
- /**
20980
- *
20981
- * @param {*} [options] Override http request option.
20982
- * @throws {RequiredError}
20983
- */
20984
- getGetServiceHealth: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20985
- const localVarPath = `/services/health`;
20986
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
20987
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
20988
- let baseOptions;
20989
- if (configuration) {
20990
- baseOptions = configuration.baseOptions;
20991
- }
20992
-
20993
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
20994
- const localVarHeaderParameter = {} as any;
20995
- const localVarQueryParameter = {} as any;
20996
-
20997
-
20998
-
20999
- setSearchParams(localVarUrlObj, localVarQueryParameter);
21000
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21001
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21002
-
21003
- return {
21004
- url: toPathString(localVarUrlObj),
21005
- options: localVarRequestOptions,
21006
- };
21007
- },
21008
- /**
21009
- *
21010
- * @param {number} id Group ID
21011
- * @param {*} [options] Override http request option.
21012
- * @throws {RequiredError}
21013
- */
21014
- patchArchiveEvent: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
21015
- // verify required parameter 'id' is not null or undefined
21016
- assertParamExists('patchArchiveEvent', 'id', id)
21017
- const localVarPath = `/services/events/{id}/archive`
21018
- .replace(`{${"id"}}`, encodeURIComponent(String(id)));
21019
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
21020
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
21021
- let baseOptions;
21022
- if (configuration) {
21023
- baseOptions = configuration.baseOptions;
21024
- }
21025
-
21026
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
21027
- const localVarHeaderParameter = {} as any;
21028
- const localVarQueryParameter = {} as any;
21029
-
21030
-
21031
-
21032
- setSearchParams(localVarUrlObj, localVarQueryParameter);
21033
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21034
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21035
-
21036
- return {
21037
- url: toPathString(localVarUrlObj),
21038
- options: localVarRequestOptions,
21039
- };
21040
- },
21041
- /**
21042
- *
21043
- * @param {EventRequestDTO} [eventRequestDTO]
21044
- * @param {*} [options] Override http request option.
21045
- * @throws {RequiredError}
21046
- */
21047
- postCreateEvent: async (eventRequestDTO?: EventRequestDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
21048
- const localVarPath = `/services/events`;
21049
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
21050
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
21051
- let baseOptions;
21052
- if (configuration) {
21053
- baseOptions = configuration.baseOptions;
21054
- }
21055
-
21056
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
21057
- const localVarHeaderParameter = {} as any;
21058
- const localVarQueryParameter = {} as any;
21059
-
21060
-
21061
-
21062
- localVarHeaderParameter['Content-Type'] = 'application/json';
21063
-
21064
- setSearchParams(localVarUrlObj, localVarQueryParameter);
21065
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21066
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21067
- localVarRequestOptions.data = serializeDataIfNeeded(eventRequestDTO, localVarRequestOptions, configuration)
21068
-
21069
- return {
21070
- url: toPathString(localVarUrlObj),
21071
- options: localVarRequestOptions,
21072
- };
21073
- },
21074
- /**
21075
- *
21076
- * @param {number} id Group ID
21077
- * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
21078
- * @param {*} [options] Override http request option.
21079
- * @throws {RequiredError}
21080
- */
21081
- postCreateEventUpdate: async (id: number, eventUpdateRequestDTO?: EventUpdateRequestDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
21082
- // verify required parameter 'id' is not null or undefined
21083
- assertParamExists('postCreateEventUpdate', 'id', id)
21084
- const localVarPath = `/services/events/{id}/updates`
21085
- .replace(`{${"id"}}`, encodeURIComponent(String(id)));
21086
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
21087
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
21088
- let baseOptions;
21089
- if (configuration) {
21090
- baseOptions = configuration.baseOptions;
21091
- }
21092
-
21093
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
21094
- const localVarHeaderParameter = {} as any;
21095
- const localVarQueryParameter = {} as any;
21096
-
21097
-
21098
-
21099
- localVarHeaderParameter['Content-Type'] = 'application/json';
21100
-
21101
- setSearchParams(localVarUrlObj, localVarQueryParameter);
21102
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21103
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21104
- localVarRequestOptions.data = serializeDataIfNeeded(eventUpdateRequestDTO, localVarRequestOptions, configuration)
21105
-
21106
- return {
21107
- url: toPathString(localVarUrlObj),
21108
- options: localVarRequestOptions,
21109
- };
21110
- },
21111
- /**
21112
- *
21113
- * @param {string} [email] Subscription Email Address
21114
- * @param {*} [options] Override http request option.
21115
- * @throws {RequiredError}
21116
- */
21117
- postSubscribe: async (email?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
21118
- const localVarPath = `/services/events/subscribe`;
21119
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
21120
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
21121
- let baseOptions;
21122
- if (configuration) {
21123
- baseOptions = configuration.baseOptions;
21124
- }
21125
-
21126
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
21127
- const localVarHeaderParameter = {} as any;
21128
- const localVarQueryParameter = {} as any;
21129
-
21130
- if (email !== undefined) {
21131
- localVarQueryParameter['email'] = email;
21132
- }
21133
-
21134
-
21135
-
21136
- setSearchParams(localVarUrlObj, localVarQueryParameter);
21137
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21138
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21139
-
21140
- return {
21141
- url: toPathString(localVarUrlObj),
21142
- options: localVarRequestOptions,
21143
- };
21144
- },
21145
- }
21146
- };
21147
-
21148
- /**
21149
- * ServicesApi - functional programming interface
21150
- * @export
21151
- */
21152
- export const ServicesApiFp = function(configuration?: Configuration) {
21153
- const localVarAxiosParamCreator = ServicesApiAxiosParamCreator(configuration)
21154
- return {
21155
- /**
21156
- *
21157
- * @param {string} [id] Unsubscribe Email ID
21158
- * @param {string} [email] Unsubscribe Email Address
21159
- * @param {*} [options] Override http request option.
21160
- * @throws {RequiredError}
21161
- */
21162
- async deleteUnsubscribe(id?: string, email?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
21163
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUnsubscribe(id, email, options);
21164
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21165
- const localVarOperationServerBasePath = operationServerMap['ServicesApi.deleteUnsubscribe']?.[localVarOperationServerIndex]?.url;
21166
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21167
- },
21168
- /**
21169
- *
21170
- * @param {*} [options] Override http request option.
21171
- * @throws {RequiredError}
21172
- */
21173
- async getGetServiceHealth(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceHealthDTO>> {
21174
- const localVarAxiosArgs = await localVarAxiosParamCreator.getGetServiceHealth(options);
21175
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21176
- const localVarOperationServerBasePath = operationServerMap['ServicesApi.getGetServiceHealth']?.[localVarOperationServerIndex]?.url;
21177
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21178
- },
21179
- /**
21180
- *
21181
- * @param {number} id Group ID
21182
- * @param {*} [options] Override http request option.
21183
- * @throws {RequiredError}
21184
- */
21185
- async patchArchiveEvent(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>> {
21186
- const localVarAxiosArgs = await localVarAxiosParamCreator.patchArchiveEvent(id, options);
21187
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21188
- const localVarOperationServerBasePath = operationServerMap['ServicesApi.patchArchiveEvent']?.[localVarOperationServerIndex]?.url;
21189
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21190
- },
21191
- /**
21192
- *
21193
- * @param {EventRequestDTO} [eventRequestDTO]
21194
- * @param {*} [options] Override http request option.
21195
- * @throws {RequiredError}
21196
- */
21197
- async postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>> {
21198
- const localVarAxiosArgs = await localVarAxiosParamCreator.postCreateEvent(eventRequestDTO, options);
21199
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21200
- const localVarOperationServerBasePath = operationServerMap['ServicesApi.postCreateEvent']?.[localVarOperationServerIndex]?.url;
21201
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21202
- },
21203
- /**
21204
- *
21205
- * @param {number} id Group ID
21206
- * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
21207
- * @param {*} [options] Override http request option.
21208
- * @throws {RequiredError}
21209
- */
21210
- async postCreateEventUpdate(id: number, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>> {
21211
- const localVarAxiosArgs = await localVarAxiosParamCreator.postCreateEventUpdate(id, eventUpdateRequestDTO, options);
21212
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21213
- const localVarOperationServerBasePath = operationServerMap['ServicesApi.postCreateEventUpdate']?.[localVarOperationServerIndex]?.url;
21214
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21215
- },
21216
- /**
21217
- *
21218
- * @param {string} [email] Subscription Email Address
21219
- * @param {*} [options] Override http request option.
21220
- * @throws {RequiredError}
21221
- */
21222
- async postSubscribe(email?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
21223
- const localVarAxiosArgs = await localVarAxiosParamCreator.postSubscribe(email, options);
21224
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21225
- const localVarOperationServerBasePath = operationServerMap['ServicesApi.postSubscribe']?.[localVarOperationServerIndex]?.url;
21226
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21227
- },
21228
- }
21229
- };
21230
-
21231
- /**
21232
- * ServicesApi - factory interface
21233
- * @export
21234
- */
21235
- export const ServicesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
21236
- const localVarFp = ServicesApiFp(configuration)
21237
- return {
21238
- /**
21239
- *
21240
- * @param {string} [id] Unsubscribe Email ID
21241
- * @param {string} [email] Unsubscribe Email Address
21242
- * @param {*} [options] Override http request option.
21243
- * @throws {RequiredError}
21244
- */
21245
- deleteUnsubscribe(id?: string, email?: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
21246
- return localVarFp.deleteUnsubscribe(id, email, options).then((request) => request(axios, basePath));
21247
- },
21248
- /**
21249
- *
21250
- * @param {*} [options] Override http request option.
21251
- * @throws {RequiredError}
21252
- */
21253
- getGetServiceHealth(options?: RawAxiosRequestConfig): AxiosPromise<ServiceHealthDTO> {
21254
- return localVarFp.getGetServiceHealth(options).then((request) => request(axios, basePath));
21255
- },
21256
- /**
21257
- *
21258
- * @param {number} id Group ID
21259
- * @param {*} [options] Override http request option.
21260
- * @throws {RequiredError}
21261
- */
21262
- patchArchiveEvent(id: number, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO> {
21263
- return localVarFp.patchArchiveEvent(id, options).then((request) => request(axios, basePath));
21264
- },
21265
- /**
21266
- *
21267
- * @param {EventRequestDTO} [eventRequestDTO]
21268
- * @param {*} [options] Override http request option.
21269
- * @throws {RequiredError}
21270
- */
21271
- postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO> {
21272
- return localVarFp.postCreateEvent(eventRequestDTO, options).then((request) => request(axios, basePath));
21273
- },
21274
- /**
21275
- *
21276
- * @param {number} id Group ID
21277
- * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
21278
- * @param {*} [options] Override http request option.
21279
- * @throws {RequiredError}
21280
- */
21281
- postCreateEventUpdate(id: number, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO> {
21282
- return localVarFp.postCreateEventUpdate(id, eventUpdateRequestDTO, options).then((request) => request(axios, basePath));
21283
- },
21284
- /**
21285
- *
21286
- * @param {string} [email] Subscription Email Address
21287
- * @param {*} [options] Override http request option.
21288
- * @throws {RequiredError}
21289
- */
21290
- postSubscribe(email?: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
21291
- return localVarFp.postSubscribe(email, options).then((request) => request(axios, basePath));
21292
- },
21293
- };
21294
- };
21295
-
21296
- /**
21297
- * ServicesApi - object-oriented interface
21298
- * @export
21299
- * @class ServicesApi
21300
- * @extends {BaseAPI}
21301
- */
21302
- export class ServicesApi extends BaseAPI {
21303
- /**
21304
- *
21305
- * @param {string} [id] Unsubscribe Email ID
21306
- * @param {string} [email] Unsubscribe Email Address
21307
- * @param {*} [options] Override http request option.
21308
- * @throws {RequiredError}
21309
- * @memberof ServicesApi
21310
- */
21311
- public deleteUnsubscribe(id?: string, email?: string, options?: RawAxiosRequestConfig) {
21312
- return ServicesApiFp(this.configuration).deleteUnsubscribe(id, email, options).then((request) => request(this.axios, this.basePath));
21313
- }
21314
-
21315
- /**
21316
- *
21317
- * @param {*} [options] Override http request option.
21318
- * @throws {RequiredError}
21319
- * @memberof ServicesApi
21320
- */
21321
- public getGetServiceHealth(options?: RawAxiosRequestConfig) {
21322
- return ServicesApiFp(this.configuration).getGetServiceHealth(options).then((request) => request(this.axios, this.basePath));
21323
- }
21324
-
21325
- /**
21326
- *
21327
- * @param {number} id Group ID
21328
- * @param {*} [options] Override http request option.
21329
- * @throws {RequiredError}
21330
- * @memberof ServicesApi
21331
- */
21332
- public patchArchiveEvent(id: number, options?: RawAxiosRequestConfig) {
21333
- return ServicesApiFp(this.configuration).patchArchiveEvent(id, options).then((request) => request(this.axios, this.basePath));
21334
- }
21335
-
21336
- /**
21337
- *
21338
- * @param {EventRequestDTO} [eventRequestDTO]
21339
- * @param {*} [options] Override http request option.
21340
- * @throws {RequiredError}
21341
- * @memberof ServicesApi
21342
- */
21343
- public postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig) {
21344
- return ServicesApiFp(this.configuration).postCreateEvent(eventRequestDTO, options).then((request) => request(this.axios, this.basePath));
21345
- }
21346
-
21347
- /**
21348
- *
21349
- * @param {number} id Group ID
21350
- * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
21351
- * @param {*} [options] Override http request option.
21352
- * @throws {RequiredError}
21353
- * @memberof ServicesApi
21354
- */
21355
- public postCreateEventUpdate(id: number, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig) {
21356
- return ServicesApiFp(this.configuration).postCreateEventUpdate(id, eventUpdateRequestDTO, options).then((request) => request(this.axios, this.basePath));
21357
- }
21358
-
21359
- /**
21360
- *
21361
- * @param {string} [email] Subscription Email Address
21362
- * @param {*} [options] Override http request option.
21363
- * @throws {RequiredError}
21364
- * @memberof ServicesApi
21365
- */
21366
- public postSubscribe(email?: string, options?: RawAxiosRequestConfig) {
21367
- return ServicesApiFp(this.configuration).postSubscribe(email, options).then((request) => request(this.axios, this.basePath));
21368
- }
21369
- }
21370
-
21371
-
21372
-
21373
20840
  /**
21374
20841
  * ShippingApi - axios parameter creator
21375
20842
  * @export