yellowgrid-api-ts 3.2.232 → 3.2.233-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 +394 -299
- package/.openapi-generator/VERSION +1 -1
- package/README.md +198 -3
- package/api.ts +19590 -10472
- package/base.ts +2 -2
- package/common.ts +1 -1
- package/config.json +4 -3
- package/configuration.ts +1 -1
- package/dist/api.d.ts +12161 -7129
- package/dist/api.js +17737 -8997
- package/dist/base.d.ts +1 -1
- package/dist/base.js +2 -2
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/ConnectionTypeEnum.d.ts +63 -0
- package/dist/models/ConnectionTypeEnum.js +65 -0
- package/dist/models/GraphTypeEnum.d.ts +13 -0
- package/dist/models/GraphTypeEnum.js +15 -0
- package/dist/models/HostingPriceListEnum.d.ts +5 -0
- package/dist/models/HostingPriceListEnum.js +5 -0
- package/dist/models/ReasonEnum.d.ts +23 -0
- package/dist/models/ReasonEnum.js +25 -0
- package/dist/models/ReportEnum.d.ts +68 -0
- package/dist/models/ReportEnum.js +70 -0
- package/dist/models/ResolutionEnum.d.ts +18 -0
- package/dist/models/ResolutionEnum.js +20 -0
- package/dist/models/RmaItemCreditTypeEnum.d.ts +13 -0
- package/dist/models/RmaItemCreditTypeEnum.js +15 -0
- package/dist/models/RmaItemResolutionEnum.d.ts +28 -0
- package/dist/models/RmaItemResolutionEnum.js +30 -0
- package/dist/models/RmaItemStatusEnum.d.ts +18 -0
- package/dist/models/RmaItemStatusEnum.js +20 -0
- package/dist/models/RmaStatusEnum.d.ts +28 -0
- package/dist/models/RmaStatusEnum.js +30 -0
- package/dist/models/StatusEnum.d.ts +18 -0
- package/dist/models/StatusEnum.js +20 -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 +7 -7
- package/docs/AccountAddressesDTO.md +3 -3
- package/docs/AccountContactEntity.md +13 -13
- package/docs/AccountContactModel.md +13 -13
- package/docs/AccountContactRequestModel.md +9 -9
- package/docs/AccountDetailedSummaryDTO.md +10 -10
- package/docs/AccountFinanceDTO.md +10 -10
- package/docs/AccountRequestModel.md +17 -17
- package/docs/AccountSummaryDTO.md +3 -3
- package/docs/AccountsApi.md +49 -1
- package/docs/AccountsResponseModel.md +4 -4
- package/docs/AddressDTO.md +12 -6
- package/docs/AddressModel.md +5 -5
- package/docs/AddressRequestModel.md +4 -4
- package/docs/AdminCustomerRmasModel.md +27 -0
- package/docs/AdminNumberPortDTO.md +18 -18
- package/docs/AdminOrderRequestDTO.md +7 -7
- package/docs/AdminRmaDTO.md +63 -0
- package/docs/AdminRmaItemDTO.md +49 -0
- package/docs/AdminRmaNoteDTO.md +27 -0
- package/docs/AdminRmaSummaryDTO.md +39 -0
- package/docs/AdminUserModel.md +10 -10
- package/docs/AgentHoursGraphModel.md +4 -4
- package/docs/AgentHoursGraphMonthModel.md +2 -2
- package/docs/ApiLogEntity.md +12 -12
- package/docs/AreaCodeModel.md +2 -2
- package/docs/AttachmentModel.md +5 -5
- package/docs/AttributeSetEnum.md +2 -2
- package/docs/AuditLogEntity.md +9 -9
- package/docs/AuthCodeResponseModel.md +3 -3
- package/docs/AxisDataDTO.md +25 -0
- package/docs/BaseService.md +36 -0
- package/docs/BasicItemDTO.md +2 -2
- package/docs/BasicProductDTO.md +2 -2
- package/docs/BatchDTO.md +17 -17
- package/docs/BatchEntity.md +17 -17
- package/docs/BillingApi.md +3576 -26
- package/docs/Bundle.md +34 -0
- package/docs/BundleCustomer.md +34 -0
- package/docs/CRMApi.md +1 -1
- package/docs/CallBarringModel.md +5 -5
- package/docs/CallTariff.md +34 -0
- package/docs/CallTariffPlan.md +36 -0
- package/docs/CallTariffResponse.md +26 -0
- package/docs/Cdr.md +112 -0
- package/docs/Class3CXApi.md +1 -1
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/ClientDetailsModel.md +7 -7
- package/docs/ClientModel.md +4 -4
- package/docs/CompanyContractModel.md +5 -5
- package/docs/ConnectionRequest.md +36 -0
- package/docs/ConnectionType.md +28 -0
- package/docs/ContactDetail.md +58 -0
- package/docs/ContactInfoModel.md +5 -5
- package/docs/ConversationModel.md +8 -8
- package/docs/CourierPriceEntity.md +10 -10
- package/docs/CreditAccountEntity.md +23 -23
- package/docs/CreditNoteDTO.md +1 -1
- package/docs/CreditNoteEntity.md +5 -5
- package/docs/CreditNoteItemDTO.md +3 -3
- package/docs/CreditNoteItemEntity.md +7 -5
- package/docs/CreditNoteItemModel.md +7 -5
- package/docs/CreditNoteModel.md +5 -5
- package/docs/CreditStatusDTO.md +3 -3
- package/docs/CrmActivitiesResponseDTO.md +2 -2
- package/docs/CrmActivityDTO.md +7 -7
- package/docs/CrmContactDTO.md +7 -7
- package/docs/CrmDateActivitiesDTO.md +2 -2
- package/docs/CrmNoteEntity.md +10 -10
- package/docs/CrmNoteModel.md +10 -10
- package/docs/Customer.md +98 -0
- package/docs/CustomerCoordinatesDTO.md +31 -0
- package/docs/CustomerInformationModel.md +4 -4
- package/docs/CustomerItemRequestDTO.md +2 -2
- package/docs/CustomerListAccountDTO.md +13 -13
- package/docs/CustomerOrderRequestDTO.md +7 -7
- package/docs/CustomerPriceListEnum.md +2 -2
- package/docs/CustomerRate.md +22 -0
- package/docs/CustomerRateType.md +12 -0
- package/docs/CustomerRmasModel.md +27 -0
- package/docs/CustomerSummaryReportDTO.md +6 -6
- package/docs/DdiRangeRequestModel.md +3 -3
- package/docs/DdiRangesRequestModel.md +1 -1
- package/docs/DetailedItemRequestDTO.md +2 -2
- package/docs/DetailedOrderRequestDTO.md +7 -7
- package/docs/DivertRequestModel.md +2 -2
- package/docs/DivertResponseModel.md +3 -3
- package/docs/EdTechProClientEntity.md +5 -5
- package/docs/EdTechProSchoolModel.md +13 -13
- package/docs/EdTechProSchoolsModel.md +4 -4
- package/docs/EdTechProSetupModel.md +5 -5
- package/docs/EmailRequestModel.md +21 -0
- package/docs/EventDTO.md +8 -8
- package/docs/EventRequestDTO.md +3 -3
- package/docs/EventSubscriptionModel.md +2 -2
- package/docs/EventUpdateDTO.md +4 -4
- package/docs/EventUpdateEntity.md +5 -5
- package/docs/EventUpdateRequestDTO.md +3 -3
- package/docs/ExpiringKeyDTO.md +5 -5
- package/docs/FraudManagementModel.md +2 -2
- package/docs/FreshdeskCompanyTicketsModel.md +4 -4
- package/docs/FreshdeskTicketEntity.md +7 -7
- package/docs/FtpAccountsEntity.md +5 -5
- package/docs/GenericFileModel.md +3 -3
- package/docs/GraphDTO.md +33 -0
- package/docs/HostingChangeResponseModel.md +5 -5
- package/docs/HostingRegionDTO.md +3 -3
- package/docs/InboundCli.md +50 -0
- package/docs/InboundTariffPlan.md +32 -0
- package/docs/InboundTariffPlanResponse.md +28 -0
- package/docs/InstallationDetailsDTO.md +10 -10
- package/docs/InstanceAutoFailoverEntity.md +5 -5
- package/docs/InstanceDeletionScheduleEntity.md +4 -4
- package/docs/InstanceEntity.md +21 -21
- package/docs/InstanceFailoverEntity.md +11 -11
- package/docs/InstanceMonitoringEntity.md +3 -3
- package/docs/InstanceMonitoringLogEntity.md +6 -6
- package/docs/InstanceScheduledTasksEntity.md +6 -6
- package/docs/InstanceTcxDetailsEntity.md +10 -10
- package/docs/InstanceUserCredentialsEntity.md +5 -5
- package/docs/ItemDTO.md +2 -2
- package/docs/ItemDiscountEntity.md +7 -7
- package/docs/ItemEntity.md +22 -22
- package/docs/ItemResolutionRequestModel.md +21 -0
- package/docs/LinkedOrderEntity.md +2 -2
- package/docs/MFARequiredModel.md +2 -2
- package/docs/MacAddressDTO.md +2 -2
- package/docs/MacAddressRequestModel.md +21 -0
- package/docs/MiscApi.md +63 -0
- package/docs/MonthlyUsageModel.md +2 -2
- package/docs/MultiTenantChangeResponseModel.md +4 -4
- package/docs/MultiTenantSipTrunkRequest.md +22 -0
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NameRequestModel.md +21 -0
- package/docs/NavigationModel.md +4 -4
- package/docs/NoteRequestModel.md +21 -0
- package/docs/NumberPortDTO.md +18 -18
- package/docs/NumberPortNoteDTO.md +5 -5
- package/docs/NumberPortRangeDTO.md +7 -7
- package/docs/NumberPortRangeRequestDTO.md +4 -4
- package/docs/NumberPortingApi.md +73 -73
- package/docs/NumberPortsModel.md +4 -4
- package/docs/OAuth20Api.md +27 -27
- package/docs/OfflineInstancesEntity.md +5 -5
- package/docs/OpayoRedirectDTO.md +5 -5
- package/docs/OrderDTO.md +3 -3
- package/docs/OrderDetailsDTO.md +16 -16
- package/docs/OrderEntity.md +58 -58
- package/docs/OrderItemDTO.md +2 -2
- package/docs/OrderRequestModel.md +13 -13
- package/docs/OrderResponseDTO.md +3 -3
- package/docs/OrderSummariesModel.md +4 -4
- package/docs/OrderSummaryDTO.md +16 -16
- package/docs/OrderTotalModel.md +8 -8
- package/docs/OrderedItemEntity.md +14 -14
- package/docs/OrderedItemModel.md +14 -14
- package/docs/OrdersApi.md +1 -1
- package/docs/OutboundCli.md +70 -0
- package/docs/PartnerDTO.md +12 -12
- package/docs/PasswordSenderDTO.md +37 -0
- package/docs/PasswordSenderEntity.md +33 -0
- package/docs/PortalAccountModel.md +23 -23
- package/docs/PortalLoginModel.md +7 -7
- package/docs/PostAddBroadbandRequest.md +28 -0
- package/docs/PostAddCallTariffToCallTariffPlanRequest.md +34 -0
- package/docs/PostAddEthernetRequest.md +28 -0
- package/docs/PostAddRecurringChargeRequest.md +30 -0
- package/docs/PostAddServiceToServicePlanRequest.md +30 -0
- package/docs/PostAddSipTrunkDDIsRequest.md +30 -0
- package/docs/PostDisconnectDDIRequest.md +20 -0
- package/docs/PostGenerateReport200Response.md +36 -0
- package/docs/PostGetBaseServicesRequest.md +22 -0
- package/docs/PostGetPriceGroupsRequest.md +22 -0
- package/docs/PostGetServicePlansRequest.md +22 -0
- package/docs/PostGetSipTrunksBillingRequest.md +34 -0
- package/docs/PostUpdateConnectionRequest.md +22 -0
- package/docs/PostUpdateRecurringChargeRequest.md +30 -0
- package/docs/PriceGroup.md +30 -0
- package/docs/PriceGroupResponse.md +24 -0
- package/docs/PriceListItemModel.md +5 -5
- package/docs/PricingApi.md +1 -1
- package/docs/PrinterEntity.md +5 -5
- package/docs/PrizesEntity.md +6 -6
- package/docs/ProcessedCdr.md +96 -0
- package/docs/ProductDetailedSummaryDTO.md +2 -2
- package/docs/ProductPriceListItemModel.md +5 -5
- package/docs/ProductSearchResultsModel.md +1 -1
- package/docs/ProductSerialInfoDTO.md +27 -0
- package/docs/ProductSerialInfoModel.md +4 -4
- package/docs/ProductSummaryDTO.md +2 -2
- package/docs/ProductsApi.md +1 -1
- package/docs/PromoCodesEntity.md +12 -12
- package/docs/PromoItemsEntity.md +8 -8
- package/docs/ProspectDTO.md +10 -10
- package/docs/ProspectEntity.md +11 -11
- package/docs/ProspectsApi.md +1 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/ProvisioningModel.md +3 -3
- package/docs/ProvisioningRequestEntity.md +3 -3
- package/docs/PutAddCallTariffToCallTariffPlanRequest.md +30 -0
- package/docs/PutAddServiceToServicePlanRequest.md +26 -0
- package/docs/PutConnectionSearchRequest.md +20 -0
- package/docs/PutGetBaseServicesRequest.md +28 -0
- package/docs/PutGetCallTariffPlanRequest.md +28 -0
- package/docs/PutGetPriceGroupsRequest.md +28 -0
- package/docs/RMAApi.md +1691 -0
- package/docs/ReasonRequestModel.md +21 -0
- package/docs/RecordingBackupAzureModel.md +5 -5
- package/docs/RecordingsBackupInfoDTO.md +2 -2
- package/docs/RecurringCharge.md +48 -0
- package/docs/RemoteStorageDTO.md +4 -4
- package/docs/ReportRequestDTO.md +37 -0
- package/docs/ReportsApi.md +107 -0
- package/docs/ResolutionRequestModel.md +21 -0
- package/docs/ResourceNotReadyException.md +3 -3
- package/docs/RmaCollectionDTO.md +27 -0
- package/docs/RmaCreditItemRequestDTO.md +25 -0
- package/docs/RmaDTO.md +45 -0
- package/docs/RmaItemDTO.md +35 -0
- package/docs/RmaItemRequestDTO.md +25 -0
- package/docs/RmaOrderDTO.md +29 -0
- package/docs/RmaOrderItemDTO.md +37 -0
- package/docs/RmaOrderSummaryDTO.md +25 -0
- package/docs/RmaReplacementOrderItemDTO.md +23 -0
- package/docs/RmaReplacementOrderRequestDTO.md +21 -0
- package/docs/RmaRequestDTO.md +34 -0
- package/docs/RmaReturnDTO.md +31 -0
- package/docs/RmaSummaryDTO.md +31 -0
- package/docs/RmaSummaryItemDTO.md +23 -0
- package/docs/RootAccessModel.md +3 -3
- package/docs/S3BucketEntity.md +4 -4
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- package/docs/SbcDTO.md +8 -8
- package/docs/ScannedItemModel.md +5 -5
- package/docs/ScopeModel.md +2 -2
- package/docs/Sdr.md +66 -0
- package/docs/SdrReferenceType.md +24 -0
- package/docs/SerialNumberRequestModel.md +21 -0
- package/docs/SeriesDTO.md +27 -0
- package/docs/Service.md +42 -0
- package/docs/ServiceHealthDTO.md +2 -2
- package/docs/ServicePlan.md +36 -0
- package/docs/ServiceStatusDTO.md +4 -4
- package/docs/ServicesApi.md +1 -1
- package/docs/ShipmentAddressEntity.md +11 -11
- package/docs/ShipmentDTO.md +11 -11
- package/docs/ShipmentEntity.md +12 -12
- package/docs/ShipmentItemDTO.md +2 -2
- package/docs/ShipmentItemEntity.md +5 -5
- package/docs/ShipmentItemModel.md +5 -5
- package/docs/ShipmentModel.md +12 -12
- package/docs/ShipmentRequestDTO.md +6 -6
- package/docs/ShippingAddressDTO.md +8 -8
- package/docs/ShippingApi.md +1 -1
- package/docs/ShippingConsignmentModel.md +4 -4
- package/docs/ShippingInformationDTO.md +3 -3
- package/docs/ShippingRequestDTO.md +5 -5
- package/docs/ShippingServiceDTO.md +2 -2
- package/docs/ShippingServiceModel.md +6 -6
- package/docs/ShippingServicesModel.md +1 -1
- package/docs/SipTrunkChangeResponseModel.md +5 -5
- package/docs/SipTrunkCreationRequestModel.md +6 -6
- package/docs/SipTrunkEntity.md +12 -12
- package/docs/SipTrunksResponseModel.md +4 -4
- package/docs/SmsAccountDTO.md +6 -6
- package/docs/SmsAccountEntity.md +7 -7
- package/docs/SmsAccountRequestDTO.md +5 -5
- package/docs/SmsDataModel.md +1 -1
- package/docs/SmsMessageModel.md +3 -3
- package/docs/SmsNumbersEntity.md +2 -2
- package/docs/SmsPayloadModel.md +3 -3
- package/docs/SmsPhoneNumberModel.md +2 -2
- package/docs/SmsResponseModel.md +3 -3
- package/docs/SmsWhitelistEntity.md +2 -2
- package/docs/SpecialService.md +40 -0
- package/docs/StockManagementApi.md +1 -1
- package/docs/StockOrderCourierEntity.md +4 -4
- package/docs/StockOrderDeductionModel.md +4 -4
- package/docs/StockOrderDeductionRequestModel.md +2 -2
- package/docs/StockOrderDeductionsEntity.md +4 -4
- package/docs/StockOrderEntity.md +22 -22
- package/docs/StockOrderItemEntity.md +7 -7
- package/docs/StockOrderItemModel.md +7 -7
- package/docs/StockOrderItemRequestModel.md +4 -4
- package/docs/StockOrderModel.md +15 -15
- package/docs/StockOrderProductEntity.md +6 -6
- package/docs/StockOrderRequestModel.md +3 -3
- package/docs/StockOrderSupplierEntity.md +9 -9
- package/docs/StockOrderSupplierModel.md +9 -9
- package/docs/StockOrdersModel.md +4 -4
- package/docs/StockProductModel.md +6 -6
- package/docs/StockProductPriceModel.md +2 -2
- package/docs/StockProductSummariesModel.md +4 -4
- package/docs/StockProductSummaryModel.md +6 -6
- package/docs/StockReportItemModel.md +31 -0
- package/docs/StockReportModel.md +29 -0
- package/docs/StockTransactionsEntity.md +8 -8
- package/docs/SupplierEntity.md +9 -9
- package/docs/SupplierItemEntity.md +8 -8
- package/docs/SupplierItemModel.md +10 -8
- package/docs/SupplierItemsResultsDTO.md +21 -0
- package/docs/SupplierModel.md +9 -9
- package/docs/SupplierProductModel.md +25 -0
- package/docs/SupplierProductResultsModel.md +27 -0
- package/docs/SuppliersApi.md +230 -0
- package/docs/SupportTicketModel.md +11 -11
- package/docs/SystemApi.md +1 -1
- package/docs/TableDTO.md +25 -0
- package/docs/TableDataDTO.md +21 -0
- package/docs/TableHistoryEntity.md +8 -8
- package/docs/TableRowDTO.md +21 -0
- package/docs/TariffRate.md +30 -0
- package/docs/TcxBackupEntity.md +9 -9
- package/docs/TcxBackupModel.md +9 -9
- package/docs/TcxBillingEntity.md +10 -10
- package/docs/TcxBulkLicenceDetailsModel.md +2 -2
- package/docs/TcxDeadLicenceEntity.md +3 -3
- package/docs/TcxExtsEntity.md +8 -8
- package/docs/TcxInstallationModel.md +33 -31
- package/docs/TcxInstallationsModel.md +4 -4
- package/docs/TcxKeySummaryDTO.md +5 -5
- package/docs/TcxKeysEntity.md +6 -6
- package/docs/TcxLicenceDetailsErrorModel.md +4 -4
- package/docs/TcxLicenceDetailsModel.md +11 -11
- package/docs/TcxMacsEntity.md +3 -3
- package/docs/TcxMultiTenantModel.md +14 -14
- package/docs/TcxMultiTenantUserModel.md +3 -3
- package/docs/TcxMultiTenantsModel.md +4 -4
- package/docs/TcxNumbersEntity.md +3 -3
- package/docs/TcxOfficeHoursEntity.md +15 -15
- package/docs/TcxPhoneModel.md +6 -6
- package/docs/TcxPhonesEntity.md +6 -6
- package/docs/TcxRemoteStorageModel.md +4 -4
- package/docs/TcxSbcDTO.md +8 -8
- package/docs/TcxSbcEntity.md +16 -16
- package/docs/TcxSbcModel.md +16 -16
- package/docs/TcxSbcResponseDTO.md +2 -2
- package/docs/TcxSetupEntity.md +26 -26
- package/docs/TcxSetupsModel.md +4 -4
- package/docs/TcxSipTrunksEntity.md +13 -13
- package/docs/TcxTemplateXmlEnum.md +2 -2
- package/docs/TcxUsersEntity.md +6 -6
- package/docs/TcxWizardConfigModel.md +2 -2
- package/docs/TcxWizardModel.md +14 -14
- package/docs/TechSupportCompanySummaryDTO.md +5 -5
- package/docs/TicketSummaryModel.md +7 -7
- package/docs/TicketTimeDTO.md +9 -9
- package/docs/TicketsApi.md +11 -11
- package/docs/TokenResponseModel.md +3 -3
- package/docs/UnconnectedSdr.md +68 -0
- package/docs/UpgradeOrderResponseModel.md +2 -2
- package/docs/UpgradeRequestModel.md +4 -4
- package/docs/UserEntity.md +12 -12
- package/docs/WebhooksApi.md +1 -1
- package/docs/XeroLogEntity.md +10 -10
- package/getEnums.php +31 -31
- package/index.ts +1 -1
- package/models/ConnectionTypeEnum.ts +64 -0
- package/models/GraphTypeEnum.ts +14 -0
- package/models/HostingPriceListEnum.ts +5 -0
- package/models/ReasonEnum.ts +24 -0
- package/models/ReportEnum.ts +69 -0
- package/models/ResolutionEnum.ts +19 -0
- package/models/RmaItemCreditTypeEnum.ts +14 -0
- package/models/RmaItemResolutionEnum.ts +29 -0
- package/models/RmaItemStatusEnum.ts +19 -0
- package/models/RmaStatusEnum.ts +29 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
package/docs/NumberPortingApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# NumberPortingApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -472,18 +472,18 @@ import {
|
|
|
472
472
|
const configuration = new Configuration();
|
|
473
473
|
const apiInstance = new NumberPortingApi(configuration);
|
|
474
474
|
|
|
475
|
-
let companyName: string; //Company Name (
|
|
476
|
-
let addressLine1: string; //Address Line 1 (
|
|
477
|
-
let addressLine2: string; //Address Line 2 (
|
|
478
|
-
let city: string; //City (
|
|
479
|
-
let postCode: string; //Post Code (
|
|
480
|
-
let trunkId: number; //Trunk ID (
|
|
481
|
-
let tenantId: string; //Starter Bundle ID (
|
|
482
|
-
let requestedPortDate: string; //Requested Port Date (
|
|
483
|
-
let asap: boolean; //Port Date ASAP (
|
|
484
|
-
let comment: string; //Comment (
|
|
485
|
-
let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (
|
|
486
|
-
let cloa: File; //CLOA (only provide on submission) (
|
|
475
|
+
let companyName: string; //Company Name (default to undefined)
|
|
476
|
+
let addressLine1: string; //Address Line 1 (default to undefined)
|
|
477
|
+
let addressLine2: string; //Address Line 2 (default to undefined)
|
|
478
|
+
let city: string; //City (default to undefined)
|
|
479
|
+
let postCode: string; //Post Code (default to undefined)
|
|
480
|
+
let trunkId: number; //Trunk ID (default to undefined)
|
|
481
|
+
let tenantId: string; //Starter Bundle ID (default to undefined)
|
|
482
|
+
let requestedPortDate: string; //Requested Port Date (default to undefined)
|
|
483
|
+
let asap: boolean; //Port Date ASAP (default to undefined)
|
|
484
|
+
let comment: string; //Comment (default to undefined)
|
|
485
|
+
let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (default to undefined)
|
|
486
|
+
let cloa: File; //CLOA (only provide on submission) (default to undefined)
|
|
487
487
|
|
|
488
488
|
const { status, data } = await apiInstance.postCreateNumberPort(
|
|
489
489
|
companyName,
|
|
@@ -505,18 +505,18 @@ const { status, data } = await apiInstance.postCreateNumberPort(
|
|
|
505
505
|
|
|
506
506
|
|Name | Type | Description | Notes|
|
|
507
507
|
|------------- | ------------- | ------------- | -------------|
|
|
508
|
-
| **companyName** | [**string**] | Company Name |
|
|
509
|
-
| **addressLine1** | [**string**] | Address Line 1 |
|
|
510
|
-
| **addressLine2** | [**string**] | Address Line 2 |
|
|
511
|
-
| **city** | [**string**] | City |
|
|
512
|
-
| **postCode** | [**string**] | Post Code |
|
|
513
|
-
| **trunkId** | [**number**] | Trunk ID |
|
|
514
|
-
| **tenantId** | [**string**] | Starter Bundle ID |
|
|
515
|
-
| **requestedPortDate** | [**string**] | Requested Port Date |
|
|
516
|
-
| **asap** | [**boolean**] | Port Date ASAP |
|
|
517
|
-
| **comment** | [**string**] | Comment |
|
|
518
|
-
| **numberRanges** | **Array<NumberPortRangeRequestDTO>** | Number Ranges |
|
|
519
|
-
| **cloa** | [**File**] | CLOA (only provide on submission) |
|
|
508
|
+
| **companyName** | [**string**] | Company Name | defaults to undefined|
|
|
509
|
+
| **addressLine1** | [**string**] | Address Line 1 | defaults to undefined|
|
|
510
|
+
| **addressLine2** | [**string**] | Address Line 2 | defaults to undefined|
|
|
511
|
+
| **city** | [**string**] | City | defaults to undefined|
|
|
512
|
+
| **postCode** | [**string**] | Post Code | defaults to undefined|
|
|
513
|
+
| **trunkId** | [**number**] | Trunk ID | defaults to undefined|
|
|
514
|
+
| **tenantId** | [**string**] | Starter Bundle ID | defaults to undefined|
|
|
515
|
+
| **requestedPortDate** | [**string**] | Requested Port Date | defaults to undefined|
|
|
516
|
+
| **asap** | [**boolean**] | Port Date ASAP | defaults to undefined|
|
|
517
|
+
| **comment** | [**string**] | Comment | defaults to undefined|
|
|
518
|
+
| **numberRanges** | **Array<NumberPortRangeRequestDTO>** | Number Ranges | defaults to undefined|
|
|
519
|
+
| **cloa** | [**File**] | CLOA (only provide on submission) | defaults to undefined|
|
|
520
520
|
|
|
521
521
|
|
|
522
522
|
### Return type
|
|
@@ -559,18 +559,18 @@ const configuration = new Configuration();
|
|
|
559
559
|
const apiInstance = new NumberPortingApi(configuration);
|
|
560
560
|
|
|
561
561
|
let id: number; //Number Port ID (default to undefined)
|
|
562
|
-
let companyName: string; //Company Name (
|
|
563
|
-
let addressLine1: string; //Address Line 1 (
|
|
564
|
-
let addressLine2: string; //Address Line 2 (
|
|
565
|
-
let city: string; //City (
|
|
566
|
-
let postCode: string; //Post Code (
|
|
567
|
-
let trunkId: number; //Trunk ID (
|
|
568
|
-
let tenantId: string; //Starter Bundle ID (
|
|
569
|
-
let requestedPortDate: string; //Requested Port Date (
|
|
570
|
-
let asap: boolean; //Port Date ASAP (
|
|
571
|
-
let comment: string; //Comment (
|
|
572
|
-
let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (
|
|
573
|
-
let cloa: File; //CLOA (only provide on submission) (
|
|
562
|
+
let companyName: string; //Company Name (default to undefined)
|
|
563
|
+
let addressLine1: string; //Address Line 1 (default to undefined)
|
|
564
|
+
let addressLine2: string; //Address Line 2 (default to undefined)
|
|
565
|
+
let city: string; //City (default to undefined)
|
|
566
|
+
let postCode: string; //Post Code (default to undefined)
|
|
567
|
+
let trunkId: number; //Trunk ID (default to undefined)
|
|
568
|
+
let tenantId: string; //Starter Bundle ID (default to undefined)
|
|
569
|
+
let requestedPortDate: string; //Requested Port Date (default to undefined)
|
|
570
|
+
let asap: boolean; //Port Date ASAP (default to undefined)
|
|
571
|
+
let comment: string; //Comment (default to undefined)
|
|
572
|
+
let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (default to undefined)
|
|
573
|
+
let cloa: File; //CLOA (only provide on submission) (default to undefined)
|
|
574
574
|
|
|
575
575
|
const { status, data } = await apiInstance.postSubmitNumberPort(
|
|
576
576
|
id,
|
|
@@ -594,18 +594,18 @@ const { status, data } = await apiInstance.postSubmitNumberPort(
|
|
|
594
594
|
|Name | Type | Description | Notes|
|
|
595
595
|
|------------- | ------------- | ------------- | -------------|
|
|
596
596
|
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
597
|
-
| **companyName** | [**string**] | Company Name |
|
|
598
|
-
| **addressLine1** | [**string**] | Address Line 1 |
|
|
599
|
-
| **addressLine2** | [**string**] | Address Line 2 |
|
|
600
|
-
| **city** | [**string**] | City |
|
|
601
|
-
| **postCode** | [**string**] | Post Code |
|
|
602
|
-
| **trunkId** | [**number**] | Trunk ID |
|
|
603
|
-
| **tenantId** | [**string**] | Starter Bundle ID |
|
|
604
|
-
| **requestedPortDate** | [**string**] | Requested Port Date |
|
|
605
|
-
| **asap** | [**boolean**] | Port Date ASAP |
|
|
606
|
-
| **comment** | [**string**] | Comment |
|
|
607
|
-
| **numberRanges** | **Array<NumberPortRangeRequestDTO>** | Number Ranges |
|
|
608
|
-
| **cloa** | [**File**] | CLOA (only provide on submission) |
|
|
597
|
+
| **companyName** | [**string**] | Company Name | defaults to undefined|
|
|
598
|
+
| **addressLine1** | [**string**] | Address Line 1 | defaults to undefined|
|
|
599
|
+
| **addressLine2** | [**string**] | Address Line 2 | defaults to undefined|
|
|
600
|
+
| **city** | [**string**] | City | defaults to undefined|
|
|
601
|
+
| **postCode** | [**string**] | Post Code | defaults to undefined|
|
|
602
|
+
| **trunkId** | [**number**] | Trunk ID | defaults to undefined|
|
|
603
|
+
| **tenantId** | [**string**] | Starter Bundle ID | defaults to undefined|
|
|
604
|
+
| **requestedPortDate** | [**string**] | Requested Port Date | defaults to undefined|
|
|
605
|
+
| **asap** | [**boolean**] | Port Date ASAP | defaults to undefined|
|
|
606
|
+
| **comment** | [**string**] | Comment | defaults to undefined|
|
|
607
|
+
| **numberRanges** | **Array<NumberPortRangeRequestDTO>** | Number Ranges | defaults to undefined|
|
|
608
|
+
| **cloa** | [**File**] | CLOA (only provide on submission) | defaults to undefined|
|
|
609
609
|
|
|
610
610
|
|
|
611
611
|
### Return type
|
|
@@ -648,18 +648,18 @@ const configuration = new Configuration();
|
|
|
648
648
|
const apiInstance = new NumberPortingApi(configuration);
|
|
649
649
|
|
|
650
650
|
let id: number; //Number Port ID (default to undefined)
|
|
651
|
-
let companyName: string; //Company Name (
|
|
652
|
-
let addressLine1: string; //Address Line 1 (
|
|
653
|
-
let addressLine2: string; //Address Line 2 (
|
|
654
|
-
let city: string; //City (
|
|
655
|
-
let postCode: string; //Post Code (
|
|
656
|
-
let trunkId: number; //Trunk ID (
|
|
657
|
-
let tenantId: string; //Starter Bundle ID (
|
|
658
|
-
let requestedPortDate: string; //Requested Port Date (
|
|
659
|
-
let asap: boolean; //Port Date ASAP (
|
|
660
|
-
let comment: string; //Comment (
|
|
661
|
-
let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (
|
|
662
|
-
let cloa: File; //CLOA (only provide on submission) (
|
|
651
|
+
let companyName: string; //Company Name (default to undefined)
|
|
652
|
+
let addressLine1: string; //Address Line 1 (default to undefined)
|
|
653
|
+
let addressLine2: string; //Address Line 2 (default to undefined)
|
|
654
|
+
let city: string; //City (default to undefined)
|
|
655
|
+
let postCode: string; //Post Code (default to undefined)
|
|
656
|
+
let trunkId: number; //Trunk ID (default to undefined)
|
|
657
|
+
let tenantId: string; //Starter Bundle ID (default to undefined)
|
|
658
|
+
let requestedPortDate: string; //Requested Port Date (default to undefined)
|
|
659
|
+
let asap: boolean; //Port Date ASAP (default to undefined)
|
|
660
|
+
let comment: string; //Comment (default to undefined)
|
|
661
|
+
let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (default to undefined)
|
|
662
|
+
let cloa: File; //CLOA (only provide on submission) (default to undefined)
|
|
663
663
|
|
|
664
664
|
const { status, data } = await apiInstance.postUpdateNumberPort(
|
|
665
665
|
id,
|
|
@@ -683,18 +683,18 @@ const { status, data } = await apiInstance.postUpdateNumberPort(
|
|
|
683
683
|
|Name | Type | Description | Notes|
|
|
684
684
|
|------------- | ------------- | ------------- | -------------|
|
|
685
685
|
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
686
|
-
| **companyName** | [**string**] | Company Name |
|
|
687
|
-
| **addressLine1** | [**string**] | Address Line 1 |
|
|
688
|
-
| **addressLine2** | [**string**] | Address Line 2 |
|
|
689
|
-
| **city** | [**string**] | City |
|
|
690
|
-
| **postCode** | [**string**] | Post Code |
|
|
691
|
-
| **trunkId** | [**number**] | Trunk ID |
|
|
692
|
-
| **tenantId** | [**string**] | Starter Bundle ID |
|
|
693
|
-
| **requestedPortDate** | [**string**] | Requested Port Date |
|
|
694
|
-
| **asap** | [**boolean**] | Port Date ASAP |
|
|
695
|
-
| **comment** | [**string**] | Comment |
|
|
696
|
-
| **numberRanges** | **Array<NumberPortRangeRequestDTO>** | Number Ranges |
|
|
697
|
-
| **cloa** | [**File**] | CLOA (only provide on submission) |
|
|
686
|
+
| **companyName** | [**string**] | Company Name | defaults to undefined|
|
|
687
|
+
| **addressLine1** | [**string**] | Address Line 1 | defaults to undefined|
|
|
688
|
+
| **addressLine2** | [**string**] | Address Line 2 | defaults to undefined|
|
|
689
|
+
| **city** | [**string**] | City | defaults to undefined|
|
|
690
|
+
| **postCode** | [**string**] | Post Code | defaults to undefined|
|
|
691
|
+
| **trunkId** | [**number**] | Trunk ID | defaults to undefined|
|
|
692
|
+
| **tenantId** | [**string**] | Starter Bundle ID | defaults to undefined|
|
|
693
|
+
| **requestedPortDate** | [**string**] | Requested Port Date | defaults to undefined|
|
|
694
|
+
| **asap** | [**boolean**] | Port Date ASAP | defaults to undefined|
|
|
695
|
+
| **comment** | [**string**] | Comment | defaults to undefined|
|
|
696
|
+
| **numberRanges** | **Array<NumberPortRangeRequestDTO>** | Number Ranges | defaults to undefined|
|
|
697
|
+
| **cloa** | [**File**] | CLOA (only provide on submission) | defaults to undefined|
|
|
698
698
|
|
|
699
699
|
|
|
700
700
|
### Return type
|
package/docs/NumberPortsModel.md
CHANGED
|
@@ -6,10 +6,10 @@ Number Ports
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<NumberPortDTO>**](NumberPortDTO.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<NumberPortDTO>**](NumberPortDTO.md) | Results | [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/OAuth20Api.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OAuth20Api
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -122,18 +122,18 @@ import {
|
|
|
122
122
|
const configuration = new Configuration();
|
|
123
123
|
const apiInstance = new OAuth20Api(configuration);
|
|
124
124
|
|
|
125
|
-
let clientId: string; //OAuth 2.0 Client ID (
|
|
126
|
-
let clientSecret: string; //OAuth 2.0 Client Secret (
|
|
127
|
-
let grantType: string; //OAuth 2.0 Grant Type (
|
|
128
|
-
let scope: string; //OAuth 2.0 Scope (
|
|
129
|
-
let redirectUri: string; //OAuth 2.0 Redirect URI (
|
|
130
|
-
let code: string; //OAuth 2.0 Auth Code (
|
|
131
|
-
let refreshToken: string; //OAuth 2.0 Refresh Token (
|
|
132
|
-
let codeVerifier: string; //OAuth 2.0 Code Verifier (
|
|
133
|
-
let token: string; //OAuth 2.0 Token (Only used in Token Exchange) (
|
|
134
|
-
let tokenExchangeType: string; //Token Exchange Type (Only used in Token Exchange) (
|
|
135
|
-
let licenceKey: string; //3CX Licence Key (Only used in Token Exchange) (
|
|
136
|
-
let endUser: boolean; //End User (Only used in Token Exchange) (
|
|
125
|
+
let clientId: string; //OAuth 2.0 Client ID (default to undefined)
|
|
126
|
+
let clientSecret: string; //OAuth 2.0 Client Secret (default to undefined)
|
|
127
|
+
let grantType: string; //OAuth 2.0 Grant Type (default to undefined)
|
|
128
|
+
let scope: string; //OAuth 2.0 Scope (default to undefined)
|
|
129
|
+
let redirectUri: string; //OAuth 2.0 Redirect URI (default to undefined)
|
|
130
|
+
let code: string; //OAuth 2.0 Auth Code (default to undefined)
|
|
131
|
+
let refreshToken: string; //OAuth 2.0 Refresh Token (default to undefined)
|
|
132
|
+
let codeVerifier: string; //OAuth 2.0 Code Verifier (default to undefined)
|
|
133
|
+
let token: string; //OAuth 2.0 Token (Only used in Token Exchange) (default to undefined)
|
|
134
|
+
let tokenExchangeType: string; //Token Exchange Type (Only used in Token Exchange) (default to undefined)
|
|
135
|
+
let licenceKey: string; //3CX Licence Key (Only used in Token Exchange) (default to undefined)
|
|
136
|
+
let endUser: boolean; //End User (Only used in Token Exchange) (default to undefined)
|
|
137
137
|
|
|
138
138
|
const { status, data } = await apiInstance.postAccessToken(
|
|
139
139
|
clientId,
|
|
@@ -155,18 +155,18 @@ const { status, data } = await apiInstance.postAccessToken(
|
|
|
155
155
|
|
|
156
156
|
|Name | Type | Description | Notes|
|
|
157
157
|
|------------- | ------------- | ------------- | -------------|
|
|
158
|
-
| **clientId** | [**string**] | OAuth 2.0 Client ID |
|
|
159
|
-
| **clientSecret** | [**string**] | OAuth 2.0 Client Secret |
|
|
160
|
-
| **grantType** | [**string**]**Array<'client_credentials' | 'code' | 'refresh_token' | 'authorization_code' | 'ms_auth' | 'token_exchange' | 'password'>** | OAuth 2.0 Grant Type |
|
|
161
|
-
| **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' | 'sms.read' | 'sms.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 |
|
|
162
|
-
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI |
|
|
163
|
-
| **code** | [**string**] | OAuth 2.0 Auth Code |
|
|
164
|
-
| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token |
|
|
165
|
-
| **codeVerifier** | [**string**] | OAuth 2.0 Code Verifier |
|
|
166
|
-
| **token** | [**string**] | OAuth 2.0 Token (Only used in Token Exchange) |
|
|
167
|
-
| **tokenExchangeType** | [**string**]**Array<'tcx_wizard' | 'portal'>** | Token Exchange Type (Only used in Token Exchange) |
|
|
168
|
-
| **licenceKey** | [**string**] | 3CX Licence Key (Only used in Token Exchange) |
|
|
169
|
-
| **endUser** | [**boolean**] | End User (Only used in Token Exchange) |
|
|
158
|
+
| **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
|
|
159
|
+
| **clientSecret** | [**string**] | OAuth 2.0 Client Secret | defaults to undefined|
|
|
160
|
+
| **grantType** | [**string**]**Array<'client_credentials' | 'code' | 'refresh_token' | 'authorization_code' | 'ms_auth' | 'token_exchange' | 'password'>** | OAuth 2.0 Grant Type | defaults to undefined|
|
|
161
|
+
| **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' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.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|
|
|
162
|
+
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | defaults to undefined|
|
|
163
|
+
| **code** | [**string**] | OAuth 2.0 Auth Code | defaults to undefined|
|
|
164
|
+
| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | defaults to undefined|
|
|
165
|
+
| **codeVerifier** | [**string**] | OAuth 2.0 Code Verifier | defaults to undefined|
|
|
166
|
+
| **token** | [**string**] | OAuth 2.0 Token (Only used in Token Exchange) | defaults to undefined|
|
|
167
|
+
| **tokenExchangeType** | [**string**]**Array<'tcx_wizard' | 'portal'>** | Token Exchange Type (Only used in Token Exchange) | defaults to undefined|
|
|
168
|
+
| **licenceKey** | [**string**] | 3CX Licence Key (Only used in Token Exchange) | defaults to undefined|
|
|
169
|
+
| **endUser** | [**boolean**] | End User (Only used in Token Exchange) | defaults to undefined|
|
|
170
170
|
|
|
171
171
|
|
|
172
172
|
### Return type
|
|
@@ -211,7 +211,7 @@ const apiInstance = new OAuth20Api(configuration);
|
|
|
211
211
|
|
|
212
212
|
let clientId: string; //OAuth 2.0 Client ID (default to undefined)
|
|
213
213
|
let responseType: string; //OAuth 2.0 Response Type (default to 'code')
|
|
214
|
-
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' | 'sms.read' | 'sms.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
|
+
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' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.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)
|
|
215
215
|
let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
|
|
216
216
|
let state: string; //OAuth 2.0 State (optional) (default to undefined)
|
|
217
217
|
let codeChallenge: string; //OAuth 2.0 Code Challenge (optional) (default to undefined)
|
|
@@ -234,7 +234,7 @@ const { status, data } = await apiInstance.postAuthorise(
|
|
|
234
234
|
|------------- | ------------- | ------------- | -------------|
|
|
235
235
|
| **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
|
|
236
236
|
| **responseType** | [**string**] | OAuth 2.0 Response Type | defaults to 'code'|
|
|
237
|
-
| **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' | 'sms.read' | 'sms.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' | 'sms.read' | 'sms.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
|
+
| **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' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.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' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.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|
|
|
238
238
|
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
|
|
239
239
|
| **state** | [**string**] | OAuth 2.0 State | (optional) defaults to undefined|
|
|
240
240
|
| **codeChallenge** | [**string**] | OAuth 2.0 Code Challenge | (optional) defaults to undefined|
|
|
@@ -6,11 +6,11 @@ OfflineInstancesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**instanceId** | **string** | instanceId | [
|
|
11
|
-
**offlineSince** | **string** | offlineSince | [
|
|
12
|
-
**rebooted** | **number** | rebooted | [
|
|
13
|
-
**alerted** | **number** | alerted | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**instanceId** | **string** | instanceId | [default to undefined]
|
|
11
|
+
**offlineSince** | **string** | offlineSince | [default to undefined]
|
|
12
|
+
**rebooted** | **number** | rebooted | [default to undefined]
|
|
13
|
+
**alerted** | **number** | alerted | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/OpayoRedirectDTO.md
CHANGED
|
@@ -6,11 +6,11 @@ Opayo Redirect
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**acsUrl** | **string** | acsUrl | [
|
|
10
|
-
**paReq** | **string** | paReq | [
|
|
11
|
-
**transactionId** | **string** | Transaction ID | [
|
|
12
|
-
**dsTranId** | **string** | dsTranId | [
|
|
13
|
-
**cReq** | **string** | cReq | [
|
|
9
|
+
**acsUrl** | **string** | acsUrl | [default to undefined]
|
|
10
|
+
**paReq** | **string** | paReq | [default to undefined]
|
|
11
|
+
**transactionId** | **string** | Transaction ID | [default to undefined]
|
|
12
|
+
**dsTranId** | **string** | dsTranId | [default to undefined]
|
|
13
|
+
**cReq** | **string** | cReq | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/OrderDTO.md
CHANGED
|
@@ -6,9 +6,9 @@ Legacy Portal Order
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**basket** | [**Array<ItemDTO>**](ItemDTO.md) | Basket | [
|
|
10
|
-
**shippingAddress** | [**ShippingAddressDTO**](ShippingAddressDTO.md) | | [
|
|
11
|
-
**orderDetails** | [**OrderDetailsDTO**](OrderDetailsDTO.md) | | [
|
|
9
|
+
**basket** | [**Array<ItemDTO>**](ItemDTO.md) | Basket | [default to undefined]
|
|
10
|
+
**shippingAddress** | [**ShippingAddressDTO**](ShippingAddressDTO.md) | | [default to undefined]
|
|
11
|
+
**orderDetails** | [**OrderDetailsDTO**](OrderDetailsDTO.md) | | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/OrderDetailsDTO.md
CHANGED
|
@@ -6,22 +6,22 @@ Order Details
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
10
|
-
**reference** | **string** | Reference | [
|
|
11
|
-
**invoiceNumber** | **string** | Invoice Number | [
|
|
12
|
-
**invoiceId** | **string** | Invoice ID | [
|
|
13
|
-
**orderDate** | **string** | Date Time | [
|
|
14
|
-
**paid** | **boolean** | Paid | [
|
|
15
|
-
**complete** | **boolean** | Complete | [
|
|
16
|
-
**quote** | **boolean** | Quote | [
|
|
17
|
-
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | | [
|
|
18
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [
|
|
19
|
-
**items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [
|
|
20
|
-
**carriageCharge** | **number** | Carriage Charge | [
|
|
21
|
-
**fulfillable** | **boolean** | Fulfillable | [
|
|
22
|
-
**provisioningUrl** | **string** | Provisioning URL | [
|
|
23
|
-
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [
|
|
24
|
-
**readonly** | **boolean** | Readonly | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**reference** | **string** | Reference | [default to undefined]
|
|
11
|
+
**invoiceNumber** | **string** | Invoice Number | [default to undefined]
|
|
12
|
+
**invoiceId** | **string** | Invoice ID | [default to undefined]
|
|
13
|
+
**orderDate** | **string** | Date Time | [default to undefined]
|
|
14
|
+
**paid** | **boolean** | Paid | [default to undefined]
|
|
15
|
+
**complete** | **boolean** | Complete | [default to undefined]
|
|
16
|
+
**quote** | **boolean** | Quote | [default to undefined]
|
|
17
|
+
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | | [default to undefined]
|
|
18
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [default to undefined]
|
|
19
|
+
**items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [default to undefined]
|
|
20
|
+
**carriageCharge** | **number** | Carriage Charge | [default to undefined]
|
|
21
|
+
**fulfillable** | **boolean** | Fulfillable | [default to undefined]
|
|
22
|
+
**provisioningUrl** | **string** | Provisioning URL | [default to undefined]
|
|
23
|
+
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [default to undefined]
|
|
24
|
+
**readonly** | **boolean** | Readonly | [default to undefined]
|
|
25
25
|
**detailedItems** | [**Array<OrderItemDTO>**](OrderItemDTO.md) | Detailed Items | [optional] [default to undefined]
|
|
26
26
|
**batches** | [**Array<BatchDTO>**](BatchDTO.md) | Batches | [optional] [default to undefined]
|
|
27
27
|
**logEntries** | [**Array<AuditLogEntity>**](AuditLogEntity.md) | Audit Log | [optional] [default to undefined]
|
package/docs/OrderEntity.md
CHANGED
|
@@ -6,64 +6,64 @@ OrdersEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**reference** | **string** | externalId | [
|
|
11
|
-
**sourceId** | **number** | sourceId | [
|
|
12
|
-
**invoiceNumber** | **string** | sageInv | [
|
|
13
|
-
**invoiceId** | **string** | invoiceId | [
|
|
14
|
-
**customerId** | **number** | creditAccountId | [
|
|
15
|
-
**orderDate** | **string** | orderDate | [
|
|
16
|
-
**orderPostedDate** | **string** | orderPostedDate | [
|
|
17
|
-
**buyerEmail** | **string** | buyerEmail | [
|
|
18
|
-
**buyerPhone** | **string** | buyerPhone | [
|
|
19
|
-
**buyerName** | **string** | buyerName | [
|
|
20
|
-
**buyerCompany** | **string** | buyerCompany | [
|
|
21
|
-
**billName** | **string** | billName | [
|
|
22
|
-
**billAddress1** | **string** | billAddress1 | [
|
|
23
|
-
**billAddress2** | **string** | billAddress2 | [
|
|
24
|
-
**billAddress3** | **string** | billAddress3 | [
|
|
25
|
-
**billCity** | **string** | billCity | [
|
|
26
|
-
**billStateRegion** | **string** | billStateRegion | [
|
|
27
|
-
**billPostalCode** | **string** | billPostalCode | [
|
|
28
|
-
**billCountry** | **string** | billCountry | [
|
|
29
|
-
**shipName** | **string** | shipName | [
|
|
30
|
-
**shipCompany** | **string** | shipCompany | [
|
|
31
|
-
**shipAddress1** | **string** | shipAddress1 | [
|
|
32
|
-
**shipAddress2** | **string** | shipAddress2 | [
|
|
33
|
-
**shipAddress3** | **string** | shipAddress3 | [
|
|
34
|
-
**shipCity** | **string** | shipCity | [
|
|
35
|
-
**shipStateRegion** | **string** | shipStateRegion | [
|
|
36
|
-
**shipPostalCode** | **string** | shipPostalCode | [
|
|
37
|
-
**shipCountry** | **string** | shipCountry | [
|
|
38
|
-
**shipVatNumber** | **string** | shipVatNumber | [
|
|
39
|
-
**shipPhoneNumber** | **string** | shipPhoneNumber | [
|
|
40
|
-
**shipCourier** | **string** | shipCourier | [
|
|
41
|
-
**shipMethod** | **string** | shipMethod | [
|
|
42
|
-
**shipServiceLevel** | **string** | shipServiceLevel | [
|
|
43
|
-
**shipTrackingId** | **string** | shipTrackingId | [
|
|
44
|
-
**currency** | **string** | currency | [
|
|
45
|
-
**taxRate** | **number** | taxRate | [
|
|
46
|
-
**taxAmount** | **number** | taxAmount | [
|
|
47
|
-
**taxAmountGbp** | **number** | taxAmountGbp | [
|
|
48
|
-
**paidStatus** | **number** | paidStatus | [
|
|
49
|
-
**invoicePaid** | **number** | invoicePaid | [
|
|
50
|
-
**quote** | **number** | quoteStatus | [
|
|
51
|
-
**sageStatus** | **string** | sageStatus | [
|
|
52
|
-
**transactionId** | **string** | transactionId | [
|
|
53
|
-
**customerInvoiceSent** | **number** | customerInvoiceSent | [
|
|
54
|
-
**supplierOrderedStatus** | **number** | supplierOrderedStatus | [
|
|
55
|
-
**supplierPaidStatus** | **number** | supplierPaidStatus | [
|
|
56
|
-
**supplierReceivedStatus** | **number** | supplierRecvdStatus | [
|
|
57
|
-
**carriageRefunded** | **number** | carriageRefunded | [
|
|
58
|
-
**amazonMinus** | **number** | amazonMinus | [
|
|
59
|
-
**currencyRate** | **number** | currencyRate | [
|
|
60
|
-
**hzStatus** | **number** | hzStatus | [
|
|
61
|
-
**prospect** | **number** | prospect | [
|
|
62
|
-
**provisioningUrl** | **number** | provisioningUrl | [
|
|
63
|
-
**uniqueId** | **string** | uniqueId | [
|
|
64
|
-
**notes** | **string** | notes | [
|
|
65
|
-
**promocode** | **string** | promocode | [
|
|
66
|
-
**fulfillable** | **boolean** | fulfillable | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**reference** | **string** | externalId | [default to undefined]
|
|
11
|
+
**sourceId** | **number** | sourceId | [default to undefined]
|
|
12
|
+
**invoiceNumber** | **string** | sageInv | [default to undefined]
|
|
13
|
+
**invoiceId** | **string** | invoiceId | [default to undefined]
|
|
14
|
+
**customerId** | **number** | creditAccountId | [default to undefined]
|
|
15
|
+
**orderDate** | **string** | orderDate | [default to undefined]
|
|
16
|
+
**orderPostedDate** | **string** | orderPostedDate | [default to undefined]
|
|
17
|
+
**buyerEmail** | **string** | buyerEmail | [default to undefined]
|
|
18
|
+
**buyerPhone** | **string** | buyerPhone | [default to undefined]
|
|
19
|
+
**buyerName** | **string** | buyerName | [default to undefined]
|
|
20
|
+
**buyerCompany** | **string** | buyerCompany | [default to undefined]
|
|
21
|
+
**billName** | **string** | billName | [default to undefined]
|
|
22
|
+
**billAddress1** | **string** | billAddress1 | [default to undefined]
|
|
23
|
+
**billAddress2** | **string** | billAddress2 | [default to undefined]
|
|
24
|
+
**billAddress3** | **string** | billAddress3 | [default to undefined]
|
|
25
|
+
**billCity** | **string** | billCity | [default to undefined]
|
|
26
|
+
**billStateRegion** | **string** | billStateRegion | [default to undefined]
|
|
27
|
+
**billPostalCode** | **string** | billPostalCode | [default to undefined]
|
|
28
|
+
**billCountry** | **string** | billCountry | [default to undefined]
|
|
29
|
+
**shipName** | **string** | shipName | [default to undefined]
|
|
30
|
+
**shipCompany** | **string** | shipCompany | [default to undefined]
|
|
31
|
+
**shipAddress1** | **string** | shipAddress1 | [default to undefined]
|
|
32
|
+
**shipAddress2** | **string** | shipAddress2 | [default to undefined]
|
|
33
|
+
**shipAddress3** | **string** | shipAddress3 | [default to undefined]
|
|
34
|
+
**shipCity** | **string** | shipCity | [default to undefined]
|
|
35
|
+
**shipStateRegion** | **string** | shipStateRegion | [default to undefined]
|
|
36
|
+
**shipPostalCode** | **string** | shipPostalCode | [default to undefined]
|
|
37
|
+
**shipCountry** | **string** | shipCountry | [default to undefined]
|
|
38
|
+
**shipVatNumber** | **string** | shipVatNumber | [default to undefined]
|
|
39
|
+
**shipPhoneNumber** | **string** | shipPhoneNumber | [default to undefined]
|
|
40
|
+
**shipCourier** | **string** | shipCourier | [default to undefined]
|
|
41
|
+
**shipMethod** | **string** | shipMethod | [default to undefined]
|
|
42
|
+
**shipServiceLevel** | **string** | shipServiceLevel | [default to undefined]
|
|
43
|
+
**shipTrackingId** | **string** | shipTrackingId | [default to undefined]
|
|
44
|
+
**currency** | **string** | currency | [default to undefined]
|
|
45
|
+
**taxRate** | **number** | taxRate | [default to undefined]
|
|
46
|
+
**taxAmount** | **number** | taxAmount | [default to undefined]
|
|
47
|
+
**taxAmountGbp** | **number** | taxAmountGbp | [default to undefined]
|
|
48
|
+
**paidStatus** | **number** | paidStatus | [default to undefined]
|
|
49
|
+
**invoicePaid** | **number** | invoicePaid | [default to undefined]
|
|
50
|
+
**quote** | **number** | quoteStatus | [default to undefined]
|
|
51
|
+
**sageStatus** | **string** | sageStatus | [default to undefined]
|
|
52
|
+
**transactionId** | **string** | transactionId | [default to undefined]
|
|
53
|
+
**customerInvoiceSent** | **number** | customerInvoiceSent | [default to undefined]
|
|
54
|
+
**supplierOrderedStatus** | **number** | supplierOrderedStatus | [default to undefined]
|
|
55
|
+
**supplierPaidStatus** | **number** | supplierPaidStatus | [default to undefined]
|
|
56
|
+
**supplierReceivedStatus** | **number** | supplierRecvdStatus | [default to undefined]
|
|
57
|
+
**carriageRefunded** | **number** | carriageRefunded | [default to undefined]
|
|
58
|
+
**amazonMinus** | **number** | amazonMinus | [default to undefined]
|
|
59
|
+
**currencyRate** | **number** | currencyRate | [default to undefined]
|
|
60
|
+
**hzStatus** | **number** | hzStatus | [default to undefined]
|
|
61
|
+
**prospect** | **number** | prospect | [default to undefined]
|
|
62
|
+
**provisioningUrl** | **number** | provisioningUrl | [default to undefined]
|
|
63
|
+
**uniqueId** | **string** | uniqueId | [default to undefined]
|
|
64
|
+
**notes** | **string** | notes | [default to undefined]
|
|
65
|
+
**promocode** | **string** | promocode | [default to undefined]
|
|
66
|
+
**fulfillable** | **boolean** | fulfillable | [default to undefined]
|
|
67
67
|
|
|
68
68
|
## Example
|
|
69
69
|
|
package/docs/OrderItemDTO.md
CHANGED
|
@@ -6,8 +6,8 @@ Order Item Details
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [
|
|
10
|
-
**quantity** | **number** | Quantity | [
|
|
9
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
10
|
+
**quantity** | **number** | Quantity | [default to undefined]
|
|
11
11
|
**id** | **number** | ID | [optional] [default to undefined]
|
|
12
12
|
**orderId** | **number** | Order ID | [optional] [default to undefined]
|
|
13
13
|
**title** | **string** | Title | [optional] [default to undefined]
|
|
@@ -6,19 +6,19 @@ EdTechPro Order Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**clientId** | **number** | Client/Trust ID | [
|
|
10
|
-
**clientName** | **string** | Client/Trust Name | [
|
|
11
|
-
**clientContactName** | **string** | Client/Trust Contact Name | [
|
|
12
|
-
**clientContactEmail** | **string** | Client/Trust Contact Email | [
|
|
13
|
-
**terms** | **boolean** | Agreed to Terms and Conditions | [
|
|
14
|
-
**schoolName** | **string** | School Name | [
|
|
15
|
-
**dfECode** | **string** | School DfE Code | [
|
|
16
|
-
**schoolContactName** | **string** | School Technical Contact Name | [
|
|
17
|
-
**schoolContactEmail** | **string** | School Technical Contact Email | [
|
|
18
|
-
**licenceType** | **string** | Licence Type | [
|
|
19
|
-
**schoolType** | **string** | School Type | [
|
|
20
|
-
**instanceId** | **string** | InstanceId | [
|
|
21
|
-
**orderReference** | **string** | Order Reference | [
|
|
9
|
+
**clientId** | **number** | Client/Trust ID | [default to undefined]
|
|
10
|
+
**clientName** | **string** | Client/Trust Name | [default to undefined]
|
|
11
|
+
**clientContactName** | **string** | Client/Trust Contact Name | [default to undefined]
|
|
12
|
+
**clientContactEmail** | **string** | Client/Trust Contact Email | [default to undefined]
|
|
13
|
+
**terms** | **boolean** | Agreed to Terms and Conditions | [default to undefined]
|
|
14
|
+
**schoolName** | **string** | School Name | [default to undefined]
|
|
15
|
+
**dfECode** | **string** | School DfE Code | [default to undefined]
|
|
16
|
+
**schoolContactName** | **string** | School Technical Contact Name | [default to undefined]
|
|
17
|
+
**schoolContactEmail** | **string** | School Technical Contact Email | [default to undefined]
|
|
18
|
+
**licenceType** | **string** | Licence Type | [default to undefined]
|
|
19
|
+
**schoolType** | **string** | School Type | [default to undefined]
|
|
20
|
+
**instanceId** | **string** | InstanceId | [default to undefined]
|
|
21
|
+
**orderReference** | **string** | Order Reference | [default to undefined]
|
|
22
22
|
|
|
23
23
|
## Example
|
|
24
24
|
|
package/docs/OrderResponseDTO.md
CHANGED
|
@@ -6,9 +6,9 @@ Legacy Portal Response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**url** | **string** | URL | [
|
|
10
|
-
**orderID** | **string** | Order ID | [
|
|
11
|
-
**uniqueID** | **string** | Unique ID | [
|
|
9
|
+
**url** | **string** | URL | [default to undefined]
|
|
10
|
+
**orderID** | **string** | Order ID | [default to undefined]
|
|
11
|
+
**uniqueID** | **string** | Unique ID | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,10 +6,10 @@ Sales Orders
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<OrderSummaryDTO>**](OrderSummaryDTO.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<OrderSummaryDTO>**](OrderSummaryDTO.md) | Results | [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|