yellowgrid-api-ts 3.2.167-dev.0 → 3.2.169-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 +2 -23
- package/.openapi-generator/VERSION +1 -1
- package/README.md +3 -53
- package/api.ts +5407 -3273
- package/base.ts +26 -2
- package/common.ts +39 -16
- package/configuration.ts +21 -27
- package/dist/api.d.ts +4537 -1460
- package/dist/api.js +897 -3030
- package/dist/base.d.ts +25 -1
- package/dist/base.js +21 -2
- package/dist/common.d.ts +36 -5
- package/dist/common.js +39 -17
- package/dist/configuration.d.ts +18 -25
- package/dist/configuration.js +4 -4
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/GroupEnum.d.ts +43 -0
- package/dist/models/GroupEnum.js +45 -0
- package/docs/AbstractOrderRequestDTO.md +1 -1
- package/docs/AccountsApi.md +54 -1428
- package/docs/AdminOrderRequestDTO.md +1 -1
- package/docs/AdminUserModel.md +0 -2
- package/docs/BillingApi.md +1 -1
- package/docs/CRMApi.md +1 -121
- package/docs/Class3CXApi.md +1 -49
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -56
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/CreditAccountEntity.md +0 -6
- package/docs/CustomerOrderRequestDTO.md +1 -1
- package/docs/DetailedOrderRequestDTO.md +1 -1
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NumberPortModel.md +51 -0
- package/docs/NumberPortingApi.md +6 -6
- package/docs/OAuth20Api.md +1 -49
- package/docs/OrdersApi.md +1 -1
- package/docs/{PatchUpdateAccountCnameRequest.md → PatchSetTcxWizardCnameRequest.md} +3 -3
- package/docs/PortalAccountModel.md +2 -6
- package/docs/{CreateCrmNoteBody.md → PostAddAdminNoteRequest.md} +3 -3
- package/docs/PostGetProductRequest.md +24 -0
- package/docs/PricingApi.md +1 -1
- package/docs/ProductSummaryDTO.md +2 -2
- package/docs/ProductsApi.md +1 -1
- package/docs/ProspectDTO.md +2 -4
- package/docs/ProspectsApi.md +1 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/RecordingBackupAzureModel.md +0 -2
- package/docs/RecordingsBackupInfoDTO.md +2 -2
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- package/docs/ServicesApi.md +1 -1
- package/docs/ShipmentRequestDTO.md +2 -2
- package/docs/ShippingApi.md +1 -1
- package/docs/StockManagementApi.md +1 -1
- package/docs/SystemApi.md +1 -1
- package/docs/TcxInstallationDetailsModel.md +45 -0
- package/docs/TcxKeySummaryDTO.md +1 -1
- package/docs/TelephonySupportTicketModel.md +41 -0
- package/docs/TicketsApi.md +1 -1
- package/docs/WebhooksApi.md +1 -1
- package/hs_err_pid16044.log +249 -0
- package/hs_err_pid44560.log +249 -0
- package/hs_err_pid53988.log +249 -0
- package/hs_err_pid58728.log +40 -0
- package/index.ts +1 -1
- package/models/GroupEnum.ts +44 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/dist/models/StatusEnum.d.ts +0 -18
- package/dist/models/StatusEnum.js +0 -20
- package/dist/src/apis/AccountsApi.d.ts +0 -258
- package/dist/src/apis/AccountsApi.js +0 -975
- package/dist/src/apis/CRMApi.d.ts +0 -26
- package/dist/src/apis/CRMApi.js +0 -122
- package/dist/src/apis/Class3CXApi.d.ts +0 -44
- package/dist/src/apis/Class3CXApi.js +0 -177
- package/dist/src/apis/Class3CXInstallationWizardApi.d.ts +0 -446
- package/dist/src/apis/Class3CXInstallationWizardApi.js +0 -1740
- package/dist/src/apis/Class3CXInstallationsApi.d.ts +0 -253
- package/dist/src/apis/Class3CXInstallationsApi.js +0 -806
- package/dist/src/apis/Class3CXIntegrationsApi.d.ts +0 -102
- package/dist/src/apis/Class3CXIntegrationsApi.js +0 -386
- package/dist/src/apis/Class3CXMultiTenantApi.d.ts +0 -122
- package/dist/src/apis/Class3CXMultiTenantApi.js +0 -431
- package/dist/src/apis/MyPBXToolsApi.d.ts +0 -32
- package/dist/src/apis/MyPBXToolsApi.js +0 -136
- package/dist/src/apis/OAuth20Api.d.ts +0 -185
- package/dist/src/apis/OAuth20Api.js +0 -507
- package/dist/src/apis/OrdersApi.d.ts +0 -154
- package/dist/src/apis/OrdersApi.js +0 -512
- package/dist/src/apis/PricingApi.d.ts +0 -154
- package/dist/src/apis/PricingApi.js +0 -308
- package/dist/src/apis/ProductsApi.d.ts +0 -135
- package/dist/src/apis/ProductsApi.js +0 -531
- package/dist/src/apis/ProvisioningApi.d.ts +0 -112
- package/dist/src/apis/ProvisioningApi.js +0 -427
- package/dist/src/apis/SIPTrunksApi.d.ts +0 -315
- package/dist/src/apis/SIPTrunksApi.js +0 -1197
- package/dist/src/apis/SMSApi.d.ts +0 -30
- package/dist/src/apis/SMSApi.js +0 -130
- package/dist/src/apis/ServicesApi.d.ts +0 -81
- package/dist/src/apis/ServicesApi.js +0 -386
- package/dist/src/apis/ShippingApi.d.ts +0 -45
- package/dist/src/apis/ShippingApi.js +0 -179
- package/dist/src/apis/StockManagementApi.d.ts +0 -345
- package/dist/src/apis/StockManagementApi.js +0 -1293
- package/dist/src/apis/SystemApi.d.ts +0 -37
- package/dist/src/apis/SystemApi.js +0 -146
- package/dist/src/apis/TicketsApi.d.ts +0 -79
- package/dist/src/apis/TicketsApi.js +0 -360
- package/dist/src/apis/WebhooksApi.d.ts +0 -56
- package/dist/src/apis/WebhooksApi.js +0 -189
- package/dist/src/apis/index.d.ts +0 -21
- package/dist/src/apis/index.js +0 -39
- package/dist/src/index.d.ts +0 -3
- package/dist/src/index.js +0 -21
- package/dist/src/models/AbstractOrderRequestDTO.d.ts +0 -71
- package/dist/src/models/AbstractOrderRequestDTO.js +0 -64
- package/dist/src/models/AccountContactEntity.d.ts +0 -104
- package/dist/src/models/AccountContactEntity.js +0 -73
- package/dist/src/models/AccountContactModel.d.ts +0 -104
- package/dist/src/models/AccountContactModel.js +0 -73
- package/dist/src/models/AccountContactRequestModel.d.ts +0 -80
- package/dist/src/models/AccountContactRequestModel.js +0 -65
- package/dist/src/models/AccountDetailedSummaryDTO.d.ts +0 -89
- package/dist/src/models/AccountDetailedSummaryDTO.js +0 -70
- package/dist/src/models/AccountRequestModel.d.ts +0 -128
- package/dist/src/models/AccountRequestModel.js +0 -81
- package/dist/src/models/AccountSummaryDTO.d.ts +0 -44
- package/dist/src/models/AccountSummaryDTO.js +0 -53
- package/dist/src/models/AccountsResponseModel.d.ts +0 -51
- package/dist/src/models/AccountsResponseModel.js +0 -56
- package/dist/src/models/AddressModel.d.ts +0 -110
- package/dist/src/models/AddressModel.js +0 -75
- package/dist/src/models/AddressRequestModel.d.ts +0 -50
- package/dist/src/models/AddressRequestModel.js +0 -55
- package/dist/src/models/AdminOrderRequestDTO.d.ts +0 -113
- package/dist/src/models/AdminOrderRequestDTO.js +0 -78
- package/dist/src/models/AdminUserModel.d.ts +0 -79
- package/dist/src/models/AdminUserModel.js +0 -72
- package/dist/src/models/AgentHoursGraphModel.d.ts +0 -51
- package/dist/src/models/AgentHoursGraphModel.js +0 -56
- package/dist/src/models/AgentHoursGraphMonthModel.d.ts +0 -38
- package/dist/src/models/AgentHoursGraphMonthModel.js +0 -51
- package/dist/src/models/ApiLogEntity.d.ts +0 -98
- package/dist/src/models/ApiLogEntity.js +0 -71
- package/dist/src/models/AreaCodeModel.d.ts +0 -38
- package/dist/src/models/AreaCodeModel.js +0 -51
- package/dist/src/models/AttachmentModel.d.ts +0 -56
- package/dist/src/models/AttachmentModel.js +0 -57
- package/dist/src/models/AttributeSetEnum.d.ts +0 -38
- package/dist/src/models/AttributeSetEnum.js +0 -51
- package/dist/src/models/AuditLogEntity.d.ts +0 -80
- package/dist/src/models/AuditLogEntity.js +0 -65
- package/dist/src/models/AuthCodeResponseModel.d.ts +0 -44
- package/dist/src/models/AuthCodeResponseModel.js +0 -53
- package/dist/src/models/BasicItemDTO.d.ts +0 -38
- package/dist/src/models/BasicItemDTO.js +0 -51
- package/dist/src/models/BasicProductDTO.d.ts +0 -38
- package/dist/src/models/BasicProductDTO.js +0 -51
- package/dist/src/models/BatchEntity.d.ts +0 -128
- package/dist/src/models/BatchEntity.js +0 -81
- package/dist/src/models/CallBarringModel.d.ts +0 -56
- package/dist/src/models/CallBarringModel.js +0 -57
- package/dist/src/models/ClientDetailsModel.d.ts +0 -68
- package/dist/src/models/ClientDetailsModel.js +0 -61
- package/dist/src/models/ClientModel.d.ts +0 -50
- package/dist/src/models/ClientModel.js +0 -55
- package/dist/src/models/CompanyContractModel.d.ts +0 -56
- package/dist/src/models/CompanyContractModel.js +0 -57
- package/dist/src/models/ContactInfoModel.d.ts +0 -56
- package/dist/src/models/ContactInfoModel.js +0 -57
- package/dist/src/models/ConversationModel.d.ts +0 -75
- package/dist/src/models/ConversationModel.js +0 -64
- package/dist/src/models/CourierPriceEntity.d.ts +0 -86
- package/dist/src/models/CourierPriceEntity.js +0 -67
- package/dist/src/models/CreditAccountEntity.d.ts +0 -152
- package/dist/src/models/CreditAccountEntity.js +0 -89
- package/dist/src/models/CrmContactDTO.d.ts +0 -68
- package/dist/src/models/CrmContactDTO.js +0 -61
- package/dist/src/models/CustomerInformationModel.d.ts +0 -68
- package/dist/src/models/CustomerInformationModel.js +0 -61
- package/dist/src/models/CustomerItemRequestDTO.d.ts +0 -81
- package/dist/src/models/CustomerItemRequestDTO.js +0 -66
- package/dist/src/models/CustomerOrderRequestDTO.d.ts +0 -71
- package/dist/src/models/CustomerOrderRequestDTO.js +0 -64
- package/dist/src/models/CustomerPriceListEnum.d.ts +0 -38
- package/dist/src/models/CustomerPriceListEnum.js +0 -51
- package/dist/src/models/CustomerSummaryReportDTO.d.ts +0 -65
- package/dist/src/models/CustomerSummaryReportDTO.js +0 -62
- package/dist/src/models/DdiRangeRequestModel.d.ts +0 -44
- package/dist/src/models/DdiRangeRequestModel.js +0 -53
- package/dist/src/models/DdiRangesRequestModel.d.ts +0 -33
- package/dist/src/models/DdiRangesRequestModel.js +0 -50
- package/dist/src/models/DetailedItemRequestDTO.d.ts +0 -99
- package/dist/src/models/DetailedItemRequestDTO.js +0 -72
- package/dist/src/models/DetailedOrderRequestDTO.d.ts +0 -71
- package/dist/src/models/DetailedOrderRequestDTO.js +0 -64
- package/dist/src/models/DivertRequestModel.d.ts +0 -38
- package/dist/src/models/DivertRequestModel.js +0 -51
- package/dist/src/models/DivertResponseModel.d.ts +0 -52
- package/dist/src/models/DivertResponseModel.js +0 -61
- package/dist/src/models/EdTechProClientEntity.d.ts +0 -56
- package/dist/src/models/EdTechProClientEntity.js +0 -57
- package/dist/src/models/EdTechProSchoolModel.d.ts +0 -104
- package/dist/src/models/EdTechProSchoolModel.js +0 -73
- package/dist/src/models/EdTechProSchoolsModel.d.ts +0 -51
- package/dist/src/models/EdTechProSchoolsModel.js +0 -56
- package/dist/src/models/EdTechProSetupModel.d.ts +0 -56
- package/dist/src/models/EdTechProSetupModel.js +0 -57
- package/dist/src/models/EventDTO.d.ts +0 -84
- package/dist/src/models/EventDTO.js +0 -73
- package/dist/src/models/EventRequestDTO.d.ts +0 -44
- package/dist/src/models/EventRequestDTO.js +0 -53
- package/dist/src/models/EventSubscriptionModel.d.ts +0 -38
- package/dist/src/models/EventSubscriptionModel.js +0 -51
- package/dist/src/models/EventTypeEnum.d.ts +0 -19
- package/dist/src/models/EventTypeEnum.js +0 -24
- package/dist/src/models/EventUpdateDTO.d.ts +0 -50
- package/dist/src/models/EventUpdateDTO.js +0 -55
- package/dist/src/models/EventUpdateEntity.d.ts +0 -56
- package/dist/src/models/EventUpdateEntity.js +0 -57
- package/dist/src/models/EventUpdateRequestDTO.d.ts +0 -44
- package/dist/src/models/EventUpdateRequestDTO.js +0 -53
- package/dist/src/models/FraudManagementModel.d.ts +0 -38
- package/dist/src/models/FraudManagementModel.js +0 -51
- package/dist/src/models/FreshdeskCompanyTicketsModel.d.ts +0 -51
- package/dist/src/models/FreshdeskCompanyTicketsModel.js +0 -56
- package/dist/src/models/FreshdeskTicketEntity.d.ts +0 -68
- package/dist/src/models/FreshdeskTicketEntity.js +0 -61
- package/dist/src/models/FtpAccountsEntity.d.ts +0 -56
- package/dist/src/models/FtpAccountsEntity.js +0 -57
- package/dist/src/models/GenericFileModel.d.ts +0 -44
- package/dist/src/models/GenericFileModel.js +0 -53
- package/dist/src/models/GetGetPrice200Response.d.ts +0 -32
- package/dist/src/models/GetGetPrice200Response.js +0 -49
- package/dist/src/models/GetGetRecording200Response.d.ts +0 -32
- package/dist/src/models/GetGetRecording200Response.js +0 -49
- package/dist/src/models/HostingChangeResponseModel.d.ts +0 -64
- package/dist/src/models/HostingChangeResponseModel.js +0 -65
- package/dist/src/models/HostingRegionDTO.d.ts +0 -59
- package/dist/src/models/HostingRegionDTO.js +0 -68
- package/dist/src/models/InstanceAutoFailoverEntity.d.ts +0 -56
- package/dist/src/models/InstanceAutoFailoverEntity.js +0 -57
- package/dist/src/models/InstanceDeletionScheduleEntity.d.ts +0 -50
- package/dist/src/models/InstanceDeletionScheduleEntity.js +0 -55
- package/dist/src/models/InstanceEntity.d.ts +0 -152
- package/dist/src/models/InstanceEntity.js +0 -89
- package/dist/src/models/InstanceFailoverEntity.d.ts +0 -92
- package/dist/src/models/InstanceFailoverEntity.js +0 -69
- package/dist/src/models/InstanceMonitoringEntity.d.ts +0 -44
- package/dist/src/models/InstanceMonitoringEntity.js +0 -53
- package/dist/src/models/InstanceMonitoringLogEntity.d.ts +0 -62
- package/dist/src/models/InstanceMonitoringLogEntity.js +0 -59
- package/dist/src/models/InstanceScheduledTasksEntity.d.ts +0 -62
- package/dist/src/models/InstanceScheduledTasksEntity.js +0 -59
- package/dist/src/models/InstanceTcxDetailsEntity.d.ts +0 -86
- package/dist/src/models/InstanceTcxDetailsEntity.js +0 -67
- package/dist/src/models/InstanceUserCredentialsEntity.d.ts +0 -56
- package/dist/src/models/InstanceUserCredentialsEntity.js +0 -57
- package/dist/src/models/ItemDTO.d.ts +0 -117
- package/dist/src/models/ItemDTO.js +0 -78
- package/dist/src/models/ItemDiscountEntity.d.ts +0 -77
- package/dist/src/models/ItemDiscountEntity.js +0 -70
- package/dist/src/models/ItemEntity.d.ts +0 -158
- package/dist/src/models/ItemEntity.js +0 -91
- package/dist/src/models/LinkedOrderEntity.d.ts +0 -38
- package/dist/src/models/LinkedOrderEntity.js +0 -51
- package/dist/src/models/MFARequiredModel.d.ts +0 -38
- package/dist/src/models/MFARequiredModel.js +0 -51
- package/dist/src/models/MonthlyUsageModel.d.ts +0 -38
- package/dist/src/models/MonthlyUsageModel.js +0 -51
- package/dist/src/models/MultiTenantChangeResponseModel.d.ts +0 -70
- package/dist/src/models/MultiTenantChangeResponseModel.js +0 -75
- package/dist/src/models/NavigationModel.d.ts +0 -50
- package/dist/src/models/NavigationModel.js +0 -55
- package/dist/src/models/OfflineInstancesEntity.d.ts +0 -56
- package/dist/src/models/OfflineInstancesEntity.js +0 -57
- package/dist/src/models/OrderEntity.d.ts +0 -374
- package/dist/src/models/OrderEntity.js +0 -163
- package/dist/src/models/OrderRequestModel.d.ts +0 -120
- package/dist/src/models/OrderRequestModel.js +0 -88
- package/dist/src/models/OrderSummariesModel.d.ts +0 -51
- package/dist/src/models/OrderSummariesModel.js +0 -56
- package/dist/src/models/OrderSummaryDTO.d.ts +0 -126
- package/dist/src/models/OrderSummaryDTO.js +0 -83
- package/dist/src/models/OrderTotalModel.d.ts +0 -111
- package/dist/src/models/OrderTotalModel.js +0 -100
- package/dist/src/models/OrderedItemEntity.d.ts +0 -110
- package/dist/src/models/OrderedItemEntity.js +0 -75
- package/dist/src/models/PatchSetTcxWizardCnameRequest.d.ts +0 -32
- package/dist/src/models/PatchSetTcxWizardCnameRequest.js +0 -49
- package/dist/src/models/PatchUpdateAccountContactPasswordRequest.d.ts +0 -32
- package/dist/src/models/PatchUpdateAccountContactPasswordRequest.js +0 -49
- package/dist/src/models/PortalAccountModel.d.ts +0 -171
- package/dist/src/models/PortalAccountModel.js +0 -96
- package/dist/src/models/PortalLoginModel.d.ts +0 -68
- package/dist/src/models/PortalLoginModel.js +0 -61
- package/dist/src/models/PostAddWebhook200Response.d.ts +0 -32
- package/dist/src/models/PostAddWebhook200Response.js +0 -49
- package/dist/src/models/PostGetClientCredentialsRequest.d.ts +0 -32
- package/dist/src/models/PostGetClientCredentialsRequest.js +0 -49
- package/dist/src/models/PostGetProductForCustomerRequest.d.ts +0 -50
- package/dist/src/models/PostGetProductForCustomerRequest.js +0 -55
- package/dist/src/models/PostGetProductRequest.d.ts +0 -44
- package/dist/src/models/PostGetProductRequest.js +0 -53
- package/dist/src/models/PriceListItemModel.d.ts +0 -56
- package/dist/src/models/PriceListItemModel.js +0 -57
- package/dist/src/models/PrizesEntity.d.ts +0 -62
- package/dist/src/models/PrizesEntity.js +0 -59
- package/dist/src/models/ProductPriceListItemModel.d.ts +0 -62
- package/dist/src/models/ProductPriceListItemModel.js +0 -59
- package/dist/src/models/ProductSearchResultsModel.d.ts +0 -33
- package/dist/src/models/ProductSearchResultsModel.js +0 -50
- package/dist/src/models/ProductSerialInfoModel.d.ts +0 -50
- package/dist/src/models/ProductSerialInfoModel.js +0 -55
- package/dist/src/models/ProductSummaryDTO.d.ts +0 -81
- package/dist/src/models/ProductSummaryDTO.js +0 -66
- package/dist/src/models/PromoCodesEntity.d.ts +0 -98
- package/dist/src/models/PromoCodesEntity.js +0 -71
- package/dist/src/models/PromoItemsEntity.d.ts +0 -74
- package/dist/src/models/PromoItemsEntity.js +0 -63
- package/dist/src/models/ProvisioningModel.d.ts +0 -56
- package/dist/src/models/ProvisioningModel.js +0 -57
- package/dist/src/models/ProvisioningRequestEntity.d.ts +0 -44
- package/dist/src/models/ProvisioningRequestEntity.js +0 -53
- package/dist/src/models/RecordingBackupAzureModel.d.ts +0 -50
- package/dist/src/models/RecordingBackupAzureModel.js +0 -55
- package/dist/src/models/RecordingsBackupInfoDTO.d.ts +0 -40
- package/dist/src/models/RecordingsBackupInfoDTO.js +0 -53
- package/dist/src/models/ResourceNotReadyException.d.ts +0 -44
- package/dist/src/models/ResourceNotReadyException.js +0 -53
- package/dist/src/models/RootAccessModel.d.ts +0 -44
- package/dist/src/models/RootAccessModel.js +0 -53
- package/dist/src/models/S3BucketEntity.d.ts +0 -50
- package/dist/src/models/S3BucketEntity.js +0 -55
- package/dist/src/models/ScannedItemModel.d.ts +0 -56
- package/dist/src/models/ScannedItemModel.js +0 -57
- package/dist/src/models/ScopeModel.d.ts +0 -38
- package/dist/src/models/ScopeModel.js +0 -51
- package/dist/src/models/ServiceEnum.d.ts +0 -14
- package/dist/src/models/ServiceEnum.js +0 -19
- package/dist/src/models/ServiceHealthDTO.d.ts +0 -48
- package/dist/src/models/ServiceHealthDTO.js +0 -61
- package/dist/src/models/ServiceHealthEnum.d.ts +0 -19
- package/dist/src/models/ServiceHealthEnum.js +0 -24
- package/dist/src/models/ServiceStatusDTO.d.ts +0 -60
- package/dist/src/models/ServiceStatusDTO.js +0 -65
- package/dist/src/models/ServiceStatusEnum.d.ts +0 -19
- package/dist/src/models/ServiceStatusEnum.js +0 -24
- package/dist/src/models/ShipmentAddressEntity.d.ts +0 -92
- package/dist/src/models/ShipmentAddressEntity.js +0 -69
- package/dist/src/models/ShipmentEntity.d.ts +0 -98
- package/dist/src/models/ShipmentEntity.js +0 -71
- package/dist/src/models/ShipmentItemEntity.d.ts +0 -56
- package/dist/src/models/ShipmentItemEntity.js +0 -57
- package/dist/src/models/ShippingConsignmentModel.d.ts +0 -51
- package/dist/src/models/ShippingConsignmentModel.js +0 -56
- package/dist/src/models/ShippingInformationDTO.d.ts +0 -45
- package/dist/src/models/ShippingInformationDTO.js +0 -54
- package/dist/src/models/ShippingServiceDTO.d.ts +0 -47
- package/dist/src/models/ShippingServiceDTO.js +0 -60
- package/dist/src/models/ShippingServiceModel.d.ts +0 -71
- package/dist/src/models/ShippingServiceModel.js +0 -68
- package/dist/src/models/ShippingServicesModel.d.ts +0 -33
- package/dist/src/models/ShippingServicesModel.js +0 -50
- package/dist/src/models/SipTrunkChangeResponseModel.d.ts +0 -77
- package/dist/src/models/SipTrunkChangeResponseModel.js +0 -78
- package/dist/src/models/SipTrunkCreationRequestModel.d.ts +0 -66
- package/dist/src/models/SipTrunkCreationRequestModel.js +0 -63
- package/dist/src/models/SipTrunkEntity.d.ts +0 -98
- package/dist/src/models/SipTrunkEntity.js +0 -71
- package/dist/src/models/SipTrunksResponseModel.d.ts +0 -51
- package/dist/src/models/SipTrunksResponseModel.js +0 -56
- package/dist/src/models/SmsAccountEntity.d.ts +0 -68
- package/dist/src/models/SmsAccountEntity.js +0 -61
- package/dist/src/models/SmsDataModel.d.ts +0 -33
- package/dist/src/models/SmsDataModel.js +0 -50
- package/dist/src/models/SmsMessageModel.d.ts +0 -44
- package/dist/src/models/SmsMessageModel.js +0 -53
- package/dist/src/models/SmsNumbersEntity.d.ts +0 -38
- package/dist/src/models/SmsNumbersEntity.js +0 -51
- package/dist/src/models/SmsPayloadModel.d.ts +0 -45
- package/dist/src/models/SmsPayloadModel.js +0 -54
- package/dist/src/models/SmsPhoneNumberModel.d.ts +0 -53
- package/dist/src/models/SmsPhoneNumberModel.js +0 -66
- package/dist/src/models/SmsResponseModel.d.ts +0 -67
- package/dist/src/models/SmsResponseModel.js +0 -68
- package/dist/src/models/SmsWhitelistEntity.d.ts +0 -38
- package/dist/src/models/SmsWhitelistEntity.js +0 -51
- package/dist/src/models/StockOrderCourierEntity.d.ts +0 -50
- package/dist/src/models/StockOrderCourierEntity.js +0 -55
- package/dist/src/models/StockOrderDeductionModel.d.ts +0 -50
- package/dist/src/models/StockOrderDeductionModel.js +0 -55
- package/dist/src/models/StockOrderDeductionRequestModel.d.ts +0 -38
- package/dist/src/models/StockOrderDeductionRequestModel.js +0 -51
- package/dist/src/models/StockOrderDeductionsEntity.d.ts +0 -50
- package/dist/src/models/StockOrderDeductionsEntity.js +0 -55
- package/dist/src/models/StockOrderEntity.d.ts +0 -158
- package/dist/src/models/StockOrderEntity.js +0 -91
- package/dist/src/models/StockOrderItemEntity.d.ts +0 -68
- package/dist/src/models/StockOrderItemEntity.js +0 -61
- package/dist/src/models/StockOrderItemModel.d.ts +0 -80
- package/dist/src/models/StockOrderItemModel.js +0 -65
- package/dist/src/models/StockOrderItemRequestModel.d.ts +0 -50
- package/dist/src/models/StockOrderItemRequestModel.js +0 -55
- package/dist/src/models/StockOrderModel.d.ts +0 -137
- package/dist/src/models/StockOrderModel.js +0 -97
- package/dist/src/models/StockOrderProductEntity.d.ts +0 -62
- package/dist/src/models/StockOrderProductEntity.js +0 -59
- package/dist/src/models/StockOrderRequestModel.d.ts +0 -46
- package/dist/src/models/StockOrderRequestModel.js +0 -55
- package/dist/src/models/StockOrderSupplierEntity.d.ts +0 -80
- package/dist/src/models/StockOrderSupplierEntity.js +0 -65
- package/dist/src/models/StockOrderSupplierModel.d.ts +0 -80
- package/dist/src/models/StockOrderSupplierModel.js +0 -65
- package/dist/src/models/StockOrdersModel.d.ts +0 -51
- package/dist/src/models/StockOrdersModel.js +0 -56
- package/dist/src/models/StockProductModel.d.ts +0 -120
- package/dist/src/models/StockProductModel.js +0 -81
- package/dist/src/models/StockProductPriceModel.d.ts +0 -39
- package/dist/src/models/StockProductPriceModel.js +0 -52
- package/dist/src/models/StockProductSummariesModel.d.ts +0 -51
- package/dist/src/models/StockProductSummariesModel.js +0 -56
- package/dist/src/models/StockProductSummaryModel.d.ts +0 -69
- package/dist/src/models/StockProductSummaryModel.js +0 -62
- package/dist/src/models/StockTransactionsEntity.d.ts +0 -74
- package/dist/src/models/StockTransactionsEntity.js +0 -63
- package/dist/src/models/SupplierEntity.d.ts +0 -80
- package/dist/src/models/SupplierEntity.js +0 -65
- package/dist/src/models/SupplierItemEntity.d.ts +0 -74
- package/dist/src/models/SupplierItemEntity.js +0 -63
- package/dist/src/models/TcxBackupEntity.d.ts +0 -80
- package/dist/src/models/TcxBackupEntity.js +0 -65
- package/dist/src/models/TcxBackupModel.d.ts +0 -140
- package/dist/src/models/TcxBackupModel.js +0 -85
- package/dist/src/models/TcxBillingEntity.d.ts +0 -86
- package/dist/src/models/TcxBillingEntity.js +0 -67
- package/dist/src/models/TcxBulkLicenceDetailsModel.d.ts +0 -40
- package/dist/src/models/TcxBulkLicenceDetailsModel.js +0 -53
- package/dist/src/models/TcxDeadLicenceEntity.d.ts +0 -44
- package/dist/src/models/TcxDeadLicenceEntity.js +0 -53
- package/dist/src/models/TcxExtsEntity.d.ts +0 -74
- package/dist/src/models/TcxExtsEntity.js +0 -63
- package/dist/src/models/TcxHostingPricingEntity.d.ts +0 -74
- package/dist/src/models/TcxHostingPricingEntity.js +0 -63
- package/dist/src/models/TcxInstallationDetailsModel.d.ts +0 -106
- package/dist/src/models/TcxInstallationDetailsModel.js +0 -75
- package/dist/src/models/TcxInstallationModel.d.ts +0 -200
- package/dist/src/models/TcxInstallationModel.js +0 -105
- package/dist/src/models/TcxInstallationsModel.d.ts +0 -51
- package/dist/src/models/TcxInstallationsModel.js +0 -56
- package/dist/src/models/TcxKeySummaryDTO.d.ts +0 -56
- package/dist/src/models/TcxKeySummaryDTO.js +0 -57
- package/dist/src/models/TcxKeysEntity.d.ts +0 -62
- package/dist/src/models/TcxKeysEntity.js +0 -59
- package/dist/src/models/TcxLicenceDetailsErrorModel.d.ts +0 -50
- package/dist/src/models/TcxLicenceDetailsErrorModel.js +0 -55
- package/dist/src/models/TcxLicenceDetailsModel.d.ts +0 -92
- package/dist/src/models/TcxLicenceDetailsModel.js +0 -69
- package/dist/src/models/TcxMacsEntity.d.ts +0 -44
- package/dist/src/models/TcxMacsEntity.js +0 -53
- package/dist/src/models/TcxMultiTenantModel.d.ts +0 -118
- package/dist/src/models/TcxMultiTenantModel.js +0 -83
- package/dist/src/models/TcxMultiTenantUserModel.d.ts +0 -44
- package/dist/src/models/TcxMultiTenantUserModel.js +0 -53
- package/dist/src/models/TcxMultiTenantsModel.d.ts +0 -51
- package/dist/src/models/TcxMultiTenantsModel.js +0 -56
- package/dist/src/models/TcxNumbersEntity.d.ts +0 -44
- package/dist/src/models/TcxNumbersEntity.js +0 -53
- package/dist/src/models/TcxOfficeHoursEntity.d.ts +0 -116
- package/dist/src/models/TcxOfficeHoursEntity.js +0 -77
- package/dist/src/models/TcxPhoneModel.d.ts +0 -68
- package/dist/src/models/TcxPhoneModel.js +0 -61
- package/dist/src/models/TcxPhonesEntity.d.ts +0 -62
- package/dist/src/models/TcxPhonesEntity.js +0 -59
- package/dist/src/models/TcxRemoteStorageModel.d.ts +0 -50
- package/dist/src/models/TcxRemoteStorageModel.js +0 -55
- package/dist/src/models/TcxSbcDTO.d.ts +0 -62
- package/dist/src/models/TcxSbcDTO.js +0 -59
- package/dist/src/models/TcxSbcEntity.d.ts +0 -122
- package/dist/src/models/TcxSbcEntity.js +0 -79
- package/dist/src/models/TcxSbcModel.d.ts +0 -122
- package/dist/src/models/TcxSbcModel.js +0 -79
- package/dist/src/models/TcxSetupEntity.d.ts +0 -207
- package/dist/src/models/TcxSetupEntity.js +0 -123
- package/dist/src/models/TcxSetupsModel.d.ts +0 -51
- package/dist/src/models/TcxSetupsModel.js +0 -56
- package/dist/src/models/TcxSipTrunksEntity.d.ts +0 -104
- package/dist/src/models/TcxSipTrunksEntity.js +0 -73
- package/dist/src/models/TcxTemplateXmlEnum.d.ts +0 -38
- package/dist/src/models/TcxTemplateXmlEnum.js +0 -51
- package/dist/src/models/TcxUsersEntity.d.ts +0 -62
- package/dist/src/models/TcxUsersEntity.js +0 -59
- package/dist/src/models/TcxWizardConfigModel.d.ts +0 -39
- package/dist/src/models/TcxWizardConfigModel.js +0 -52
- package/dist/src/models/TcxWizardModel.d.ts +0 -150
- package/dist/src/models/TcxWizardModel.js +0 -114
- package/dist/src/models/TechSupportCompanySummaryDTO.d.ts +0 -57
- package/dist/src/models/TechSupportCompanySummaryDTO.js +0 -58
- package/dist/src/models/TelephonySupportTicketModel.d.ts +0 -94
- package/dist/src/models/TelephonySupportTicketModel.js +0 -71
- package/dist/src/models/TicketSummaryModel.d.ts +0 -74
- package/dist/src/models/TicketSummaryModel.js +0 -63
- package/dist/src/models/TicketTimeDTO.d.ts +0 -80
- package/dist/src/models/TicketTimeDTO.js +0 -65
- package/dist/src/models/TokenResponseModel.d.ts +0 -44
- package/dist/src/models/TokenResponseModel.js +0 -53
- package/dist/src/models/UpdateTypeEnum.d.ts +0 -19
- package/dist/src/models/UpdateTypeEnum.js +0 -24
- package/dist/src/models/UpgradeOrderResponseModel.d.ts +0 -38
- package/dist/src/models/UpgradeOrderResponseModel.js +0 -51
- package/dist/src/models/UpgradeRequestModel.d.ts +0 -66
- package/dist/src/models/UpgradeRequestModel.js +0 -70
- package/dist/src/models/UserEntity.d.ts +0 -98
- package/dist/src/models/UserEntity.js +0 -71
- package/dist/src/models/XeroLogEntity.d.ts +0 -86
- package/dist/src/models/XeroLogEntity.js +0 -67
- package/dist/src/models/index.d.ts +0 -196
- package/dist/src/models/index.js +0 -214
- package/dist/src/runtime.d.ts +0 -184
- package/dist/src/runtime.js +0 -564
- package/docs/AccountAddressesDTO.md +0 -25
- package/docs/AccountFinanceDTO.md +0 -37
- package/docs/AddressDTO.md +0 -31
- package/docs/CrmActivitiesResponseDTO.md +0 -23
- package/docs/CrmActivityDTO.md +0 -33
- package/docs/CrmDateActivitiesDTO.md +0 -23
- package/docs/CrmNoteEntity.md +0 -39
- package/docs/CrmNoteModel.md +0 -39
- package/docs/CustomerListAccountDTO.md +0 -45
- package/docs/NumberPortAdminNoteBody.md +0 -20
- package/docs/PartnerDTO.md +0 -39
- package/docs/PatchUpdateAccountCompanyNumberRequest.md +0 -20
- package/docs/PatchUpdateAccountPhoneRequest.md +0 -20
- package/docs/PatchUpdateAccountVatNumberRequest.md +0 -20
- package/docs/PatchUpdateCreditLimitRequest.md +0 -20
- package/docs/PatchUpdatePriceListRequest.md +0 -20
- package/docs/PatchUpdateSipChannelCostRequest.md +0 -20
- package/docs/PatchUpdateTcxHostingPriceListRequest.md +0 -20
- package/docs/PatchUpdateTcxPartnerIdRequest.md +0 -20
- package/docs/PostSendWelcomeEmailRequest.md +0 -20
- package/docs/TableHistoryEntity.md +0 -35
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [optional] [default to undefined]
|
|
11
11
|
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
|
|
12
12
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) |
|
|
13
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
|
|
14
14
|
**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
|
|
15
15
|
**quote** | **boolean** | Quote | [optional] [default to undefined]
|
|
16
16
|
**customerId** | **number** | Customer ID | [optional] [default to undefined]
|
package/docs/AdminUserModel.md
CHANGED
|
@@ -6,7 +6,6 @@ Admin User
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [optional] [default to undefined]
|
|
10
9
|
**firstName** | **string** | First Name | [optional] [default to undefined]
|
|
11
10
|
**lastName** | **string** | Last Name | [optional] [default to undefined]
|
|
12
11
|
**avatar** | **string** | Avatar | [optional] [default to undefined]
|
|
@@ -23,7 +22,6 @@ Name | Type | Description | Notes
|
|
|
23
22
|
import { AdminUserModel } from 'yellowgrid-api-ts';
|
|
24
23
|
|
|
25
24
|
const instance: AdminUserModel = {
|
|
26
|
-
id,
|
|
27
25
|
firstName,
|
|
28
26
|
lastName,
|
|
29
27
|
avatar,
|
package/docs/BillingApi.md
CHANGED
package/docs/CRMApi.md
CHANGED
|
@@ -1,72 +1,10 @@
|
|
|
1
1
|
# CRMApi
|
|
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
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**getGetCrmActivities**](#getgetcrmactivities) | **GET** /admin/crm/{id}/activities | |
|
|
8
7
|
|[**getSearchByPhone**](#getsearchbyphone) | **GET** /crm/contact/search | |
|
|
9
|
-
|[**postCreateCrmNote**](#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | |
|
|
10
|
-
|
|
11
|
-
# **getGetCrmActivities**
|
|
12
|
-
> CrmActivitiesResponseDTO getGetCrmActivities()
|
|
13
|
-
|
|
14
|
-
Get Customer CRM Activities
|
|
15
|
-
|
|
16
|
-
### Example
|
|
17
|
-
|
|
18
|
-
```typescript
|
|
19
|
-
import {
|
|
20
|
-
CRMApi,
|
|
21
|
-
Configuration
|
|
22
|
-
} from 'yellowgrid-api-ts';
|
|
23
|
-
|
|
24
|
-
const configuration = new Configuration();
|
|
25
|
-
const apiInstance = new CRMApi(configuration);
|
|
26
|
-
|
|
27
|
-
let id: number; //Account ID (default to undefined)
|
|
28
|
-
let type: 'alert' | 'call' | 'email' | 'note' | 'order' | 'quote' | 'tcx_order'; //Activity Type (optional) (default to undefined)
|
|
29
|
-
let userId: number; //Activity Created By (optional) (default to undefined)
|
|
30
|
-
|
|
31
|
-
const { status, data } = await apiInstance.getGetCrmActivities(
|
|
32
|
-
id,
|
|
33
|
-
type,
|
|
34
|
-
userId
|
|
35
|
-
);
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
### Parameters
|
|
39
|
-
|
|
40
|
-
|Name | Type | Description | Notes|
|
|
41
|
-
|------------- | ------------- | ------------- | -------------|
|
|
42
|
-
| **id** | [**number**] | Account ID | defaults to undefined|
|
|
43
|
-
| **type** | [**'alert' | 'call' | 'email' | 'note' | 'order' | 'quote' | 'tcx_order'**]**Array<'alert' | 'call' | 'email' | 'note' | 'order' | 'quote' | 'tcx_order'>** | Activity Type | (optional) defaults to undefined|
|
|
44
|
-
| **userId** | [**number**] | Activity Created By | (optional) defaults to undefined|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
### Return type
|
|
48
|
-
|
|
49
|
-
**CrmActivitiesResponseDTO**
|
|
50
|
-
|
|
51
|
-
### Authorization
|
|
52
|
-
|
|
53
|
-
No authorization required
|
|
54
|
-
|
|
55
|
-
### HTTP request headers
|
|
56
|
-
|
|
57
|
-
- **Content-Type**: Not defined
|
|
58
|
-
- **Accept**: application/json
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
### HTTP response details
|
|
62
|
-
| Status code | Description | Response headers |
|
|
63
|
-
|-------------|-------------|------------------|
|
|
64
|
-
|**200** | CRM Activities | - |
|
|
65
|
-
|**400** | Bad Request | - |
|
|
66
|
-
|**401** | Unauthorised | - |
|
|
67
|
-
|**403** | Access Denied | - |
|
|
68
|
-
|
|
69
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
70
8
|
|
|
71
9
|
# **getSearchByPhone**
|
|
72
10
|
> CrmContactDTO getSearchByPhone()
|
|
@@ -115,61 +53,3 @@ No authorization required
|
|
|
115
53
|
|
|
116
54
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
117
55
|
|
|
118
|
-
# **postCreateCrmNote**
|
|
119
|
-
> CrmActivityDTO postCreateCrmNote()
|
|
120
|
-
|
|
121
|
-
Create CRM Note
|
|
122
|
-
|
|
123
|
-
### Example
|
|
124
|
-
|
|
125
|
-
```typescript
|
|
126
|
-
import {
|
|
127
|
-
CRMApi,
|
|
128
|
-
Configuration,
|
|
129
|
-
CreateCrmNoteBody
|
|
130
|
-
} from 'yellowgrid-api-ts';
|
|
131
|
-
|
|
132
|
-
const configuration = new Configuration();
|
|
133
|
-
const apiInstance = new CRMApi(configuration);
|
|
134
|
-
|
|
135
|
-
let id: number; //Account ID (default to undefined)
|
|
136
|
-
let createCrmNoteBody: CreateCrmNoteBody; //CRM Note Request (optional)
|
|
137
|
-
|
|
138
|
-
const { status, data } = await apiInstance.postCreateCrmNote(
|
|
139
|
-
id,
|
|
140
|
-
createCrmNoteBody
|
|
141
|
-
);
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
### Parameters
|
|
145
|
-
|
|
146
|
-
|Name | Type | Description | Notes|
|
|
147
|
-
|------------- | ------------- | ------------- | -------------|
|
|
148
|
-
| **createCrmNoteBody** | **CreateCrmNoteBody**| CRM Note Request | |
|
|
149
|
-
| **id** | [**number**] | Account ID | defaults to undefined|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
### Return type
|
|
153
|
-
|
|
154
|
-
**CrmActivityDTO**
|
|
155
|
-
|
|
156
|
-
### Authorization
|
|
157
|
-
|
|
158
|
-
No authorization required
|
|
159
|
-
|
|
160
|
-
### HTTP request headers
|
|
161
|
-
|
|
162
|
-
- **Content-Type**: application/json
|
|
163
|
-
- **Accept**: application/json
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
### HTTP response details
|
|
167
|
-
| Status code | Description | Response headers |
|
|
168
|
-
|-------------|-------------|------------------|
|
|
169
|
-
|**200** | CRM Activity | - |
|
|
170
|
-
|**400** | Bad Request | - |
|
|
171
|
-
|**401** | Unauthorised | - |
|
|
172
|
-
|**403** | Access Denied | - |
|
|
173
|
-
|
|
174
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
175
|
-
|
package/docs/Class3CXApi.md
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
# Class3CXApi
|
|
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
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
|
|
8
|
-
|[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
|
|
9
8
|
|[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
|
|
10
9
|
|
|
11
10
|
# **getGetLicenceDetails**
|
|
@@ -62,53 +61,6 @@ No authorization required
|
|
|
62
61
|
|
|
63
62
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
64
63
|
|
|
65
|
-
# **getGetTcxExpiringKeys**
|
|
66
|
-
> string getGetTcxExpiringKeys()
|
|
67
|
-
|
|
68
|
-
Get 3CX Expiring Keys
|
|
69
|
-
|
|
70
|
-
### Example
|
|
71
|
-
|
|
72
|
-
```typescript
|
|
73
|
-
import {
|
|
74
|
-
Class3CXApi,
|
|
75
|
-
Configuration
|
|
76
|
-
} from 'yellowgrid-api-ts';
|
|
77
|
-
|
|
78
|
-
const configuration = new Configuration();
|
|
79
|
-
const apiInstance = new Class3CXApi(configuration);
|
|
80
|
-
|
|
81
|
-
const { status, data } = await apiInstance.getGetTcxExpiringKeys();
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
### Parameters
|
|
85
|
-
This endpoint does not have any parameters.
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
### Return type
|
|
89
|
-
|
|
90
|
-
**string**
|
|
91
|
-
|
|
92
|
-
### Authorization
|
|
93
|
-
|
|
94
|
-
No authorization required
|
|
95
|
-
|
|
96
|
-
### HTTP request headers
|
|
97
|
-
|
|
98
|
-
- **Content-Type**: Not defined
|
|
99
|
-
- **Accept**: text/csv
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
### HTTP response details
|
|
103
|
-
| Status code | Description | Response headers |
|
|
104
|
-
|-------------|-------------|------------------|
|
|
105
|
-
|**200** | 3CX Expiring Key CSV | - |
|
|
106
|
-
|**400** | Bad Request | - |
|
|
107
|
-
|**401** | Unauthorised | - |
|
|
108
|
-
|**403** | Access Denied | - |
|
|
109
|
-
|
|
110
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
111
|
-
|
|
112
64
|
# **postGetBulkLicenceDetails**
|
|
113
65
|
> TcxBulkLicenceDetailsModel postGetBulkLicenceDetails()
|
|
114
66
|
|
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
# Class3CXInstallationsApi
|
|
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
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getGetDetails**](#getgetdetails) | **GET** /tcx/installations/{wizard_id}/details | Get 3CX Installation Details|
|
|
8
8
|
|[**getGetInstallations**](#getgetinstallations) | **GET** /tcx/installations | Get 3CX Installations|
|
|
9
|
-
|[**getGetRecordingBackupStorage**](#getgetrecordingbackupstorage) | **GET** /tcx/installations/{instance_id}/recordings/backup | Get Recording Backup Storage|
|
|
10
9
|
|[**patchChangeInstanceOwner**](#patchchangeinstanceowner) | **PATCH** /tcx/installations/{instance_id}/owner | Change instance owner|
|
|
11
10
|
|[**patchUpdateAutoFailover**](#patchupdateautofailover) | **PATCH** /tcx/installations/{instance_id}/failover/auto | Update 3CX Instance Auto Failover|
|
|
12
11
|
|[**postAddDisk**](#postadddisk) | **POST** /tcx/installations/{instance_id}/disk | Add additional disk on 3CX Instance|
|
|
@@ -151,60 +150,6 @@ No authorization required
|
|
|
151
150
|
|
|
152
151
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
153
152
|
|
|
154
|
-
# **getGetRecordingBackupStorage**
|
|
155
|
-
> RecordingBackupAzureModel getGetRecordingBackupStorage()
|
|
156
|
-
|
|
157
|
-
Get Recording Backup Storage
|
|
158
|
-
|
|
159
|
-
### Example
|
|
160
|
-
|
|
161
|
-
```typescript
|
|
162
|
-
import {
|
|
163
|
-
Class3CXInstallationsApi,
|
|
164
|
-
Configuration
|
|
165
|
-
} from 'yellowgrid-api-ts';
|
|
166
|
-
|
|
167
|
-
const configuration = new Configuration();
|
|
168
|
-
const apiInstance = new Class3CXInstallationsApi(configuration);
|
|
169
|
-
|
|
170
|
-
let instanceId: string; //Instance ID (default to undefined)
|
|
171
|
-
|
|
172
|
-
const { status, data } = await apiInstance.getGetRecordingBackupStorage(
|
|
173
|
-
instanceId
|
|
174
|
-
);
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
### Parameters
|
|
178
|
-
|
|
179
|
-
|Name | Type | Description | Notes|
|
|
180
|
-
|------------- | ------------- | ------------- | -------------|
|
|
181
|
-
| **instanceId** | [**string**] | Instance ID | defaults to undefined|
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
### Return type
|
|
185
|
-
|
|
186
|
-
**RecordingBackupAzureModel**
|
|
187
|
-
|
|
188
|
-
### Authorization
|
|
189
|
-
|
|
190
|
-
No authorization required
|
|
191
|
-
|
|
192
|
-
### HTTP request headers
|
|
193
|
-
|
|
194
|
-
- **Content-Type**: Not defined
|
|
195
|
-
- **Accept**: application/json
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
### HTTP response details
|
|
199
|
-
| Status code | Description | Response headers |
|
|
200
|
-
|-------------|-------------|------------------|
|
|
201
|
-
|**200** | Recordings Backup Storage | - |
|
|
202
|
-
|**400** | Bad Request | - |
|
|
203
|
-
|**401** | Unauthorised | - |
|
|
204
|
-
|**403** | Access Denied | - |
|
|
205
|
-
|
|
206
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
207
|
-
|
|
208
153
|
# **patchChangeInstanceOwner**
|
|
209
154
|
> patchChangeInstanceOwner()
|
|
210
155
|
|
|
@@ -24,12 +24,9 @@ Name | Type | Description | Notes
|
|
|
24
24
|
**creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
|
|
25
25
|
**paymentMethod** | **string** | Payment Method | [optional] [default to undefined]
|
|
26
26
|
**servicePaymentMethod** | **string** | Service Payment Method | [optional] [default to undefined]
|
|
27
|
-
**status** | **boolean** | Active | [optional] [default to undefined]
|
|
28
27
|
**resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
|
|
29
28
|
**creationDate** | **string** | Creation Date | [optional] [default to undefined]
|
|
30
29
|
**prizePromo** | **boolean** | Prize Promo Enabled | [optional] [default to undefined]
|
|
31
|
-
**portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
|
|
32
|
-
**cname** | **string** | CNAME | [optional] [default to undefined]
|
|
33
30
|
|
|
34
31
|
## Example
|
|
35
32
|
|
|
@@ -55,12 +52,9 @@ const instance: CreditAccountEntity = {
|
|
|
55
52
|
creditLimit,
|
|
56
53
|
paymentMethod,
|
|
57
54
|
servicePaymentMethod,
|
|
58
|
-
status,
|
|
59
55
|
resellerId,
|
|
60
56
|
creationDate,
|
|
61
57
|
prizePromo,
|
|
62
|
-
portalAccess,
|
|
63
|
-
cname,
|
|
64
58
|
};
|
|
65
59
|
```
|
|
66
60
|
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
|
|
11
11
|
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
|
|
12
12
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) |
|
|
13
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
|
|
14
14
|
**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
|
|
15
15
|
**quote** | **boolean** | Quote | [optional] [default to undefined]
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [optional] [default to undefined]
|
|
11
11
|
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
|
|
12
12
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) |
|
|
13
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
|
|
14
14
|
**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
|
|
15
15
|
**quote** | **boolean** | Quote | [optional] [default to undefined]
|
|
16
16
|
|
package/docs/MyPBXToolsApi.md
CHANGED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# NumberPortModel
|
|
2
|
+
|
|
3
|
+
Number Port Model
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | Number Port ID | [optional] [default to undefined]
|
|
10
|
+
**customerId** | **number** | Customer ID | [optional] [default to undefined]
|
|
11
|
+
**endUser** | **string** | End User | [optional] [default to undefined]
|
|
12
|
+
**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
|
|
13
|
+
**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
|
|
14
|
+
**city** | **string** | City | [optional] [default to undefined]
|
|
15
|
+
**postCode** | **string** | Post Code | [optional] [default to undefined]
|
|
16
|
+
**trunkId** | **number** | Trunk ID | [optional] [default to undefined]
|
|
17
|
+
**tenantId** | **string** | Tenant ID | [optional] [default to undefined]
|
|
18
|
+
**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
|
|
19
|
+
**portDate** | **string** | Port Date | [optional] [default to undefined]
|
|
20
|
+
**comment** | **string** | Comment | [optional] [default to undefined]
|
|
21
|
+
**status** | **number** | Status | [optional] [default to undefined]
|
|
22
|
+
**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
|
|
23
|
+
**ranges** | **Array<any>** | Number Port Ranges | [optional] [default to undefined]
|
|
24
|
+
**customerName** | **string** | Customer Company Name | [optional] [default to undefined]
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { NumberPortModel } from 'yellowgrid-api-ts';
|
|
30
|
+
|
|
31
|
+
const instance: NumberPortModel = {
|
|
32
|
+
id,
|
|
33
|
+
customerId,
|
|
34
|
+
endUser,
|
|
35
|
+
addressLine1,
|
|
36
|
+
addressLine2,
|
|
37
|
+
city,
|
|
38
|
+
postCode,
|
|
39
|
+
trunkId,
|
|
40
|
+
tenantId,
|
|
41
|
+
requestedPortDate,
|
|
42
|
+
portDate,
|
|
43
|
+
comment,
|
|
44
|
+
status,
|
|
45
|
+
ticketId,
|
|
46
|
+
ranges,
|
|
47
|
+
customerName,
|
|
48
|
+
};
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/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
|
|------------- | ------------- | -------------|
|
|
@@ -401,7 +401,7 @@ No authorization required
|
|
|
401
401
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
402
402
|
|
|
403
403
|
# **postAddAdminNote**
|
|
404
|
-
> AdminNumberPortDTO postAddAdminNote(
|
|
404
|
+
> AdminNumberPortDTO postAddAdminNote(postAddAdminNoteRequest)
|
|
405
405
|
|
|
406
406
|
|
|
407
407
|
### Example
|
|
@@ -410,18 +410,18 @@ No authorization required
|
|
|
410
410
|
import {
|
|
411
411
|
NumberPortingApi,
|
|
412
412
|
Configuration,
|
|
413
|
-
|
|
413
|
+
PostAddAdminNoteRequest
|
|
414
414
|
} from 'yellowgrid-api-ts';
|
|
415
415
|
|
|
416
416
|
const configuration = new Configuration();
|
|
417
417
|
const apiInstance = new NumberPortingApi(configuration);
|
|
418
418
|
|
|
419
419
|
let id: number; //Number Port ID (default to undefined)
|
|
420
|
-
let
|
|
420
|
+
let postAddAdminNoteRequest: PostAddAdminNoteRequest; //
|
|
421
421
|
|
|
422
422
|
const { status, data } = await apiInstance.postAddAdminNote(
|
|
423
423
|
id,
|
|
424
|
-
|
|
424
|
+
postAddAdminNoteRequest
|
|
425
425
|
);
|
|
426
426
|
```
|
|
427
427
|
|
|
@@ -429,7 +429,7 @@ const { status, data } = await apiInstance.postAddAdminNote(
|
|
|
429
429
|
|
|
430
430
|
|Name | Type | Description | Notes|
|
|
431
431
|
|------------- | ------------- | ------------- | -------------|
|
|
432
|
-
| **
|
|
432
|
+
| **postAddAdminNoteRequest** | **PostAddAdminNoteRequest**| | |
|
|
433
433
|
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
434
434
|
|
|
435
435
|
|
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
|
|------------- | ------------- | -------------|
|
|
@@ -9,7 +9,6 @@ All URIs are relative to *https://localhost*
|
|
|
9
9
|
|[**postAccessToken**](#postaccesstoken) | **POST** /oauth2/access_token | Validates client credentials and returns access token|
|
|
10
10
|
|[**postAuthorise**](#postauthorise) | **POST** /oauth2/authorise | Get OAuth2.0 Auth Code|
|
|
11
11
|
|[**postGetIdentity**](#postgetidentity) | **POST** /oauth2/me | Get Token Identity|
|
|
12
|
-
|[**postLogout**](#postlogout) | **POST** /oauth2/logout | |
|
|
13
12
|
|[**postPortalLogin**](#postportallogin) | **POST** /oauth2/portal/login | Portal Login|
|
|
14
13
|
|
|
15
14
|
# **getGetMfaQrCode**
|
|
@@ -312,53 +311,6 @@ No authorization required
|
|
|
312
311
|
|
|
313
312
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
314
313
|
|
|
315
|
-
# **postLogout**
|
|
316
|
-
> postLogout()
|
|
317
|
-
|
|
318
|
-
Remove Oauth 2.0 Cookies
|
|
319
|
-
|
|
320
|
-
### Example
|
|
321
|
-
|
|
322
|
-
```typescript
|
|
323
|
-
import {
|
|
324
|
-
OAuth20Api,
|
|
325
|
-
Configuration
|
|
326
|
-
} from 'yellowgrid-api-ts';
|
|
327
|
-
|
|
328
|
-
const configuration = new Configuration();
|
|
329
|
-
const apiInstance = new OAuth20Api(configuration);
|
|
330
|
-
|
|
331
|
-
const { status, data } = await apiInstance.postLogout();
|
|
332
|
-
```
|
|
333
|
-
|
|
334
|
-
### Parameters
|
|
335
|
-
This endpoint does not have any parameters.
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
### Return type
|
|
339
|
-
|
|
340
|
-
void (empty response body)
|
|
341
|
-
|
|
342
|
-
### Authorization
|
|
343
|
-
|
|
344
|
-
No authorization required
|
|
345
|
-
|
|
346
|
-
### HTTP request headers
|
|
347
|
-
|
|
348
|
-
- **Content-Type**: Not defined
|
|
349
|
-
- **Accept**: Not defined
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
### HTTP response details
|
|
353
|
-
| Status code | Description | Response headers |
|
|
354
|
-
|-------------|-------------|------------------|
|
|
355
|
-
|**200** | No Response | - |
|
|
356
|
-
|**400** | Bad Request | - |
|
|
357
|
-
|**401** | Unauthorised | - |
|
|
358
|
-
|**403** | Access Denied | - |
|
|
359
|
-
|
|
360
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
361
|
-
|
|
362
314
|
# **postPortalLogin**
|
|
363
315
|
> AuthCodeResponseModel postPortalLogin()
|
|
364
316
|
|
package/docs/OrdersApi.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PatchSetTcxWizardCnameRequest
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { PatchSetTcxWizardCnameRequest } from 'yellowgrid-api-ts';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
15
|
+
const instance: PatchSetTcxWizardCnameRequest = {
|
|
16
16
|
cname,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
@@ -24,14 +24,12 @@ Name | Type | Description | Notes
|
|
|
24
24
|
**creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
|
|
25
25
|
**paymentMethod** | **string** | Payment Method | [optional] [default to undefined]
|
|
26
26
|
**servicePaymentMethod** | **string** | Service Payment Method | [optional] [default to undefined]
|
|
27
|
-
**status** | **boolean** | Active | [optional] [default to undefined]
|
|
28
27
|
**resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
|
|
29
28
|
**creationDate** | **string** | Creation Date | [optional] [default to undefined]
|
|
30
29
|
**prizePromo** | **boolean** | Prize Promo Enabled | [optional] [default to undefined]
|
|
31
|
-
**portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
|
|
32
|
-
**cname** | **string** | Wizard CNAME | [optional] [default to undefined]
|
|
33
30
|
**directDebitMandate** | **boolean** | Active Direct Debit Mandate | [optional] [default to undefined]
|
|
34
31
|
**navigation** | [**Array<NavigationModel>**](NavigationModel.md) | Portal Navigation | [optional] [default to undefined]
|
|
32
|
+
**cname** | **string** | Wizard CNAME | [optional] [default to undefined]
|
|
35
33
|
|
|
36
34
|
## Example
|
|
37
35
|
|
|
@@ -57,14 +55,12 @@ const instance: PortalAccountModel = {
|
|
|
57
55
|
creditLimit,
|
|
58
56
|
paymentMethod,
|
|
59
57
|
servicePaymentMethod,
|
|
60
|
-
status,
|
|
61
58
|
resellerId,
|
|
62
59
|
creationDate,
|
|
63
60
|
prizePromo,
|
|
64
|
-
portalAccess,
|
|
65
|
-
cname,
|
|
66
61
|
directDebitMandate,
|
|
67
62
|
navigation,
|
|
63
|
+
cname,
|
|
68
64
|
};
|
|
69
65
|
```
|
|
70
66
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PostAddAdminNoteRequest
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { PostAddAdminNoteRequest } from 'yellowgrid-api-ts';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
15
|
+
const instance: PostAddAdminNoteRequest = {
|
|
16
16
|
note,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PostGetProductRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**quantity** | **number** | Quantity | [optional] [default to undefined]
|
|
9
|
+
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
10
|
+
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PostGetProductRequest } from 'yellowgrid-api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: PostGetProductRequest = {
|
|
18
|
+
quantity,
|
|
19
|
+
licenceKey,
|
|
20
|
+
hosting,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|