yellowgrid-api-ts 3.2.231-dev.0 → 3.2.232-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/api.ts +1697 -1675
- package/dist/api.d.ts +1666 -1666
- package/dist/api.js +90 -68
- package/docs/AbstractOrderRequestDTO.md +4 -4
- package/docs/AccountAddressesDTO.md +3 -3
- package/docs/AccountContactEntity.md +13 -13
- package/docs/AccountContactModel.md +13 -13
- package/docs/AccountContactRequestModel.md +9 -9
- package/docs/AccountDetailedSummaryDTO.md +9 -9
- package/docs/AccountFinanceDTO.md +10 -10
- package/docs/AccountRequestModel.md +11 -11
- package/docs/AccountSummaryDTO.md +3 -3
- package/docs/AccountsResponseModel.md +4 -4
- package/docs/AddressDTO.md +6 -6
- package/docs/AddressModel.md +5 -5
- package/docs/AddressRequestModel.md +4 -4
- package/docs/AdminCustomerRmasModel.md +4 -4
- package/docs/AdminNumberPortDTO.md +7 -7
- package/docs/AdminOrderRequestDTO.md +4 -4
- package/docs/AdminRmaDTO.md +19 -19
- package/docs/AdminRmaItemDTO.md +6 -6
- package/docs/AdminRmaNoteDTO.md +4 -4
- package/docs/AdminRmaSummaryDTO.md +6 -6
- package/docs/AdminUserModel.md +5 -5
- package/docs/AgentHoursGraphModel.md +4 -4
- package/docs/AgentHoursGraphMonthModel.md +2 -2
- package/docs/ApiLogEntity.md +12 -12
- package/docs/AreaCodeModel.md +2 -2
- package/docs/AttachmentModel.md +5 -5
- package/docs/AttributeSetEnum.md +2 -2
- package/docs/AuditLogEntity.md +9 -9
- package/docs/AuthCodeResponseModel.md +1 -1
- package/docs/AxisDataDTO.md +1 -1
- package/docs/BasicItemDTO.md +2 -2
- package/docs/BasicProductDTO.md +2 -2
- package/docs/BatchDTO.md +17 -17
- package/docs/BatchEntity.md +17 -17
- package/docs/CallBarringModel.md +5 -5
- package/docs/ClientDetailsModel.md +7 -7
- package/docs/ClientModel.md +4 -4
- package/docs/CompanyContractModel.md +5 -5
- package/docs/ContactInfoModel.md +5 -5
- package/docs/ConversationModel.md +8 -8
- package/docs/CourierPriceEntity.md +10 -10
- package/docs/CreditAccountEntity.md +23 -23
- package/docs/CreditNoteDTO.md +1 -1
- package/docs/CreditNoteEntity.md +5 -5
- package/docs/CreditNoteItemDTO.md +1 -1
- package/docs/CreditNoteItemEntity.md +6 -6
- package/docs/CreditNoteItemModel.md +6 -6
- package/docs/CreditNoteModel.md +5 -5
- package/docs/CrmActivitiesResponseDTO.md +2 -2
- package/docs/CrmActivityDTO.md +3 -3
- package/docs/CrmContactDTO.md +7 -7
- package/docs/CrmDateActivitiesDTO.md +1 -1
- package/docs/CrmNoteEntity.md +10 -10
- package/docs/CrmNoteModel.md +10 -10
- package/docs/CustomerCoordinatesDTO.md +5 -5
- package/docs/CustomerInformationModel.md +4 -4
- package/docs/CustomerItemRequestDTO.md +2 -2
- package/docs/CustomerListAccountDTO.md +13 -13
- package/docs/CustomerOrderRequestDTO.md +4 -4
- package/docs/CustomerPriceListEnum.md +2 -2
- package/docs/CustomerRmasModel.md +4 -4
- package/docs/CustomerSummaryReportDTO.md +6 -6
- package/docs/DdiRangeRequestModel.md +3 -3
- package/docs/DdiRangesRequestModel.md +1 -1
- package/docs/DetailedItemRequestDTO.md +2 -2
- package/docs/DetailedOrderRequestDTO.md +4 -4
- package/docs/DivertRequestModel.md +1 -1
- package/docs/DivertResponseModel.md +2 -2
- package/docs/EdTechProClientEntity.md +4 -4
- package/docs/EdTechProSchoolModel.md +11 -11
- package/docs/EdTechProSchoolsModel.md +4 -4
- package/docs/EdTechProSetupModel.md +5 -5
- package/docs/EmailRequestModel.md +1 -1
- package/docs/EventDTO.md +8 -8
- package/docs/EventRequestDTO.md +3 -3
- package/docs/EventSubscriptionModel.md +2 -2
- package/docs/EventUpdateDTO.md +4 -4
- package/docs/EventUpdateEntity.md +5 -5
- package/docs/EventUpdateRequestDTO.md +3 -3
- package/docs/ExpiringKeyDTO.md +5 -5
- package/docs/FraudManagementModel.md +2 -2
- package/docs/FreshdeskCompanyTicketsModel.md +4 -4
- package/docs/FreshdeskTicketEntity.md +6 -6
- package/docs/FtpAccountsEntity.md +5 -5
- package/docs/GenericFileModel.md +3 -3
- package/docs/GraphDTO.md +6 -6
- package/docs/HostingChangeResponseModel.md +5 -5
- package/docs/HostingRegionDTO.md +3 -3
- package/docs/InstallationDetailsDTO.md +3 -3
- package/docs/InstanceAutoFailoverEntity.md +5 -5
- package/docs/InstanceDeletionScheduleEntity.md +4 -4
- package/docs/InstanceEntity.md +21 -21
- package/docs/InstanceFailoverEntity.md +11 -11
- package/docs/InstanceMonitoringEntity.md +3 -3
- package/docs/InstanceMonitoringLogEntity.md +6 -6
- package/docs/InstanceScheduledTasksEntity.md +6 -6
- package/docs/InstanceTcxDetailsEntity.md +10 -10
- package/docs/InstanceUserCredentialsEntity.md +5 -5
- package/docs/ItemDTO.md +2 -2
- package/docs/ItemDiscountEntity.md +6 -6
- package/docs/ItemEntity.md +21 -21
- package/docs/ItemResolutionRequestModel.md +1 -1
- package/docs/LinkedOrderEntity.md +2 -2
- package/docs/MFARequiredModel.md +2 -2
- package/docs/MacAddressDTO.md +2 -2
- package/docs/MacAddressRequestModel.md +1 -1
- package/docs/MonthlyUsageModel.md +2 -2
- package/docs/MultiTenantChangeResponseModel.md +4 -4
- package/docs/NameRequestModel.md +1 -1
- package/docs/NavigationModel.md +4 -4
- package/docs/NoteRequestModel.md +1 -1
- package/docs/NumberPortDTO.md +7 -7
- package/docs/NumberPortNoteDTO.md +5 -5
- package/docs/NumberPortRangeDTO.md +2 -2
- package/docs/NumberPortingApi.md +21 -21
- package/docs/NumberPortsModel.md +4 -4
- package/docs/OfflineInstancesEntity.md +5 -5
- package/docs/OrderDTO.md +3 -3
- package/docs/OrderDetailsDTO.md +10 -10
- package/docs/OrderEntity.md +56 -56
- package/docs/OrderItemDTO.md +2 -2
- package/docs/OrderRequestModel.md +6 -6
- package/docs/OrderSummariesModel.md +4 -4
- package/docs/OrderSummaryDTO.md +10 -10
- package/docs/OrderTotalModel.md +7 -7
- package/docs/OrderedItemEntity.md +14 -14
- package/docs/OrderedItemModel.md +14 -14
- package/docs/PartnerDTO.md +10 -10
- package/docs/PasswordSenderDTO.md +2 -2
- package/docs/PasswordSenderEntity.md +7 -7
- package/docs/PortalAccountModel.md +23 -23
- package/docs/PortalLoginModel.md +7 -7
- package/docs/PostGenerateReport200Response.md +8 -8
- package/docs/PriceListItemModel.md +2 -2
- package/docs/PrinterEntity.md +5 -5
- package/docs/PrizesEntity.md +6 -6
- package/docs/ProductDetailedSummaryDTO.md +2 -2
- package/docs/ProductPriceListItemModel.md +2 -2
- package/docs/ProductSearchResultsModel.md +1 -1
- package/docs/ProductSerialInfoDTO.md +4 -4
- package/docs/ProductSerialInfoModel.md +3 -3
- package/docs/ProductSummaryDTO.md +2 -2
- package/docs/PromoCodesEntity.md +12 -12
- package/docs/PromoItemsEntity.md +8 -8
- package/docs/ProspectDTO.md +7 -7
- package/docs/ProspectEntity.md +11 -11
- package/docs/ProvisioningModel.md +3 -3
- package/docs/ProvisioningRequestEntity.md +3 -3
- package/docs/ReasonRequestModel.md +1 -1
- package/docs/RecordingBackupAzureModel.md +4 -4
- package/docs/RemoteStorageDTO.md +4 -4
- package/docs/ReportRequestDTO.md +1 -1
- package/docs/ResolutionRequestModel.md +1 -1
- package/docs/ResourceNotReadyException.md +3 -3
- package/docs/RmaCollectionDTO.md +4 -4
- package/docs/RmaCreditItemRequestDTO.md +3 -3
- package/docs/RmaDTO.md +12 -12
- package/docs/RmaItemDTO.md +6 -6
- package/docs/RmaItemRequestDTO.md +1 -1
- package/docs/RmaOrderDTO.md +3 -3
- package/docs/RmaOrderItemDTO.md +9 -9
- package/docs/RmaOrderSummaryDTO.md +3 -3
- package/docs/RmaReplacementOrderItemDTO.md +2 -2
- package/docs/RmaReplacementOrderRequestDTO.md +1 -1
- package/docs/RmaRequestDTO.md +8 -8
- package/docs/RmaReturnDTO.md +6 -6
- package/docs/RmaSummaryDTO.md +6 -6
- package/docs/RmaSummaryItemDTO.md +2 -2
- package/docs/RootAccessModel.md +3 -3
- package/docs/S3BucketEntity.md +4 -4
- package/docs/ScannedItemModel.md +1 -1
- package/docs/ScopeModel.md +2 -2
- package/docs/SerialNumberRequestModel.md +1 -1
- package/docs/SeriesDTO.md +3 -3
- package/docs/ServiceHealthDTO.md +2 -2
- package/docs/ServiceStatusDTO.md +4 -4
- package/docs/ShipmentAddressEntity.md +11 -11
- package/docs/ShipmentDTO.md +4 -4
- package/docs/ShipmentEntity.md +12 -12
- package/docs/ShipmentItemDTO.md +2 -2
- package/docs/ShipmentItemEntity.md +5 -5
- package/docs/ShipmentItemModel.md +5 -5
- package/docs/ShipmentModel.md +12 -12
- package/docs/ShipmentRequestDTO.md +4 -4
- package/docs/ShippingConsignmentModel.md +4 -4
- package/docs/ShippingInformationDTO.md +3 -3
- package/docs/ShippingRequestDTO.md +3 -3
- package/docs/ShippingServiceDTO.md +2 -2
- package/docs/ShippingServiceModel.md +4 -4
- package/docs/ShippingServicesModel.md +1 -1
- package/docs/SipTrunkChangeResponseModel.md +5 -5
- package/docs/SipTrunkCreationRequestModel.md +6 -6
- package/docs/SipTrunkEntity.md +12 -12
- package/docs/SipTrunksResponseModel.md +4 -4
- package/docs/SmsAccountDTO.md +6 -6
- package/docs/SmsAccountEntity.md +6 -6
- package/docs/SmsAccountRequestDTO.md +5 -5
- package/docs/SmsDataModel.md +1 -1
- package/docs/SmsMessageModel.md +3 -3
- package/docs/SmsNumbersEntity.md +2 -2
- package/docs/SmsPayloadModel.md +3 -3
- package/docs/SmsPhoneNumberModel.md +1 -1
- package/docs/SmsResponseModel.md +3 -3
- package/docs/SmsWhitelistEntity.md +2 -2
- package/docs/StockOrderCourierEntity.md +4 -4
- package/docs/StockOrderDeductionModel.md +4 -4
- package/docs/StockOrderDeductionRequestModel.md +2 -2
- package/docs/StockOrderDeductionsEntity.md +4 -4
- package/docs/StockOrderEntity.md +22 -22
- package/docs/StockOrderItemEntity.md +7 -7
- package/docs/StockOrderItemModel.md +7 -7
- package/docs/StockOrderItemRequestModel.md +4 -4
- package/docs/StockOrderModel.md +14 -14
- package/docs/StockOrderProductEntity.md +6 -6
- package/docs/StockOrderRequestModel.md +3 -3
- package/docs/StockOrderSupplierEntity.md +9 -9
- package/docs/StockOrderSupplierModel.md +9 -9
- package/docs/StockOrdersModel.md +4 -4
- package/docs/StockProductModel.md +6 -6
- package/docs/StockProductPriceModel.md +1 -1
- package/docs/StockProductSummariesModel.md +4 -4
- package/docs/StockProductSummaryModel.md +6 -6
- package/docs/StockReportItemModel.md +6 -6
- package/docs/StockReportModel.md +5 -5
- package/docs/StockTransactionsEntity.md +8 -8
- package/docs/SupplierEntity.md +9 -9
- package/docs/SupplierItemEntity.md +8 -8
- package/docs/SupplierItemModel.md +8 -8
- package/docs/SupplierItemsResultsDTO.md +1 -1
- package/docs/SupplierModel.md +9 -9
- package/docs/SupplierProductModel.md +3 -3
- package/docs/SupplierProductResultsModel.md +4 -4
- package/docs/SupportTicketModel.md +10 -10
- package/docs/TableDTO.md +3 -3
- package/docs/TableDataDTO.md +1 -1
- package/docs/TableHistoryEntity.md +8 -8
- package/docs/TableRowDTO.md +1 -1
- package/docs/TcxBackupEntity.md +9 -9
- package/docs/TcxBackupModel.md +9 -9
- package/docs/TcxBillingEntity.md +10 -10
- package/docs/TcxBulkLicenceDetailsModel.md +2 -2
- package/docs/TcxDeadLicenceEntity.md +3 -3
- package/docs/TcxExtsEntity.md +8 -8
- package/docs/TcxInstallationModel.md +17 -17
- package/docs/TcxInstallationsModel.md +4 -4
- package/docs/TcxKeySummaryDTO.md +3 -3
- package/docs/TcxKeysEntity.md +6 -6
- package/docs/TcxLicenceDetailsErrorModel.md +4 -4
- package/docs/TcxLicenceDetailsModel.md +11 -11
- package/docs/TcxMacsEntity.md +3 -3
- package/docs/TcxMultiTenantModel.md +7 -7
- package/docs/TcxMultiTenantUserModel.md +3 -3
- package/docs/TcxMultiTenantsModel.md +4 -4
- package/docs/TcxNumbersEntity.md +3 -3
- package/docs/TcxOfficeHoursEntity.md +15 -15
- package/docs/TcxPhoneModel.md +6 -6
- package/docs/TcxPhonesEntity.md +6 -6
- package/docs/TcxRemoteStorageModel.md +4 -4
- package/docs/TcxSbcDTO.md +7 -7
- package/docs/TcxSbcEntity.md +16 -16
- package/docs/TcxSbcModel.md +16 -16
- package/docs/TcxSbcResponseDTO.md +2 -2
- package/docs/TcxSetupEntity.md +25 -25
- package/docs/TcxSetupsModel.md +4 -4
- package/docs/TcxSipTrunksEntity.md +13 -13
- package/docs/TcxTemplateXmlEnum.md +2 -2
- package/docs/TcxUsersEntity.md +6 -6
- package/docs/TcxWizardConfigModel.md +2 -2
- package/docs/TcxWizardModel.md +9 -9
- package/docs/TechSupportCompanySummaryDTO.md +5 -5
- package/docs/TicketSummaryModel.md +6 -6
- package/docs/TicketTimeDTO.md +9 -9
- package/docs/TicketsApi.md +10 -10
- package/docs/TokenResponseModel.md +3 -3
- package/docs/UpgradeOrderResponseModel.md +2 -2
- package/docs/UpgradeRequestModel.md +4 -4
- package/docs/UserEntity.md +10 -10
- package/docs/XeroLogEntity.md +10 -10
- package/package.json +1 -1
|
@@ -12,14 +12,14 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**price** | **number** | Price Per User | [optional] [default to undefined]
|
|
13
13
|
**username** | **string** | Admin Username | [optional] [default to undefined]
|
|
14
14
|
**password** | **string** | Admin Password | [optional] [default to undefined]
|
|
15
|
-
**companyName** | **string** | Tenant Name | [
|
|
16
|
-
**address1** | **string** | Address Line 1 | [
|
|
17
|
-
**address2** | **string** | Address Line 2 | [
|
|
18
|
-
**city** | **string** | City | [
|
|
19
|
-
**postalCode** | **string** | Postal Code | [
|
|
15
|
+
**companyName** | **string** | Tenant Name | [default to undefined]
|
|
16
|
+
**address1** | **string** | Address Line 1 | [default to undefined]
|
|
17
|
+
**address2** | **string** | Address Line 2 | [default to undefined]
|
|
18
|
+
**city** | **string** | City | [default to undefined]
|
|
19
|
+
**postalCode** | **string** | Postal Code | [default to undefined]
|
|
20
20
|
**mainNumber** | **string** | Tenant Main Number | [optional] [default to undefined]
|
|
21
|
-
**numbers** | **Array<string>** | Tenant Numbers | [
|
|
22
|
-
**users** | [**Array<TcxMultiTenantUserModel>**](TcxMultiTenantUserModel.md) | Tenant Users | [
|
|
21
|
+
**numbers** | **Array<string>** | Tenant Numbers | [default to undefined]
|
|
22
|
+
**users** | [**Array<TcxMultiTenantUserModel>**](TcxMultiTenantUserModel.md) | Tenant Users | [default to undefined]
|
|
23
23
|
|
|
24
24
|
## Example
|
|
25
25
|
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**firstName** | **string** | User Name | [
|
|
10
|
-
**lastName** | **string** | User Surname | [
|
|
11
|
-
**email** | **string** | User Email Address | [
|
|
9
|
+
**firstName** | **string** | User Name | [default to undefined]
|
|
10
|
+
**lastName** | **string** | User Surname | [default to undefined]
|
|
11
|
+
**email** | **string** | User Email Address | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<TcxMultiTenantModel>**](TcxMultiTenantModel.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<TcxMultiTenantModel>**](TcxMultiTenantModel.md) | Results | [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/TcxNumbersEntity.md
CHANGED
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**number** | **string** | Number | [
|
|
11
|
-
**label** | **string** | Label | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**number** | **string** | Number | [default to undefined]
|
|
11
|
+
**label** | **string** | Label | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,21 +6,21 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**mondayFrom** | **string** | Monday Hours From | [
|
|
11
|
-
**mondayTo** | **string** | Monday Hours To | [
|
|
12
|
-
**tuesdayFrom** | **string** | Tuesday Hours From | [
|
|
13
|
-
**tuesdayTo** | **string** | Tuesday Hours To | [
|
|
14
|
-
**wednesdayFrom** | **string** | Wednesday Hours From | [
|
|
15
|
-
**wednesdayTo** | **string** | Wednesday Hours To | [
|
|
16
|
-
**thursdayFrom** | **string** | Thursday Hours From | [
|
|
17
|
-
**thursdayTo** | **string** | Thursday Hours To | [
|
|
18
|
-
**fridayFrom** | **string** | Friday Hours From | [
|
|
19
|
-
**fridayTo** | **string** | Friday Hours To | [
|
|
20
|
-
**saturdayFrom** | **string** | Saturday Hours From | [
|
|
21
|
-
**saturdayTo** | **string** | Saturday Hours To | [
|
|
22
|
-
**sundayFrom** | **string** | Sunday Hours From | [
|
|
23
|
-
**sundayTo** | **string** | Sunday Hours To | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**mondayFrom** | **string** | Monday Hours From | [default to undefined]
|
|
11
|
+
**mondayTo** | **string** | Monday Hours To | [default to undefined]
|
|
12
|
+
**tuesdayFrom** | **string** | Tuesday Hours From | [default to undefined]
|
|
13
|
+
**tuesdayTo** | **string** | Tuesday Hours To | [default to undefined]
|
|
14
|
+
**wednesdayFrom** | **string** | Wednesday Hours From | [default to undefined]
|
|
15
|
+
**wednesdayTo** | **string** | Wednesday Hours To | [default to undefined]
|
|
16
|
+
**thursdayFrom** | **string** | Thursday Hours From | [default to undefined]
|
|
17
|
+
**thursdayTo** | **string** | Thursday Hours To | [default to undefined]
|
|
18
|
+
**fridayFrom** | **string** | Friday Hours From | [default to undefined]
|
|
19
|
+
**fridayTo** | **string** | Friday Hours To | [default to undefined]
|
|
20
|
+
**saturdayFrom** | **string** | Saturday Hours From | [default to undefined]
|
|
21
|
+
**saturdayTo** | **string** | Saturday Hours To | [default to undefined]
|
|
22
|
+
**sundayFrom** | **string** | Sunday Hours From | [default to undefined]
|
|
23
|
+
**sundayTo** | **string** | Sunday Hours To | [default to undefined]
|
|
24
24
|
|
|
25
25
|
## Example
|
|
26
26
|
|
package/docs/TcxPhoneModel.md
CHANGED
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **number** | id | [
|
|
9
|
-
**phone** | **string** | Phone Model | [
|
|
10
|
-
**mac** | **string** | MAC Address | [
|
|
11
|
-
**sku** | **string** | SKU | [
|
|
12
|
-
**extNo** | **string** | Extension Number | [
|
|
13
|
-
**sbcId** | **string** | SBC ID | [
|
|
8
|
+
**id** | **number** | id | [default to undefined]
|
|
9
|
+
**phone** | **string** | Phone Model | [default to undefined]
|
|
10
|
+
**mac** | **string** | MAC Address | [default to undefined]
|
|
11
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
12
|
+
**extNo** | **string** | Extension Number | [default to undefined]
|
|
13
|
+
**sbcId** | **string** | SBC ID | [default to undefined]
|
|
14
14
|
**fromOrder** | **boolean** | Phone exists on order | [optional] [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
package/docs/TcxPhonesEntity.md
CHANGED
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**phone** | **string** | Phone Model | [
|
|
11
|
-
**mac** | **string** | MAC Address | [
|
|
12
|
-
**sku** | **string** | SKU | [
|
|
13
|
-
**extNo** | **string** | Extension Number | [
|
|
14
|
-
**sbcId** | **string** | SBC ID | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**phone** | **string** | Phone Model | [default to undefined]
|
|
11
|
+
**mac** | **string** | MAC Address | [default to undefined]
|
|
12
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
13
|
+
**extNo** | **string** | Extension Number | [default to undefined]
|
|
14
|
+
**sbcId** | **string** | SBC ID | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**name** | **string** | name | [
|
|
10
|
-
**region** | **string** | region | [
|
|
11
|
-
**accessKeyId** | **string** | accessKeyId | [
|
|
12
|
-
**secretAccessKey** | **string** | secretAccessKey | [
|
|
9
|
+
**name** | **string** | name | [default to undefined]
|
|
10
|
+
**region** | **string** | region | [default to undefined]
|
|
11
|
+
**accessKeyId** | **string** | accessKeyId | [default to undefined]
|
|
12
|
+
**secretAccessKey** | **string** | secretAccessKey | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/TcxSbcDTO.md
CHANGED
|
@@ -7,13 +7,13 @@ SBC Data
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**id** | **number** | ID | [optional] [default to undefined]
|
|
10
|
-
**ipAddress** | **string** | LAN IP Address | [
|
|
11
|
-
**defaultGateway** | **string** | LAN Default Gateway | [
|
|
12
|
-
**netmask** | **string** | LAN Subnet Mask | [
|
|
13
|
-
**dns** | **string** | DNS | [
|
|
14
|
-
**tcxUrl** | **string** | 3CX URL | [
|
|
15
|
-
**tcxKey** | **string** | 3CX SBC Key | [
|
|
16
|
-
**configured** | **boolean** | 3CX SBC Configured | [
|
|
10
|
+
**ipAddress** | **string** | LAN IP Address | [default to undefined]
|
|
11
|
+
**defaultGateway** | **string** | LAN Default Gateway | [default to undefined]
|
|
12
|
+
**netmask** | **string** | LAN Subnet Mask | [default to undefined]
|
|
13
|
+
**dns** | **string** | DNS | [default to undefined]
|
|
14
|
+
**tcxUrl** | **string** | 3CX URL | [default to undefined]
|
|
15
|
+
**tcxKey** | **string** | 3CX SBC Key | [default to undefined]
|
|
16
|
+
**configured** | **boolean** | 3CX SBC Configured | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
package/docs/TcxSbcEntity.md
CHANGED
|
@@ -6,22 +6,22 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**sbcId** | **number** | SBC ID | [
|
|
11
|
-
**tcxUrl** | **string** | 3CX URL | [
|
|
12
|
-
**tcxKey** | **string** | 3CX SBC Auth Key | [
|
|
13
|
-
**label** | **string** | Label | [
|
|
14
|
-
**ipAddress** | **string** | IP Address | [
|
|
15
|
-
**netmask** | **string** | Subnet Mask | [
|
|
16
|
-
**defaultGateway** | **string** | Default Gateway | [
|
|
17
|
-
**dns1** | **string** | DNS 1 | [
|
|
18
|
-
**dns2** | **string** | DNS 2 | [
|
|
19
|
-
**address1** | **string** | Site Address Line 1 | [
|
|
20
|
-
**address2** | **string** | Site Address Line 2 | [
|
|
21
|
-
**city** | **string** | Site City | [
|
|
22
|
-
**postalCode** | **string** | Site Postal Code | [
|
|
23
|
-
**primaryContact** | **string** | Site Primary Contact | [
|
|
24
|
-
**technicalContact** | **string** | Site Technical Contact | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**sbcId** | **number** | SBC ID | [default to undefined]
|
|
11
|
+
**tcxUrl** | **string** | 3CX URL | [default to undefined]
|
|
12
|
+
**tcxKey** | **string** | 3CX SBC Auth Key | [default to undefined]
|
|
13
|
+
**label** | **string** | Label | [default to undefined]
|
|
14
|
+
**ipAddress** | **string** | IP Address | [default to undefined]
|
|
15
|
+
**netmask** | **string** | Subnet Mask | [default to undefined]
|
|
16
|
+
**defaultGateway** | **string** | Default Gateway | [default to undefined]
|
|
17
|
+
**dns1** | **string** | DNS 1 | [default to undefined]
|
|
18
|
+
**dns2** | **string** | DNS 2 | [default to undefined]
|
|
19
|
+
**address1** | **string** | Site Address Line 1 | [default to undefined]
|
|
20
|
+
**address2** | **string** | Site Address Line 2 | [default to undefined]
|
|
21
|
+
**city** | **string** | Site City | [default to undefined]
|
|
22
|
+
**postalCode** | **string** | Site Postal Code | [default to undefined]
|
|
23
|
+
**primaryContact** | **string** | Site Primary Contact | [default to undefined]
|
|
24
|
+
**technicalContact** | **string** | Site Technical Contact | [default to undefined]
|
|
25
25
|
|
|
26
26
|
## Example
|
|
27
27
|
|
package/docs/TcxSbcModel.md
CHANGED
|
@@ -6,22 +6,22 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**sbcId** | **number** | SBC ID | [
|
|
11
|
-
**tcxUrl** | **string** | 3CX URL | [
|
|
12
|
-
**tcxKey** | **string** | 3CX SBC Auth Key | [
|
|
13
|
-
**label** | **string** | Label | [
|
|
14
|
-
**ipAddress** | **string** | IP Address | [
|
|
15
|
-
**netmask** | **string** | Subnet Mask | [
|
|
16
|
-
**defaultGateway** | **string** | Default Gateway | [
|
|
17
|
-
**dns1** | **string** | DNS 1 | [
|
|
18
|
-
**dns2** | **string** | DNS 2 | [
|
|
19
|
-
**address1** | **string** | Site Address Line 1 | [
|
|
20
|
-
**address2** | **string** | Site Address Line 2 | [
|
|
21
|
-
**city** | **string** | Site City | [
|
|
22
|
-
**postalCode** | **string** | Site Postal Code | [
|
|
23
|
-
**primaryContact** | **string** | Site Primary Contact | [
|
|
24
|
-
**technicalContact** | **string** | Site Technical Contact | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**sbcId** | **number** | SBC ID | [default to undefined]
|
|
11
|
+
**tcxUrl** | **string** | 3CX URL | [default to undefined]
|
|
12
|
+
**tcxKey** | **string** | 3CX SBC Auth Key | [default to undefined]
|
|
13
|
+
**label** | **string** | Label | [default to undefined]
|
|
14
|
+
**ipAddress** | **string** | IP Address | [default to undefined]
|
|
15
|
+
**netmask** | **string** | Subnet Mask | [default to undefined]
|
|
16
|
+
**defaultGateway** | **string** | Default Gateway | [default to undefined]
|
|
17
|
+
**dns1** | **string** | DNS 1 | [default to undefined]
|
|
18
|
+
**dns2** | **string** | DNS 2 | [default to undefined]
|
|
19
|
+
**address1** | **string** | Site Address Line 1 | [default to undefined]
|
|
20
|
+
**address2** | **string** | Site Address Line 2 | [default to undefined]
|
|
21
|
+
**city** | **string** | Site City | [default to undefined]
|
|
22
|
+
**postalCode** | **string** | Site Postal Code | [default to undefined]
|
|
23
|
+
**primaryContact** | **string** | Site Primary Contact | [default to undefined]
|
|
24
|
+
**technicalContact** | **string** | Site Technical Contact | [default to undefined]
|
|
25
25
|
|
|
26
26
|
## Example
|
|
27
27
|
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**status** | **string** | Status | [
|
|
10
|
-
**message** | **string** | Message | [
|
|
9
|
+
**status** | **string** | Status | [default to undefined]
|
|
10
|
+
**message** | **string** | Message | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/TcxSetupEntity.md
CHANGED
|
@@ -6,32 +6,32 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**creation** | **string** | Creation Date | [
|
|
9
|
+
**creation** | **string** | Creation Date | [default to undefined]
|
|
10
10
|
**installType** | **string** | Install Type | [optional] [default to undefined]
|
|
11
|
-
**installVersion** | **number** | 3CX Install Version | [
|
|
12
|
-
**orderId** | **number** | Linked Order ID | [
|
|
13
|
-
**customerId** | **number** | Customer ID | [
|
|
14
|
-
**username** | **string** | 3CX System Owner Username | [
|
|
15
|
-
**password** | **string** | 3CX System Owner Password | [
|
|
16
|
-
**primaryContactName** | **string** | Primary Contact Name | [
|
|
17
|
-
**primaryContactNumber** | **string** | Primary Contact Number | [
|
|
18
|
-
**technicalContactName** | **string** | Technical Contact Name | [
|
|
19
|
-
**technicalContactNumber** | **string** | Technical Contact Number | [
|
|
20
|
-
**companyName** | **string** | Company Name | [
|
|
21
|
-
**email** | **string** | 3CX Admin Email Address | [
|
|
22
|
-
**phone** | **string** | Contact Phone Number | [
|
|
23
|
-
**additionalDisk** | **number** | Additional Disk Space | [
|
|
24
|
-
**licencekey** | **string** | 3CX Licence Key | [
|
|
25
|
-
**hostname** | **string** | 3CX Hostname | [
|
|
26
|
-
**suffix** | **string** | 3CX DNS Suffix | [
|
|
27
|
-
**extLength** | **number** | Extension Length | [
|
|
28
|
-
**address1** | **string** | Address Line 1 | [
|
|
29
|
-
**address2** | **string** | Address Line 2 | [
|
|
30
|
-
**city** | **string** | City | [
|
|
31
|
-
**postCode** | **string** | Postal Code | [
|
|
32
|
-
**region** | **string** | Region | [
|
|
33
|
-
**status** | **number** | Status | [
|
|
34
|
-
**instanceId** | **string** | Instance ID | [
|
|
11
|
+
**installVersion** | **number** | 3CX Install Version | [default to 20]
|
|
12
|
+
**orderId** | **number** | Linked Order ID | [default to undefined]
|
|
13
|
+
**customerId** | **number** | Customer ID | [default to undefined]
|
|
14
|
+
**username** | **string** | 3CX System Owner Username | [default to undefined]
|
|
15
|
+
**password** | **string** | 3CX System Owner Password | [default to undefined]
|
|
16
|
+
**primaryContactName** | **string** | Primary Contact Name | [default to undefined]
|
|
17
|
+
**primaryContactNumber** | **string** | Primary Contact Number | [default to undefined]
|
|
18
|
+
**technicalContactName** | **string** | Technical Contact Name | [default to undefined]
|
|
19
|
+
**technicalContactNumber** | **string** | Technical Contact Number | [default to undefined]
|
|
20
|
+
**companyName** | **string** | Company Name | [default to undefined]
|
|
21
|
+
**email** | **string** | 3CX Admin Email Address | [default to undefined]
|
|
22
|
+
**phone** | **string** | Contact Phone Number | [default to undefined]
|
|
23
|
+
**additionalDisk** | **number** | Additional Disk Space | [default to undefined]
|
|
24
|
+
**licencekey** | **string** | 3CX Licence Key | [default to undefined]
|
|
25
|
+
**hostname** | **string** | 3CX Hostname | [default to undefined]
|
|
26
|
+
**suffix** | **string** | 3CX DNS Suffix | [default to undefined]
|
|
27
|
+
**extLength** | **number** | Extension Length | [default to undefined]
|
|
28
|
+
**address1** | **string** | Address Line 1 | [default to undefined]
|
|
29
|
+
**address2** | **string** | Address Line 2 | [default to undefined]
|
|
30
|
+
**city** | **string** | City | [default to undefined]
|
|
31
|
+
**postCode** | **string** | Postal Code | [default to undefined]
|
|
32
|
+
**region** | **string** | Region | [default to undefined]
|
|
33
|
+
**status** | **number** | Status | [default to undefined]
|
|
34
|
+
**instanceId** | **string** | Instance ID | [default to undefined]
|
|
35
35
|
|
|
36
36
|
## Example
|
|
37
37
|
|
package/docs/TcxSetupsModel.md
CHANGED
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<TcxSetupEntity>**](TcxSetupEntity.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<TcxSetupEntity>**](TcxSetupEntity.md) | Results | [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,19 +6,19 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**provider** | **string** | Provider | [
|
|
11
|
-
**serviceId** | **number** | Service ID (YG Trunks Only) | [
|
|
12
|
-
**authType** | **string** | Auth Type | [
|
|
13
|
-
**server** | **string** | Registrar Address | [
|
|
14
|
-
**username** | **string** | Username | [
|
|
15
|
-
**password** | **string** | Password | [
|
|
16
|
-
**channels** | **number** | Channels | [
|
|
17
|
-
**port** | **number** | SIP Port | [
|
|
18
|
-
**proxy** | **string** | Proxy Address | [
|
|
19
|
-
**password2** | **string** | Secondary Authentication Password | [
|
|
20
|
-
**number** | **string** | Main Trunk Number | [
|
|
21
|
-
**ipAddress** | **string** | PBX IP Address | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**provider** | **string** | Provider | [default to undefined]
|
|
11
|
+
**serviceId** | **number** | Service ID (YG Trunks Only) | [default to undefined]
|
|
12
|
+
**authType** | **string** | Auth Type | [default to undefined]
|
|
13
|
+
**server** | **string** | Registrar Address | [default to undefined]
|
|
14
|
+
**username** | **string** | Username | [default to undefined]
|
|
15
|
+
**password** | **string** | Password | [default to undefined]
|
|
16
|
+
**channels** | **number** | Channels | [default to undefined]
|
|
17
|
+
**port** | **number** | SIP Port | [default to undefined]
|
|
18
|
+
**proxy** | **string** | Proxy Address | [default to undefined]
|
|
19
|
+
**password2** | **string** | Secondary Authentication Password | [default to undefined]
|
|
20
|
+
**number** | **string** | Main Trunk Number | [default to undefined]
|
|
21
|
+
**ipAddress** | **string** | PBX IP Address | [default to undefined]
|
|
22
22
|
|
|
23
23
|
## Example
|
|
24
24
|
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Attribute ID | [
|
|
10
|
-
**name** | **string** | Template Filename | [
|
|
9
|
+
**id** | **number** | Attribute ID | [default to undefined]
|
|
10
|
+
**name** | **string** | Template Filename | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/TcxUsersEntity.md
CHANGED
|
@@ -6,12 +6,12 @@ TcxUsersEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**instanceId** | **string** | instanceId | [
|
|
11
|
-
**extension** | **string** | extension | [
|
|
12
|
-
**username** | **string** | username | [
|
|
13
|
-
**password** | **string** | password | [
|
|
14
|
-
**secret** | **string** | secret | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**instanceId** | **string** | instanceId | [default to undefined]
|
|
11
|
+
**extension** | **string** | extension | [default to undefined]
|
|
12
|
+
**username** | **string** | username | [default to undefined]
|
|
13
|
+
**password** | **string** | password | [default to undefined]
|
|
14
|
+
**secret** | **string** | secret | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**logo** | [**GenericFileModel**](GenericFileModel.md) | | [
|
|
10
|
-
**hex** | **string** | Hex Colour | [
|
|
9
|
+
**logo** | [**GenericFileModel**](GenericFileModel.md) | | [default to undefined]
|
|
10
|
+
**hex** | **string** | Hex Colour | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/TcxWizardModel.md
CHANGED
|
@@ -6,20 +6,20 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | 3CX Installation Wizard ID | [
|
|
10
|
-
**config** | [**TcxWizardConfigModel**](TcxWizardConfigModel.md) | | [
|
|
11
|
-
**licenceKey** | **string** | 3CX Licence Key | [
|
|
12
|
-
**installType** | **string** | Install Type | [
|
|
9
|
+
**id** | **number** | 3CX Installation Wizard ID | [default to undefined]
|
|
10
|
+
**config** | [**TcxWizardConfigModel**](TcxWizardConfigModel.md) | | [default to undefined]
|
|
11
|
+
**licenceKey** | **string** | 3CX Licence Key | [default to undefined]
|
|
12
|
+
**installType** | **string** | Install Type | [default to undefined]
|
|
13
13
|
**backup** | [**TcxBackupModel**](TcxBackupModel.md) | | [optional] [default to undefined]
|
|
14
|
-
**extensions** | [**Array<TcxExtsEntity>**](TcxExtsEntity.md) | | [
|
|
15
|
-
**numbers** | [**Array<TcxNumbersEntity>**](TcxNumbersEntity.md) | | [
|
|
14
|
+
**extensions** | [**Array<TcxExtsEntity>**](TcxExtsEntity.md) | | [default to undefined]
|
|
15
|
+
**numbers** | [**Array<TcxNumbersEntity>**](TcxNumbersEntity.md) | | [default to undefined]
|
|
16
16
|
**officeHours** | [**TcxOfficeHoursEntity**](TcxOfficeHoursEntity.md) | | [optional] [default to undefined]
|
|
17
|
-
**phones** | [**Array<TcxPhoneModel>**](TcxPhoneModel.md) | | [
|
|
18
|
-
**sbcs** | [**Array<TcxSbcModel>**](TcxSbcModel.md) | | [
|
|
17
|
+
**phones** | [**Array<TcxPhoneModel>**](TcxPhoneModel.md) | | [default to undefined]
|
|
18
|
+
**sbcs** | [**Array<TcxSbcModel>**](TcxSbcModel.md) | | [default to undefined]
|
|
19
19
|
**sipTrunk** | [**TcxSipTrunksEntity**](TcxSipTrunksEntity.md) | | [optional] [default to undefined]
|
|
20
20
|
**installationStatus** | **string** | | [optional] [default to undefined]
|
|
21
21
|
**setup** | [**TcxSetupEntity**](TcxSetupEntity.md) | | [optional] [default to undefined]
|
|
22
|
-
**endUserView** | **boolean** | End User Wizard View | [
|
|
22
|
+
**endUserView** | **boolean** | End User Wizard View | [default to undefined]
|
|
23
23
|
|
|
24
24
|
## Example
|
|
25
25
|
|
|
@@ -6,11 +6,11 @@ Tech Support Company Summary
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**companyId** | **number** | Company ID | [
|
|
10
|
-
**companyName** | **string** | Company Name | [
|
|
11
|
-
**contract** | [**CompanyContractModel**](CompanyContractModel.md) | | [
|
|
12
|
-
**reportUrl** | **string** | Report URL | [
|
|
13
|
-
**monthlyReportEmailAddress** | **string** | Monthly Report Email Address | [
|
|
9
|
+
**companyId** | **number** | Company ID | [default to undefined]
|
|
10
|
+
**companyName** | **string** | Company Name | [default to undefined]
|
|
11
|
+
**contract** | [**CompanyContractModel**](CompanyContractModel.md) | | [default to undefined]
|
|
12
|
+
**reportUrl** | **string** | Report URL | [default to undefined]
|
|
13
|
+
**monthlyReportEmailAddress** | **string** | Monthly Report Email Address | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,13 +6,13 @@ Ticket Summary Model
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**subject** | **string** | subject | [
|
|
11
|
-
**companyId** | **number** | companyId | [
|
|
12
|
-
**groupId** | **number** | groupId | [
|
|
13
|
-
**productId** | **number** | productId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**subject** | **string** | subject | [default to undefined]
|
|
11
|
+
**companyId** | **number** | companyId | [default to undefined]
|
|
12
|
+
**groupId** | **number** | groupId | [default to undefined]
|
|
13
|
+
**productId** | **number** | productId | [default to undefined]
|
|
14
14
|
**statusId** | **number** | status | [optional] [default to undefined]
|
|
15
|
-
**lastUpdated** | **string** | lastUpdated | [
|
|
15
|
+
**lastUpdated** | **string** | lastUpdated | [default to undefined]
|
|
16
16
|
**statusText** | **string** | Status Text | [optional] [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
package/docs/TicketTimeDTO.md
CHANGED
|
@@ -5,15 +5,15 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**ticketId** | **number** | Ticket ID | [
|
|
9
|
-
**ticketUrl** | **string** | Ticket URL | [
|
|
10
|
-
**created** | **string** | Date Time | [
|
|
11
|
-
**contactName** | **string** | Contact Name | [
|
|
12
|
-
**agentName** | **string** | Agent Name | [
|
|
13
|
-
**status** | **string** | Status | [
|
|
14
|
-
**subject** | **string** | Ticket Subject | [
|
|
15
|
-
**supportBankTime** | **string** | Support Bank Time | [
|
|
16
|
-
**fixedPriceTime** | **string** | Fixed Price Time | [
|
|
8
|
+
**ticketId** | **number** | Ticket ID | [default to undefined]
|
|
9
|
+
**ticketUrl** | **string** | Ticket URL | [default to undefined]
|
|
10
|
+
**created** | **string** | Date Time | [default to undefined]
|
|
11
|
+
**contactName** | **string** | Contact Name | [default to undefined]
|
|
12
|
+
**agentName** | **string** | Agent Name | [default to undefined]
|
|
13
|
+
**status** | **string** | Status | [default to undefined]
|
|
14
|
+
**subject** | **string** | Ticket Subject | [default to undefined]
|
|
15
|
+
**supportBankTime** | **string** | Support Bank Time | [default to undefined]
|
|
16
|
+
**fixedPriceTime** | **string** | Fixed Price Time | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
package/docs/TicketsApi.md
CHANGED
|
@@ -194,9 +194,9 @@ import {
|
|
|
194
194
|
const configuration = new Configuration();
|
|
195
195
|
const apiInstance = new TicketsApi(configuration);
|
|
196
196
|
|
|
197
|
-
let subject: string; //Ticket Subject (
|
|
198
|
-
let message: string; //Ticket Message (
|
|
199
|
-
let attachments: Array<File>; //Attachments (up to 20MB combined) (
|
|
197
|
+
let subject: string; //Ticket Subject (default to undefined)
|
|
198
|
+
let message: string; //Ticket Message (default to undefined)
|
|
199
|
+
let attachments: Array<File>; //Attachments (up to 20MB combined) (default to undefined)
|
|
200
200
|
|
|
201
201
|
const { status, data } = await apiInstance.postCreateTicket(
|
|
202
202
|
subject,
|
|
@@ -209,9 +209,9 @@ const { status, data } = await apiInstance.postCreateTicket(
|
|
|
209
209
|
|
|
210
210
|
|Name | Type | Description | Notes|
|
|
211
211
|
|------------- | ------------- | ------------- | -------------|
|
|
212
|
-
| **subject** | [**string**] | Ticket Subject |
|
|
213
|
-
| **message** | [**string**] | Ticket Message |
|
|
214
|
-
| **attachments** | **Array<File>** | Attachments (up to 20MB combined) |
|
|
212
|
+
| **subject** | [**string**] | Ticket Subject | defaults to undefined|
|
|
213
|
+
| **message** | [**string**] | Ticket Message | defaults to undefined|
|
|
214
|
+
| **attachments** | **Array<File>** | Attachments (up to 20MB combined) | defaults to undefined|
|
|
215
215
|
|
|
216
216
|
|
|
217
217
|
### Return type
|
|
@@ -255,8 +255,8 @@ const configuration = new Configuration();
|
|
|
255
255
|
const apiInstance = new TicketsApi(configuration);
|
|
256
256
|
|
|
257
257
|
let id: number; //Ticket ID (default to undefined)
|
|
258
|
-
let body: string; //Reply Body (
|
|
259
|
-
let attachments: Array<File>; //Attachments (up to 20MB combined) (
|
|
258
|
+
let body: string; //Reply Body (default to undefined)
|
|
259
|
+
let attachments: Array<File>; //Attachments (up to 20MB combined) (default to undefined)
|
|
260
260
|
|
|
261
261
|
const { status, data } = await apiInstance.postTicketReply(
|
|
262
262
|
id,
|
|
@@ -270,8 +270,8 @@ const { status, data } = await apiInstance.postTicketReply(
|
|
|
270
270
|
|Name | Type | Description | Notes|
|
|
271
271
|
|------------- | ------------- | ------------- | -------------|
|
|
272
272
|
| **id** | [**number**] | Ticket ID | defaults to undefined|
|
|
273
|
-
| **body** | [**string**] | Reply Body |
|
|
274
|
-
| **attachments** | **Array<File>** | Attachments (up to 20MB combined) |
|
|
273
|
+
| **body** | [**string**] | Reply Body | defaults to undefined|
|
|
274
|
+
| **attachments** | **Array<File>** | Attachments (up to 20MB combined) | defaults to undefined|
|
|
275
275
|
|
|
276
276
|
|
|
277
277
|
### Return type
|
|
@@ -6,9 +6,9 @@ OAuth Token Response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**token_type** | **string** | Access Token Type | [
|
|
10
|
-
**expires_in** | **number** | Seconds until expiry | [
|
|
11
|
-
**access_token** | **string** | Access Token | [
|
|
9
|
+
**token_type** | **string** | Access Token Type | [default to 'Bearer']
|
|
10
|
+
**expires_in** | **number** | Seconds until expiry | [default to undefined]
|
|
11
|
+
**access_token** | **string** | Access Token | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,8 +6,8 @@ EdTechPro Upgrade Response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**message** | **string** | Response Message | [
|
|
10
|
-
**templateUrl** | **string** | Integration Template URL | [
|
|
9
|
+
**message** | **string** | Response Message | [default to undefined]
|
|
10
|
+
**templateUrl** | **string** | Integration Template URL | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,10 +6,10 @@ EdTechPro Upgrade Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**clientId** | **number** | Client/Trust ID | [
|
|
10
|
-
**schoolId** | **number** | School Id | [
|
|
11
|
-
**licenceType** | **string** | Licence Type | [
|
|
12
|
-
**schoolType** | **string** | School Type | [
|
|
9
|
+
**clientId** | **number** | Client/Trust ID | [default to undefined]
|
|
10
|
+
**schoolId** | **number** | School Id | [default to undefined]
|
|
11
|
+
**licenceType** | **string** | Licence Type | [default to undefined]
|
|
12
|
+
**schoolType** | **string** | School Type | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|