yellowgrid-api-ts 3.2.257-dev.0 → 3.2.258-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +7 -1
- package/.openapi-generator/VERSION +1 -1
- package/README.md +16 -1
- package/api.ts +10283 -757
- package/base.ts +24 -0
- package/common.ts +38 -15
- package/configuration.ts +20 -26
- package/dist/api.d.ts +9016 -82
- package/dist/api.js +1749 -622
- package/dist/base.d.ts +24 -0
- package/dist/base.js +19 -0
- package/dist/common.d.ts +35 -4
- package/dist/common.js +38 -16
- package/dist/configuration.d.ts +17 -24
- package/dist/configuration.js +3 -3
- package/dist/models/GroupEnum.d.ts +43 -0
- package/dist/models/GroupEnum.js +45 -0
- package/dist/models/ReportEnum.d.ts +6 -1
- package/dist/models/ReportEnum.js +6 -1
- package/docs/AbstractItemDiscountModel.md +21 -0
- package/docs/AbstractOrderRequestDTO.md +1 -1
- package/docs/AdminOrderRequestDTO.md +1 -1
- package/docs/BrandedVideoSummaryDTO.md +2 -2
- package/docs/CRMApi.md +59 -0
- package/docs/CallJournalRequestModel.md +35 -0
- package/docs/Class3CXInstallationWizardApi.md +336 -0
- package/docs/CrmActivityDTO.md +9 -1
- package/docs/CrmDateActivitiesDTO.md +1 -1
- package/docs/CustomerOrderRequestDTO.md +1 -1
- package/docs/DetailedOrderRequestDTO.md +1 -1
- package/docs/GetDisconnectDDIRequest.md +20 -0
- package/docs/NumberPortModel.md +51 -0
- package/docs/OAuth20Api.md +1 -1
- package/docs/OrdersApi.md +59 -0
- package/docs/PartnerDTO.md +1 -1
- package/docs/PasswordSenderDTO.md +1 -1
- package/docs/PatchSetTcxWizardCnameRequest.md +20 -0
- package/docs/PostAddAdminNoteRequest.md +20 -0
- package/docs/PostGetProductRequest.md +24 -0
- package/docs/ProductDetailedSummaryDTO.md +2 -2
- package/docs/ProductPriceModel.md +23 -0
- package/docs/ProductSearchDTO.md +37 -0
- package/docs/ProductSummaryDTO.md +1 -1
- package/docs/PromoCodesEntity.md +2 -2
- package/docs/PromoModel.md +2 -2
- package/docs/PromoSummaryDTO.md +2 -2
- package/docs/ProspectDTO.md +2 -2
- package/docs/RecordingsBackupInfoDTO.md +2 -2
- package/docs/ReportRequestDTO.md +2 -2
- package/docs/ShipmentRequestDTO.md +2 -2
- package/docs/StockProductModel.md +5 -5
- package/docs/StockProductPriceModel.md +1 -1
- package/docs/SupplierProductDTO.md +41 -0
- package/docs/SuppliersApi.md +56 -0
- package/docs/TcxHostingPricingEntity.md +35 -0
- package/docs/TcxInstallationDetailsModel.md +45 -0
- package/docs/TcxKeySummaryDTO.md +1 -1
- package/docs/TcxWizardModel.md +2 -0
- package/docs/TelephonySupportTicketModel.md +41 -0
- 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/models/GroupEnum.ts +44 -0
- package/models/ReportEnum.ts +6 -1
- package/openapitools.json +1 -1
- package/package.json +1 -1
- 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
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# CallJournalRequestModel
|
|
2
|
+
|
|
3
|
+
Call Journal Request Model
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**userEmail** | **string** | User Email | [default to undefined]
|
|
10
|
+
**note** | **string** | Call Note | [default to undefined]
|
|
11
|
+
**timestamp** | **string** | Call Timestamp | [default to undefined]
|
|
12
|
+
**duration** | **string** | Call Duration | [default to undefined]
|
|
13
|
+
**recordingUrl** | **string** | Call Recording URL | [default to undefined]
|
|
14
|
+
**transcription** | **string** | Call Transcription | [default to undefined]
|
|
15
|
+
**summary** | **string** | Call Summary | [default to undefined]
|
|
16
|
+
**sentiment** | **number** | Call Sentiment | [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { CallJournalRequestModel } from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: CallJournalRequestModel = {
|
|
24
|
+
userEmail,
|
|
25
|
+
note,
|
|
26
|
+
timestamp,
|
|
27
|
+
duration,
|
|
28
|
+
recordingUrl,
|
|
29
|
+
transcription,
|
|
30
|
+
summary,
|
|
31
|
+
sentiment,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -25,7 +25,13 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
25
25
|
|[**patchAddNumbers**](#patchaddnumbers) | **PATCH** /tcx/wizards/numbers | Update 3CX Installation Wizard Numbers|
|
|
26
26
|
|[**patchAddPhones**](#patchaddphones) | **PATCH** /tcx/wizards/phones | Update 3CX Installation Wizard Phones|
|
|
27
27
|
|[**patchAddSbcs**](#patchaddsbcs) | **PATCH** /tcx/wizards/sbcs | Update 3CX Installation Wizard SBCs|
|
|
28
|
+
|[**patchAllocateEngineer**](#patchallocateengineer) | **PATCH** /tcx/wizards/engineering/engineer | |
|
|
28
29
|
|[**patchGetWizard**](#patchgetwizard) | **PATCH** /tcx/wizards | Update 3CX Installation Wizard|
|
|
30
|
+
|[**patchMarkEngineerTaskAsComplete**](#patchmarkengineertaskascomplete) | **PATCH** /tcx/wizards/engineering/tasks/{task_id}/complete | |
|
|
31
|
+
|[**patchUpdateEngineerTaskNote**](#patchupdateengineertasknote) | **PATCH** /tcx/wizards/engineering/tasks/{task_id}/note | |
|
|
32
|
+
|[**patchUpdateGoLiveDate**](#patchupdategolivedate) | **PATCH** /tcx/wizards/engineering/go_live_date | |
|
|
33
|
+
|[**patchUpdateNote**](#patchupdatenote) | **PATCH** /tcx/wizards/engineering/note | |
|
|
34
|
+
|[**patchUpdateSpec**](#patchupdatespec) | **PATCH** /tcx/wizards/engineering/spec | |
|
|
29
35
|
|[**postAddExtensions**](#postaddextensions) | **POST** /tcx/wizards/extensions | Add Extensions To 3CX Installation Wizard|
|
|
30
36
|
|[**postAddNumbers**](#postaddnumbers) | **POST** /tcx/wizards/numbers | Add Numbers To 3CX Installation Wizard|
|
|
31
37
|
|[**postAddPhones**](#postaddphones) | **POST** /tcx/wizards/phones | Add Phones To 3CX Installation Wizard|
|
|
@@ -1127,6 +1133,60 @@ No authorization required
|
|
|
1127
1133
|
|
|
1128
1134
|
[[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)
|
|
1129
1135
|
|
|
1136
|
+
# **patchAllocateEngineer**
|
|
1137
|
+
> patchAllocateEngineer()
|
|
1138
|
+
|
|
1139
|
+
Allocate Wizard Engineer
|
|
1140
|
+
|
|
1141
|
+
### Example
|
|
1142
|
+
|
|
1143
|
+
```typescript
|
|
1144
|
+
import {
|
|
1145
|
+
Class3CXInstallationWizardApi,
|
|
1146
|
+
Configuration
|
|
1147
|
+
} from 'yellowgrid-api-ts';
|
|
1148
|
+
|
|
1149
|
+
const configuration = new Configuration();
|
|
1150
|
+
const apiInstance = new Class3CXInstallationWizardApi(configuration);
|
|
1151
|
+
|
|
1152
|
+
let engineerId: number; //Engineer ID (default to undefined)
|
|
1153
|
+
|
|
1154
|
+
const { status, data } = await apiInstance.patchAllocateEngineer(
|
|
1155
|
+
engineerId
|
|
1156
|
+
);
|
|
1157
|
+
```
|
|
1158
|
+
|
|
1159
|
+
### Parameters
|
|
1160
|
+
|
|
1161
|
+
|Name | Type | Description | Notes|
|
|
1162
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1163
|
+
| **engineerId** | [**number**] | Engineer ID | defaults to undefined|
|
|
1164
|
+
|
|
1165
|
+
|
|
1166
|
+
### Return type
|
|
1167
|
+
|
|
1168
|
+
void (empty response body)
|
|
1169
|
+
|
|
1170
|
+
### Authorization
|
|
1171
|
+
|
|
1172
|
+
No authorization required
|
|
1173
|
+
|
|
1174
|
+
### HTTP request headers
|
|
1175
|
+
|
|
1176
|
+
- **Content-Type**: Not defined
|
|
1177
|
+
- **Accept**: Not defined
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
### HTTP response details
|
|
1181
|
+
| Status code | Description | Response headers |
|
|
1182
|
+
|-------------|-------------|------------------|
|
|
1183
|
+
|**204** | No Response | - |
|
|
1184
|
+
|**400** | Bad Request | - |
|
|
1185
|
+
|**401** | Unauthorised | - |
|
|
1186
|
+
|**403** | Access Denied | - |
|
|
1187
|
+
|
|
1188
|
+
[[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)
|
|
1189
|
+
|
|
1130
1190
|
# **patchGetWizard**
|
|
1131
1191
|
> TcxWizardModel patchGetWizard()
|
|
1132
1192
|
|
|
@@ -1182,6 +1242,282 @@ No authorization required
|
|
|
1182
1242
|
|
|
1183
1243
|
[[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)
|
|
1184
1244
|
|
|
1245
|
+
# **patchMarkEngineerTaskAsComplete**
|
|
1246
|
+
> patchMarkEngineerTaskAsComplete()
|
|
1247
|
+
|
|
1248
|
+
Update Wizard Engineer Task Complete Status
|
|
1249
|
+
|
|
1250
|
+
### Example
|
|
1251
|
+
|
|
1252
|
+
```typescript
|
|
1253
|
+
import {
|
|
1254
|
+
Class3CXInstallationWizardApi,
|
|
1255
|
+
Configuration
|
|
1256
|
+
} from 'yellowgrid-api-ts';
|
|
1257
|
+
|
|
1258
|
+
const configuration = new Configuration();
|
|
1259
|
+
const apiInstance = new Class3CXInstallationWizardApi(configuration);
|
|
1260
|
+
|
|
1261
|
+
let taskId: number; //Task ID (default to undefined)
|
|
1262
|
+
let complete: 'true' | 'false'; //Complete Status (default to undefined)
|
|
1263
|
+
|
|
1264
|
+
const { status, data } = await apiInstance.patchMarkEngineerTaskAsComplete(
|
|
1265
|
+
taskId,
|
|
1266
|
+
complete
|
|
1267
|
+
);
|
|
1268
|
+
```
|
|
1269
|
+
|
|
1270
|
+
### Parameters
|
|
1271
|
+
|
|
1272
|
+
|Name | Type | Description | Notes|
|
|
1273
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1274
|
+
| **taskId** | [**number**] | Task ID | defaults to undefined|
|
|
1275
|
+
| **complete** | [**'true' | 'false'**]**Array<'true' | 'false'>** | Complete Status | defaults to undefined|
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
### Return type
|
|
1279
|
+
|
|
1280
|
+
void (empty response body)
|
|
1281
|
+
|
|
1282
|
+
### Authorization
|
|
1283
|
+
|
|
1284
|
+
No authorization required
|
|
1285
|
+
|
|
1286
|
+
### HTTP request headers
|
|
1287
|
+
|
|
1288
|
+
- **Content-Type**: Not defined
|
|
1289
|
+
- **Accept**: Not defined
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
### HTTP response details
|
|
1293
|
+
| Status code | Description | Response headers |
|
|
1294
|
+
|-------------|-------------|------------------|
|
|
1295
|
+
|**204** | No Response | - |
|
|
1296
|
+
|**400** | Bad Request | - |
|
|
1297
|
+
|**401** | Unauthorised | - |
|
|
1298
|
+
|**403** | Access Denied | - |
|
|
1299
|
+
|
|
1300
|
+
[[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)
|
|
1301
|
+
|
|
1302
|
+
# **patchUpdateEngineerTaskNote**
|
|
1303
|
+
> patchUpdateEngineerTaskNote()
|
|
1304
|
+
|
|
1305
|
+
Update Wizard Engineer Task Note
|
|
1306
|
+
|
|
1307
|
+
### Example
|
|
1308
|
+
|
|
1309
|
+
```typescript
|
|
1310
|
+
import {
|
|
1311
|
+
Class3CXInstallationWizardApi,
|
|
1312
|
+
Configuration
|
|
1313
|
+
} from 'yellowgrid-api-ts';
|
|
1314
|
+
|
|
1315
|
+
const configuration = new Configuration();
|
|
1316
|
+
const apiInstance = new Class3CXInstallationWizardApi(configuration);
|
|
1317
|
+
|
|
1318
|
+
let taskId: number; //Task ID (default to undefined)
|
|
1319
|
+
let note: string; //note (default to undefined)
|
|
1320
|
+
|
|
1321
|
+
const { status, data } = await apiInstance.patchUpdateEngineerTaskNote(
|
|
1322
|
+
taskId,
|
|
1323
|
+
note
|
|
1324
|
+
);
|
|
1325
|
+
```
|
|
1326
|
+
|
|
1327
|
+
### Parameters
|
|
1328
|
+
|
|
1329
|
+
|Name | Type | Description | Notes|
|
|
1330
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1331
|
+
| **taskId** | [**number**] | Task ID | defaults to undefined|
|
|
1332
|
+
| **note** | [**string**] | note | defaults to undefined|
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
### Return type
|
|
1336
|
+
|
|
1337
|
+
void (empty response body)
|
|
1338
|
+
|
|
1339
|
+
### Authorization
|
|
1340
|
+
|
|
1341
|
+
No authorization required
|
|
1342
|
+
|
|
1343
|
+
### HTTP request headers
|
|
1344
|
+
|
|
1345
|
+
- **Content-Type**: Not defined
|
|
1346
|
+
- **Accept**: Not defined
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
### HTTP response details
|
|
1350
|
+
| Status code | Description | Response headers |
|
|
1351
|
+
|-------------|-------------|------------------|
|
|
1352
|
+
|**204** | No Response | - |
|
|
1353
|
+
|**400** | Bad Request | - |
|
|
1354
|
+
|**401** | Unauthorised | - |
|
|
1355
|
+
|**403** | Access Denied | - |
|
|
1356
|
+
|
|
1357
|
+
[[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)
|
|
1358
|
+
|
|
1359
|
+
# **patchUpdateGoLiveDate**
|
|
1360
|
+
> patchUpdateGoLiveDate()
|
|
1361
|
+
|
|
1362
|
+
Update Wizard Go Live Date
|
|
1363
|
+
|
|
1364
|
+
### Example
|
|
1365
|
+
|
|
1366
|
+
```typescript
|
|
1367
|
+
import {
|
|
1368
|
+
Class3CXInstallationWizardApi,
|
|
1369
|
+
Configuration
|
|
1370
|
+
} from 'yellowgrid-api-ts';
|
|
1371
|
+
|
|
1372
|
+
const configuration = new Configuration();
|
|
1373
|
+
const apiInstance = new Class3CXInstallationWizardApi(configuration);
|
|
1374
|
+
|
|
1375
|
+
let goLiveDate: string; //Go Live Date (default to undefined)
|
|
1376
|
+
|
|
1377
|
+
const { status, data } = await apiInstance.patchUpdateGoLiveDate(
|
|
1378
|
+
goLiveDate
|
|
1379
|
+
);
|
|
1380
|
+
```
|
|
1381
|
+
|
|
1382
|
+
### Parameters
|
|
1383
|
+
|
|
1384
|
+
|Name | Type | Description | Notes|
|
|
1385
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1386
|
+
| **goLiveDate** | [**string**] | Go Live Date | defaults to undefined|
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
### Return type
|
|
1390
|
+
|
|
1391
|
+
void (empty response body)
|
|
1392
|
+
|
|
1393
|
+
### Authorization
|
|
1394
|
+
|
|
1395
|
+
No authorization required
|
|
1396
|
+
|
|
1397
|
+
### HTTP request headers
|
|
1398
|
+
|
|
1399
|
+
- **Content-Type**: Not defined
|
|
1400
|
+
- **Accept**: Not defined
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
### HTTP response details
|
|
1404
|
+
| Status code | Description | Response headers |
|
|
1405
|
+
|-------------|-------------|------------------|
|
|
1406
|
+
|**204** | No Response | - |
|
|
1407
|
+
|**400** | Bad Request | - |
|
|
1408
|
+
|**401** | Unauthorised | - |
|
|
1409
|
+
|**403** | Access Denied | - |
|
|
1410
|
+
|
|
1411
|
+
[[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)
|
|
1412
|
+
|
|
1413
|
+
# **patchUpdateNote**
|
|
1414
|
+
> patchUpdateNote()
|
|
1415
|
+
|
|
1416
|
+
Update Wizard Engineer Note
|
|
1417
|
+
|
|
1418
|
+
### Example
|
|
1419
|
+
|
|
1420
|
+
```typescript
|
|
1421
|
+
import {
|
|
1422
|
+
Class3CXInstallationWizardApi,
|
|
1423
|
+
Configuration
|
|
1424
|
+
} from 'yellowgrid-api-ts';
|
|
1425
|
+
|
|
1426
|
+
const configuration = new Configuration();
|
|
1427
|
+
const apiInstance = new Class3CXInstallationWizardApi(configuration);
|
|
1428
|
+
|
|
1429
|
+
let note: string; //Note (default to undefined)
|
|
1430
|
+
|
|
1431
|
+
const { status, data } = await apiInstance.patchUpdateNote(
|
|
1432
|
+
note
|
|
1433
|
+
);
|
|
1434
|
+
```
|
|
1435
|
+
|
|
1436
|
+
### Parameters
|
|
1437
|
+
|
|
1438
|
+
|Name | Type | Description | Notes|
|
|
1439
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1440
|
+
| **note** | [**string**] | Note | defaults to undefined|
|
|
1441
|
+
|
|
1442
|
+
|
|
1443
|
+
### Return type
|
|
1444
|
+
|
|
1445
|
+
void (empty response body)
|
|
1446
|
+
|
|
1447
|
+
### Authorization
|
|
1448
|
+
|
|
1449
|
+
No authorization required
|
|
1450
|
+
|
|
1451
|
+
### HTTP request headers
|
|
1452
|
+
|
|
1453
|
+
- **Content-Type**: Not defined
|
|
1454
|
+
- **Accept**: Not defined
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
### HTTP response details
|
|
1458
|
+
| Status code | Description | Response headers |
|
|
1459
|
+
|-------------|-------------|------------------|
|
|
1460
|
+
|**204** | No Response | - |
|
|
1461
|
+
|**400** | Bad Request | - |
|
|
1462
|
+
|**401** | Unauthorised | - |
|
|
1463
|
+
|**403** | Access Denied | - |
|
|
1464
|
+
|
|
1465
|
+
[[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)
|
|
1466
|
+
|
|
1467
|
+
# **patchUpdateSpec**
|
|
1468
|
+
> patchUpdateSpec()
|
|
1469
|
+
|
|
1470
|
+
Update Wizard Engineer Spec
|
|
1471
|
+
|
|
1472
|
+
### Example
|
|
1473
|
+
|
|
1474
|
+
```typescript
|
|
1475
|
+
import {
|
|
1476
|
+
Class3CXInstallationWizardApi,
|
|
1477
|
+
Configuration
|
|
1478
|
+
} from 'yellowgrid-api-ts';
|
|
1479
|
+
|
|
1480
|
+
const configuration = new Configuration();
|
|
1481
|
+
const apiInstance = new Class3CXInstallationWizardApi(configuration);
|
|
1482
|
+
|
|
1483
|
+
let spec: string; //Spec (default to undefined)
|
|
1484
|
+
|
|
1485
|
+
const { status, data } = await apiInstance.patchUpdateSpec(
|
|
1486
|
+
spec
|
|
1487
|
+
);
|
|
1488
|
+
```
|
|
1489
|
+
|
|
1490
|
+
### Parameters
|
|
1491
|
+
|
|
1492
|
+
|Name | Type | Description | Notes|
|
|
1493
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1494
|
+
| **spec** | [**string**] | Spec | defaults to undefined|
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
### Return type
|
|
1498
|
+
|
|
1499
|
+
void (empty response body)
|
|
1500
|
+
|
|
1501
|
+
### Authorization
|
|
1502
|
+
|
|
1503
|
+
No authorization required
|
|
1504
|
+
|
|
1505
|
+
### HTTP request headers
|
|
1506
|
+
|
|
1507
|
+
- **Content-Type**: Not defined
|
|
1508
|
+
- **Accept**: Not defined
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
### HTTP response details
|
|
1512
|
+
| Status code | Description | Response headers |
|
|
1513
|
+
|-------------|-------------|------------------|
|
|
1514
|
+
|**204** | No Response | - |
|
|
1515
|
+
|**400** | Bad Request | - |
|
|
1516
|
+
|**401** | Unauthorised | - |
|
|
1517
|
+
|**403** | Access Denied | - |
|
|
1518
|
+
|
|
1519
|
+
[[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)
|
|
1520
|
+
|
|
1185
1521
|
# **postAddExtensions**
|
|
1186
1522
|
> Array<TcxExtsEntity> postAddExtensions()
|
|
1187
1523
|
|
package/docs/CrmActivityDTO.md
CHANGED
|
@@ -7,12 +7,16 @@ CRM Activity
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**type** | **string** | Activity Type | [default to undefined]
|
|
10
|
-
**timestamp** | **string** |
|
|
10
|
+
**timestamp** | **string** | Date Time | [optional] [default to undefined]
|
|
11
11
|
**title** | **string** | Activity Title | [default to undefined]
|
|
12
12
|
**description** | **string** | Activity Description | [default to undefined]
|
|
13
13
|
**user** | **string** | Activity User Name | [optional] [default to undefined]
|
|
14
14
|
**contact** | **string** | Activity Contact Name | [optional] [default to undefined]
|
|
15
15
|
**orderId** | **number** | Activity Order ID | [optional] [default to undefined]
|
|
16
|
+
**recordingUrl** | **string** | Call Recording URL | [optional] [default to undefined]
|
|
17
|
+
**transcription** | **string** | Call Transcription | [optional] [default to undefined]
|
|
18
|
+
**summary** | **string** | Call Summary | [optional] [default to undefined]
|
|
19
|
+
**sentiment** | **number** | Call Sentiment | [optional] [default to undefined]
|
|
16
20
|
|
|
17
21
|
## Example
|
|
18
22
|
|
|
@@ -27,6 +31,10 @@ const instance: CrmActivityDTO = {
|
|
|
27
31
|
user,
|
|
28
32
|
contact,
|
|
29
33
|
orderId,
|
|
34
|
+
recordingUrl,
|
|
35
|
+
transcription,
|
|
36
|
+
summary,
|
|
37
|
+
sentiment,
|
|
30
38
|
};
|
|
31
39
|
```
|
|
32
40
|
|
|
@@ -6,7 +6,7 @@ CRM Date Activities
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**date** | **string** | Date | [optional] [default to undefined]
|
|
9
|
+
**date** | **string** | Date Time | [optional] [default to undefined]
|
|
10
10
|
**activities** | [**Array<CrmActivityDTO>**](CrmActivityDTO.md) | Activities | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [default to undefined]
|
|
11
11
|
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [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 | [default to undefined]
|
|
15
15
|
**quote** | **boolean** | Quote | [default to undefined]
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [default to undefined]
|
|
11
11
|
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [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 | [default to undefined]
|
|
15
15
|
**quote** | **boolean** | Quote | [default to undefined]
|
|
16
16
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# GetDisconnectDDIRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **number** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { GetDisconnectDDIRequest } from 'yellowgrid-api-ts';
|
|
14
|
+
|
|
15
|
+
const instance: GetDisconnectDDIRequest = {
|
|
16
|
+
id,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -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/OAuth20Api.md
CHANGED
|
@@ -164,7 +164,7 @@ const { status, data } = await apiInstance.postAccessToken(
|
|
|
164
164
|
| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
|
|
165
165
|
| **codeVerifier** | [**string**] | OAuth 2.0 Code Verifier | (optional) defaults to undefined|
|
|
166
166
|
| **token** | [**string**] | OAuth 2.0 Token (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
167
|
-
| **tokenExchangeType** | [**string**]**Array<'tcx_wizard' | 'portal'>** | Token Exchange Type (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
167
|
+
| **tokenExchangeType** | [**string**]**Array<'tcx_wizard' | 'tcx_wizard_admin' | 'portal'>** | Token Exchange Type (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
168
168
|
| **licenceKey** | [**string**] | 3CX Licence Key (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
169
169
|
| **endUser** | [**boolean**] | End User (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
170
170
|
|
package/docs/OrdersApi.md
CHANGED
|
@@ -22,6 +22,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
22
22
|
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
23
23
|
|[**postCreatePortalOrderLegacy**](#postcreateportalorderlegacy) | **POST** /orders/portal/legacy | Create an order via the legacy portal|
|
|
24
24
|
|[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
|
|
25
|
+
|[**postCreateWizardFromOrder**](#postcreatewizardfromorder) | **POST** /admin/orders/{id}/wizard | |
|
|
25
26
|
|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
|
|
26
27
|
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
27
28
|
|[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
|
|
@@ -1071,6 +1072,64 @@ No authorization required
|
|
|
1071
1072
|
|
|
1072
1073
|
[[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)
|
|
1073
1074
|
|
|
1075
|
+
# **postCreateWizardFromOrder**
|
|
1076
|
+
> TcxSummaryDTO postCreateWizardFromOrder()
|
|
1077
|
+
|
|
1078
|
+
Create Engineered Wizard
|
|
1079
|
+
|
|
1080
|
+
### Example
|
|
1081
|
+
|
|
1082
|
+
```typescript
|
|
1083
|
+
import {
|
|
1084
|
+
OrdersApi,
|
|
1085
|
+
Configuration,
|
|
1086
|
+
EngineeredWizardRequestModel
|
|
1087
|
+
} from 'yellowgrid-api-ts';
|
|
1088
|
+
|
|
1089
|
+
const configuration = new Configuration();
|
|
1090
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1091
|
+
|
|
1092
|
+
let id: number; //Order ID (default to undefined)
|
|
1093
|
+
let engineeredWizardRequestModel: EngineeredWizardRequestModel; //Engineered Wizard Request (optional)
|
|
1094
|
+
|
|
1095
|
+
const { status, data } = await apiInstance.postCreateWizardFromOrder(
|
|
1096
|
+
id,
|
|
1097
|
+
engineeredWizardRequestModel
|
|
1098
|
+
);
|
|
1099
|
+
```
|
|
1100
|
+
|
|
1101
|
+
### Parameters
|
|
1102
|
+
|
|
1103
|
+
|Name | Type | Description | Notes|
|
|
1104
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1105
|
+
| **engineeredWizardRequestModel** | **EngineeredWizardRequestModel**| Engineered Wizard Request | |
|
|
1106
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
### Return type
|
|
1110
|
+
|
|
1111
|
+
**TcxSummaryDTO**
|
|
1112
|
+
|
|
1113
|
+
### Authorization
|
|
1114
|
+
|
|
1115
|
+
No authorization required
|
|
1116
|
+
|
|
1117
|
+
### HTTP request headers
|
|
1118
|
+
|
|
1119
|
+
- **Content-Type**: application/json
|
|
1120
|
+
- **Accept**: application/json
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
### HTTP response details
|
|
1124
|
+
| Status code | Description | Response headers |
|
|
1125
|
+
|-------------|-------------|------------------|
|
|
1126
|
+
|**200** | Wizard Details | - |
|
|
1127
|
+
|**400** | Bad Request | - |
|
|
1128
|
+
|**401** | Unauthorised | - |
|
|
1129
|
+
|**403** | Access Denied | - |
|
|
1130
|
+
|
|
1131
|
+
[[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)
|
|
1132
|
+
|
|
1074
1133
|
# **postGetOrders**
|
|
1075
1134
|
> Array<OrderSummaryDTO> postGetOrders()
|
|
1076
1135
|
|
package/docs/PartnerDTO.md
CHANGED
|
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**hostingPriceListId** | **number** | 3CX Hosting Price List ID | [default to undefined]
|
|
18
18
|
**installationUrl** | **string** | 3CX Installation URL | [default to undefined]
|
|
19
19
|
**aligned** | **boolean** | Aligned | [default to undefined]
|
|
20
|
-
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) |
|
|
20
|
+
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | | [optional] [default to undefined]
|
|
21
21
|
|
|
22
22
|
## Example
|
|
23
23
|
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**password** | **string** | Password | [optional] [default to undefined]
|
|
11
11
|
**expiryInterval** | **number** | Expiry Interval | [optional] [default to undefined]
|
|
12
12
|
**intervalType** | **string** | Interval Type | [optional] [default to undefined]
|
|
13
|
-
**expiry** | **string** |
|
|
13
|
+
**expiry** | **string** | Date Time | [optional] [default to undefined]
|
|
14
14
|
**recipient** | **Array<string>** | Recipient | [default to undefined]
|
|
15
15
|
**url** | **string** | URL | [optional] [default to undefined]
|
|
16
16
|
**description** | **string** | Description | [optional] [default to undefined]
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PatchSetTcxWizardCnameRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**cname** | **string** | CNAME | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PatchSetTcxWizardCnameRequest } from 'yellowgrid-api-ts';
|
|
14
|
+
|
|
15
|
+
const instance: PatchSetTcxWizardCnameRequest = {
|
|
16
|
+
cname,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PostAddAdminNoteRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**note** | **string** | Note | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PostAddAdminNoteRequest } from 'yellowgrid-api-ts';
|
|
14
|
+
|
|
15
|
+
const instance: PostAddAdminNoteRequest = {
|
|
16
|
+
note,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|