yellowgrid-api-ts 3.2.48 → 3.2.49-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 +18 -1
- package/api.ts +1569 -4169
- 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 +747 -3786
- package/dist/api.js +1295 -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 +0 -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 +51 -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,614 @@
|
|
|
1
|
+
# NumberPortingApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://api.yellowgrid.local*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteGetAdminNumberPort**](#deletegetadminnumberport) | **DELETE** /admin/sip/numbers/ports/{id} | |
|
|
8
|
+
|[**getCreateNumberPort**](#getcreatenumberport) | **GET** /sip/numbers/ports | |
|
|
9
|
+
|[**getGetAdminNumberPort**](#getgetadminnumberport) | **GET** /admin/sip/numbers/ports/{id} | |
|
|
10
|
+
|[**getGetAdminNumberPorts**](#getgetadminnumberports) | **GET** /admin/sip/numbers/ports | |
|
|
11
|
+
|[**getUpdateNumberPort**](#getupdatenumberport) | **GET** /sip/numbers/ports/{id} | |
|
|
12
|
+
|[**postCreateNumberPort**](#postcreatenumberport) | **POST** /sip/numbers/ports | |
|
|
13
|
+
|[**postSubmitNumberPort**](#postsubmitnumberport) | **POST** /sip/numbers/ports/{id}/submit | |
|
|
14
|
+
|[**postUpdateNumberPort**](#postupdatenumberport) | **POST** /sip/numbers/ports/{id} | |
|
|
15
|
+
|[**putGetAdminNumberPort**](#putgetadminnumberport) | **PUT** /admin/sip/numbers/ports/{id} | |
|
|
16
|
+
|
|
17
|
+
# **deleteGetAdminNumberPort**
|
|
18
|
+
> deleteGetAdminNumberPort()
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import {
|
|
25
|
+
NumberPortingApi,
|
|
26
|
+
Configuration
|
|
27
|
+
} from 'yellowgrid-api-ts';
|
|
28
|
+
|
|
29
|
+
const configuration = new Configuration();
|
|
30
|
+
const apiInstance = new NumberPortingApi(configuration);
|
|
31
|
+
|
|
32
|
+
let id: number; //Number Port ID (default to undefined)
|
|
33
|
+
|
|
34
|
+
const { status, data } = await apiInstance.deleteGetAdminNumberPort(
|
|
35
|
+
id
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
|Name | Type | Description | Notes|
|
|
42
|
+
|------------- | ------------- | ------------- | -------------|
|
|
43
|
+
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Return type
|
|
47
|
+
|
|
48
|
+
void (empty response body)
|
|
49
|
+
|
|
50
|
+
### Authorization
|
|
51
|
+
|
|
52
|
+
No authorization required
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: Not defined
|
|
57
|
+
- **Accept**: Not defined
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### HTTP response details
|
|
61
|
+
| Status code | Description | Response headers |
|
|
62
|
+
|-------------|-------------|------------------|
|
|
63
|
+
|**204** | No Response | - |
|
|
64
|
+
|**400** | Bad Request | - |
|
|
65
|
+
|**401** | Unauthorised | - |
|
|
66
|
+
|**403** | Access Denied | - |
|
|
67
|
+
|
|
68
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
69
|
+
|
|
70
|
+
# **getCreateNumberPort**
|
|
71
|
+
> NumberPortsModel getCreateNumberPort()
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import {
|
|
78
|
+
NumberPortingApi,
|
|
79
|
+
Configuration
|
|
80
|
+
} from 'yellowgrid-api-ts';
|
|
81
|
+
|
|
82
|
+
const configuration = new Configuration();
|
|
83
|
+
const apiInstance = new NumberPortingApi(configuration);
|
|
84
|
+
|
|
85
|
+
let pageSize: number; //Number Of Results (optional) (default to 20)
|
|
86
|
+
let page: number; //Page Number (optional) (default to 1)
|
|
87
|
+
let search: string; //Search (optional) (default to undefined)
|
|
88
|
+
|
|
89
|
+
const { status, data } = await apiInstance.getCreateNumberPort(
|
|
90
|
+
pageSize,
|
|
91
|
+
page,
|
|
92
|
+
search
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|Name | Type | Description | Notes|
|
|
99
|
+
|------------- | ------------- | ------------- | -------------|
|
|
100
|
+
| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
|
|
101
|
+
| **page** | [**number**] | Page Number | (optional) defaults to 1|
|
|
102
|
+
| **search** | [**string**] | Search | (optional) defaults to undefined|
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
### Return type
|
|
106
|
+
|
|
107
|
+
**NumberPortsModel**
|
|
108
|
+
|
|
109
|
+
### Authorization
|
|
110
|
+
|
|
111
|
+
No authorization required
|
|
112
|
+
|
|
113
|
+
### HTTP request headers
|
|
114
|
+
|
|
115
|
+
- **Content-Type**: Not defined
|
|
116
|
+
- **Accept**: application/json
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
### HTTP response details
|
|
120
|
+
| Status code | Description | Response headers |
|
|
121
|
+
|-------------|-------------|------------------|
|
|
122
|
+
|**200** | Number Ports | - |
|
|
123
|
+
|**400** | Bad Request | - |
|
|
124
|
+
|**401** | Unauthorised | - |
|
|
125
|
+
|**403** | Access Denied | - |
|
|
126
|
+
|
|
127
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
128
|
+
|
|
129
|
+
# **getGetAdminNumberPort**
|
|
130
|
+
> NumberPortDTO getGetAdminNumberPort()
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
### Example
|
|
134
|
+
|
|
135
|
+
```typescript
|
|
136
|
+
import {
|
|
137
|
+
NumberPortingApi,
|
|
138
|
+
Configuration
|
|
139
|
+
} from 'yellowgrid-api-ts';
|
|
140
|
+
|
|
141
|
+
const configuration = new Configuration();
|
|
142
|
+
const apiInstance = new NumberPortingApi(configuration);
|
|
143
|
+
|
|
144
|
+
let id: number; //Number Port ID (default to undefined)
|
|
145
|
+
|
|
146
|
+
const { status, data } = await apiInstance.getGetAdminNumberPort(
|
|
147
|
+
id
|
|
148
|
+
);
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### Parameters
|
|
152
|
+
|
|
153
|
+
|Name | Type | Description | Notes|
|
|
154
|
+
|------------- | ------------- | ------------- | -------------|
|
|
155
|
+
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
### Return type
|
|
159
|
+
|
|
160
|
+
**NumberPortDTO**
|
|
161
|
+
|
|
162
|
+
### Authorization
|
|
163
|
+
|
|
164
|
+
No authorization required
|
|
165
|
+
|
|
166
|
+
### HTTP request headers
|
|
167
|
+
|
|
168
|
+
- **Content-Type**: Not defined
|
|
169
|
+
- **Accept**: application/json
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
### HTTP response details
|
|
173
|
+
| Status code | Description | Response headers |
|
|
174
|
+
|-------------|-------------|------------------|
|
|
175
|
+
|**200** | NumberPortDTO | - |
|
|
176
|
+
|**400** | Bad Request | - |
|
|
177
|
+
|**401** | Unauthorised | - |
|
|
178
|
+
|**403** | Access Denied | - |
|
|
179
|
+
|
|
180
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
181
|
+
|
|
182
|
+
# **getGetAdminNumberPorts**
|
|
183
|
+
> NumberPortsModel getGetAdminNumberPorts()
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
### Example
|
|
187
|
+
|
|
188
|
+
```typescript
|
|
189
|
+
import {
|
|
190
|
+
NumberPortingApi,
|
|
191
|
+
Configuration
|
|
192
|
+
} from 'yellowgrid-api-ts';
|
|
193
|
+
|
|
194
|
+
const configuration = new Configuration();
|
|
195
|
+
const apiInstance = new NumberPortingApi(configuration);
|
|
196
|
+
|
|
197
|
+
let pageSize: number; //Number Of Results (optional) (default to 20)
|
|
198
|
+
let page: number; //Page Number (optional) (default to 1)
|
|
199
|
+
let search: string; //Search (optional) (default to undefined)
|
|
200
|
+
|
|
201
|
+
const { status, data } = await apiInstance.getGetAdminNumberPorts(
|
|
202
|
+
pageSize,
|
|
203
|
+
page,
|
|
204
|
+
search
|
|
205
|
+
);
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Parameters
|
|
209
|
+
|
|
210
|
+
|Name | Type | Description | Notes|
|
|
211
|
+
|------------- | ------------- | ------------- | -------------|
|
|
212
|
+
| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
|
|
213
|
+
| **page** | [**number**] | Page Number | (optional) defaults to 1|
|
|
214
|
+
| **search** | [**string**] | Search | (optional) defaults to undefined|
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
### Return type
|
|
218
|
+
|
|
219
|
+
**NumberPortsModel**
|
|
220
|
+
|
|
221
|
+
### Authorization
|
|
222
|
+
|
|
223
|
+
No authorization required
|
|
224
|
+
|
|
225
|
+
### HTTP request headers
|
|
226
|
+
|
|
227
|
+
- **Content-Type**: Not defined
|
|
228
|
+
- **Accept**: application/json
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
### HTTP response details
|
|
232
|
+
| Status code | Description | Response headers |
|
|
233
|
+
|-------------|-------------|------------------|
|
|
234
|
+
|**200** | Number Ports | - |
|
|
235
|
+
|**400** | Bad Request | - |
|
|
236
|
+
|**401** | Unauthorised | - |
|
|
237
|
+
|**403** | Access Denied | - |
|
|
238
|
+
|
|
239
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
240
|
+
|
|
241
|
+
# **getUpdateNumberPort**
|
|
242
|
+
> NumberPortDTO getUpdateNumberPort()
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
### Example
|
|
246
|
+
|
|
247
|
+
```typescript
|
|
248
|
+
import {
|
|
249
|
+
NumberPortingApi,
|
|
250
|
+
Configuration
|
|
251
|
+
} from 'yellowgrid-api-ts';
|
|
252
|
+
|
|
253
|
+
const configuration = new Configuration();
|
|
254
|
+
const apiInstance = new NumberPortingApi(configuration);
|
|
255
|
+
|
|
256
|
+
let id: number; //Number Port ID (default to undefined)
|
|
257
|
+
|
|
258
|
+
const { status, data } = await apiInstance.getUpdateNumberPort(
|
|
259
|
+
id
|
|
260
|
+
);
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
### Parameters
|
|
264
|
+
|
|
265
|
+
|Name | Type | Description | Notes|
|
|
266
|
+
|------------- | ------------- | ------------- | -------------|
|
|
267
|
+
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
### Return type
|
|
271
|
+
|
|
272
|
+
**NumberPortDTO**
|
|
273
|
+
|
|
274
|
+
### Authorization
|
|
275
|
+
|
|
276
|
+
No authorization required
|
|
277
|
+
|
|
278
|
+
### HTTP request headers
|
|
279
|
+
|
|
280
|
+
- **Content-Type**: Not defined
|
|
281
|
+
- **Accept**: application/json
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
### HTTP response details
|
|
285
|
+
| Status code | Description | Response headers |
|
|
286
|
+
|-------------|-------------|------------------|
|
|
287
|
+
|**200** | NumberPortResponseDTO | - |
|
|
288
|
+
|**400** | Bad Request | - |
|
|
289
|
+
|**401** | Unauthorised | - |
|
|
290
|
+
|**403** | Access Denied | - |
|
|
291
|
+
|
|
292
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
293
|
+
|
|
294
|
+
# **postCreateNumberPort**
|
|
295
|
+
> NumberPortDTO postCreateNumberPort()
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
### Example
|
|
299
|
+
|
|
300
|
+
```typescript
|
|
301
|
+
import {
|
|
302
|
+
NumberPortingApi,
|
|
303
|
+
Configuration
|
|
304
|
+
} from 'yellowgrid-api-ts';
|
|
305
|
+
|
|
306
|
+
const configuration = new Configuration();
|
|
307
|
+
const apiInstance = new NumberPortingApi(configuration);
|
|
308
|
+
|
|
309
|
+
let companyName: string; //Company Name (optional) (default to undefined)
|
|
310
|
+
let addressLine1: string; //Address Line 1 (optional) (default to undefined)
|
|
311
|
+
let addressLine2: string; //Address Line 2 (optional) (default to undefined)
|
|
312
|
+
let city: string; //City (optional) (default to undefined)
|
|
313
|
+
let postCode: string; //Post Code (optional) (default to undefined)
|
|
314
|
+
let trunkId: number; //Trunk ID (optional) (default to undefined)
|
|
315
|
+
let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
|
|
316
|
+
let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
|
|
317
|
+
let asap: boolean; //Port Date ASAP (optional) (default to undefined)
|
|
318
|
+
let comment: string; //Comment (optional) (default to undefined)
|
|
319
|
+
let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (optional) (default to undefined)
|
|
320
|
+
let cloa: File; //CLOA (only provide on submission) (optional) (default to undefined)
|
|
321
|
+
|
|
322
|
+
const { status, data } = await apiInstance.postCreateNumberPort(
|
|
323
|
+
companyName,
|
|
324
|
+
addressLine1,
|
|
325
|
+
addressLine2,
|
|
326
|
+
city,
|
|
327
|
+
postCode,
|
|
328
|
+
trunkId,
|
|
329
|
+
tenantId,
|
|
330
|
+
requestedPortDate,
|
|
331
|
+
asap,
|
|
332
|
+
comment,
|
|
333
|
+
numberRanges,
|
|
334
|
+
cloa
|
|
335
|
+
);
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
### Parameters
|
|
339
|
+
|
|
340
|
+
|Name | Type | Description | Notes|
|
|
341
|
+
|------------- | ------------- | ------------- | -------------|
|
|
342
|
+
| **companyName** | [**string**] | Company Name | (optional) defaults to undefined|
|
|
343
|
+
| **addressLine1** | [**string**] | Address Line 1 | (optional) defaults to undefined|
|
|
344
|
+
| **addressLine2** | [**string**] | Address Line 2 | (optional) defaults to undefined|
|
|
345
|
+
| **city** | [**string**] | City | (optional) defaults to undefined|
|
|
346
|
+
| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
|
|
347
|
+
| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
|
|
348
|
+
| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
|
|
349
|
+
| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
|
|
350
|
+
| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
|
|
351
|
+
| **comment** | [**string**] | Comment | (optional) defaults to undefined|
|
|
352
|
+
| **numberRanges** | **Array<NumberPortRangeRequestDTO>** | Number Ranges | (optional) defaults to undefined|
|
|
353
|
+
| **cloa** | [**File**] | CLOA (only provide on submission) | (optional) defaults to undefined|
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
### Return type
|
|
357
|
+
|
|
358
|
+
**NumberPortDTO**
|
|
359
|
+
|
|
360
|
+
### Authorization
|
|
361
|
+
|
|
362
|
+
No authorization required
|
|
363
|
+
|
|
364
|
+
### HTTP request headers
|
|
365
|
+
|
|
366
|
+
- **Content-Type**: multipart/form-data
|
|
367
|
+
- **Accept**: application/json
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
### HTTP response details
|
|
371
|
+
| Status code | Description | Response headers |
|
|
372
|
+
|-------------|-------------|------------------|
|
|
373
|
+
|**200** | NumberPortResponseDTO | - |
|
|
374
|
+
|**400** | Bad Request | - |
|
|
375
|
+
|**401** | Unauthorised | - |
|
|
376
|
+
|**403** | Access Denied | - |
|
|
377
|
+
|
|
378
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
379
|
+
|
|
380
|
+
# **postSubmitNumberPort**
|
|
381
|
+
> NumberPortDTO postSubmitNumberPort()
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
### Example
|
|
385
|
+
|
|
386
|
+
```typescript
|
|
387
|
+
import {
|
|
388
|
+
NumberPortingApi,
|
|
389
|
+
Configuration
|
|
390
|
+
} from 'yellowgrid-api-ts';
|
|
391
|
+
|
|
392
|
+
const configuration = new Configuration();
|
|
393
|
+
const apiInstance = new NumberPortingApi(configuration);
|
|
394
|
+
|
|
395
|
+
let id: number; //Number Port ID (default to undefined)
|
|
396
|
+
let companyName: string; //Company Name (optional) (default to undefined)
|
|
397
|
+
let addressLine1: string; //Address Line 1 (optional) (default to undefined)
|
|
398
|
+
let addressLine2: string; //Address Line 2 (optional) (default to undefined)
|
|
399
|
+
let city: string; //City (optional) (default to undefined)
|
|
400
|
+
let postCode: string; //Post Code (optional) (default to undefined)
|
|
401
|
+
let trunkId: number; //Trunk ID (optional) (default to undefined)
|
|
402
|
+
let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
|
|
403
|
+
let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
|
|
404
|
+
let asap: boolean; //Port Date ASAP (optional) (default to undefined)
|
|
405
|
+
let comment: string; //Comment (optional) (default to undefined)
|
|
406
|
+
let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (optional) (default to undefined)
|
|
407
|
+
let cloa: File; //CLOA (only provide on submission) (optional) (default to undefined)
|
|
408
|
+
|
|
409
|
+
const { status, data } = await apiInstance.postSubmitNumberPort(
|
|
410
|
+
id,
|
|
411
|
+
companyName,
|
|
412
|
+
addressLine1,
|
|
413
|
+
addressLine2,
|
|
414
|
+
city,
|
|
415
|
+
postCode,
|
|
416
|
+
trunkId,
|
|
417
|
+
tenantId,
|
|
418
|
+
requestedPortDate,
|
|
419
|
+
asap,
|
|
420
|
+
comment,
|
|
421
|
+
numberRanges,
|
|
422
|
+
cloa
|
|
423
|
+
);
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
### Parameters
|
|
427
|
+
|
|
428
|
+
|Name | Type | Description | Notes|
|
|
429
|
+
|------------- | ------------- | ------------- | -------------|
|
|
430
|
+
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
431
|
+
| **companyName** | [**string**] | Company Name | (optional) defaults to undefined|
|
|
432
|
+
| **addressLine1** | [**string**] | Address Line 1 | (optional) defaults to undefined|
|
|
433
|
+
| **addressLine2** | [**string**] | Address Line 2 | (optional) defaults to undefined|
|
|
434
|
+
| **city** | [**string**] | City | (optional) defaults to undefined|
|
|
435
|
+
| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
|
|
436
|
+
| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
|
|
437
|
+
| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
|
|
438
|
+
| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
|
|
439
|
+
| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
|
|
440
|
+
| **comment** | [**string**] | Comment | (optional) defaults to undefined|
|
|
441
|
+
| **numberRanges** | **Array<NumberPortRangeRequestDTO>** | Number Ranges | (optional) defaults to undefined|
|
|
442
|
+
| **cloa** | [**File**] | CLOA (only provide on submission) | (optional) defaults to undefined|
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
### Return type
|
|
446
|
+
|
|
447
|
+
**NumberPortDTO**
|
|
448
|
+
|
|
449
|
+
### Authorization
|
|
450
|
+
|
|
451
|
+
No authorization required
|
|
452
|
+
|
|
453
|
+
### HTTP request headers
|
|
454
|
+
|
|
455
|
+
- **Content-Type**: multipart/form-data
|
|
456
|
+
- **Accept**: application/json
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
### HTTP response details
|
|
460
|
+
| Status code | Description | Response headers |
|
|
461
|
+
|-------------|-------------|------------------|
|
|
462
|
+
|**200** | NumberPortResponseDTO | - |
|
|
463
|
+
|**400** | Bad Request | - |
|
|
464
|
+
|**401** | Unauthorised | - |
|
|
465
|
+
|**403** | Access Denied | - |
|
|
466
|
+
|
|
467
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
468
|
+
|
|
469
|
+
# **postUpdateNumberPort**
|
|
470
|
+
> NumberPortDTO postUpdateNumberPort()
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
### Example
|
|
474
|
+
|
|
475
|
+
```typescript
|
|
476
|
+
import {
|
|
477
|
+
NumberPortingApi,
|
|
478
|
+
Configuration
|
|
479
|
+
} from 'yellowgrid-api-ts';
|
|
480
|
+
|
|
481
|
+
const configuration = new Configuration();
|
|
482
|
+
const apiInstance = new NumberPortingApi(configuration);
|
|
483
|
+
|
|
484
|
+
let id: number; //Number Port ID (default to undefined)
|
|
485
|
+
let companyName: string; //Company Name (optional) (default to undefined)
|
|
486
|
+
let addressLine1: string; //Address Line 1 (optional) (default to undefined)
|
|
487
|
+
let addressLine2: string; //Address Line 2 (optional) (default to undefined)
|
|
488
|
+
let city: string; //City (optional) (default to undefined)
|
|
489
|
+
let postCode: string; //Post Code (optional) (default to undefined)
|
|
490
|
+
let trunkId: number; //Trunk ID (optional) (default to undefined)
|
|
491
|
+
let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
|
|
492
|
+
let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
|
|
493
|
+
let asap: boolean; //Port Date ASAP (optional) (default to undefined)
|
|
494
|
+
let comment: string; //Comment (optional) (default to undefined)
|
|
495
|
+
let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (optional) (default to undefined)
|
|
496
|
+
let cloa: File; //CLOA (only provide on submission) (optional) (default to undefined)
|
|
497
|
+
|
|
498
|
+
const { status, data } = await apiInstance.postUpdateNumberPort(
|
|
499
|
+
id,
|
|
500
|
+
companyName,
|
|
501
|
+
addressLine1,
|
|
502
|
+
addressLine2,
|
|
503
|
+
city,
|
|
504
|
+
postCode,
|
|
505
|
+
trunkId,
|
|
506
|
+
tenantId,
|
|
507
|
+
requestedPortDate,
|
|
508
|
+
asap,
|
|
509
|
+
comment,
|
|
510
|
+
numberRanges,
|
|
511
|
+
cloa
|
|
512
|
+
);
|
|
513
|
+
```
|
|
514
|
+
|
|
515
|
+
### Parameters
|
|
516
|
+
|
|
517
|
+
|Name | Type | Description | Notes|
|
|
518
|
+
|------------- | ------------- | ------------- | -------------|
|
|
519
|
+
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
520
|
+
| **companyName** | [**string**] | Company Name | (optional) defaults to undefined|
|
|
521
|
+
| **addressLine1** | [**string**] | Address Line 1 | (optional) defaults to undefined|
|
|
522
|
+
| **addressLine2** | [**string**] | Address Line 2 | (optional) defaults to undefined|
|
|
523
|
+
| **city** | [**string**] | City | (optional) defaults to undefined|
|
|
524
|
+
| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
|
|
525
|
+
| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
|
|
526
|
+
| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
|
|
527
|
+
| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
|
|
528
|
+
| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
|
|
529
|
+
| **comment** | [**string**] | Comment | (optional) defaults to undefined|
|
|
530
|
+
| **numberRanges** | **Array<NumberPortRangeRequestDTO>** | Number Ranges | (optional) defaults to undefined|
|
|
531
|
+
| **cloa** | [**File**] | CLOA (only provide on submission) | (optional) defaults to undefined|
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
### Return type
|
|
535
|
+
|
|
536
|
+
**NumberPortDTO**
|
|
537
|
+
|
|
538
|
+
### Authorization
|
|
539
|
+
|
|
540
|
+
No authorization required
|
|
541
|
+
|
|
542
|
+
### HTTP request headers
|
|
543
|
+
|
|
544
|
+
- **Content-Type**: multipart/form-data
|
|
545
|
+
- **Accept**: application/json
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
### HTTP response details
|
|
549
|
+
| Status code | Description | Response headers |
|
|
550
|
+
|-------------|-------------|------------------|
|
|
551
|
+
|**200** | NumberPortResponseDTO | - |
|
|
552
|
+
|**400** | Bad Request | - |
|
|
553
|
+
|**401** | Unauthorised | - |
|
|
554
|
+
|**403** | Access Denied | - |
|
|
555
|
+
|
|
556
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
557
|
+
|
|
558
|
+
# **putGetAdminNumberPort**
|
|
559
|
+
> NumberPortDTO putGetAdminNumberPort(numberPortDTO)
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
### Example
|
|
563
|
+
|
|
564
|
+
```typescript
|
|
565
|
+
import {
|
|
566
|
+
NumberPortingApi,
|
|
567
|
+
Configuration,
|
|
568
|
+
NumberPortDTO
|
|
569
|
+
} from 'yellowgrid-api-ts';
|
|
570
|
+
|
|
571
|
+
const configuration = new Configuration();
|
|
572
|
+
const apiInstance = new NumberPortingApi(configuration);
|
|
573
|
+
|
|
574
|
+
let id: number; //Number Port ID (default to undefined)
|
|
575
|
+
let numberPortDTO: NumberPortDTO; //
|
|
576
|
+
|
|
577
|
+
const { status, data } = await apiInstance.putGetAdminNumberPort(
|
|
578
|
+
id,
|
|
579
|
+
numberPortDTO
|
|
580
|
+
);
|
|
581
|
+
```
|
|
582
|
+
|
|
583
|
+
### Parameters
|
|
584
|
+
|
|
585
|
+
|Name | Type | Description | Notes|
|
|
586
|
+
|------------- | ------------- | ------------- | -------------|
|
|
587
|
+
| **numberPortDTO** | **NumberPortDTO**| | |
|
|
588
|
+
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
### Return type
|
|
592
|
+
|
|
593
|
+
**NumberPortDTO**
|
|
594
|
+
|
|
595
|
+
### Authorization
|
|
596
|
+
|
|
597
|
+
No authorization required
|
|
598
|
+
|
|
599
|
+
### HTTP request headers
|
|
600
|
+
|
|
601
|
+
- **Content-Type**: application/json
|
|
602
|
+
- **Accept**: application/json
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
### HTTP response details
|
|
606
|
+
| Status code | Description | Response headers |
|
|
607
|
+
|-------------|-------------|------------------|
|
|
608
|
+
|**200** | NumberPortResponseDTO | - |
|
|
609
|
+
|**400** | Bad Request | - |
|
|
610
|
+
|**401** | Unauthorised | - |
|
|
611
|
+
|**403** | Access Denied | - |
|
|
612
|
+
|
|
613
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
614
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# NumberPortsModel
|
|
2
|
+
|
|
3
|
+
Number Ports
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**results** | [**Array<NumberPortDTO>**](NumberPortDTO.md) | Results | [optional] [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [optional] [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [optional] [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { NumberPortsModel } from 'yellowgrid-api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: NumberPortsModel = {
|
|
20
|
+
results,
|
|
21
|
+
page,
|
|
22
|
+
perPage,
|
|
23
|
+
totalResults,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/OAuth20Api.md
CHANGED
|
@@ -157,7 +157,7 @@ const { status, data } = await apiInstance.postAccessToken(
|
|
|
157
157
|
| **clientId** | [**string**] | OAuth 2.0 Client ID | (optional) defaults to undefined|
|
|
158
158
|
| **clientSecret** | [**string**] | OAuth 2.0 Client Secret | (optional) defaults to undefined|
|
|
159
159
|
| **grantType** | [**string**]**Array<'client_credentials' | 'code' | 'refresh_token' | 'authorization_code' | 'ms_auth' | 'token_exchange' | 'password'>** | OAuth 2.0 Grant Type | (optional) defaults to undefined|
|
|
160
|
-
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | (optional) defaults to undefined|
|
|
160
|
+
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | (optional) defaults to undefined|
|
|
161
161
|
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
|
|
162
162
|
| **code** | [**string**] | OAuth 2.0 Auth Code | (optional) defaults to undefined|
|
|
163
163
|
| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
|
|
@@ -210,7 +210,7 @@ const apiInstance = new OAuth20Api(configuration);
|
|
|
210
210
|
|
|
211
211
|
let clientId: string; //OAuth 2.0 Client ID (default to undefined)
|
|
212
212
|
let responseType: string; //OAuth 2.0 Response Type (default to 'code')
|
|
213
|
-
let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
|
|
213
|
+
let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
|
|
214
214
|
let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
|
|
215
215
|
let state: string; //OAuth 2.0 State (optional) (default to undefined)
|
|
216
216
|
let codeChallenge: string; //OAuth 2.0 Code Challenge (optional) (default to undefined)
|
|
@@ -233,7 +233,7 @@ const { status, data } = await apiInstance.postAuthorise(
|
|
|
233
233
|
|------------- | ------------- | ------------- | -------------|
|
|
234
234
|
| **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
|
|
235
235
|
| **responseType** | [**string**] | OAuth 2.0 Response Type | defaults to 'code'|
|
|
236
|
-
| **scope** | [**'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | defaults to undefined|
|
|
236
|
+
| **scope** | [**'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | defaults to undefined|
|
|
237
237
|
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
|
|
238
238
|
| **state** | [**string**] | OAuth 2.0 State | (optional) defaults to undefined|
|
|
239
239
|
| **codeChallenge** | [**string**] | OAuth 2.0 Code Challenge | (optional) defaults to undefined|
|
|
File without changes
|
package/docs/OrderEntity.md
CHANGED
|
File without changes
|
|
File without changes
|
|
File without changes
|
package/docs/OrderSummaryDTO.md
CHANGED
|
File without changes
|
package/docs/OrderTotalModel.md
CHANGED
|
File without changes
|
|
File without changes
|
package/docs/OrdersApi.md
CHANGED
|
File without changes
|