yellowgrid-api-ts 3.2.48 → 3.2.50-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +7 -2
- package/.openapi-generator/VERSION +1 -1
- package/.openapi-generator-ignore +0 -0
- package/README.md +19 -1
- package/api.ts +1657 -4182
- package/base.ts +1 -25
- package/common.ts +15 -39
- package/config.json +3 -3
- package/configuration.ts +25 -19
- package/dist/api.d.ts +783 -3786
- package/dist/api.js +1379 -420
- package/dist/base.d.ts +1 -25
- package/dist/base.js +1 -20
- package/dist/common.d.ts +5 -36
- package/dist/common.js +16 -39
- package/dist/configuration.d.ts +25 -18
- package/dist/configuration.js +2 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/EventTypeEnum.d.ts +0 -0
- package/dist/models/EventTypeEnum.js +0 -0
- package/dist/models/ServiceEnum.d.ts +0 -0
- package/dist/models/ServiceEnum.js +0 -0
- package/dist/models/ServiceHealthEnum.d.ts +0 -0
- package/dist/models/ServiceHealthEnum.js +0 -0
- package/dist/models/ServiceStatusEnum.d.ts +0 -0
- package/dist/models/ServiceStatusEnum.js +0 -0
- package/dist/models/UpdateTypeEnum.d.ts +0 -0
- package/dist/models/UpdateTypeEnum.js +0 -0
- package/dist/src/apis/AccountsApi.d.ts +258 -0
- package/dist/src/apis/AccountsApi.js +975 -0
- package/dist/src/apis/CRMApi.d.ts +26 -0
- package/dist/src/apis/CRMApi.js +122 -0
- package/dist/src/apis/Class3CXApi.d.ts +44 -0
- package/dist/src/apis/Class3CXApi.js +177 -0
- package/dist/src/apis/Class3CXInstallationWizardApi.d.ts +446 -0
- package/dist/src/apis/Class3CXInstallationWizardApi.js +1740 -0
- package/dist/src/apis/Class3CXInstallationsApi.d.ts +253 -0
- package/dist/src/apis/Class3CXInstallationsApi.js +806 -0
- package/dist/src/apis/Class3CXIntegrationsApi.d.ts +102 -0
- package/dist/src/apis/Class3CXIntegrationsApi.js +386 -0
- package/dist/src/apis/Class3CXMultiTenantApi.d.ts +122 -0
- package/dist/src/apis/Class3CXMultiTenantApi.js +431 -0
- package/dist/src/apis/MyPBXToolsApi.d.ts +32 -0
- package/dist/src/apis/MyPBXToolsApi.js +136 -0
- package/dist/src/apis/OAuth20Api.d.ts +185 -0
- package/dist/src/apis/OAuth20Api.js +507 -0
- package/dist/src/apis/OrdersApi.d.ts +154 -0
- package/dist/src/apis/OrdersApi.js +512 -0
- package/dist/src/apis/PricingApi.d.ts +154 -0
- package/dist/src/apis/PricingApi.js +308 -0
- package/dist/src/apis/ProductsApi.d.ts +135 -0
- package/dist/src/apis/ProductsApi.js +531 -0
- package/dist/src/apis/ProvisioningApi.d.ts +112 -0
- package/dist/src/apis/ProvisioningApi.js +427 -0
- package/dist/src/apis/SIPTrunksApi.d.ts +315 -0
- package/dist/src/apis/SIPTrunksApi.js +1197 -0
- package/dist/src/apis/SMSApi.d.ts +30 -0
- package/dist/src/apis/SMSApi.js +130 -0
- package/dist/src/apis/ServicesApi.d.ts +81 -0
- package/dist/src/apis/ServicesApi.js +386 -0
- package/dist/src/apis/ShippingApi.d.ts +45 -0
- package/dist/src/apis/ShippingApi.js +179 -0
- package/dist/src/apis/StockManagementApi.d.ts +345 -0
- package/dist/src/apis/StockManagementApi.js +1293 -0
- package/dist/src/apis/SystemApi.d.ts +37 -0
- package/dist/src/apis/SystemApi.js +146 -0
- package/dist/src/apis/TicketsApi.d.ts +79 -0
- package/dist/src/apis/TicketsApi.js +360 -0
- package/dist/src/apis/WebhooksApi.d.ts +56 -0
- package/dist/src/apis/WebhooksApi.js +189 -0
- package/dist/src/apis/index.d.ts +21 -0
- package/dist/src/apis/index.js +39 -0
- package/dist/src/index.d.ts +3 -0
- package/dist/src/index.js +21 -0
- package/dist/src/models/AbstractOrderRequestDTO.d.ts +71 -0
- package/dist/src/models/AbstractOrderRequestDTO.js +64 -0
- package/dist/src/models/AccountContactEntity.d.ts +104 -0
- package/dist/src/models/AccountContactEntity.js +73 -0
- package/dist/src/models/AccountContactModel.d.ts +104 -0
- package/dist/src/models/AccountContactModel.js +73 -0
- package/dist/src/models/AccountContactRequestModel.d.ts +80 -0
- package/dist/src/models/AccountContactRequestModel.js +65 -0
- package/dist/src/models/AccountDetailedSummaryDTO.d.ts +89 -0
- package/dist/src/models/AccountDetailedSummaryDTO.js +70 -0
- package/dist/src/models/AccountRequestModel.d.ts +128 -0
- package/dist/src/models/AccountRequestModel.js +81 -0
- package/dist/src/models/AccountSummaryDTO.d.ts +44 -0
- package/dist/src/models/AccountSummaryDTO.js +53 -0
- package/dist/src/models/AccountsResponseModel.d.ts +51 -0
- package/dist/src/models/AccountsResponseModel.js +56 -0
- package/dist/src/models/AddressModel.d.ts +110 -0
- package/dist/src/models/AddressModel.js +75 -0
- package/dist/src/models/AddressRequestModel.d.ts +50 -0
- package/dist/src/models/AddressRequestModel.js +55 -0
- package/dist/src/models/AdminOrderRequestDTO.d.ts +113 -0
- package/dist/src/models/AdminOrderRequestDTO.js +78 -0
- package/dist/src/models/AdminUserModel.d.ts +79 -0
- package/dist/src/models/AdminUserModel.js +72 -0
- package/dist/src/models/AgentHoursGraphModel.d.ts +51 -0
- package/dist/src/models/AgentHoursGraphModel.js +56 -0
- package/dist/src/models/AgentHoursGraphMonthModel.d.ts +38 -0
- package/dist/src/models/AgentHoursGraphMonthModel.js +51 -0
- package/dist/src/models/ApiLogEntity.d.ts +98 -0
- package/dist/src/models/ApiLogEntity.js +71 -0
- package/dist/src/models/AreaCodeModel.d.ts +38 -0
- package/dist/src/models/AreaCodeModel.js +51 -0
- package/dist/src/models/AttachmentModel.d.ts +56 -0
- package/dist/src/models/AttachmentModel.js +57 -0
- package/dist/src/models/AttributeSetEnum.d.ts +38 -0
- package/dist/src/models/AttributeSetEnum.js +51 -0
- package/dist/src/models/AuditLogEntity.d.ts +80 -0
- package/dist/src/models/AuditLogEntity.js +65 -0
- package/dist/src/models/AuthCodeResponseModel.d.ts +44 -0
- package/dist/src/models/AuthCodeResponseModel.js +53 -0
- package/dist/src/models/BasicItemDTO.d.ts +38 -0
- package/dist/src/models/BasicItemDTO.js +51 -0
- package/dist/src/models/BasicProductDTO.d.ts +38 -0
- package/dist/src/models/BasicProductDTO.js +51 -0
- package/dist/src/models/BatchEntity.d.ts +128 -0
- package/dist/src/models/BatchEntity.js +81 -0
- package/dist/src/models/CallBarringModel.d.ts +56 -0
- package/dist/src/models/CallBarringModel.js +57 -0
- package/dist/src/models/ClientDetailsModel.d.ts +68 -0
- package/dist/src/models/ClientDetailsModel.js +61 -0
- package/dist/src/models/ClientModel.d.ts +50 -0
- package/dist/src/models/ClientModel.js +55 -0
- package/dist/src/models/CompanyContractModel.d.ts +56 -0
- package/dist/src/models/CompanyContractModel.js +57 -0
- package/dist/src/models/ContactInfoModel.d.ts +56 -0
- package/dist/src/models/ContactInfoModel.js +57 -0
- package/dist/src/models/ConversationModel.d.ts +75 -0
- package/dist/src/models/ConversationModel.js +64 -0
- package/dist/src/models/CourierPriceEntity.d.ts +86 -0
- package/dist/src/models/CourierPriceEntity.js +67 -0
- package/dist/src/models/CreditAccountEntity.d.ts +152 -0
- package/dist/src/models/CreditAccountEntity.js +89 -0
- package/dist/src/models/CrmContactDTO.d.ts +68 -0
- package/dist/src/models/CrmContactDTO.js +61 -0
- package/dist/src/models/CustomerInformationModel.d.ts +68 -0
- package/dist/src/models/CustomerInformationModel.js +61 -0
- package/dist/src/models/CustomerItemRequestDTO.d.ts +81 -0
- package/dist/src/models/CustomerItemRequestDTO.js +66 -0
- package/dist/src/models/CustomerOrderRequestDTO.d.ts +71 -0
- package/dist/src/models/CustomerOrderRequestDTO.js +64 -0
- package/dist/src/models/CustomerPriceListEnum.d.ts +38 -0
- package/dist/src/models/CustomerPriceListEnum.js +51 -0
- package/dist/src/models/CustomerSummaryReportDTO.d.ts +65 -0
- package/dist/src/models/CustomerSummaryReportDTO.js +62 -0
- package/dist/src/models/DdiRangeRequestModel.d.ts +44 -0
- package/dist/src/models/DdiRangeRequestModel.js +53 -0
- package/dist/src/models/DdiRangesRequestModel.d.ts +33 -0
- package/dist/src/models/DdiRangesRequestModel.js +50 -0
- package/dist/src/models/DetailedItemRequestDTO.d.ts +99 -0
- package/dist/src/models/DetailedItemRequestDTO.js +72 -0
- package/dist/src/models/DetailedOrderRequestDTO.d.ts +71 -0
- package/dist/src/models/DetailedOrderRequestDTO.js +64 -0
- package/dist/src/models/DivertRequestModel.d.ts +38 -0
- package/dist/src/models/DivertRequestModel.js +51 -0
- package/dist/src/models/DivertResponseModel.d.ts +52 -0
- package/dist/src/models/DivertResponseModel.js +61 -0
- package/dist/src/models/EdTechProClientEntity.d.ts +56 -0
- package/dist/src/models/EdTechProClientEntity.js +57 -0
- package/dist/src/models/EdTechProSchoolModel.d.ts +104 -0
- package/dist/src/models/EdTechProSchoolModel.js +73 -0
- package/dist/src/models/EdTechProSchoolsModel.d.ts +51 -0
- package/dist/src/models/EdTechProSchoolsModel.js +56 -0
- package/dist/src/models/EdTechProSetupModel.d.ts +56 -0
- package/dist/src/models/EdTechProSetupModel.js +57 -0
- package/dist/src/models/EventDTO.d.ts +84 -0
- package/dist/src/models/EventDTO.js +73 -0
- package/dist/src/models/EventRequestDTO.d.ts +44 -0
- package/dist/src/models/EventRequestDTO.js +53 -0
- package/dist/src/models/EventSubscriptionModel.d.ts +38 -0
- package/dist/src/models/EventSubscriptionModel.js +51 -0
- package/dist/src/models/EventTypeEnum.d.ts +19 -0
- package/dist/src/models/EventTypeEnum.js +24 -0
- package/dist/src/models/EventUpdateDTO.d.ts +50 -0
- package/dist/src/models/EventUpdateDTO.js +55 -0
- package/dist/src/models/EventUpdateEntity.d.ts +56 -0
- package/dist/src/models/EventUpdateEntity.js +57 -0
- package/dist/src/models/EventUpdateRequestDTO.d.ts +44 -0
- package/dist/src/models/EventUpdateRequestDTO.js +53 -0
- package/dist/src/models/FraudManagementModel.d.ts +38 -0
- package/dist/src/models/FraudManagementModel.js +51 -0
- package/dist/src/models/FreshdeskCompanyTicketsModel.d.ts +51 -0
- package/dist/src/models/FreshdeskCompanyTicketsModel.js +56 -0
- package/dist/src/models/FreshdeskTicketEntity.d.ts +68 -0
- package/dist/src/models/FreshdeskTicketEntity.js +61 -0
- package/dist/src/models/FtpAccountsEntity.d.ts +56 -0
- package/dist/src/models/FtpAccountsEntity.js +57 -0
- package/dist/src/models/GenericFileModel.d.ts +44 -0
- package/dist/src/models/GenericFileModel.js +53 -0
- package/dist/src/models/GetGetPrice200Response.d.ts +32 -0
- package/dist/src/models/GetGetPrice200Response.js +49 -0
- package/dist/src/models/GetGetRecording200Response.d.ts +32 -0
- package/dist/src/models/GetGetRecording200Response.js +49 -0
- package/dist/src/models/HostingChangeResponseModel.d.ts +64 -0
- package/dist/src/models/HostingChangeResponseModel.js +65 -0
- package/dist/src/models/HostingRegionDTO.d.ts +59 -0
- package/dist/src/models/HostingRegionDTO.js +68 -0
- package/dist/src/models/InstanceAutoFailoverEntity.d.ts +56 -0
- package/dist/src/models/InstanceAutoFailoverEntity.js +57 -0
- package/dist/src/models/InstanceDeletionScheduleEntity.d.ts +50 -0
- package/dist/src/models/InstanceDeletionScheduleEntity.js +55 -0
- package/dist/src/models/InstanceEntity.d.ts +152 -0
- package/dist/src/models/InstanceEntity.js +89 -0
- package/dist/src/models/InstanceFailoverEntity.d.ts +92 -0
- package/dist/src/models/InstanceFailoverEntity.js +69 -0
- package/dist/src/models/InstanceMonitoringEntity.d.ts +44 -0
- package/dist/src/models/InstanceMonitoringEntity.js +53 -0
- package/dist/src/models/InstanceMonitoringLogEntity.d.ts +62 -0
- package/dist/src/models/InstanceMonitoringLogEntity.js +59 -0
- package/dist/src/models/InstanceScheduledTasksEntity.d.ts +62 -0
- package/dist/src/models/InstanceScheduledTasksEntity.js +59 -0
- package/dist/src/models/InstanceTcxDetailsEntity.d.ts +86 -0
- package/dist/src/models/InstanceTcxDetailsEntity.js +67 -0
- package/dist/src/models/InstanceUserCredentialsEntity.d.ts +56 -0
- package/dist/src/models/InstanceUserCredentialsEntity.js +57 -0
- package/dist/src/models/ItemDTO.d.ts +117 -0
- package/dist/src/models/ItemDTO.js +78 -0
- package/dist/src/models/ItemDiscountEntity.d.ts +77 -0
- package/dist/src/models/ItemDiscountEntity.js +70 -0
- package/dist/src/models/ItemEntity.d.ts +158 -0
- package/dist/src/models/ItemEntity.js +91 -0
- package/dist/src/models/LinkedOrderEntity.d.ts +38 -0
- package/dist/src/models/LinkedOrderEntity.js +51 -0
- package/dist/src/models/MFARequiredModel.d.ts +38 -0
- package/dist/src/models/MFARequiredModel.js +51 -0
- package/dist/src/models/MonthlyUsageModel.d.ts +38 -0
- package/dist/src/models/MonthlyUsageModel.js +51 -0
- package/dist/src/models/MultiTenantChangeResponseModel.d.ts +70 -0
- package/dist/src/models/MultiTenantChangeResponseModel.js +75 -0
- package/dist/src/models/NavigationModel.d.ts +50 -0
- package/dist/src/models/NavigationModel.js +55 -0
- package/dist/src/models/OfflineInstancesEntity.d.ts +56 -0
- package/dist/src/models/OfflineInstancesEntity.js +57 -0
- package/dist/src/models/OrderEntity.d.ts +374 -0
- package/dist/src/models/OrderEntity.js +163 -0
- package/dist/src/models/OrderRequestModel.d.ts +120 -0
- package/dist/src/models/OrderRequestModel.js +88 -0
- package/dist/src/models/OrderSummariesModel.d.ts +51 -0
- package/dist/src/models/OrderSummariesModel.js +56 -0
- package/dist/src/models/OrderSummaryDTO.d.ts +126 -0
- package/dist/src/models/OrderSummaryDTO.js +83 -0
- package/dist/src/models/OrderTotalModel.d.ts +111 -0
- package/dist/src/models/OrderTotalModel.js +100 -0
- package/dist/src/models/OrderedItemEntity.d.ts +110 -0
- package/dist/src/models/OrderedItemEntity.js +75 -0
- package/dist/src/models/PatchSetTcxWizardCnameRequest.d.ts +32 -0
- package/dist/src/models/PatchSetTcxWizardCnameRequest.js +49 -0
- package/dist/src/models/PatchUpdateAccountContactPasswordRequest.d.ts +32 -0
- package/dist/src/models/PatchUpdateAccountContactPasswordRequest.js +49 -0
- package/dist/src/models/PortalAccountModel.d.ts +171 -0
- package/dist/src/models/PortalAccountModel.js +96 -0
- package/dist/src/models/PortalLoginModel.d.ts +68 -0
- package/dist/src/models/PortalLoginModel.js +61 -0
- package/dist/src/models/PostAddWebhook200Response.d.ts +32 -0
- package/dist/src/models/PostAddWebhook200Response.js +49 -0
- package/dist/src/models/PostGetClientCredentialsRequest.d.ts +32 -0
- package/dist/src/models/PostGetClientCredentialsRequest.js +49 -0
- package/dist/src/models/PostGetProductForCustomerRequest.d.ts +50 -0
- package/dist/src/models/PostGetProductForCustomerRequest.js +55 -0
- package/dist/src/models/PostGetProductRequest.d.ts +44 -0
- package/dist/src/models/PostGetProductRequest.js +53 -0
- package/dist/src/models/PriceListItemModel.d.ts +56 -0
- package/dist/src/models/PriceListItemModel.js +57 -0
- package/dist/src/models/PrizesEntity.d.ts +62 -0
- package/dist/src/models/PrizesEntity.js +59 -0
- package/dist/src/models/ProductPriceListItemModel.d.ts +62 -0
- package/dist/src/models/ProductPriceListItemModel.js +59 -0
- package/dist/src/models/ProductSearchResultsModel.d.ts +33 -0
- package/dist/src/models/ProductSearchResultsModel.js +50 -0
- package/dist/src/models/ProductSerialInfoModel.d.ts +50 -0
- package/dist/src/models/ProductSerialInfoModel.js +55 -0
- package/dist/src/models/ProductSummaryDTO.d.ts +81 -0
- package/dist/src/models/ProductSummaryDTO.js +66 -0
- package/dist/src/models/PromoCodesEntity.d.ts +98 -0
- package/dist/src/models/PromoCodesEntity.js +71 -0
- package/dist/src/models/PromoItemsEntity.d.ts +74 -0
- package/dist/src/models/PromoItemsEntity.js +63 -0
- package/dist/src/models/ProvisioningModel.d.ts +56 -0
- package/dist/src/models/ProvisioningModel.js +57 -0
- package/dist/src/models/ProvisioningRequestEntity.d.ts +44 -0
- package/dist/src/models/ProvisioningRequestEntity.js +53 -0
- package/dist/src/models/RecordingBackupAzureModel.d.ts +50 -0
- package/dist/src/models/RecordingBackupAzureModel.js +55 -0
- package/dist/src/models/RecordingsBackupInfoDTO.d.ts +40 -0
- package/dist/src/models/RecordingsBackupInfoDTO.js +53 -0
- package/dist/src/models/ResourceNotReadyException.d.ts +44 -0
- package/dist/src/models/ResourceNotReadyException.js +53 -0
- package/dist/src/models/RootAccessModel.d.ts +44 -0
- package/dist/src/models/RootAccessModel.js +53 -0
- package/dist/src/models/S3BucketEntity.d.ts +50 -0
- package/dist/src/models/S3BucketEntity.js +55 -0
- package/dist/src/models/ScannedItemModel.d.ts +56 -0
- package/dist/src/models/ScannedItemModel.js +57 -0
- package/dist/src/models/ScopeModel.d.ts +38 -0
- package/dist/src/models/ScopeModel.js +51 -0
- package/dist/src/models/ServiceEnum.d.ts +14 -0
- package/dist/src/models/ServiceEnum.js +19 -0
- package/dist/src/models/ServiceHealthDTO.d.ts +48 -0
- package/dist/src/models/ServiceHealthDTO.js +61 -0
- package/dist/src/models/ServiceHealthEnum.d.ts +19 -0
- package/dist/src/models/ServiceHealthEnum.js +24 -0
- package/dist/src/models/ServiceStatusDTO.d.ts +60 -0
- package/dist/src/models/ServiceStatusDTO.js +65 -0
- package/dist/src/models/ServiceStatusEnum.d.ts +19 -0
- package/dist/src/models/ServiceStatusEnum.js +24 -0
- package/dist/src/models/ShipmentAddressEntity.d.ts +92 -0
- package/dist/src/models/ShipmentAddressEntity.js +69 -0
- package/dist/src/models/ShipmentEntity.d.ts +98 -0
- package/dist/src/models/ShipmentEntity.js +71 -0
- package/dist/src/models/ShipmentItemEntity.d.ts +56 -0
- package/dist/src/models/ShipmentItemEntity.js +57 -0
- package/dist/src/models/ShippingConsignmentModel.d.ts +51 -0
- package/dist/src/models/ShippingConsignmentModel.js +56 -0
- package/dist/src/models/ShippingInformationDTO.d.ts +45 -0
- package/dist/src/models/ShippingInformationDTO.js +54 -0
- package/dist/src/models/ShippingServiceDTO.d.ts +47 -0
- package/dist/src/models/ShippingServiceDTO.js +60 -0
- package/dist/src/models/ShippingServiceModel.d.ts +71 -0
- package/dist/src/models/ShippingServiceModel.js +68 -0
- package/dist/src/models/ShippingServicesModel.d.ts +33 -0
- package/dist/src/models/ShippingServicesModel.js +50 -0
- package/dist/src/models/SipTrunkChangeResponseModel.d.ts +77 -0
- package/dist/src/models/SipTrunkChangeResponseModel.js +78 -0
- package/dist/src/models/SipTrunkCreationRequestModel.d.ts +66 -0
- package/dist/src/models/SipTrunkCreationRequestModel.js +63 -0
- package/dist/src/models/SipTrunkEntity.d.ts +98 -0
- package/dist/src/models/SipTrunkEntity.js +71 -0
- package/dist/src/models/SipTrunksResponseModel.d.ts +51 -0
- package/dist/src/models/SipTrunksResponseModel.js +56 -0
- package/dist/src/models/SmsAccountEntity.d.ts +68 -0
- package/dist/src/models/SmsAccountEntity.js +61 -0
- package/dist/src/models/SmsDataModel.d.ts +33 -0
- package/dist/src/models/SmsDataModel.js +50 -0
- package/dist/src/models/SmsMessageModel.d.ts +44 -0
- package/dist/src/models/SmsMessageModel.js +53 -0
- package/dist/src/models/SmsNumbersEntity.d.ts +38 -0
- package/dist/src/models/SmsNumbersEntity.js +51 -0
- package/dist/src/models/SmsPayloadModel.d.ts +45 -0
- package/dist/src/models/SmsPayloadModel.js +54 -0
- package/dist/src/models/SmsPhoneNumberModel.d.ts +53 -0
- package/dist/src/models/SmsPhoneNumberModel.js +66 -0
- package/dist/src/models/SmsResponseModel.d.ts +67 -0
- package/dist/src/models/SmsResponseModel.js +68 -0
- package/dist/src/models/SmsWhitelistEntity.d.ts +38 -0
- package/dist/src/models/SmsWhitelistEntity.js +51 -0
- package/dist/src/models/StockOrderCourierEntity.d.ts +50 -0
- package/dist/src/models/StockOrderCourierEntity.js +55 -0
- package/dist/src/models/StockOrderDeductionModel.d.ts +50 -0
- package/dist/src/models/StockOrderDeductionModel.js +55 -0
- package/dist/src/models/StockOrderDeductionRequestModel.d.ts +38 -0
- package/dist/src/models/StockOrderDeductionRequestModel.js +51 -0
- package/dist/src/models/StockOrderDeductionsEntity.d.ts +50 -0
- package/dist/src/models/StockOrderDeductionsEntity.js +55 -0
- package/dist/src/models/StockOrderEntity.d.ts +158 -0
- package/dist/src/models/StockOrderEntity.js +91 -0
- package/dist/src/models/StockOrderItemEntity.d.ts +68 -0
- package/dist/src/models/StockOrderItemEntity.js +61 -0
- package/dist/src/models/StockOrderItemModel.d.ts +80 -0
- package/dist/src/models/StockOrderItemModel.js +65 -0
- package/dist/src/models/StockOrderItemRequestModel.d.ts +50 -0
- package/dist/src/models/StockOrderItemRequestModel.js +55 -0
- package/dist/src/models/StockOrderModel.d.ts +137 -0
- package/dist/src/models/StockOrderModel.js +97 -0
- package/dist/src/models/StockOrderProductEntity.d.ts +62 -0
- package/dist/src/models/StockOrderProductEntity.js +59 -0
- package/dist/src/models/StockOrderRequestModel.d.ts +46 -0
- package/dist/src/models/StockOrderRequestModel.js +55 -0
- package/dist/src/models/StockOrderSupplierEntity.d.ts +80 -0
- package/dist/src/models/StockOrderSupplierEntity.js +65 -0
- package/dist/src/models/StockOrderSupplierModel.d.ts +80 -0
- package/dist/src/models/StockOrderSupplierModel.js +65 -0
- package/dist/src/models/StockOrdersModel.d.ts +51 -0
- package/dist/src/models/StockOrdersModel.js +56 -0
- package/dist/src/models/StockProductModel.d.ts +120 -0
- package/dist/src/models/StockProductModel.js +81 -0
- package/dist/src/models/StockProductPriceModel.d.ts +39 -0
- package/dist/src/models/StockProductPriceModel.js +52 -0
- package/dist/src/models/StockProductSummariesModel.d.ts +51 -0
- package/dist/src/models/StockProductSummariesModel.js +56 -0
- package/dist/src/models/StockProductSummaryModel.d.ts +69 -0
- package/dist/src/models/StockProductSummaryModel.js +62 -0
- package/dist/src/models/StockTransactionsEntity.d.ts +74 -0
- package/dist/src/models/StockTransactionsEntity.js +63 -0
- package/dist/src/models/SupplierEntity.d.ts +80 -0
- package/dist/src/models/SupplierEntity.js +65 -0
- package/dist/src/models/SupplierItemEntity.d.ts +74 -0
- package/dist/src/models/SupplierItemEntity.js +63 -0
- package/dist/src/models/TcxBackupEntity.d.ts +80 -0
- package/dist/src/models/TcxBackupEntity.js +65 -0
- package/dist/src/models/TcxBackupModel.d.ts +140 -0
- package/dist/src/models/TcxBackupModel.js +85 -0
- package/dist/src/models/TcxBillingEntity.d.ts +86 -0
- package/dist/src/models/TcxBillingEntity.js +67 -0
- package/dist/src/models/TcxBulkLicenceDetailsModel.d.ts +40 -0
- package/dist/src/models/TcxBulkLicenceDetailsModel.js +53 -0
- package/dist/src/models/TcxDeadLicenceEntity.d.ts +44 -0
- package/dist/src/models/TcxDeadLicenceEntity.js +53 -0
- package/dist/src/models/TcxExtsEntity.d.ts +74 -0
- package/dist/src/models/TcxExtsEntity.js +63 -0
- package/dist/src/models/TcxHostingPricingEntity.d.ts +74 -0
- package/dist/src/models/TcxHostingPricingEntity.js +63 -0
- package/dist/src/models/TcxInstallationDetailsModel.d.ts +106 -0
- package/dist/src/models/TcxInstallationDetailsModel.js +75 -0
- package/dist/src/models/TcxInstallationModel.d.ts +200 -0
- package/dist/src/models/TcxInstallationModel.js +105 -0
- package/dist/src/models/TcxInstallationsModel.d.ts +51 -0
- package/dist/src/models/TcxInstallationsModel.js +56 -0
- package/dist/src/models/TcxKeySummaryDTO.d.ts +56 -0
- package/dist/src/models/TcxKeySummaryDTO.js +57 -0
- package/dist/src/models/TcxKeysEntity.d.ts +62 -0
- package/dist/src/models/TcxKeysEntity.js +59 -0
- package/dist/src/models/TcxLicenceDetailsErrorModel.d.ts +50 -0
- package/dist/src/models/TcxLicenceDetailsErrorModel.js +55 -0
- package/dist/src/models/TcxLicenceDetailsModel.d.ts +92 -0
- package/dist/src/models/TcxLicenceDetailsModel.js +69 -0
- package/dist/src/models/TcxMacsEntity.d.ts +44 -0
- package/dist/src/models/TcxMacsEntity.js +53 -0
- package/dist/src/models/TcxMultiTenantModel.d.ts +118 -0
- package/dist/src/models/TcxMultiTenantModel.js +83 -0
- package/dist/src/models/TcxMultiTenantUserModel.d.ts +44 -0
- package/dist/src/models/TcxMultiTenantUserModel.js +53 -0
- package/dist/src/models/TcxMultiTenantsModel.d.ts +51 -0
- package/dist/src/models/TcxMultiTenantsModel.js +56 -0
- package/dist/src/models/TcxNumbersEntity.d.ts +44 -0
- package/dist/src/models/TcxNumbersEntity.js +53 -0
- package/dist/src/models/TcxOfficeHoursEntity.d.ts +116 -0
- package/dist/src/models/TcxOfficeHoursEntity.js +77 -0
- package/dist/src/models/TcxPhoneModel.d.ts +68 -0
- package/dist/src/models/TcxPhoneModel.js +61 -0
- package/dist/src/models/TcxPhonesEntity.d.ts +62 -0
- package/dist/src/models/TcxPhonesEntity.js +59 -0
- package/dist/src/models/TcxRemoteStorageModel.d.ts +50 -0
- package/dist/src/models/TcxRemoteStorageModel.js +55 -0
- package/dist/src/models/TcxSbcDTO.d.ts +62 -0
- package/dist/src/models/TcxSbcDTO.js +59 -0
- package/dist/src/models/TcxSbcEntity.d.ts +122 -0
- package/dist/src/models/TcxSbcEntity.js +79 -0
- package/dist/src/models/TcxSbcModel.d.ts +122 -0
- package/dist/src/models/TcxSbcModel.js +79 -0
- package/dist/src/models/TcxSetupEntity.d.ts +207 -0
- package/dist/src/models/TcxSetupEntity.js +123 -0
- package/dist/src/models/TcxSetupsModel.d.ts +51 -0
- package/dist/src/models/TcxSetupsModel.js +56 -0
- package/dist/src/models/TcxSipTrunksEntity.d.ts +104 -0
- package/dist/src/models/TcxSipTrunksEntity.js +73 -0
- package/dist/src/models/TcxTemplateXmlEnum.d.ts +38 -0
- package/dist/src/models/TcxTemplateXmlEnum.js +51 -0
- package/dist/src/models/TcxUsersEntity.d.ts +62 -0
- package/dist/src/models/TcxUsersEntity.js +59 -0
- package/dist/src/models/TcxWizardConfigModel.d.ts +39 -0
- package/dist/src/models/TcxWizardConfigModel.js +52 -0
- package/dist/src/models/TcxWizardModel.d.ts +150 -0
- package/dist/src/models/TcxWizardModel.js +114 -0
- package/dist/src/models/TechSupportCompanySummaryDTO.d.ts +57 -0
- package/dist/src/models/TechSupportCompanySummaryDTO.js +58 -0
- package/dist/src/models/TelephonySupportTicketModel.d.ts +94 -0
- package/dist/src/models/TelephonySupportTicketModel.js +71 -0
- package/dist/src/models/TicketSummaryModel.d.ts +74 -0
- package/dist/src/models/TicketSummaryModel.js +63 -0
- package/dist/src/models/TicketTimeDTO.d.ts +80 -0
- package/dist/src/models/TicketTimeDTO.js +65 -0
- package/dist/src/models/TokenResponseModel.d.ts +44 -0
- package/dist/src/models/TokenResponseModel.js +53 -0
- package/dist/src/models/UpdateTypeEnum.d.ts +19 -0
- package/dist/src/models/UpdateTypeEnum.js +24 -0
- package/dist/src/models/UpgradeOrderResponseModel.d.ts +38 -0
- package/dist/src/models/UpgradeOrderResponseModel.js +51 -0
- package/dist/src/models/UpgradeRequestModel.d.ts +66 -0
- package/dist/src/models/UpgradeRequestModel.js +70 -0
- package/dist/src/models/UserEntity.d.ts +98 -0
- package/dist/src/models/UserEntity.js +71 -0
- package/dist/src/models/XeroLogEntity.d.ts +86 -0
- package/dist/src/models/XeroLogEntity.js +67 -0
- package/dist/src/models/index.d.ts +196 -0
- package/dist/src/models/index.js +214 -0
- package/dist/src/runtime.d.ts +184 -0
- package/dist/src/runtime.js +564 -0
- package/docs/AbstractOrderRequestDTO.md +0 -0
- package/docs/AccountContactEntity.md +0 -0
- package/docs/AccountContactModel.md +0 -0
- package/docs/AccountContactRequestModel.md +0 -0
- package/docs/AccountDetailedSummaryDTO.md +0 -0
- package/docs/AccountRequestModel.md +0 -0
- package/docs/AccountSummaryDTO.md +0 -0
- package/docs/AccountsApi.md +0 -0
- package/docs/AccountsResponseModel.md +0 -0
- package/docs/AddressModel.md +0 -0
- package/docs/AddressRequestModel.md +0 -0
- package/docs/AdminOrderRequestDTO.md +0 -0
- package/docs/AdminUserModel.md +0 -0
- package/docs/AgentHoursGraphModel.md +0 -0
- package/docs/AgentHoursGraphMonthModel.md +0 -0
- package/docs/ApiLogEntity.md +0 -0
- package/docs/AreaCodeModel.md +0 -0
- package/docs/AttachmentModel.md +0 -0
- package/docs/AttributeSetEnum.md +0 -0
- package/docs/AuditLogEntity.md +0 -0
- package/docs/AuthCodeResponseModel.md +0 -0
- package/docs/BasicItemDTO.md +0 -0
- package/docs/BasicProductDTO.md +0 -0
- package/docs/BatchEntity.md +0 -0
- package/docs/CRMApi.md +0 -0
- package/docs/CallBarringModel.md +0 -0
- package/docs/Class3CXApi.md +0 -0
- package/docs/Class3CXInstallationWizardApi.md +0 -0
- package/docs/Class3CXInstallationsApi.md +0 -0
- package/docs/Class3CXIntegrationsApi.md +0 -0
- package/docs/Class3CXMultiTenantApi.md +55 -0
- package/docs/ClientDetailsModel.md +0 -0
- package/docs/ClientModel.md +0 -0
- package/docs/CompanyContractModel.md +0 -0
- package/docs/ContactInfoModel.md +0 -0
- package/docs/ConversationModel.md +0 -0
- package/docs/CourierPriceEntity.md +0 -0
- package/docs/CreditAccountEntity.md +0 -0
- package/docs/CrmContactDTO.md +0 -0
- package/docs/CustomerInformationModel.md +0 -0
- package/docs/CustomerItemRequestDTO.md +0 -0
- package/docs/CustomerOrderRequestDTO.md +0 -0
- package/docs/CustomerPriceListEnum.md +0 -0
- package/docs/CustomerSummaryReportDTO.md +0 -0
- package/docs/DdiRangeRequestModel.md +0 -0
- package/docs/DdiRangesRequestModel.md +0 -0
- package/docs/DetailedItemRequestDTO.md +0 -0
- package/docs/DetailedOrderRequestDTO.md +0 -0
- package/docs/DivertRequestModel.md +0 -0
- package/docs/DivertResponseModel.md +0 -0
- package/docs/EdTechProClientEntity.md +0 -0
- package/docs/EdTechProSchoolModel.md +0 -0
- package/docs/EdTechProSchoolsModel.md +0 -0
- package/docs/EdTechProSetupModel.md +0 -0
- package/docs/EventDTO.md +0 -0
- package/docs/EventRequestDTO.md +0 -0
- package/docs/EventSubscriptionModel.md +0 -0
- package/docs/EventUpdateDTO.md +0 -0
- package/docs/EventUpdateEntity.md +0 -0
- package/docs/EventUpdateRequestDTO.md +0 -0
- package/docs/FraudManagementModel.md +0 -0
- package/docs/FreshdeskCompanyTicketsModel.md +0 -0
- package/docs/FreshdeskTicketEntity.md +0 -0
- package/docs/FtpAccountsEntity.md +0 -0
- package/docs/GenericFileModel.md +0 -0
- package/docs/GetGetPrice200Response.md +0 -0
- package/docs/GetGetRecording200Response.md +0 -0
- package/docs/HostingChangeResponseModel.md +0 -0
- package/docs/HostingRegionDTO.md +0 -0
- package/docs/InstanceAutoFailoverEntity.md +0 -0
- package/docs/InstanceDeletionScheduleEntity.md +0 -0
- package/docs/InstanceEntity.md +0 -0
- package/docs/InstanceFailoverEntity.md +0 -0
- package/docs/InstanceMonitoringEntity.md +0 -0
- package/docs/InstanceMonitoringLogEntity.md +0 -0
- package/docs/InstanceScheduledTasksEntity.md +0 -0
- package/docs/InstanceTcxDetailsEntity.md +0 -0
- package/docs/InstanceUserCredentialsEntity.md +0 -0
- package/docs/ItemDTO.md +0 -0
- package/docs/ItemDiscountEntity.md +0 -0
- package/docs/ItemEntity.md +0 -0
- package/docs/LinkedOrderEntity.md +0 -0
- package/docs/MFARequiredModel.md +0 -0
- package/docs/MonthlyUsageModel.md +0 -0
- package/docs/MultiTenantChangeResponseModel.md +0 -0
- package/docs/MyPBXToolsApi.md +0 -0
- package/docs/NavigationModel.md +0 -0
- package/docs/NumberPortDTO.md +53 -0
- package/docs/NumberPortModel.md +51 -0
- package/docs/NumberPortRangeDTO.md +33 -0
- package/docs/NumberPortRangeRequestDTO.md +27 -0
- package/docs/NumberPortingApi.md +614 -0
- package/docs/NumberPortsModel.md +27 -0
- package/docs/OAuth20Api.md +3 -3
- package/docs/OfflineInstancesEntity.md +0 -0
- package/docs/OrderEntity.md +0 -0
- package/docs/OrderRequestModel.md +0 -0
- package/docs/OrderSummariesModel.md +0 -0
- package/docs/OrderSummaryDTO.md +0 -0
- package/docs/OrderTotalModel.md +0 -0
- package/docs/OrderedItemEntity.md +0 -0
- package/docs/OrdersApi.md +0 -0
- package/docs/PatchSetTcxWizardCnameRequest.md +0 -0
- package/docs/PatchUpdateAccountContactPasswordRequest.md +0 -0
- package/docs/PortalAccountModel.md +0 -0
- package/docs/PortalLoginModel.md +0 -0
- package/docs/PostAddWebhook200Response.md +0 -0
- package/docs/PostGetClientCredentialsRequest.md +0 -0
- package/docs/PostGetProductForCustomerRequest.md +0 -0
- package/docs/PostGetProductRequest.md +0 -0
- package/docs/PriceListItemModel.md +0 -0
- package/docs/PricingApi.md +0 -0
- package/docs/PrizesEntity.md +0 -0
- package/docs/ProductPriceListItemModel.md +0 -0
- package/docs/ProductSearchResultsModel.md +0 -0
- package/docs/ProductSerialInfoModel.md +0 -0
- package/docs/ProductSummaryDTO.md +0 -0
- package/docs/ProductsApi.md +0 -0
- package/docs/PromoCodesEntity.md +0 -0
- package/docs/PromoItemsEntity.md +0 -0
- package/docs/ProvisioningApi.md +0 -0
- package/docs/ProvisioningModel.md +0 -0
- package/docs/ProvisioningRequestEntity.md +0 -0
- package/docs/RecordingBackupAzureModel.md +0 -0
- package/docs/RecordingsBackupInfoDTO.md +0 -0
- package/docs/ResourceNotReadyException.md +0 -0
- package/docs/RootAccessModel.md +0 -0
- package/docs/S3BucketEntity.md +0 -0
- package/docs/SIPTrunksApi.md +55 -0
- package/docs/SMSApi.md +0 -0
- package/docs/ScannedItemModel.md +0 -0
- package/docs/ScopeModel.md +0 -0
- package/docs/ServiceHealthDTO.md +0 -0
- package/docs/ServiceStatusDTO.md +0 -0
- package/docs/ServicesApi.md +0 -0
- package/docs/ShipmentAddressEntity.md +0 -0
- package/docs/ShipmentEntity.md +0 -0
- package/docs/ShipmentItemEntity.md +0 -0
- package/docs/ShippingApi.md +0 -0
- package/docs/ShippingConsignmentModel.md +0 -0
- package/docs/ShippingInformationDTO.md +0 -0
- package/docs/ShippingServiceDTO.md +0 -0
- package/docs/ShippingServiceModel.md +0 -0
- package/docs/ShippingServicesModel.md +0 -0
- package/docs/SipTrunkChangeResponseModel.md +0 -0
- package/docs/SipTrunkCreationRequestModel.md +0 -0
- package/docs/SipTrunkEntity.md +0 -0
- package/docs/SipTrunksResponseModel.md +0 -0
- package/docs/SmsAccountEntity.md +0 -0
- package/docs/SmsDataModel.md +0 -0
- package/docs/SmsMessageModel.md +0 -0
- package/docs/SmsNumbersEntity.md +0 -0
- package/docs/SmsPayloadModel.md +0 -0
- package/docs/SmsPhoneNumberModel.md +0 -0
- package/docs/SmsResponseModel.md +0 -0
- package/docs/SmsWhitelistEntity.md +0 -0
- package/docs/StockManagementApi.md +0 -0
- package/docs/StockOrderCourierEntity.md +0 -0
- package/docs/StockOrderDeductionModel.md +0 -0
- package/docs/StockOrderDeductionRequestModel.md +0 -0
- package/docs/StockOrderDeductionsEntity.md +0 -0
- package/docs/StockOrderEntity.md +0 -0
- package/docs/StockOrderItemEntity.md +0 -0
- package/docs/StockOrderItemModel.md +0 -0
- package/docs/StockOrderItemRequestModel.md +0 -0
- package/docs/StockOrderModel.md +0 -0
- package/docs/StockOrderProductEntity.md +0 -0
- package/docs/StockOrderRequestModel.md +0 -0
- package/docs/StockOrderSupplierEntity.md +0 -0
- package/docs/StockOrderSupplierModel.md +0 -0
- package/docs/StockOrdersModel.md +0 -0
- package/docs/StockProductModel.md +0 -0
- package/docs/StockProductPriceModel.md +0 -0
- package/docs/StockProductSummariesModel.md +0 -0
- package/docs/StockProductSummaryModel.md +0 -0
- package/docs/StockTransactionsEntity.md +0 -0
- package/docs/SupplierEntity.md +0 -0
- package/docs/SupplierItemEntity.md +0 -0
- package/docs/{TelephonySupportTicketModel.md → SupportTicketModel.md} +3 -3
- package/docs/SystemApi.md +0 -0
- package/docs/TcxBackupEntity.md +0 -0
- package/docs/TcxBackupModel.md +0 -0
- package/docs/TcxBillingEntity.md +0 -0
- package/docs/TcxBulkLicenceDetailsModel.md +0 -0
- package/docs/TcxDeadLicenceEntity.md +0 -0
- package/docs/TcxExtsEntity.md +0 -0
- package/docs/TcxHostingPricingEntity.md +0 -0
- package/docs/TcxInstallationDetailsModel.md +0 -0
- package/docs/TcxInstallationModel.md +0 -0
- package/docs/TcxInstallationsModel.md +0 -0
- package/docs/TcxKeySummaryDTO.md +0 -0
- package/docs/TcxKeysEntity.md +0 -0
- package/docs/TcxLicenceDetailsErrorModel.md +0 -0
- package/docs/TcxLicenceDetailsModel.md +0 -0
- package/docs/TcxMacsEntity.md +0 -0
- package/docs/TcxMultiTenantModel.md +0 -0
- package/docs/TcxMultiTenantUserModel.md +0 -0
- package/docs/TcxMultiTenantsModel.md +0 -0
- package/docs/TcxNumbersEntity.md +0 -0
- package/docs/TcxOfficeHoursEntity.md +0 -0
- package/docs/TcxPhoneModel.md +0 -0
- package/docs/TcxPhonesEntity.md +0 -0
- package/docs/TcxRemoteStorageModel.md +0 -0
- package/docs/TcxSbcDTO.md +0 -0
- package/docs/TcxSbcEntity.md +0 -0
- package/docs/TcxSbcModel.md +0 -0
- package/docs/TcxSetupEntity.md +0 -0
- package/docs/TcxSetupsModel.md +0 -0
- package/docs/TcxSipTrunksEntity.md +0 -0
- package/docs/TcxTemplateXmlEnum.md +0 -0
- package/docs/TcxUsersEntity.md +0 -0
- package/docs/TcxWizardConfigModel.md +0 -0
- package/docs/TcxWizardModel.md +0 -0
- package/docs/TechSupportCompanySummaryDTO.md +0 -0
- package/docs/TicketSummaryModel.md +0 -0
- package/docs/TicketTimeDTO.md +0 -0
- package/docs/TicketsApi.md +8 -8
- package/docs/TokenResponseModel.md +0 -0
- package/docs/UpgradeOrderResponseModel.md +0 -0
- package/docs/UpgradeRequestModel.md +0 -0
- package/docs/UserEntity.md +0 -0
- package/docs/WebhooksApi.md +0 -0
- package/docs/XeroLogEntity.md +0 -0
- package/getEnums.php +31 -31
- package/git_push.sh +0 -0
- package/index.ts +1 -1
- package/models/EventTypeEnum.ts +0 -0
- package/models/ServiceEnum.ts +0 -0
- package/models/ServiceHealthEnum.ts +0 -0
- package/models/ServiceStatusEnum.ts +0 -0
- package/models/UpdateTypeEnum.ts +0 -0
- package/openapitools.json +1 -1
- package/package.json +1 -1
- package/tsconfig.json +0 -0
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Yellowgrid
|
|
3
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { EdTechProClientEntity, EdTechProSchoolsModel, EdTechProSetupModel, GetGetPrice200Response, OrderRequestModel, UpgradeOrderResponseModel, UpgradeRequestModel } from '../models/index';
|
|
14
|
+
export interface GetGetPriceRequest {
|
|
15
|
+
licenceType: GetGetPriceLicenceTypeEnum;
|
|
16
|
+
schoolType: GetGetPriceSchoolTypeEnum;
|
|
17
|
+
}
|
|
18
|
+
export interface GetGetSchoolsRequest {
|
|
19
|
+
pageSize?: number;
|
|
20
|
+
page?: number;
|
|
21
|
+
search?: string;
|
|
22
|
+
}
|
|
23
|
+
export interface PatchUpdateEtpOrderReferenceRequest {
|
|
24
|
+
clientId: number;
|
|
25
|
+
schoolId: number;
|
|
26
|
+
ref: string;
|
|
27
|
+
}
|
|
28
|
+
export interface PostOrderEdTechProRequest {
|
|
29
|
+
orderRequestModel?: OrderRequestModel;
|
|
30
|
+
}
|
|
31
|
+
export interface PostUpgradeEdTechProRequest {
|
|
32
|
+
upgradeRequestModel?: UpgradeRequestModel;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
*/
|
|
37
|
+
export declare class Class3CXIntegrationsApi extends runtime.BaseAPI {
|
|
38
|
+
/**
|
|
39
|
+
* Get EdTechPro Schools
|
|
40
|
+
*/
|
|
41
|
+
getGetPriceRaw(requestParameters: GetGetPriceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetGetPrice200Response>>;
|
|
42
|
+
/**
|
|
43
|
+
* Get EdTechPro Schools
|
|
44
|
+
*/
|
|
45
|
+
getGetPrice(requestParameters: GetGetPriceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetGetPrice200Response>;
|
|
46
|
+
/**
|
|
47
|
+
* Get EdTechPro Schools
|
|
48
|
+
*/
|
|
49
|
+
getGetSchoolsRaw(requestParameters: GetGetSchoolsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EdTechProSchoolsModel>>;
|
|
50
|
+
/**
|
|
51
|
+
* Get EdTechPro Schools
|
|
52
|
+
*/
|
|
53
|
+
getGetSchools(requestParameters?: GetGetSchoolsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EdTechProSchoolsModel>;
|
|
54
|
+
/**
|
|
55
|
+
* Get EdTechPro Trusts
|
|
56
|
+
*/
|
|
57
|
+
getGetTrustsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<EdTechProClientEntity>>>;
|
|
58
|
+
/**
|
|
59
|
+
* Get EdTechPro Trusts
|
|
60
|
+
*/
|
|
61
|
+
getGetTrusts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<EdTechProClientEntity>>;
|
|
62
|
+
/**
|
|
63
|
+
* Update EdTechPro School Order Reference
|
|
64
|
+
*/
|
|
65
|
+
patchUpdateEtpOrderReferenceRaw(requestParameters: PatchUpdateEtpOrderReferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
66
|
+
/**
|
|
67
|
+
* Update EdTechPro School Order Reference
|
|
68
|
+
*/
|
|
69
|
+
patchUpdateEtpOrderReference(requestParameters: PatchUpdateEtpOrderReferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
70
|
+
/**
|
|
71
|
+
* Setup a new EdTechPro Integration
|
|
72
|
+
*/
|
|
73
|
+
postOrderEdTechProRaw(requestParameters: PostOrderEdTechProRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EdTechProSetupModel>>;
|
|
74
|
+
/**
|
|
75
|
+
* Setup a new EdTechPro Integration
|
|
76
|
+
*/
|
|
77
|
+
postOrderEdTechPro(requestParameters?: PostOrderEdTechProRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EdTechProSetupModel>;
|
|
78
|
+
/**
|
|
79
|
+
* Upgrade an existing EdTechPro Integration
|
|
80
|
+
*/
|
|
81
|
+
postUpgradeEdTechProRaw(requestParameters: PostUpgradeEdTechProRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpgradeOrderResponseModel>>;
|
|
82
|
+
/**
|
|
83
|
+
* Upgrade an existing EdTechPro Integration
|
|
84
|
+
*/
|
|
85
|
+
postUpgradeEdTechPro(requestParameters?: PostUpgradeEdTechProRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpgradeOrderResponseModel>;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* @export
|
|
89
|
+
*/
|
|
90
|
+
export declare const GetGetPriceLicenceTypeEnum: {
|
|
91
|
+
readonly Lite: "lite";
|
|
92
|
+
readonly Pro: "pro";
|
|
93
|
+
};
|
|
94
|
+
export type GetGetPriceLicenceTypeEnum = typeof GetGetPriceLicenceTypeEnum[keyof typeof GetGetPriceLicenceTypeEnum];
|
|
95
|
+
/**
|
|
96
|
+
* @export
|
|
97
|
+
*/
|
|
98
|
+
export declare const GetGetPriceSchoolTypeEnum: {
|
|
99
|
+
readonly Primary: "primary";
|
|
100
|
+
readonly Secondary: "secondary";
|
|
101
|
+
};
|
|
102
|
+
export type GetGetPriceSchoolTypeEnum = typeof GetGetPriceSchoolTypeEnum[keyof typeof GetGetPriceSchoolTypeEnum];
|
|
@@ -0,0 +1,386 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Yellowgrid
|
|
6
|
+
* 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.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __extends = (this && this.__extends) || (function () {
|
|
16
|
+
var extendStatics = function (d, b) {
|
|
17
|
+
extendStatics = Object.setPrototypeOf ||
|
|
18
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
19
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
20
|
+
return extendStatics(d, b);
|
|
21
|
+
};
|
|
22
|
+
return function (d, b) {
|
|
23
|
+
if (typeof b !== "function" && b !== null)
|
|
24
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
25
|
+
extendStatics(d, b);
|
|
26
|
+
function __() { this.constructor = d; }
|
|
27
|
+
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
28
|
+
};
|
|
29
|
+
})();
|
|
30
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
31
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
32
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
33
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
34
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
35
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
36
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
37
|
+
});
|
|
38
|
+
};
|
|
39
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
40
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
|
|
41
|
+
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
42
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
43
|
+
function step(op) {
|
|
44
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
45
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
46
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
47
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
48
|
+
switch (op[0]) {
|
|
49
|
+
case 0: case 1: t = op; break;
|
|
50
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
51
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
52
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
53
|
+
default:
|
|
54
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
55
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
56
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
57
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
58
|
+
if (t[2]) _.ops.pop();
|
|
59
|
+
_.trys.pop(); continue;
|
|
60
|
+
}
|
|
61
|
+
op = body.call(thisArg, _);
|
|
62
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
63
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
64
|
+
}
|
|
65
|
+
};
|
|
66
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
67
|
+
exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = void 0;
|
|
68
|
+
var runtime = require("../runtime");
|
|
69
|
+
var index_1 = require("../models/index");
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
*/
|
|
73
|
+
var Class3CXIntegrationsApi = /** @class */ (function (_super) {
|
|
74
|
+
__extends(Class3CXIntegrationsApi, _super);
|
|
75
|
+
function Class3CXIntegrationsApi() {
|
|
76
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Get EdTechPro Schools
|
|
80
|
+
*/
|
|
81
|
+
Class3CXIntegrationsApi.prototype.getGetPriceRaw = function (requestParameters, initOverrides) {
|
|
82
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
83
|
+
var queryParameters, headerParameters, urlPath, response;
|
|
84
|
+
return __generator(this, function (_a) {
|
|
85
|
+
switch (_a.label) {
|
|
86
|
+
case 0:
|
|
87
|
+
if (requestParameters['licenceType'] == null) {
|
|
88
|
+
throw new runtime.RequiredError('licenceType', 'Required parameter "licenceType" was null or undefined when calling getGetPrice().');
|
|
89
|
+
}
|
|
90
|
+
if (requestParameters['schoolType'] == null) {
|
|
91
|
+
throw new runtime.RequiredError('schoolType', 'Required parameter "schoolType" was null or undefined when calling getGetPrice().');
|
|
92
|
+
}
|
|
93
|
+
queryParameters = {};
|
|
94
|
+
if (requestParameters['licenceType'] != null) {
|
|
95
|
+
queryParameters['licenceType'] = requestParameters['licenceType'];
|
|
96
|
+
}
|
|
97
|
+
if (requestParameters['schoolType'] != null) {
|
|
98
|
+
queryParameters['schoolType'] = requestParameters['schoolType'];
|
|
99
|
+
}
|
|
100
|
+
headerParameters = {};
|
|
101
|
+
urlPath = "/tcx/integrations/edtechpro/prices";
|
|
102
|
+
return [4 /*yield*/, this.request({
|
|
103
|
+
path: urlPath,
|
|
104
|
+
method: 'GET',
|
|
105
|
+
headers: headerParameters,
|
|
106
|
+
query: queryParameters,
|
|
107
|
+
}, initOverrides)];
|
|
108
|
+
case 1:
|
|
109
|
+
response = _a.sent();
|
|
110
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.GetGetPrice200ResponseFromJSON)(jsonValue); })];
|
|
111
|
+
}
|
|
112
|
+
});
|
|
113
|
+
});
|
|
114
|
+
};
|
|
115
|
+
/**
|
|
116
|
+
* Get EdTechPro Schools
|
|
117
|
+
*/
|
|
118
|
+
Class3CXIntegrationsApi.prototype.getGetPrice = function (requestParameters, initOverrides) {
|
|
119
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
120
|
+
var response;
|
|
121
|
+
return __generator(this, function (_a) {
|
|
122
|
+
switch (_a.label) {
|
|
123
|
+
case 0: return [4 /*yield*/, this.getGetPriceRaw(requestParameters, initOverrides)];
|
|
124
|
+
case 1:
|
|
125
|
+
response = _a.sent();
|
|
126
|
+
return [4 /*yield*/, response.value()];
|
|
127
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
128
|
+
}
|
|
129
|
+
});
|
|
130
|
+
});
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* Get EdTechPro Schools
|
|
134
|
+
*/
|
|
135
|
+
Class3CXIntegrationsApi.prototype.getGetSchoolsRaw = function (requestParameters, initOverrides) {
|
|
136
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
137
|
+
var queryParameters, headerParameters, urlPath, response;
|
|
138
|
+
return __generator(this, function (_a) {
|
|
139
|
+
switch (_a.label) {
|
|
140
|
+
case 0:
|
|
141
|
+
queryParameters = {};
|
|
142
|
+
if (requestParameters['pageSize'] != null) {
|
|
143
|
+
queryParameters['pageSize'] = requestParameters['pageSize'];
|
|
144
|
+
}
|
|
145
|
+
if (requestParameters['page'] != null) {
|
|
146
|
+
queryParameters['page'] = requestParameters['page'];
|
|
147
|
+
}
|
|
148
|
+
if (requestParameters['search'] != null) {
|
|
149
|
+
queryParameters['search'] = requestParameters['search'];
|
|
150
|
+
}
|
|
151
|
+
headerParameters = {};
|
|
152
|
+
urlPath = "/tcx/integrations/edtechpro/schools";
|
|
153
|
+
return [4 /*yield*/, this.request({
|
|
154
|
+
path: urlPath,
|
|
155
|
+
method: 'GET',
|
|
156
|
+
headers: headerParameters,
|
|
157
|
+
query: queryParameters,
|
|
158
|
+
}, initOverrides)];
|
|
159
|
+
case 1:
|
|
160
|
+
response = _a.sent();
|
|
161
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.EdTechProSchoolsModelFromJSON)(jsonValue); })];
|
|
162
|
+
}
|
|
163
|
+
});
|
|
164
|
+
});
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* Get EdTechPro Schools
|
|
168
|
+
*/
|
|
169
|
+
Class3CXIntegrationsApi.prototype.getGetSchools = function () {
|
|
170
|
+
return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
|
|
171
|
+
var response;
|
|
172
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
173
|
+
return __generator(this, function (_a) {
|
|
174
|
+
switch (_a.label) {
|
|
175
|
+
case 0: return [4 /*yield*/, this.getGetSchoolsRaw(requestParameters, initOverrides)];
|
|
176
|
+
case 1:
|
|
177
|
+
response = _a.sent();
|
|
178
|
+
return [4 /*yield*/, response.value()];
|
|
179
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
180
|
+
}
|
|
181
|
+
});
|
|
182
|
+
});
|
|
183
|
+
};
|
|
184
|
+
/**
|
|
185
|
+
* Get EdTechPro Trusts
|
|
186
|
+
*/
|
|
187
|
+
Class3CXIntegrationsApi.prototype.getGetTrustsRaw = function (initOverrides) {
|
|
188
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
189
|
+
var queryParameters, headerParameters, urlPath, response;
|
|
190
|
+
return __generator(this, function (_a) {
|
|
191
|
+
switch (_a.label) {
|
|
192
|
+
case 0:
|
|
193
|
+
queryParameters = {};
|
|
194
|
+
headerParameters = {};
|
|
195
|
+
urlPath = "/tcx/integrations/edtechpro/trusts";
|
|
196
|
+
return [4 /*yield*/, this.request({
|
|
197
|
+
path: urlPath,
|
|
198
|
+
method: 'GET',
|
|
199
|
+
headers: headerParameters,
|
|
200
|
+
query: queryParameters,
|
|
201
|
+
}, initOverrides)];
|
|
202
|
+
case 1:
|
|
203
|
+
response = _a.sent();
|
|
204
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.EdTechProClientEntityFromJSON); })];
|
|
205
|
+
}
|
|
206
|
+
});
|
|
207
|
+
});
|
|
208
|
+
};
|
|
209
|
+
/**
|
|
210
|
+
* Get EdTechPro Trusts
|
|
211
|
+
*/
|
|
212
|
+
Class3CXIntegrationsApi.prototype.getGetTrusts = function (initOverrides) {
|
|
213
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
214
|
+
var response;
|
|
215
|
+
return __generator(this, function (_a) {
|
|
216
|
+
switch (_a.label) {
|
|
217
|
+
case 0: return [4 /*yield*/, this.getGetTrustsRaw(initOverrides)];
|
|
218
|
+
case 1:
|
|
219
|
+
response = _a.sent();
|
|
220
|
+
return [4 /*yield*/, response.value()];
|
|
221
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
222
|
+
}
|
|
223
|
+
});
|
|
224
|
+
});
|
|
225
|
+
};
|
|
226
|
+
/**
|
|
227
|
+
* Update EdTechPro School Order Reference
|
|
228
|
+
*/
|
|
229
|
+
Class3CXIntegrationsApi.prototype.patchUpdateEtpOrderReferenceRaw = function (requestParameters, initOverrides) {
|
|
230
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
231
|
+
var queryParameters, headerParameters, urlPath, response;
|
|
232
|
+
return __generator(this, function (_a) {
|
|
233
|
+
switch (_a.label) {
|
|
234
|
+
case 0:
|
|
235
|
+
if (requestParameters['clientId'] == null) {
|
|
236
|
+
throw new runtime.RequiredError('clientId', 'Required parameter "clientId" was null or undefined when calling patchUpdateEtpOrderReference().');
|
|
237
|
+
}
|
|
238
|
+
if (requestParameters['schoolId'] == null) {
|
|
239
|
+
throw new runtime.RequiredError('schoolId', 'Required parameter "schoolId" was null or undefined when calling patchUpdateEtpOrderReference().');
|
|
240
|
+
}
|
|
241
|
+
if (requestParameters['ref'] == null) {
|
|
242
|
+
throw new runtime.RequiredError('ref', 'Required parameter "ref" was null or undefined when calling patchUpdateEtpOrderReference().');
|
|
243
|
+
}
|
|
244
|
+
queryParameters = {};
|
|
245
|
+
if (requestParameters['ref'] != null) {
|
|
246
|
+
queryParameters['ref'] = requestParameters['ref'];
|
|
247
|
+
}
|
|
248
|
+
headerParameters = {};
|
|
249
|
+
urlPath = "/tcx/integrations/edtechpro/{clientId}/schools/{schoolId}/orderReference";
|
|
250
|
+
urlPath = urlPath.replace("{".concat("clientId", "}"), encodeURIComponent(String(requestParameters['clientId'])));
|
|
251
|
+
urlPath = urlPath.replace("{".concat("schoolId", "}"), encodeURIComponent(String(requestParameters['schoolId'])));
|
|
252
|
+
return [4 /*yield*/, this.request({
|
|
253
|
+
path: urlPath,
|
|
254
|
+
method: 'PATCH',
|
|
255
|
+
headers: headerParameters,
|
|
256
|
+
query: queryParameters,
|
|
257
|
+
}, initOverrides)];
|
|
258
|
+
case 1:
|
|
259
|
+
response = _a.sent();
|
|
260
|
+
return [2 /*return*/, new runtime.VoidApiResponse(response)];
|
|
261
|
+
}
|
|
262
|
+
});
|
|
263
|
+
});
|
|
264
|
+
};
|
|
265
|
+
/**
|
|
266
|
+
* Update EdTechPro School Order Reference
|
|
267
|
+
*/
|
|
268
|
+
Class3CXIntegrationsApi.prototype.patchUpdateEtpOrderReference = function (requestParameters, initOverrides) {
|
|
269
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
270
|
+
return __generator(this, function (_a) {
|
|
271
|
+
switch (_a.label) {
|
|
272
|
+
case 0: return [4 /*yield*/, this.patchUpdateEtpOrderReferenceRaw(requestParameters, initOverrides)];
|
|
273
|
+
case 1:
|
|
274
|
+
_a.sent();
|
|
275
|
+
return [2 /*return*/];
|
|
276
|
+
}
|
|
277
|
+
});
|
|
278
|
+
});
|
|
279
|
+
};
|
|
280
|
+
/**
|
|
281
|
+
* Setup a new EdTechPro Integration
|
|
282
|
+
*/
|
|
283
|
+
Class3CXIntegrationsApi.prototype.postOrderEdTechProRaw = function (requestParameters, initOverrides) {
|
|
284
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
285
|
+
var queryParameters, headerParameters, urlPath, response;
|
|
286
|
+
return __generator(this, function (_a) {
|
|
287
|
+
switch (_a.label) {
|
|
288
|
+
case 0:
|
|
289
|
+
queryParameters = {};
|
|
290
|
+
headerParameters = {};
|
|
291
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
292
|
+
urlPath = "/tcx/integrations/edtechpro/orders";
|
|
293
|
+
return [4 /*yield*/, this.request({
|
|
294
|
+
path: urlPath,
|
|
295
|
+
method: 'POST',
|
|
296
|
+
headers: headerParameters,
|
|
297
|
+
query: queryParameters,
|
|
298
|
+
body: (0, index_1.OrderRequestModelToJSON)(requestParameters['orderRequestModel']),
|
|
299
|
+
}, initOverrides)];
|
|
300
|
+
case 1:
|
|
301
|
+
response = _a.sent();
|
|
302
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.EdTechProSetupModelFromJSON)(jsonValue); })];
|
|
303
|
+
}
|
|
304
|
+
});
|
|
305
|
+
});
|
|
306
|
+
};
|
|
307
|
+
/**
|
|
308
|
+
* Setup a new EdTechPro Integration
|
|
309
|
+
*/
|
|
310
|
+
Class3CXIntegrationsApi.prototype.postOrderEdTechPro = function () {
|
|
311
|
+
return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
|
|
312
|
+
var response;
|
|
313
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
314
|
+
return __generator(this, function (_a) {
|
|
315
|
+
switch (_a.label) {
|
|
316
|
+
case 0: return [4 /*yield*/, this.postOrderEdTechProRaw(requestParameters, initOverrides)];
|
|
317
|
+
case 1:
|
|
318
|
+
response = _a.sent();
|
|
319
|
+
return [4 /*yield*/, response.value()];
|
|
320
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
321
|
+
}
|
|
322
|
+
});
|
|
323
|
+
});
|
|
324
|
+
};
|
|
325
|
+
/**
|
|
326
|
+
* Upgrade an existing EdTechPro Integration
|
|
327
|
+
*/
|
|
328
|
+
Class3CXIntegrationsApi.prototype.postUpgradeEdTechProRaw = function (requestParameters, initOverrides) {
|
|
329
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
330
|
+
var queryParameters, headerParameters, urlPath, response;
|
|
331
|
+
return __generator(this, function (_a) {
|
|
332
|
+
switch (_a.label) {
|
|
333
|
+
case 0:
|
|
334
|
+
queryParameters = {};
|
|
335
|
+
headerParameters = {};
|
|
336
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
337
|
+
urlPath = "/tcx/integrations/edtechpro/upgrades";
|
|
338
|
+
return [4 /*yield*/, this.request({
|
|
339
|
+
path: urlPath,
|
|
340
|
+
method: 'POST',
|
|
341
|
+
headers: headerParameters,
|
|
342
|
+
query: queryParameters,
|
|
343
|
+
body: (0, index_1.UpgradeRequestModelToJSON)(requestParameters['upgradeRequestModel']),
|
|
344
|
+
}, initOverrides)];
|
|
345
|
+
case 1:
|
|
346
|
+
response = _a.sent();
|
|
347
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.UpgradeOrderResponseModelFromJSON)(jsonValue); })];
|
|
348
|
+
}
|
|
349
|
+
});
|
|
350
|
+
});
|
|
351
|
+
};
|
|
352
|
+
/**
|
|
353
|
+
* Upgrade an existing EdTechPro Integration
|
|
354
|
+
*/
|
|
355
|
+
Class3CXIntegrationsApi.prototype.postUpgradeEdTechPro = function () {
|
|
356
|
+
return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
|
|
357
|
+
var response;
|
|
358
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
359
|
+
return __generator(this, function (_a) {
|
|
360
|
+
switch (_a.label) {
|
|
361
|
+
case 0: return [4 /*yield*/, this.postUpgradeEdTechProRaw(requestParameters, initOverrides)];
|
|
362
|
+
case 1:
|
|
363
|
+
response = _a.sent();
|
|
364
|
+
return [4 /*yield*/, response.value()];
|
|
365
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
366
|
+
}
|
|
367
|
+
});
|
|
368
|
+
});
|
|
369
|
+
};
|
|
370
|
+
return Class3CXIntegrationsApi;
|
|
371
|
+
}(runtime.BaseAPI));
|
|
372
|
+
exports.Class3CXIntegrationsApi = Class3CXIntegrationsApi;
|
|
373
|
+
/**
|
|
374
|
+
* @export
|
|
375
|
+
*/
|
|
376
|
+
exports.GetGetPriceLicenceTypeEnum = {
|
|
377
|
+
Lite: 'lite',
|
|
378
|
+
Pro: 'pro'
|
|
379
|
+
};
|
|
380
|
+
/**
|
|
381
|
+
* @export
|
|
382
|
+
*/
|
|
383
|
+
exports.GetGetPriceSchoolTypeEnum = {
|
|
384
|
+
Primary: 'primary',
|
|
385
|
+
Secondary: 'secondary'
|
|
386
|
+
};
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Yellowgrid
|
|
3
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { MultiTenantChangeResponseModel, TcxMultiTenantModel, TcxMultiTenantsModel } from '../models/index';
|
|
14
|
+
export interface DeleteGetTenantRequest {
|
|
15
|
+
reference: string;
|
|
16
|
+
}
|
|
17
|
+
export interface GetGetTenantRequest {
|
|
18
|
+
reference: string;
|
|
19
|
+
}
|
|
20
|
+
export interface GetGetTenantsRequest {
|
|
21
|
+
pageSize?: number;
|
|
22
|
+
page?: number;
|
|
23
|
+
search?: string;
|
|
24
|
+
status?: GetGetTenantsStatusEnum;
|
|
25
|
+
}
|
|
26
|
+
export interface PostAddMtDdiRequest {
|
|
27
|
+
areacode: string;
|
|
28
|
+
}
|
|
29
|
+
export interface PostGetMtNewDdisRequest {
|
|
30
|
+
multiTenantChangeResponseModel?: MultiTenantChangeResponseModel;
|
|
31
|
+
}
|
|
32
|
+
export interface PostGetTenantsRequest {
|
|
33
|
+
tcxMultiTenantModel?: TcxMultiTenantModel;
|
|
34
|
+
}
|
|
35
|
+
export interface PostTrackMtChangeRequest {
|
|
36
|
+
multiTenantChangeResponseModel?: MultiTenantChangeResponseModel;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
*/
|
|
41
|
+
export declare class Class3CXMultiTenantApi extends runtime.BaseAPI {
|
|
42
|
+
/**
|
|
43
|
+
* Delete 3CX Starter Bundle Tenant
|
|
44
|
+
* Delete 3CX MT Tenant
|
|
45
|
+
*/
|
|
46
|
+
deleteGetTenantRaw(requestParameters: DeleteGetTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
47
|
+
/**
|
|
48
|
+
* Delete 3CX Starter Bundle Tenant
|
|
49
|
+
* Delete 3CX MT Tenant
|
|
50
|
+
*/
|
|
51
|
+
deleteGetTenant(requestParameters: DeleteGetTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
52
|
+
/**
|
|
53
|
+
* Get 3CX Starter Bundle Tenant
|
|
54
|
+
* Get 3CX MT Tenant
|
|
55
|
+
*/
|
|
56
|
+
getGetTenantRaw(requestParameters: GetGetTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TcxMultiTenantModel>>;
|
|
57
|
+
/**
|
|
58
|
+
* Get 3CX Starter Bundle Tenant
|
|
59
|
+
* Get 3CX MT Tenant
|
|
60
|
+
*/
|
|
61
|
+
getGetTenant(requestParameters: GetGetTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TcxMultiTenantModel>;
|
|
62
|
+
/**
|
|
63
|
+
* Get 3CX Starter Bundle Tenants
|
|
64
|
+
* Get 3CX MT Tenants
|
|
65
|
+
*/
|
|
66
|
+
getGetTenantsRaw(requestParameters: GetGetTenantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TcxMultiTenantsModel>>;
|
|
67
|
+
/**
|
|
68
|
+
* Get 3CX Starter Bundle Tenants
|
|
69
|
+
* Get 3CX MT Tenants
|
|
70
|
+
*/
|
|
71
|
+
getGetTenants(requestParameters?: GetGetTenantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TcxMultiTenantsModel>;
|
|
72
|
+
/**
|
|
73
|
+
* Add 3CX MT DDI
|
|
74
|
+
* Add 3CX MT DDI
|
|
75
|
+
*/
|
|
76
|
+
postAddMtDdiRaw(requestParameters: PostAddMtDdiRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MultiTenantChangeResponseModel>>;
|
|
77
|
+
/**
|
|
78
|
+
* Add 3CX MT DDI
|
|
79
|
+
* Add 3CX MT DDI
|
|
80
|
+
*/
|
|
81
|
+
postAddMtDdi(requestParameters: PostAddMtDdiRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MultiTenantChangeResponseModel>;
|
|
82
|
+
/**
|
|
83
|
+
* Get 3CX MT New DDIs
|
|
84
|
+
* Get 3CX MT New DDIs
|
|
85
|
+
*/
|
|
86
|
+
postGetMtNewDdisRaw(requestParameters: PostGetMtNewDdisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
|
|
87
|
+
/**
|
|
88
|
+
* Get 3CX MT New DDIs
|
|
89
|
+
* Get 3CX MT New DDIs
|
|
90
|
+
*/
|
|
91
|
+
postGetMtNewDdis(requestParameters?: PostGetMtNewDdisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
|
|
92
|
+
/**
|
|
93
|
+
* Add 3CX Starter Bundle Tenant
|
|
94
|
+
* Add 3CX MT Tenant
|
|
95
|
+
*/
|
|
96
|
+
postGetTenantsRaw(requestParameters: PostGetTenantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TcxMultiTenantModel>>;
|
|
97
|
+
/**
|
|
98
|
+
* Add 3CX Starter Bundle Tenant
|
|
99
|
+
* Add 3CX MT Tenant
|
|
100
|
+
*/
|
|
101
|
+
postGetTenants(requestParameters?: PostGetTenantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TcxMultiTenantModel>;
|
|
102
|
+
/**
|
|
103
|
+
* Track 3CX MT Change
|
|
104
|
+
* Track 3CX MT Change
|
|
105
|
+
*/
|
|
106
|
+
postTrackMtChangeRaw(requestParameters: PostTrackMtChangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MultiTenantChangeResponseModel>>;
|
|
107
|
+
/**
|
|
108
|
+
* Track 3CX MT Change
|
|
109
|
+
* Track 3CX MT Change
|
|
110
|
+
*/
|
|
111
|
+
postTrackMtChange(requestParameters?: PostTrackMtChangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MultiTenantChangeResponseModel>;
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* @export
|
|
115
|
+
*/
|
|
116
|
+
export declare const GetGetTenantsStatusEnum: {
|
|
117
|
+
readonly Completed: "Completed";
|
|
118
|
+
readonly Outstanding: "Outstanding";
|
|
119
|
+
readonly Offline: "Offline";
|
|
120
|
+
readonly FailedOver: "Failed Over";
|
|
121
|
+
};
|
|
122
|
+
export type GetGetTenantsStatusEnum = typeof GetGetTenantsStatusEnum[keyof typeof GetGetTenantsStatusEnum];
|