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
|
@@ -6,13 +6,13 @@ Client Details
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**clientId** | **string** | Client ID | [
|
|
10
|
-
**userId** | **number** | User ID | [
|
|
11
|
-
**email** | **string** | Email Address | [
|
|
12
|
-
**customerId** | **number** | Customer ID | [
|
|
13
|
-
**xeroId** | **string** | Xero ID | [
|
|
14
|
-
**firstName** | **string** | User First Name | [
|
|
15
|
-
**lastName** | **string** | User Last Name | [
|
|
9
|
+
**clientId** | **string** | Client ID | [default to undefined]
|
|
10
|
+
**userId** | **number** | User ID | [default to undefined]
|
|
11
|
+
**email** | **string** | Email Address | [default to undefined]
|
|
12
|
+
**customerId** | **number** | Customer ID | [default to undefined]
|
|
13
|
+
**xeroId** | **string** | Xero ID | [default to undefined]
|
|
14
|
+
**firstName** | **string** | User First Name | [default to undefined]
|
|
15
|
+
**lastName** | **string** | User Last Name | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
package/docs/ClientModel.md
CHANGED
|
@@ -6,10 +6,10 @@ OAuth client details
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**scopes** | **Array<string>** | OAuth 2.0 Scopes | [
|
|
10
|
-
**client_id** | **string** | OAuth 2.0 Client ID | [
|
|
11
|
-
**client_secret** | **string** | OAuth 2.0 Client Secret | [
|
|
12
|
-
**created** | **string** | Creation Date | [
|
|
9
|
+
**scopes** | **Array<string>** | OAuth 2.0 Scopes | [default to undefined]
|
|
10
|
+
**client_id** | **string** | OAuth 2.0 Client ID | [default to undefined]
|
|
11
|
+
**client_secret** | **string** | OAuth 2.0 Client Secret | [default to undefined]
|
|
12
|
+
**created** | **string** | Creation Date | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,11 +6,11 @@ Company Tech Support Contract
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**contractStartDate** | **string** | Contract Start Date | [
|
|
10
|
-
**contractEndDate** | **string** | Contract End Date | [
|
|
11
|
-
**supportBankTime** | **string** | Contract Support Bank Hours | [
|
|
12
|
-
**timeUsed** | **string** | Time Used | [
|
|
13
|
-
**timeRemaining** | **string** | Time Remaining | [
|
|
9
|
+
**contractStartDate** | **string** | Contract Start Date | [default to undefined]
|
|
10
|
+
**contractEndDate** | **string** | Contract End Date | [default to undefined]
|
|
11
|
+
**supportBankTime** | **string** | Contract Support Bank Hours | [default to undefined]
|
|
12
|
+
**timeUsed** | **string** | Time Used | [default to undefined]
|
|
13
|
+
**timeRemaining** | **string** | Time Remaining | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/ContactInfoModel.md
CHANGED
|
@@ -6,11 +6,11 @@ Order Contact Info
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**firstName** | **string** | Contact First Name | [
|
|
10
|
-
**lastName** | **string** | Contact Last Name | [
|
|
11
|
-
**fullName** | **string** | Contact Full Name | [
|
|
12
|
-
**telephone** | **string** | Contact Telephone | [
|
|
13
|
-
**vatNumber** | **string** | VAT Number | [
|
|
9
|
+
**firstName** | **string** | Contact First Name | [default to undefined]
|
|
10
|
+
**lastName** | **string** | Contact Last Name | [default to undefined]
|
|
11
|
+
**fullName** | **string** | Contact Full Name | [default to undefined]
|
|
12
|
+
**telephone** | **string** | Contact Telephone | [default to undefined]
|
|
13
|
+
**vatNumber** | **string** | VAT Number | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,14 +6,14 @@ Freshdesk Ticket Conversation
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**body** | **string** | Conversation Body | [
|
|
10
|
-
**fromCustomer** | **boolean** | From Customer | [
|
|
11
|
-
**targetEmails** | **Array<string>** | Target Email | [
|
|
12
|
-
**senderEmail** | **string** | Sender Email | [
|
|
13
|
-
**sender** | **string** | Sender | [
|
|
14
|
-
**ccEmails** | **Array<string>** | CC Emails | [
|
|
15
|
-
**createdAt** | **string** | Conversation Creation Time | [
|
|
16
|
-
**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [
|
|
9
|
+
**body** | **string** | Conversation Body | [default to undefined]
|
|
10
|
+
**fromCustomer** | **boolean** | From Customer | [default to undefined]
|
|
11
|
+
**targetEmails** | **Array<string>** | Target Email | [default to undefined]
|
|
12
|
+
**senderEmail** | **string** | Sender Email | [default to undefined]
|
|
13
|
+
**sender** | **string** | Sender | [default to undefined]
|
|
14
|
+
**ccEmails** | **Array<string>** | CC Emails | [default to undefined]
|
|
15
|
+
**createdAt** | **string** | Conversation Creation Time | [default to undefined]
|
|
16
|
+
**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
@@ -6,16 +6,16 @@ CourierPricesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**courier** | **string** | courier | [
|
|
11
|
-
**destinationIso** | **string** | destinationIso | [
|
|
12
|
-
**serviceDescription** | **string** | serviceDescription | [
|
|
13
|
-
**flatRate** | **number** | flatRate | [
|
|
14
|
-
**initialBox** | **number** | initialBox | [
|
|
15
|
-
**initialKg** | **number** | initialKg | [
|
|
16
|
-
**perBox** | **number** | perBox | [
|
|
17
|
-
**perKg** | **number** | perKg | [
|
|
18
|
-
**maxKg** | **number** | maxKg | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**courier** | **string** | courier | [default to undefined]
|
|
11
|
+
**destinationIso** | **string** | destinationIso | [default to undefined]
|
|
12
|
+
**serviceDescription** | **string** | serviceDescription | [default to undefined]
|
|
13
|
+
**flatRate** | **number** | flatRate | [default to undefined]
|
|
14
|
+
**initialBox** | **number** | initialBox | [default to undefined]
|
|
15
|
+
**initialKg** | **number** | initialKg | [default to undefined]
|
|
16
|
+
**perBox** | **number** | perBox | [default to undefined]
|
|
17
|
+
**perKg** | **number** | perKg | [default to undefined]
|
|
18
|
+
**maxKg** | **number** | maxKg | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -6,29 +6,29 @@ Credit Account
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
10
|
-
**name** | **string** | Contact Name | [
|
|
11
|
-
**email** | **string** | Email | [
|
|
12
|
-
**phone** | **string** | Phone Number | [
|
|
13
|
-
**company** | **string** | Company Name | [
|
|
14
|
-
**companyNumber** | **string** | Company Registration Number | [
|
|
15
|
-
**vatNumber** | **string** | VAT Number | [
|
|
16
|
-
**addressLine1** | **string** | Address Line 1 | [
|
|
17
|
-
**addressLine2** | **string** | Address Line 2 | [
|
|
18
|
-
**city** | **string** | City | [
|
|
19
|
-
**county** | **string** | County | [
|
|
20
|
-
**iso** | **string** | Country ISO Code | [
|
|
21
|
-
**postalCode** | **string** | Post Code | [
|
|
22
|
-
**accountNumber** | **string** | Account Number | [
|
|
23
|
-
**xeroId** | **string** | Xero Contact ID | [
|
|
24
|
-
**creditLimit** | **number** | Credit Limit | [
|
|
25
|
-
**paymentMethod** | **string** | Payment Method | [
|
|
26
|
-
**servicePaymentMethod** | **string** | Service Payment Method | [
|
|
27
|
-
**resellerId** | **string** | 3CX Reseller ID | [
|
|
28
|
-
**creationDate** | **string** | Creation Date | [
|
|
29
|
-
**prizePromo** | **boolean** | Prize Promo Enabled | [
|
|
30
|
-
**portalAccess** | **boolean** | Portal Access | [
|
|
31
|
-
**cname** | **string** | CNAME | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**name** | **string** | Contact Name | [default to undefined]
|
|
11
|
+
**email** | **string** | Email | [default to undefined]
|
|
12
|
+
**phone** | **string** | Phone Number | [default to undefined]
|
|
13
|
+
**company** | **string** | Company Name | [default to undefined]
|
|
14
|
+
**companyNumber** | **string** | Company Registration Number | [default to undefined]
|
|
15
|
+
**vatNumber** | **string** | VAT Number | [default to undefined]
|
|
16
|
+
**addressLine1** | **string** | Address Line 1 | [default to undefined]
|
|
17
|
+
**addressLine2** | **string** | Address Line 2 | [default to undefined]
|
|
18
|
+
**city** | **string** | City | [default to undefined]
|
|
19
|
+
**county** | **string** | County | [default to undefined]
|
|
20
|
+
**iso** | **string** | Country ISO Code | [default to undefined]
|
|
21
|
+
**postalCode** | **string** | Post Code | [default to undefined]
|
|
22
|
+
**accountNumber** | **string** | Account Number | [default to undefined]
|
|
23
|
+
**xeroId** | **string** | Xero Contact ID | [default to undefined]
|
|
24
|
+
**creditLimit** | **number** | Credit Limit | [default to undefined]
|
|
25
|
+
**paymentMethod** | **string** | Payment Method | [default to undefined]
|
|
26
|
+
**servicePaymentMethod** | **string** | Service Payment Method | [default to undefined]
|
|
27
|
+
**resellerId** | **string** | 3CX Reseller ID | [default to undefined]
|
|
28
|
+
**creationDate** | **string** | Creation Date | [default to undefined]
|
|
29
|
+
**prizePromo** | **boolean** | Prize Promo Enabled | [default to undefined]
|
|
30
|
+
**portalAccess** | **boolean** | Portal Access | [default to undefined]
|
|
31
|
+
**cname** | **string** | CNAME | [default to undefined]
|
|
32
32
|
|
|
33
33
|
## Example
|
|
34
34
|
|
package/docs/CreditNoteDTO.md
CHANGED
|
@@ -6,7 +6,7 @@ Credit Note
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**items** | [**Array<CreditNoteItemDTO>**](CreditNoteItemDTO.md) | Items | [
|
|
9
|
+
**items** | [**Array<CreditNoteItemDTO>**](CreditNoteItemDTO.md) | Items | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
package/docs/CreditNoteEntity.md
CHANGED
|
@@ -6,11 +6,11 @@ CreditNotesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**orderId** | **number** | orderId | [
|
|
11
|
-
**transactionId** | **string** | transactionId | [
|
|
12
|
-
**amount** | **number** | amount | [
|
|
13
|
-
**timestamp** | **string** | timestamp | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
11
|
+
**transactionId** | **string** | transactionId | [default to undefined]
|
|
12
|
+
**amount** | **number** | amount | [default to undefined]
|
|
13
|
+
**timestamp** | **string** | timestamp | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,7 +6,7 @@ Credit Note Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**itemId** | **number** | Item ID | [
|
|
9
|
+
**itemId** | **number** | Item ID | [default to undefined]
|
|
10
10
|
**quantity** | **number** | Quantity | [optional] [default to undefined]
|
|
11
11
|
**amount** | **number** | Amount | [optional] [default to undefined]
|
|
12
12
|
|
|
@@ -6,12 +6,12 @@ CreditNotesItemsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**creditNoteId** | **number** | creditNoteId | [
|
|
11
|
-
**orderId** | **number** | orderId | [
|
|
12
|
-
**itemId** | **number** | itemId | [
|
|
13
|
-
**amount** | **number** | amount | [
|
|
14
|
-
**quantity** | **number** | quantity | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**creditNoteId** | **number** | creditNoteId | [default to undefined]
|
|
11
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
12
|
+
**itemId** | **number** | itemId | [default to undefined]
|
|
13
|
+
**amount** | **number** | amount | [default to undefined]
|
|
14
|
+
**quantity** | **number** | quantity | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -6,12 +6,12 @@ Credit Note Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**creditNoteId** | **number** | creditNoteId | [
|
|
11
|
-
**orderId** | **number** | orderId | [
|
|
12
|
-
**itemId** | **number** | itemId | [
|
|
13
|
-
**amount** | **number** | amount | [
|
|
14
|
-
**quantity** | **number** | quantity | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**creditNoteId** | **number** | creditNoteId | [default to undefined]
|
|
11
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
12
|
+
**itemId** | **number** | itemId | [default to undefined]
|
|
13
|
+
**amount** | **number** | amount | [default to undefined]
|
|
14
|
+
**quantity** | **number** | quantity | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
package/docs/CreditNoteModel.md
CHANGED
|
@@ -6,11 +6,11 @@ Credit Note Model
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**orderId** | **number** | orderId | [
|
|
11
|
-
**transactionId** | **string** | transactionId | [
|
|
12
|
-
**amount** | **number** | amount | [
|
|
13
|
-
**timestamp** | **string** | timestamp | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
11
|
+
**transactionId** | **string** | transactionId | [default to undefined]
|
|
12
|
+
**amount** | **number** | amount | [default to undefined]
|
|
13
|
+
**timestamp** | **string** | timestamp | [default to undefined]
|
|
14
14
|
**items** | [**Array<CreditNoteItemModel>**](CreditNoteItemModel.md) | Credit Note Items | [optional] [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
@@ -6,8 +6,8 @@ CRM Activities Response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**dates** | [**Array<CrmDateActivitiesDTO>**](CrmDateActivitiesDTO.md) | Dates | [
|
|
10
|
-
**agents** | [**Array<AdminUserModel>**](AdminUserModel.md) | Agents | [
|
|
9
|
+
**dates** | [**Array<CrmDateActivitiesDTO>**](CrmDateActivitiesDTO.md) | Dates | [default to undefined]
|
|
10
|
+
**agents** | [**Array<AdminUserModel>**](AdminUserModel.md) | Agents | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/CrmActivityDTO.md
CHANGED
|
@@ -6,10 +6,10 @@ CRM Activity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**type** | **string** | Activity Type | [
|
|
9
|
+
**type** | **string** | Activity Type | [default to undefined]
|
|
10
10
|
**timestamp** | **string** | Activity Timestamp | [optional] [default to undefined]
|
|
11
|
-
**title** | **string** | Activity Title | [
|
|
12
|
-
**description** | **string** | Activity Description | [
|
|
11
|
+
**title** | **string** | Activity Title | [default to undefined]
|
|
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]
|
package/docs/CrmContactDTO.md
CHANGED
|
@@ -6,13 +6,13 @@ CRM Contact
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | Contact ID | [
|
|
10
|
-
**firstName** | **string** | Contact First Name | [
|
|
11
|
-
**lastName** | **string** | Contact Last Name | [
|
|
12
|
-
**phone** | **string** | Phone Number | [
|
|
13
|
-
**company** | **string** | Company Name | [
|
|
14
|
-
**email** | **string** | Email Address | [
|
|
15
|
-
**url** | **string** | URL | [
|
|
9
|
+
**id** | **string** | Contact ID | [default to undefined]
|
|
10
|
+
**firstName** | **string** | Contact First Name | [default to undefined]
|
|
11
|
+
**lastName** | **string** | Contact Last Name | [default to undefined]
|
|
12
|
+
**phone** | **string** | Phone Number | [default to undefined]
|
|
13
|
+
**company** | **string** | Company Name | [default to undefined]
|
|
14
|
+
**email** | **string** | Email Address | [default to undefined]
|
|
15
|
+
**url** | **string** | URL | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -7,7 +7,7 @@ CRM Date Activities
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**date** | **string** | Date | [optional] [default to undefined]
|
|
10
|
-
**activities** | [**Array<CrmActivityDTO>**](CrmActivityDTO.md) | Activities | [
|
|
10
|
+
**activities** | [**Array<CrmActivityDTO>**](CrmActivityDTO.md) | Activities | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/CrmNoteEntity.md
CHANGED
|
@@ -6,16 +6,16 @@ CrmNotesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**customerId** | **string** | customerId | [
|
|
11
|
-
**userId** | **number** | userId | [
|
|
12
|
-
**type** | **string** | type | [
|
|
13
|
-
**note** | **string** | note | [
|
|
14
|
-
**timestamp** | **string** | timestamp | [
|
|
15
|
-
**journalTime** | **string** | journalTime | [
|
|
16
|
-
**duration** | **string** | duration | [
|
|
17
|
-
**callType** | **string** | callType | [
|
|
18
|
-
**callId** | **number** | callId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**customerId** | **string** | customerId | [default to undefined]
|
|
11
|
+
**userId** | **number** | userId | [default to undefined]
|
|
12
|
+
**type** | **string** | type | [default to undefined]
|
|
13
|
+
**note** | **string** | note | [default to undefined]
|
|
14
|
+
**timestamp** | **string** | timestamp | [default to undefined]
|
|
15
|
+
**journalTime** | **string** | journalTime | [default to undefined]
|
|
16
|
+
**duration** | **string** | duration | [default to undefined]
|
|
17
|
+
**callType** | **string** | callType | [default to undefined]
|
|
18
|
+
**callId** | **number** | callId | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
package/docs/CrmNoteModel.md
CHANGED
|
@@ -6,16 +6,16 @@ CrmNotesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**customerId** | **string** | customerId | [
|
|
11
|
-
**userId** | **number** | userId | [
|
|
12
|
-
**type** | **string** | type | [
|
|
13
|
-
**note** | **string** | note | [
|
|
14
|
-
**timestamp** | **string** | timestamp | [
|
|
15
|
-
**journalTime** | **string** | journalTime | [
|
|
16
|
-
**duration** | **string** | duration | [
|
|
17
|
-
**callType** | **string** | callType | [
|
|
18
|
-
**callId** | **number** | callId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**customerId** | **string** | customerId | [default to undefined]
|
|
11
|
+
**userId** | **number** | userId | [default to undefined]
|
|
12
|
+
**type** | **string** | type | [default to undefined]
|
|
13
|
+
**note** | **string** | note | [default to undefined]
|
|
14
|
+
**timestamp** | **string** | timestamp | [default to undefined]
|
|
15
|
+
**journalTime** | **string** | journalTime | [default to undefined]
|
|
16
|
+
**duration** | **string** | duration | [default to undefined]
|
|
17
|
+
**callType** | **string** | callType | [default to undefined]
|
|
18
|
+
**callId** | **number** | callId | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -6,12 +6,12 @@ Customer Coordinates
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | ID | [
|
|
10
|
-
**company** | **string** | Company | [
|
|
9
|
+
**id** | **string** | ID | [default to undefined]
|
|
10
|
+
**company** | **string** | Company | [default to undefined]
|
|
11
11
|
**resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
|
|
12
|
-
**postCode** | **string** | Post Code | [
|
|
13
|
-
**latitude** | **string** | Latitude | [
|
|
14
|
-
**longitude** | **string** | Longitude | [
|
|
12
|
+
**postCode** | **string** | Post Code | [default to undefined]
|
|
13
|
+
**latitude** | **string** | Latitude | [default to undefined]
|
|
14
|
+
**longitude** | **string** | Longitude | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -6,10 +6,10 @@ SIP Trunk Customer
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**addressLine1** | **string** | End User Address Line 1 | [
|
|
10
|
-
**addressLine2** | **string** | End User Address Line 2 | [
|
|
11
|
-
**addressCity** | **string** | End User Town/City | [
|
|
12
|
-
**addressPostcode** | **string** | End User Postal Code | [
|
|
9
|
+
**addressLine1** | **string** | End User Address Line 1 | [default to undefined]
|
|
10
|
+
**addressLine2** | **string** | End User Address Line 2 | [default to undefined]
|
|
11
|
+
**addressCity** | **string** | End User Town/City | [default to undefined]
|
|
12
|
+
**addressPostcode** | **string** | End User Postal Code | [default to undefined]
|
|
13
13
|
**companyName** | **string** | End User Company Name | [optional] [default to undefined]
|
|
14
14
|
**contactFirstName** | **string** | End User Contact First Name | [optional] [default to undefined]
|
|
15
15
|
**contactLastName** | **string** | End User Contact Surname | [optional] [default to undefined]
|
|
@@ -6,8 +6,8 @@ Order Item Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [
|
|
10
|
-
**quantity** | **number** | Quantity | [
|
|
9
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
10
|
+
**quantity** | **number** | Quantity | [default to undefined]
|
|
11
11
|
**id** | **number** | ID | [optional] [default to undefined]
|
|
12
12
|
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
13
13
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
@@ -6,19 +6,19 @@ Customer List Account
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
10
|
-
**xeroId** | **string** | Xero ID | [
|
|
11
|
-
**accountNumber** | **string** | Account Number | [
|
|
12
|
-
**company** | **string** | Company Name | [
|
|
13
|
-
**domains** | **Array<string>** | Associated Email Domains | [
|
|
14
|
-
**telephone** | **string** | Telephone | [
|
|
15
|
-
**vatNumber** | **string** | VAT Number | [
|
|
16
|
-
**companyNumber** | **string** | Company Number | [
|
|
17
|
-
**cname** | **string** | Wizard CNAME | [
|
|
18
|
-
**partnerId** | **string** | 3CX Reseller ID | [
|
|
19
|
-
**status** | **boolean** | Account Status | [
|
|
20
|
-
**portalAccess** | **boolean** | Portal Access | [
|
|
21
|
-
**prizePromo** | **boolean** | Prize Promo | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**xeroId** | **string** | Xero ID | [default to undefined]
|
|
11
|
+
**accountNumber** | **string** | Account Number | [default to undefined]
|
|
12
|
+
**company** | **string** | Company Name | [default to undefined]
|
|
13
|
+
**domains** | **Array<string>** | Associated Email Domains | [default to undefined]
|
|
14
|
+
**telephone** | **string** | Telephone | [default to undefined]
|
|
15
|
+
**vatNumber** | **string** | VAT Number | [default to undefined]
|
|
16
|
+
**companyNumber** | **string** | Company Number | [default to undefined]
|
|
17
|
+
**cname** | **string** | Wizard CNAME | [default to undefined]
|
|
18
|
+
**partnerId** | **string** | 3CX Reseller ID | [default to undefined]
|
|
19
|
+
**status** | **boolean** | Account Status | [default to undefined]
|
|
20
|
+
**portalAccess** | **boolean** | Portal Access | [default to undefined]
|
|
21
|
+
**prizePromo** | **boolean** | Prize Promo | [default to undefined]
|
|
22
22
|
|
|
23
23
|
## Example
|
|
24
24
|
|
|
@@ -7,12 +7,12 @@ Order Request
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**orderReference** | **string** | Order Reference | [optional] [default to undefined]
|
|
10
|
-
**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [
|
|
11
|
-
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [
|
|
10
|
+
**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [default to undefined]
|
|
11
|
+
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [default to undefined]
|
|
12
12
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
13
|
**shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
|
|
14
|
-
**partShip** | **boolean** | Part Ship Order | [
|
|
15
|
-
**quote** | **boolean** | Quote | [
|
|
14
|
+
**partShip** | **boolean** | Part Ship Order | [default to undefined]
|
|
15
|
+
**quote** | **boolean** | Quote | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -6,8 +6,8 @@ Customer Price List
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Price List ID | [
|
|
10
|
-
**name** | **string** | Price List Name | [
|
|
9
|
+
**id** | **number** | Price List ID | [default to undefined]
|
|
10
|
+
**name** | **string** | Price List Name | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,10 +6,10 @@ Customer RMAs
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<RmaSummaryDTO>**](RmaSummaryDTO.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<RmaSummaryDTO>**](RmaSummaryDTO.md) | Results | [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,12 +6,12 @@ Customer Summary Report
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**companyName** | **string** | Company Name | [
|
|
10
|
-
**contract** | [**CompanyContractModel**](CompanyContractModel.md) | | [
|
|
11
|
-
**monthlyUsages** | [**Array<MonthlyUsageModel>**](MonthlyUsageModel.md) | Contract Use by Month | [
|
|
12
|
-
**ticketTimes** | [**Array<TicketTimeDTO>**](TicketTimeDTO.md) | Time Entries | [
|
|
13
|
-
**supportBankTimeTotal** | **string** | Time Entries | [
|
|
14
|
-
**fixedPriceTimeTotal** | **string** | Time Entries | [
|
|
9
|
+
**companyName** | **string** | Company Name | [default to undefined]
|
|
10
|
+
**contract** | [**CompanyContractModel**](CompanyContractModel.md) | | [default to undefined]
|
|
11
|
+
**monthlyUsages** | [**Array<MonthlyUsageModel>**](MonthlyUsageModel.md) | Contract Use by Month | [default to undefined]
|
|
12
|
+
**ticketTimes** | [**Array<TicketTimeDTO>**](TicketTimeDTO.md) | Time Entries | [default to undefined]
|
|
13
|
+
**supportBankTimeTotal** | **string** | Time Entries | [default to undefined]
|
|
14
|
+
**fixedPriceTimeTotal** | **string** | Time Entries | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -6,9 +6,9 @@ DDI Range
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**areaCode** | **string** | UK Area Code | [
|
|
10
|
-
**quantity** | **number** | Number of DDIs | [
|
|
11
|
-
**consecutive** | **boolean** | Consecutive Numbers | [
|
|
9
|
+
**areaCode** | **string** | UK Area Code | [default to '161']
|
|
10
|
+
**quantity** | **number** | Number of DDIs | [default to 1]
|
|
11
|
+
**consecutive** | **boolean** | Consecutive Numbers | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@ DDI Range Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**ranges** | [**Array<DdiRangeRequestModel>**](DdiRangeRequestModel.md) | DDI Ranges | [
|
|
9
|
+
**ranges** | [**Array<DdiRangeRequestModel>**](DdiRangeRequestModel.md) | DDI Ranges | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -6,8 +6,8 @@ Detailed Order Item Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [
|
|
10
|
-
**quantity** | **number** | Quantity | [
|
|
9
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
10
|
+
**quantity** | **number** | Quantity | [default to undefined]
|
|
11
11
|
**id** | **number** | ID | [optional] [default to undefined]
|
|
12
12
|
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
13
13
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
@@ -7,12 +7,12 @@ Detailed Order Request
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**orderReference** | **string** | Order Reference | [optional] [default to undefined]
|
|
10
|
-
**items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [
|
|
11
|
-
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [
|
|
10
|
+
**items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [default to undefined]
|
|
11
|
+
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [default to undefined]
|
|
12
12
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
13
|
**shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
|
|
14
|
-
**partShip** | **boolean** | Part Ship Order | [
|
|
15
|
-
**quote** | **boolean** | Quote | [
|
|
14
|
+
**partShip** | **boolean** | Part Ship Order | [default to undefined]
|
|
15
|
+
**quote** | **boolean** | Quote | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -6,7 +6,7 @@ Divert Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**numbers** | **Array<string>** | Numbers to divert | [
|
|
9
|
+
**numbers** | **Array<string>** | Numbers to divert | [default to undefined]
|
|
10
10
|
**destination** | **string** | Destination | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -6,9 +6,9 @@ Divert
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**number** | **string** | Number | [
|
|
9
|
+
**number** | **string** | Number | [default to undefined]
|
|
10
10
|
**destination** | **string** | Divert Destination | [optional] [default to undefined]
|
|
11
|
-
**status** | **string** | Divert Status | [
|
|
11
|
+
**status** | **string** | Divert Status | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|