yellowgrid-api-ts 3.2.238-dev.0 → 3.2.239-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 +30 -3
- package/.openapi-generator/VERSION +1 -1
- package/README.md +60 -4
- package/api.ts +5647 -10824
- package/base.ts +0 -24
- package/common.ts +15 -38
- package/configuration.ts +26 -20
- package/dist/api.d.ts +3905 -9959
- package/dist/api.js +3326 -1313
- package/dist/base.d.ts +0 -24
- package/dist/base.js +0 -19
- package/dist/common.d.ts +4 -35
- package/dist/common.js +16 -38
- package/dist/configuration.d.ts +24 -17
- package/dist/configuration.js +3 -3
- package/dist/models/ConnectionTypeEnum.d.ts +7 -17
- package/dist/models/ConnectionTypeEnum.js +7 -17
- package/dist/models/ReasonEnum.d.ts +23 -0
- package/dist/models/ReasonEnum.js +25 -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 +5 -5
- 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 +9 -11
- package/docs/AccountFinanceDTO.md +10 -10
- package/docs/AccountRequestModel.md +11 -11
- package/docs/AccountSummaryDTO.md +3 -3
- 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 +7 -7
- package/docs/AdminOrderRequestDTO.md +5 -5
- package/docs/AdminRmaDTO.md +63 -0
- package/docs/AdminRmaItemDTO.md +51 -0
- package/docs/AdminRmaNoteDTO.md +27 -0
- package/docs/AdminRmaSummaryDTO.md +39 -0
- package/docs/AdminUserModel.md +5 -5
- 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 +1 -1
- package/docs/AxisDataDTO.md +1 -1
- 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 +6 -61
- package/docs/CallBarringModel.md +5 -5
- package/docs/ClientDetailsModel.md +7 -7
- package/docs/ClientModel.md +4 -4
- package/docs/CompanyContractModel.md +5 -5
- 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 +5 -1
- package/docs/CreditNoteEntity.md +5 -5
- package/docs/CreditNoteItemDTO.md +3 -1
- package/docs/CreditNoteItemEntity.md +7 -5
- package/docs/CreditNoteItemModel.md +7 -5
- package/docs/CreditNoteModel.md +5 -5
- package/docs/CrmActivitiesResponseDTO.md +2 -2
- package/docs/CrmActivityDTO.md +4 -4
- 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/CustomerCoordinatesDTO.md +5 -5
- package/docs/CustomerInformationModel.md +4 -4
- package/docs/CustomerItemRequestDTO.md +2 -2
- package/docs/CustomerListAccountDTO.md +13 -13
- package/docs/CustomerOrderRequestDTO.md +5 -5
- package/docs/CustomerPriceListEnum.md +2 -2
- 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 +5 -5
- package/docs/DivertRequestModel.md +1 -1
- package/docs/DivertResponseModel.md +2 -2
- package/docs/EdTechProClientEntity.md +4 -4
- package/docs/EdTechProSchoolModel.md +11 -11
- package/docs/EdTechProSchoolsModel.md +4 -4
- package/docs/EdTechProSetupModel.md +5 -5
- package/docs/{PatchSetTcxWizardCnameRequest.md → EmailRequestModel.md} +6 -5
- 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 +6 -6
- package/docs/FtpAccountsEntity.md +5 -5
- package/docs/GenericFileModel.md +3 -3
- package/docs/GraphDTO.md +6 -6
- package/docs/HostingChangeResponseModel.md +5 -5
- package/docs/HostingRegionDTO.md +3 -3
- package/docs/InstallationDetailsDTO.md +3 -3
- 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 +6 -6
- package/docs/ItemEntity.md +21 -21
- 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/{AbstractItemDiscountModel.md → MacAddressRequestModel.md} +6 -6
- package/docs/MonthlyUsageModel.md +2 -2
- package/docs/MultiTenantChangeResponseModel.md +4 -4
- package/docs/{GetDisconnectDDIRequest.md → NameRequestModel.md} +6 -5
- package/docs/NavigationModel.md +4 -4
- package/docs/{PostAddAdminNoteRequest.md → NoteRequestModel.md} +5 -4
- package/docs/NumberPortDTO.md +7 -7
- package/docs/NumberPortNoteDTO.md +5 -5
- package/docs/NumberPortRangeDTO.md +2 -2
- package/docs/NumberPortingApi.md +21 -21
- package/docs/NumberPortsModel.md +4 -4
- package/docs/OAuth20Api.md +3 -3
- package/docs/OfflineInstancesEntity.md +5 -5
- package/docs/OrderDTO.md +3 -3
- package/docs/OrderDetailsDTO.md +10 -10
- package/docs/OrderEntity.md +56 -56
- package/docs/OrderItemDTO.md +2 -2
- package/docs/OrderRequestModel.md +6 -6
- package/docs/OrderSummariesModel.md +4 -4
- package/docs/OrderSummaryDTO.md +10 -10
- package/docs/OrderTotalModel.md +7 -7
- package/docs/OrderedItemEntity.md +14 -14
- package/docs/OrderedItemModel.md +14 -14
- package/docs/PartnerDTO.md +11 -11
- package/docs/PasswordSenderDTO.md +3 -3
- package/docs/PasswordSenderEntity.md +7 -7
- package/docs/PortalAccountModel.md +23 -23
- package/docs/PortalLoginModel.md +7 -7
- package/docs/PostGenerateReport200Response.md +8 -8
- package/docs/PriceListItemModel.md +2 -2
- package/docs/PrinterEntity.md +5 -5
- package/docs/PrizesEntity.md +6 -6
- package/docs/ProductDetailedSummaryDTO.md +4 -4
- package/docs/ProductPriceListItemModel.md +2 -2
- package/docs/ProductSearchResultsModel.md +1 -1
- package/docs/ProductSerialInfoDTO.md +27 -0
- package/docs/ProductSerialInfoModel.md +3 -3
- package/docs/ProductSummaryDTO.md +3 -3
- package/docs/PromoCodesEntity.md +12 -12
- package/docs/PromoItemsEntity.md +8 -8
- package/docs/ProspectDTO.md +9 -9
- package/docs/ProspectEntity.md +11 -11
- package/docs/ProvisioningModel.md +3 -3
- package/docs/ProvisioningRequestEntity.md +3 -3
- package/docs/RMAApi.md +1691 -0
- package/docs/ReasonRequestModel.md +21 -0
- package/docs/RecordingBackupAzureModel.md +4 -4
- package/docs/RecordingsBackupInfoDTO.md +2 -2
- package/docs/RemoteStorageDTO.md +4 -4
- package/docs/ReportRequestDTO.md +3 -3
- 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/ScannedItemModel.md +1 -1
- package/docs/ScopeModel.md +2 -2
- package/docs/SerialNumberRequestModel.md +21 -0
- package/docs/SeriesDTO.md +3 -3
- package/docs/ServiceHealthDTO.md +2 -2
- package/docs/ServiceStatusDTO.md +4 -4
- package/docs/ShipmentAddressEntity.md +11 -11
- package/docs/ShipmentDTO.md +4 -4
- 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/ShippingConsignmentModel.md +4 -4
- package/docs/ShippingInformationDTO.md +3 -3
- package/docs/ShippingRequestDTO.md +3 -3
- package/docs/ShippingServiceDTO.md +2 -2
- package/docs/ShippingServiceModel.md +4 -4
- 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 +6 -6
- 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 +1 -1
- package/docs/SmsResponseModel.md +3 -3
- package/docs/SmsWhitelistEntity.md +2 -2
- 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 +14 -14
- 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 +1 -1
- package/docs/StockProductSummariesModel.md +4 -4
- package/docs/StockProductSummaryModel.md +6 -6
- package/docs/StockReportItemModel.md +6 -6
- package/docs/StockReportModel.md +5 -5
- package/docs/StockTransactionsEntity.md +8 -8
- package/docs/SupplierEntity.md +9 -9
- package/docs/SupplierItemEntity.md +8 -8
- package/docs/SupplierItemModel.md +8 -8
- package/docs/SupplierItemsResultsDTO.md +1 -1
- package/docs/SupplierModel.md +9 -9
- package/docs/SupplierProductModel.md +3 -3
- package/docs/SupplierProductResultsModel.md +4 -4
- package/docs/SupportTicketModel.md +10 -10
- package/docs/TableDTO.md +3 -3
- package/docs/TableDataDTO.md +1 -1
- package/docs/TableHistoryEntity.md +8 -8
- package/docs/TableRowDTO.md +1 -1
- 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 +17 -17
- package/docs/TcxInstallationsModel.md +4 -4
- package/docs/TcxKeySummaryDTO.md +4 -4
- 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 +7 -7
- 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 +7 -7
- package/docs/TcxSbcEntity.md +16 -16
- package/docs/TcxSbcModel.md +16 -16
- package/docs/TcxSbcResponseDTO.md +2 -2
- package/docs/TcxSetupEntity.md +25 -25
- 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 +9 -9
- package/docs/TechSupportCompanySummaryDTO.md +5 -5
- package/docs/TicketSummaryModel.md +6 -6
- package/docs/TicketTimeDTO.md +9 -9
- package/docs/TicketsApi.md +10 -10
- package/docs/TokenResponseModel.md +3 -3
- package/docs/UpgradeOrderResponseModel.md +2 -2
- package/docs/UpgradeRequestModel.md +4 -4
- package/docs/UserEntity.md +10 -10
- package/docs/XeroLogEntity.md +10 -10
- package/models/ConnectionTypeEnum.ts +7 -17
- package/models/ReasonEnum.ts +24 -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 +1 -1
- package/dist/models/GroupEnum.d.ts +0 -43
- package/dist/models/GroupEnum.js +0 -45
- package/docs/NumberPortModel.md +0 -51
- package/docs/PostGetProductRequest.md +0 -24
- package/docs/ProductSearchDTO.md +0 -37
- package/docs/PromoSummariesModel.md +0 -27
- package/docs/PromoSummaryDTO.md +0 -29
- package/docs/PromotionsApi.md +0 -71
- package/docs/TcxHostingPricingEntity.md +0 -35
- package/docs/TcxInstallationDetailsModel.md +0 -45
- package/docs/TelephonySupportTicketModel.md +0 -41
- package/hs_err_pid16044.log +0 -249
- package/hs_err_pid44560.log +0 -249
- package/hs_err_pid53988.log +0 -249
- package/hs_err_pid58728.log +0 -40
- package/models/GroupEnum.ts +0 -44
|
@@ -6,8 +6,8 @@ CRM Date Activities
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**date** | **string** | Date
|
|
10
|
-
**activities** | [**Array<CrmActivityDTO>**](CrmActivityDTO.md) | Activities | [
|
|
9
|
+
**date** | **string** | Date | [optional] [default to undefined]
|
|
10
|
+
**activities** | [**Array<CrmActivityDTO>**](CrmActivityDTO.md) | Activities | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/CrmNoteEntity.md
CHANGED
|
@@ -6,16 +6,16 @@ CrmNotesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**customerId** | **string** | customerId | [
|
|
11
|
-
**userId** | **number** | userId | [
|
|
12
|
-
**type** | **string** | type | [
|
|
13
|
-
**note** | **string** | note | [
|
|
14
|
-
**timestamp** | **string** | timestamp | [
|
|
15
|
-
**journalTime** | **string** | journalTime | [
|
|
16
|
-
**duration** | **string** | duration | [
|
|
17
|
-
**callType** | **string** | callType | [
|
|
18
|
-
**callId** | **number** | callId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**customerId** | **string** | customerId | [default to undefined]
|
|
11
|
+
**userId** | **number** | userId | [default to undefined]
|
|
12
|
+
**type** | **string** | type | [default to undefined]
|
|
13
|
+
**note** | **string** | note | [default to undefined]
|
|
14
|
+
**timestamp** | **string** | timestamp | [default to undefined]
|
|
15
|
+
**journalTime** | **string** | journalTime | [default to undefined]
|
|
16
|
+
**duration** | **string** | duration | [default to undefined]
|
|
17
|
+
**callType** | **string** | callType | [default to undefined]
|
|
18
|
+
**callId** | **number** | callId | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
package/docs/CrmNoteModel.md
CHANGED
|
@@ -6,16 +6,16 @@ CrmNotesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**customerId** | **string** | customerId | [
|
|
11
|
-
**userId** | **number** | userId | [
|
|
12
|
-
**type** | **string** | type | [
|
|
13
|
-
**note** | **string** | note | [
|
|
14
|
-
**timestamp** | **string** | timestamp | [
|
|
15
|
-
**journalTime** | **string** | journalTime | [
|
|
16
|
-
**duration** | **string** | duration | [
|
|
17
|
-
**callType** | **string** | callType | [
|
|
18
|
-
**callId** | **number** | callId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**customerId** | **string** | customerId | [default to undefined]
|
|
11
|
+
**userId** | **number** | userId | [default to undefined]
|
|
12
|
+
**type** | **string** | type | [default to undefined]
|
|
13
|
+
**note** | **string** | note | [default to undefined]
|
|
14
|
+
**timestamp** | **string** | timestamp | [default to undefined]
|
|
15
|
+
**journalTime** | **string** | journalTime | [default to undefined]
|
|
16
|
+
**duration** | **string** | duration | [default to undefined]
|
|
17
|
+
**callType** | **string** | callType | [default to undefined]
|
|
18
|
+
**callId** | **number** | callId | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -6,12 +6,12 @@ Customer Coordinates
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | ID | [
|
|
10
|
-
**company** | **string** | Company | [
|
|
9
|
+
**id** | **string** | ID | [default to undefined]
|
|
10
|
+
**company** | **string** | Company | [default to undefined]
|
|
11
11
|
**resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
|
|
12
|
-
**postCode** | **string** | Post Code | [
|
|
13
|
-
**latitude** | **string** | Latitude | [
|
|
14
|
-
**longitude** | **string** | Longitude | [
|
|
12
|
+
**postCode** | **string** | Post Code | [default to undefined]
|
|
13
|
+
**latitude** | **string** | Latitude | [default to undefined]
|
|
14
|
+
**longitude** | **string** | Longitude | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -6,10 +6,10 @@ SIP Trunk Customer
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**addressLine1** | **string** | End User Address Line 1 | [
|
|
10
|
-
**addressLine2** | **string** | End User Address Line 2 | [
|
|
11
|
-
**addressCity** | **string** | End User Town/City | [
|
|
12
|
-
**addressPostcode** | **string** | End User Postal Code | [
|
|
9
|
+
**addressLine1** | **string** | End User Address Line 1 | [default to undefined]
|
|
10
|
+
**addressLine2** | **string** | End User Address Line 2 | [default to undefined]
|
|
11
|
+
**addressCity** | **string** | End User Town/City | [default to undefined]
|
|
12
|
+
**addressPostcode** | **string** | End User Postal Code | [default to undefined]
|
|
13
13
|
**companyName** | **string** | End User Company Name | [optional] [default to undefined]
|
|
14
14
|
**contactFirstName** | **string** | End User Contact First Name | [optional] [default to undefined]
|
|
15
15
|
**contactLastName** | **string** | End User Contact Surname | [optional] [default to undefined]
|
|
@@ -6,8 +6,8 @@ Order Item Request
|
|
|
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
|
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
13
13
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
@@ -6,19 +6,19 @@ Customer List Account
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
10
|
-
**xeroId** | **string** | Xero ID | [
|
|
11
|
-
**accountNumber** | **string** | Account Number | [
|
|
12
|
-
**company** | **string** | Company Name | [
|
|
13
|
-
**domains** | **Array<string>** | Associated Email Domains | [
|
|
14
|
-
**telephone** | **string** | Telephone | [
|
|
15
|
-
**vatNumber** | **string** | VAT Number | [
|
|
16
|
-
**companyNumber** | **string** | Company Number | [
|
|
17
|
-
**cname** | **string** | Wizard CNAME | [
|
|
18
|
-
**partnerId** | **string** | 3CX Reseller ID | [
|
|
19
|
-
**status** | **boolean** | Account Status | [
|
|
20
|
-
**portalAccess** | **boolean** | Portal Access | [
|
|
21
|
-
**prizePromo** | **boolean** | Prize Promo | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**xeroId** | **string** | Xero ID | [default to undefined]
|
|
11
|
+
**accountNumber** | **string** | Account Number | [default to undefined]
|
|
12
|
+
**company** | **string** | Company Name | [default to undefined]
|
|
13
|
+
**domains** | **Array<string>** | Associated Email Domains | [default to undefined]
|
|
14
|
+
**telephone** | **string** | Telephone | [default to undefined]
|
|
15
|
+
**vatNumber** | **string** | VAT Number | [default to undefined]
|
|
16
|
+
**companyNumber** | **string** | Company Number | [default to undefined]
|
|
17
|
+
**cname** | **string** | Wizard CNAME | [default to undefined]
|
|
18
|
+
**partnerId** | **string** | 3CX Reseller ID | [default to undefined]
|
|
19
|
+
**status** | **boolean** | Account Status | [default to undefined]
|
|
20
|
+
**portalAccess** | **boolean** | Portal Access | [default to undefined]
|
|
21
|
+
**prizePromo** | **boolean** | Prize Promo | [default to undefined]
|
|
22
22
|
|
|
23
23
|
## Example
|
|
24
24
|
|
|
@@ -7,12 +7,12 @@ Order Request
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**orderReference** | **string** | Order Reference | [optional] [default to undefined]
|
|
10
|
-
**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [
|
|
11
|
-
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [
|
|
10
|
+
**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [default to undefined]
|
|
11
|
+
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [default to undefined]
|
|
12
12
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) |
|
|
14
|
-
**partShip** | **boolean** | Part Ship Order | [
|
|
15
|
-
**quote** | **boolean** | Quote | [
|
|
13
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
|
|
14
|
+
**partShip** | **boolean** | Part Ship Order | [default to undefined]
|
|
15
|
+
**quote** | **boolean** | Quote | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -6,8 +6,8 @@ Customer Price List
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Price List ID | [
|
|
10
|
-
**name** | **string** | Price List Name | [
|
|
9
|
+
**id** | **number** | Price List ID | [default to undefined]
|
|
10
|
+
**name** | **string** | Price List Name | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# CustomerRmasModel
|
|
2
|
+
|
|
3
|
+
Customer RMAs
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**results** | [**Array<RmaSummaryDTO>**](RmaSummaryDTO.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
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { CustomerRmasModel } from 'yellowgrid-api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: CustomerRmasModel = {
|
|
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)
|
|
@@ -6,12 +6,12 @@ Customer Summary Report
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**companyName** | **string** | Company Name | [
|
|
10
|
-
**contract** | [**CompanyContractModel**](CompanyContractModel.md) | | [
|
|
11
|
-
**monthlyUsages** | [**Array<MonthlyUsageModel>**](MonthlyUsageModel.md) | Contract Use by Month | [
|
|
12
|
-
**ticketTimes** | [**Array<TicketTimeDTO>**](TicketTimeDTO.md) | Time Entries | [
|
|
13
|
-
**supportBankTimeTotal** | **string** | Time Entries | [
|
|
14
|
-
**fixedPriceTimeTotal** | **string** | Time Entries | [
|
|
9
|
+
**companyName** | **string** | Company Name | [default to undefined]
|
|
10
|
+
**contract** | [**CompanyContractModel**](CompanyContractModel.md) | | [default to undefined]
|
|
11
|
+
**monthlyUsages** | [**Array<MonthlyUsageModel>**](MonthlyUsageModel.md) | Contract Use by Month | [default to undefined]
|
|
12
|
+
**ticketTimes** | [**Array<TicketTimeDTO>**](TicketTimeDTO.md) | Time Entries | [default to undefined]
|
|
13
|
+
**supportBankTimeTotal** | **string** | Time Entries | [default to undefined]
|
|
14
|
+
**fixedPriceTimeTotal** | **string** | Time Entries | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -6,9 +6,9 @@ DDI Range
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**areaCode** | **string** | UK Area Code | [
|
|
10
|
-
**quantity** | **number** | Number of DDIs | [
|
|
11
|
-
**consecutive** | **boolean** | Consecutive Numbers | [
|
|
9
|
+
**areaCode** | **string** | UK Area Code | [default to '161']
|
|
10
|
+
**quantity** | **number** | Number of DDIs | [default to 1]
|
|
11
|
+
**consecutive** | **boolean** | Consecutive Numbers | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@ DDI Range Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**ranges** | [**Array<DdiRangeRequestModel>**](DdiRangeRequestModel.md) | DDI Ranges | [
|
|
9
|
+
**ranges** | [**Array<DdiRangeRequestModel>**](DdiRangeRequestModel.md) | DDI Ranges | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -6,8 +6,8 @@ Detailed Order Item Request
|
|
|
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
|
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
13
13
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
@@ -7,12 +7,12 @@ Detailed Order Request
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**orderReference** | **string** | Order Reference | [optional] [default to undefined]
|
|
10
|
-
**items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [
|
|
11
|
-
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [
|
|
10
|
+
**items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [default to undefined]
|
|
11
|
+
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [default to undefined]
|
|
12
12
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) |
|
|
14
|
-
**partShip** | **boolean** | Part Ship Order | [
|
|
15
|
-
**quote** | **boolean** | Quote | [
|
|
13
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
|
|
14
|
+
**partShip** | **boolean** | Part Ship Order | [default to undefined]
|
|
15
|
+
**quote** | **boolean** | Quote | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -6,7 +6,7 @@ Divert Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**numbers** | **Array<string>** | Numbers to divert | [
|
|
9
|
+
**numbers** | **Array<string>** | Numbers to divert | [default to undefined]
|
|
10
10
|
**destination** | **string** | Destination | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -6,9 +6,9 @@ Divert
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**number** | **string** | Number | [
|
|
9
|
+
**number** | **string** | Number | [default to undefined]
|
|
10
10
|
**destination** | **string** | Divert Destination | [optional] [default to undefined]
|
|
11
|
-
**status** | **string** | Divert Status | [
|
|
11
|
+
**status** | **string** | Divert Status | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,10 +6,10 @@ EdTechPro Trusts
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
10
|
-
**clientId** | **number** | Client ID | [
|
|
11
|
-
**customerId** | **number** | Customer ID | [
|
|
12
|
-
**clientName** | **string** | Client/Trust Name | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**clientId** | **number** | Client ID | [default to undefined]
|
|
11
|
+
**customerId** | **number** | Customer ID | [default to undefined]
|
|
12
|
+
**clientName** | **string** | Client/Trust Name | [default to undefined]
|
|
13
13
|
**apiKey** | **string** | Client API Key | [optional] [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
@@ -6,18 +6,18 @@ EdTechPro School
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
10
|
-
**clientId** | **number** | Client/Trust ID | [
|
|
11
|
-
**schoolId** | **number** | School ID | [
|
|
12
|
-
**schoolName** | **string** | School Name | [
|
|
13
|
-
**sku** | **string** | Product Sku | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**clientId** | **number** | Client/Trust ID | [default to undefined]
|
|
11
|
+
**schoolId** | **number** | School ID | [default to undefined]
|
|
12
|
+
**schoolName** | **string** | School Name | [default to undefined]
|
|
13
|
+
**sku** | **string** | Product Sku | [default to undefined]
|
|
14
14
|
**orderReference** | **string** | Order Reference | [optional] [default to undefined]
|
|
15
|
-
**creationDate** | **string** | Creation Date | [
|
|
16
|
-
**price** | **number** | School Annual Price | [
|
|
17
|
-
**rrp** | **number** | School Annual Price (RRP) | [
|
|
18
|
-
**templateUrl** | **string** | Integration Template URL | [
|
|
19
|
-
**clientName** | **string** | Client/Trust Name | [
|
|
20
|
-
**customerId** | **number** | Customer ID | [
|
|
15
|
+
**creationDate** | **string** | Creation Date | [default to undefined]
|
|
16
|
+
**price** | **number** | School Annual Price | [default to undefined]
|
|
17
|
+
**rrp** | **number** | School Annual Price (RRP) | [default to undefined]
|
|
18
|
+
**templateUrl** | **string** | Integration Template URL | [default to undefined]
|
|
19
|
+
**clientName** | **string** | Client/Trust Name | [default to undefined]
|
|
20
|
+
**customerId** | **number** | Customer ID | [default to undefined]
|
|
21
21
|
**apiKey** | **string** | API Key | [optional] [default to undefined]
|
|
22
22
|
|
|
23
23
|
## Example
|
|
@@ -6,10 +6,10 @@ EdTechPro Schools
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<EdTechProSchoolModel>**](EdTechProSchoolModel.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<EdTechProSchoolModel>**](EdTechProSchoolModel.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
|
|
|
@@ -6,11 +6,11 @@ EdTechPro Setup Details
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**clientId** | **number** | Client ID | [
|
|
10
|
-
**schoolName** | **string** | School Name | [
|
|
11
|
-
**apiKey** | **string** | API Key | [
|
|
12
|
-
**templateUrl** | **string** | Template Url | [
|
|
13
|
-
**installed** | **boolean** | installed | [
|
|
9
|
+
**clientId** | **number** | Client ID | [default to undefined]
|
|
10
|
+
**schoolName** | **string** | School Name | [default to undefined]
|
|
11
|
+
**apiKey** | **string** | API Key | [default to undefined]
|
|
12
|
+
**templateUrl** | **string** | Template Url | [default to undefined]
|
|
13
|
+
**installed** | **boolean** | installed | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -1,19 +1,20 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EmailRequestModel
|
|
2
2
|
|
|
3
|
+
Email Request Model
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
9
|
+
**email** | **string** | Email Address | [default to undefined]
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
12
13
|
```typescript
|
|
13
|
-
import {
|
|
14
|
+
import { EmailRequestModel } from 'yellowgrid-api-ts';
|
|
14
15
|
|
|
15
|
-
const instance:
|
|
16
|
-
|
|
16
|
+
const instance: EmailRequestModel = {
|
|
17
|
+
email,
|
|
17
18
|
};
|
|
18
19
|
```
|
|
19
20
|
|
package/docs/EventDTO.md
CHANGED
|
@@ -6,14 +6,14 @@ Service Event DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**title** | **string** | Service Event Title | [
|
|
10
|
-
**type** | **number** | Service Event Type | [
|
|
11
|
-
**service** | **number** | Service Impacted | [
|
|
12
|
-
**statusName** | **string** | Event Status Description | [
|
|
13
|
-
**typeName** | **string** | Event Type Description | [
|
|
14
|
-
**id** | **number** | Service Event ID | [
|
|
15
|
-
**status** | **number** | Service Event Status | [
|
|
16
|
-
**updates** | [**Array<EventUpdateDTO>**](EventUpdateDTO.md) | Service Event Updates | [
|
|
9
|
+
**title** | **string** | Service Event Title | [default to undefined]
|
|
10
|
+
**type** | **number** | Service Event Type | [default to undefined]
|
|
11
|
+
**service** | **number** | Service Impacted | [default to undefined]
|
|
12
|
+
**statusName** | **string** | Event Status Description | [default to undefined]
|
|
13
|
+
**typeName** | **string** | Event Type Description | [default to undefined]
|
|
14
|
+
**id** | **number** | Service Event ID | [default to undefined]
|
|
15
|
+
**status** | **number** | Service Event Status | [default to undefined]
|
|
16
|
+
**updates** | [**Array<EventUpdateDTO>**](EventUpdateDTO.md) | Service Event Updates | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
package/docs/EventRequestDTO.md
CHANGED
|
@@ -6,9 +6,9 @@ Service Event Request DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**title** | **string** | Service Event Title | [
|
|
10
|
-
**type** | **number** | Service Event Type | [
|
|
11
|
-
**service** | **number** | Service Impacted | [
|
|
9
|
+
**title** | **string** | Service Event Title | [default to undefined]
|
|
10
|
+
**type** | **number** | Service Event Type | [default to undefined]
|
|
11
|
+
**service** | **number** | Service Impacted | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,8 +6,8 @@ Service Event Subscribption Model
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | id | [
|
|
10
|
-
**email** | **string** | email | [
|
|
9
|
+
**id** | **string** | id | [default to undefined]
|
|
10
|
+
**email** | **string** | email | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/EventUpdateDTO.md
CHANGED
|
@@ -6,10 +6,10 @@ Service Event Update DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**message** | **string** | Service Event Update Message | [
|
|
10
|
-
**type** | **number** | Service Event Update Type | [
|
|
11
|
-
**createdAt** | **string** | Date Time | [
|
|
12
|
-
**typeName** | **string** | Service Event Update Type Description | [
|
|
9
|
+
**message** | **string** | Service Event Update Message | [default to undefined]
|
|
10
|
+
**type** | **number** | Service Event Update Type | [default to undefined]
|
|
11
|
+
**createdAt** | **string** | Date Time | [default to undefined]
|
|
12
|
+
**typeName** | **string** | Service Event Update Type Description | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,11 +6,11 @@ Event Update Entity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**eventId** | **number** | eventId | [
|
|
11
|
-
**message** | **string** | message | [
|
|
12
|
-
**type** | **number** | type | [
|
|
13
|
-
**createdAt** | **string** | createdAt | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**eventId** | **number** | eventId | [default to undefined]
|
|
11
|
+
**message** | **string** | message | [default to undefined]
|
|
12
|
+
**type** | **number** | type | [default to undefined]
|
|
13
|
+
**createdAt** | **string** | createdAt | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,9 +6,9 @@ Service Event Update Request DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**message** | **string** | Service Event Update Message | [
|
|
10
|
-
**type** | **number** | Service Event Update Type | [
|
|
11
|
-
**createdAt** | **string** | Date Time | [
|
|
9
|
+
**message** | **string** | Service Event Update Message | [default to undefined]
|
|
10
|
+
**type** | **number** | Service Event Update Type | [default to undefined]
|
|
11
|
+
**createdAt** | **string** | Date Time | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/ExpiringKeyDTO.md
CHANGED
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**expiryDate** | **string** | Date Time | [
|
|
10
|
-
**licenceKey** | **string** | Licence Key | [
|
|
11
|
-
**edition** | **string** | Edition | [
|
|
12
|
-
**type** | **string** | Type | [
|
|
13
|
-
**partner** | [**PartnerDTO**](PartnerDTO.md) | | [
|
|
9
|
+
**expiryDate** | **string** | Date Time | [default to undefined]
|
|
10
|
+
**licenceKey** | **string** | Licence Key | [default to undefined]
|
|
11
|
+
**edition** | **string** | Edition | [default to undefined]
|
|
12
|
+
**type** | **string** | Type | [default to undefined]
|
|
13
|
+
**partner** | [**PartnerDTO**](PartnerDTO.md) | | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,8 +6,8 @@ Fraud Management
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**dailyLimit** | **number** | Daily call spend (£) | [
|
|
10
|
-
**weeklyLimit** | **number** | Monthly call spend (£) | [
|
|
9
|
+
**dailyLimit** | **number** | Daily call spend (£) | [default to 50]
|
|
10
|
+
**weeklyLimit** | **number** | Monthly call spend (£) | [default to 100]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,10 +6,10 @@ Freshdesk Company Tickets
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<TicketSummaryModel>**](TicketSummaryModel.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<TicketSummaryModel>**](TicketSummaryModel.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
|
|
|
@@ -6,13 +6,13 @@ FreshdeskTicketsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**subject** | **string** | subject | [
|
|
11
|
-
**companyId** | **number** | companyId | [
|
|
12
|
-
**groupId** | **number** | groupId | [
|
|
13
|
-
**productId** | **number** | productId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**subject** | **string** | subject | [default to undefined]
|
|
11
|
+
**companyId** | **number** | companyId | [default to undefined]
|
|
12
|
+
**groupId** | **number** | groupId | [default to undefined]
|
|
13
|
+
**productId** | **number** | productId | [default to undefined]
|
|
14
14
|
**statusId** | **number** | status | [optional] [default to undefined]
|
|
15
|
-
**lastUpdated** | **string** | lastUpdated | [
|
|
15
|
+
**lastUpdated** | **string** | lastUpdated | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -6,11 +6,11 @@ FtpAccountsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**username** | **string** | username | [
|
|
11
|
-
**password** | **string** | password | [
|
|
12
|
-
**home** | **string** | home | [
|
|
13
|
-
**host** | **string** | host | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**username** | **string** | username | [default to undefined]
|
|
11
|
+
**password** | **string** | password | [default to undefined]
|
|
12
|
+
**home** | **string** | home | [default to undefined]
|
|
13
|
+
**host** | **string** | host | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/GenericFileModel.md
CHANGED
|
@@ -6,9 +6,9 @@ Generic File
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**content** | **string** | File Content | [
|
|
10
|
-
**name** | **string** | File Name | [
|
|
11
|
-
**type** | **string** | File Type | [
|
|
9
|
+
**content** | **string** | File Content | [default to undefined]
|
|
10
|
+
**name** | **string** | File Name | [default to undefined]
|
|
11
|
+
**type** | **string** | File Type | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|