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
package/docs/OrderSummaryDTO.md
CHANGED
|
@@ -6,22 +6,22 @@ Order Summary
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
10
|
**reference** | **string** | Reference | [optional] [default to undefined]
|
|
11
|
-
**invoiceNumber** | **string** | Invoice Number | [
|
|
11
|
+
**invoiceNumber** | **string** | Invoice Number | [default to undefined]
|
|
12
12
|
**invoiceId** | **string** | Invoice ID | [optional] [default to undefined]
|
|
13
|
-
**orderDate** | **string** | Date Time | [
|
|
14
|
-
**paid** | **boolean** | Paid | [
|
|
15
|
-
**complete** | **boolean** | Complete | [
|
|
16
|
-
**quote** | **boolean** | Quote | [
|
|
17
|
-
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | | [
|
|
13
|
+
**orderDate** | **string** | Date Time | [default to undefined]
|
|
14
|
+
**paid** | **boolean** | Paid | [default to undefined]
|
|
15
|
+
**complete** | **boolean** | Complete | [default to undefined]
|
|
16
|
+
**quote** | **boolean** | Quote | [default to undefined]
|
|
17
|
+
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | | [default to undefined]
|
|
18
18
|
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
|
|
19
|
-
**items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [
|
|
20
|
-
**carriageCharge** | **number** | Carriage Charge | [
|
|
19
|
+
**items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [default to undefined]
|
|
20
|
+
**carriageCharge** | **number** | Carriage Charge | [default to undefined]
|
|
21
21
|
**fulfillable** | **boolean** | Fulfillable | [optional] [default to undefined]
|
|
22
22
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
23
23
|
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
|
|
24
|
-
**readonly** | **boolean** | Readonly | [
|
|
24
|
+
**readonly** | **boolean** | Readonly | [default to undefined]
|
|
25
25
|
|
|
26
26
|
## Example
|
|
27
27
|
|
package/docs/OrderTotalModel.md
CHANGED
|
@@ -6,13 +6,13 @@ Order Totals
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**subtotal** | **number** | Subtotal | [
|
|
10
|
-
**vat** | **number** | VAT | [
|
|
11
|
-
**total** | **number** | Total | [
|
|
12
|
-
**totalGbp** | **number** | Total in GBP | [
|
|
13
|
-
**vatRate** | **number** | VAT Rate | [
|
|
14
|
-
**credit** | **number** | Credit | [
|
|
15
|
-
**currency** | **string** | Currency | [
|
|
9
|
+
**subtotal** | **number** | Subtotal | [default to undefined]
|
|
10
|
+
**vat** | **number** | VAT | [default to undefined]
|
|
11
|
+
**total** | **number** | Total | [default to undefined]
|
|
12
|
+
**totalGbp** | **number** | Total in GBP | [default to undefined]
|
|
13
|
+
**vatRate** | **number** | VAT Rate | [default to undefined]
|
|
14
|
+
**credit** | **number** | Credit | [default to undefined]
|
|
15
|
+
**currency** | **string** | Currency | [default to undefined]
|
|
16
16
|
**delivery** | **number** | Delivery | [optional] [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
@@ -6,20 +6,20 @@ OrderedItemsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**itemId** | **number** | itemId | [
|
|
11
|
-
**orderedQuantity** | **number** | orderedQuantity | [
|
|
12
|
-
**itemStatus** | **number** | itemStatus | [
|
|
13
|
-
**supplierId** | **number** | supplierId | [
|
|
14
|
-
**supplierItemId** | **number** | supplierItemId | [
|
|
15
|
-
**supplierPrice** | **number** | supplierPrice | [
|
|
16
|
-
**statusDate** | **string** | statusDate | [
|
|
17
|
-
**statusAuthor** | **number** | statusAuthor | [
|
|
18
|
-
**supplierPaid** | **number** | supplierPaid | [
|
|
19
|
-
**supplierCreditDue** | **number** | supplierCreditDue | [
|
|
20
|
-
**supplierCreditReceived** | **number** | supplierCreditReceived | [
|
|
21
|
-
**supplierSku** | **string** | supplierSku | [
|
|
22
|
-
**returnedStock** | **number** | returnedStock | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**itemId** | **number** | itemId | [default to undefined]
|
|
11
|
+
**orderedQuantity** | **number** | orderedQuantity | [default to undefined]
|
|
12
|
+
**itemStatus** | **number** | itemStatus | [default to undefined]
|
|
13
|
+
**supplierId** | **number** | supplierId | [default to undefined]
|
|
14
|
+
**supplierItemId** | **number** | supplierItemId | [default to undefined]
|
|
15
|
+
**supplierPrice** | **number** | supplierPrice | [default to undefined]
|
|
16
|
+
**statusDate** | **string** | statusDate | [default to undefined]
|
|
17
|
+
**statusAuthor** | **number** | statusAuthor | [default to undefined]
|
|
18
|
+
**supplierPaid** | **number** | supplierPaid | [default to undefined]
|
|
19
|
+
**supplierCreditDue** | **number** | supplierCreditDue | [default to undefined]
|
|
20
|
+
**supplierCreditReceived** | **number** | supplierCreditReceived | [default to undefined]
|
|
21
|
+
**supplierSku** | **string** | supplierSku | [default to undefined]
|
|
22
|
+
**returnedStock** | **number** | returnedStock | [default to undefined]
|
|
23
23
|
|
|
24
24
|
## Example
|
|
25
25
|
|
package/docs/OrderedItemModel.md
CHANGED
|
@@ -6,20 +6,20 @@ Ordered Item Model
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**itemId** | **number** | itemId | [
|
|
11
|
-
**orderedQuantity** | **number** | orderedQuantity | [
|
|
12
|
-
**itemStatus** | **number** | itemStatus | [
|
|
13
|
-
**supplierId** | **number** | supplierId | [
|
|
14
|
-
**supplierItemId** | **number** | supplierItemId | [
|
|
15
|
-
**supplierPrice** | **number** | supplierPrice | [
|
|
16
|
-
**statusDate** | **string** | statusDate | [
|
|
17
|
-
**statusAuthor** | **number** | statusAuthor | [
|
|
18
|
-
**supplierPaid** | **number** | supplierPaid | [
|
|
19
|
-
**supplierCreditDue** | **number** | supplierCreditDue | [
|
|
20
|
-
**supplierCreditReceived** | **number** | supplierCreditReceived | [
|
|
21
|
-
**supplierSku** | **string** | supplierSku | [
|
|
22
|
-
**returnedStock** | **number** | returnedStock | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**itemId** | **number** | itemId | [default to undefined]
|
|
11
|
+
**orderedQuantity** | **number** | orderedQuantity | [default to undefined]
|
|
12
|
+
**itemStatus** | **number** | itemStatus | [default to undefined]
|
|
13
|
+
**supplierId** | **number** | supplierId | [default to undefined]
|
|
14
|
+
**supplierItemId** | **number** | supplierItemId | [default to undefined]
|
|
15
|
+
**supplierPrice** | **number** | supplierPrice | [default to undefined]
|
|
16
|
+
**statusDate** | **string** | statusDate | [default to undefined]
|
|
17
|
+
**statusAuthor** | **number** | statusAuthor | [default to undefined]
|
|
18
|
+
**supplierPaid** | **number** | supplierPaid | [default to undefined]
|
|
19
|
+
**supplierCreditDue** | **number** | supplierCreditDue | [default to undefined]
|
|
20
|
+
**supplierCreditReceived** | **number** | supplierCreditReceived | [default to undefined]
|
|
21
|
+
**supplierSku** | **string** | supplierSku | [default to undefined]
|
|
22
|
+
**returnedStock** | **number** | returnedStock | [default to undefined]
|
|
23
23
|
|
|
24
24
|
## Example
|
|
25
25
|
|
package/docs/PartnerDTO.md
CHANGED
|
@@ -7,16 +7,16 @@
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**partnerId** | **string** | 3CX Partner ID | [optional] [default to undefined]
|
|
10
|
-
**companyName** | **string** | 3CX Partner Company Name | [
|
|
11
|
-
**contactName** | **string** | 3CX Partner Contact Name | [
|
|
12
|
-
**contactPhone** | **string** | 3CX Partner Contact Phone | [
|
|
13
|
-
**contactEmail** | **string** | 3CX Partner Contact Email | [
|
|
14
|
-
**partnerLevel** | **string** | 3CX Partner Level | [
|
|
15
|
-
**licenceDiscountPercent** | **number** | 3CX Partner Licence Discount Percent | [
|
|
16
|
-
**hostingDisountPercent** | **number** | 3CX Partner Hosting Discount Percent | [
|
|
17
|
-
**hostingPriceListId** | **number** | 3CX Hosting Price List ID | [
|
|
18
|
-
**installationUrl** | **string** | 3CX Installation URL | [
|
|
19
|
-
**aligned** | **boolean** | Aligned | [
|
|
10
|
+
**companyName** | **string** | 3CX Partner Company Name | [default to undefined]
|
|
11
|
+
**contactName** | **string** | 3CX Partner Contact Name | [default to undefined]
|
|
12
|
+
**contactPhone** | **string** | 3CX Partner Contact Phone | [default to undefined]
|
|
13
|
+
**contactEmail** | **string** | 3CX Partner Contact Email | [default to undefined]
|
|
14
|
+
**partnerLevel** | **string** | 3CX Partner Level | [default to undefined]
|
|
15
|
+
**licenceDiscountPercent** | **number** | 3CX Partner Licence Discount Percent | [default to undefined]
|
|
16
|
+
**hostingDisountPercent** | **number** | 3CX Partner Hosting Discount Percent | [default to undefined]
|
|
17
|
+
**hostingPriceListId** | **number** | 3CX Hosting Price List ID | [default to undefined]
|
|
18
|
+
**installationUrl** | **string** | 3CX Installation URL | [default to undefined]
|
|
19
|
+
**aligned** | **boolean** | Aligned | [default to undefined]
|
|
20
20
|
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | Customer | [optional] [default to undefined]
|
|
21
21
|
|
|
22
22
|
## Example
|
|
@@ -6,12 +6,12 @@ Password Sender Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**username** | **string** | Username | [
|
|
9
|
+
**username** | **string** | Username | [default to undefined]
|
|
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
13
|
**expiry** | **string** | Expiry | [optional] [default to undefined]
|
|
14
|
-
**recipient** | **Array<string>** | Recipient | [
|
|
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]
|
|
17
17
|
**passwordUrl** | **string** | Password URL | [optional] [default to undefined]
|
|
@@ -6,13 +6,13 @@ PasswordSenderEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**uniqueId** | **string** | uniqueId | [
|
|
10
|
-
**url** | **string** | url | [
|
|
11
|
-
**username** | **string** | username | [
|
|
12
|
-
**password** | **string** | password | [
|
|
13
|
-
**expiryTime** | **string** | expiryTime | [
|
|
14
|
-
**emailRecipient** | **string** | emailRecipient | [
|
|
15
|
-
**description** | **string** | description | [
|
|
9
|
+
**uniqueId** | **string** | uniqueId | [default to undefined]
|
|
10
|
+
**url** | **string** | url | [default to undefined]
|
|
11
|
+
**username** | **string** | username | [default to undefined]
|
|
12
|
+
**password** | **string** | password | [default to undefined]
|
|
13
|
+
**expiryTime** | **string** | expiryTime | [default to undefined]
|
|
14
|
+
**emailRecipient** | **string** | emailRecipient | [default to undefined]
|
|
15
|
+
**description** | **string** | description | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -6,29 +6,29 @@ Customer 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** | Wizard 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** | Wizard CNAME | [default to undefined]
|
|
32
32
|
**directDebitMandate** | **boolean** | Active Direct Debit Mandate | [optional] [default to undefined]
|
|
33
33
|
**navigation** | [**Array<NavigationModel>**](NavigationModel.md) | Portal Navigation | [optional] [default to undefined]
|
|
34
34
|
|
package/docs/PortalLoginModel.md
CHANGED
|
@@ -6,13 +6,13 @@ Portal Login
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**email** | **string** | Email Address | [
|
|
10
|
-
**password** | **string** | Password | [
|
|
11
|
-
**code** | **string** | MFA Code | [
|
|
12
|
-
**secret** | **string** | MFA Secret | [
|
|
13
|
-
**codeChallenge** | **string** | Oauth 2.0 code challenge | [
|
|
14
|
-
**codeVerifier** | **string** | Oauth 2.0 code verifier | [
|
|
15
|
-
**redirect_uri** | **string** | Oauth 2.0 code redirect uri | [
|
|
9
|
+
**email** | **string** | Email Address | [default to undefined]
|
|
10
|
+
**password** | **string** | Password | [default to undefined]
|
|
11
|
+
**code** | **string** | MFA Code | [default to undefined]
|
|
12
|
+
**secret** | **string** | MFA Secret | [default to undefined]
|
|
13
|
+
**codeChallenge** | **string** | Oauth 2.0 code challenge | [default to undefined]
|
|
14
|
+
**codeVerifier** | **string** | Oauth 2.0 code verifier | [default to undefined]
|
|
15
|
+
**redirect_uri** | **string** | Oauth 2.0 code redirect uri | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -5,15 +5,15 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**title** | **string** | Title | [
|
|
9
|
-
**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [
|
|
10
|
-
**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [
|
|
11
|
-
**legend** | **Array<string>** | Legend | [
|
|
12
|
-
**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [
|
|
8
|
+
**title** | **string** | Title | [default to undefined]
|
|
9
|
+
**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [default to undefined]
|
|
10
|
+
**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [default to undefined]
|
|
11
|
+
**legend** | **Array<string>** | Legend | [default to undefined]
|
|
12
|
+
**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [default to undefined]
|
|
13
13
|
**currency** | **string** | Currency | [optional] [default to undefined]
|
|
14
|
-
**locale** | **string** | Locale | [
|
|
15
|
-
**headers** | [**TableRowDTO**](TableRowDTO.md) | | [
|
|
16
|
-
**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [
|
|
14
|
+
**locale** | **string** | Locale | [default to undefined]
|
|
15
|
+
**headers** | [**TableRowDTO**](TableRowDTO.md) | | [default to undefined]
|
|
16
|
+
**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
@@ -6,9 +6,9 @@ Price & Stock List
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**title** | **string** | Title | [
|
|
9
|
+
**title** | **string** | Title | [default to undefined]
|
|
10
10
|
**sku** | **string** | SKU | [optional] [default to undefined]
|
|
11
|
-
**price** | **number** | Price | [
|
|
11
|
+
**price** | **number** | Price | [default to undefined]
|
|
12
12
|
**rrp** | **number** | RRP | [optional] [default to undefined]
|
|
13
13
|
**stock** | **number** | Stock | [optional] [default to undefined]
|
|
14
14
|
|
package/docs/PrinterEntity.md
CHANGED
|
@@ -6,11 +6,11 @@ PrintersEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**brand** | **string** | brand | [
|
|
11
|
-
**model** | **string** | model | [
|
|
12
|
-
**sn** | **string** | sn | [
|
|
13
|
-
**location** | **string** | location | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**brand** | **string** | brand | [default to undefined]
|
|
11
|
+
**model** | **string** | model | [default to undefined]
|
|
12
|
+
**sn** | **string** | sn | [default to undefined]
|
|
13
|
+
**location** | **string** | location | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/PrizesEntity.md
CHANGED
|
@@ -6,12 +6,12 @@ PrizesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**year** | **number** | year | [
|
|
11
|
-
**sku** | **string** | sku | [
|
|
12
|
-
**title** | **string** | title | [
|
|
13
|
-
**target** | **number** | target | [
|
|
14
|
-
**image** | **string** | image | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**year** | **number** | year | [default to undefined]
|
|
11
|
+
**sku** | **string** | sku | [default to undefined]
|
|
12
|
+
**title** | **string** | title | [default to undefined]
|
|
13
|
+
**target** | **number** | target | [default to undefined]
|
|
14
|
+
**image** | **string** | image | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -6,8 +6,8 @@ Product Detailed Summary
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [
|
|
10
|
-
**title** | **string** | Title | [
|
|
9
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
10
|
+
**title** | **string** | Title | [default to undefined]
|
|
11
11
|
**quantity** | **number** | Stock Quantity | [optional] [default to undefined]
|
|
12
12
|
**stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
|
|
13
13
|
**price** | **number** | Price | [optional] [default to undefined]
|
|
@@ -6,9 +6,9 @@ Product Price List Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**title** | **string** | Title | [
|
|
9
|
+
**title** | **string** | Title | [default to undefined]
|
|
10
10
|
**sku** | **string** | SKU | [optional] [default to undefined]
|
|
11
|
-
**price** | **number** | Price | [
|
|
11
|
+
**price** | **number** | Price | [default to undefined]
|
|
12
12
|
**rrp** | **number** | RRP | [optional] [default to undefined]
|
|
13
13
|
**stock** | **number** | Stock | [optional] [default to undefined]
|
|
14
14
|
**brand** | **string** | Brand | [optional] [default to undefined]
|
|
@@ -6,7 +6,7 @@ Product Search Results
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<ProductSummaryDTO>**](ProductSummaryDTO.md) | Results | [
|
|
9
|
+
**results** | [**Array<ProductSummaryDTO>**](ProductSummaryDTO.md) | Results | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -6,10 +6,10 @@ Product Serial Info Response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [
|
|
10
|
-
**title** | **string** | Product Title | [
|
|
11
|
-
**mac** | **boolean** | Has MAC Address | [
|
|
12
|
-
**serialPrefixes** | **Array<string>** | Serial Prefix | [
|
|
9
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
10
|
+
**title** | **string** | Product Title | [default to undefined]
|
|
11
|
+
**mac** | **boolean** | Has MAC Address | [default to undefined]
|
|
12
|
+
**serialPrefixes** | **Array<string>** | Serial Prefix | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,9 +6,9 @@ Product Serial Info
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [
|
|
10
|
-
**title** | **string** | Product Title | [
|
|
11
|
-
**mac** | **boolean** | Has MAC Address | [
|
|
9
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
10
|
+
**title** | **string** | Product Title | [default to undefined]
|
|
11
|
+
**mac** | **boolean** | Has MAC Address | [default to undefined]
|
|
12
12
|
**serial_prefixes** | **Array<string>** | Serial Prefix | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
@@ -6,8 +6,8 @@ Product Summary
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [
|
|
10
|
-
**title** | **string** | Title | [
|
|
9
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
10
|
+
**title** | **string** | Title | [default to undefined]
|
|
11
11
|
**quantity** | **number** | Stock Quantity | [optional] [default to undefined]
|
|
12
12
|
**stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
|
|
13
13
|
**price** | **number** | Price | [optional] [default to undefined]
|
package/docs/PromoCodesEntity.md
CHANGED
|
@@ -6,18 +6,18 @@ PromoCodesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**code** | **string** | code | [
|
|
11
|
-
**description** | **string** | description | [
|
|
12
|
-
**banner** | **string** | banner | [
|
|
13
|
-
**start** | **string** | start | [
|
|
14
|
-
**expiry** | **string** | expiry | [
|
|
15
|
-
**customerLimit** | **number** | customerLimit | [
|
|
16
|
-
**globalLimit** | **number** | globalLimit | [
|
|
17
|
-
**orderRestrictions** | **string** | orderRestrictions | [
|
|
18
|
-
**includeDistribution** | **number** | includeDistribution | [
|
|
19
|
-
**distributionOnly** | **number** | distributionOnly | [
|
|
20
|
-
**note** | **string** | note | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**code** | **string** | code | [default to undefined]
|
|
11
|
+
**description** | **string** | description | [default to undefined]
|
|
12
|
+
**banner** | **string** | banner | [default to undefined]
|
|
13
|
+
**start** | **string** | start | [default to undefined]
|
|
14
|
+
**expiry** | **string** | expiry | [default to undefined]
|
|
15
|
+
**customerLimit** | **number** | customerLimit | [default to undefined]
|
|
16
|
+
**globalLimit** | **number** | globalLimit | [default to undefined]
|
|
17
|
+
**orderRestrictions** | **string** | orderRestrictions | [default to undefined]
|
|
18
|
+
**includeDistribution** | **number** | includeDistribution | [default to undefined]
|
|
19
|
+
**distributionOnly** | **number** | distributionOnly | [default to undefined]
|
|
20
|
+
**note** | **string** | note | [default to undefined]
|
|
21
21
|
|
|
22
22
|
## Example
|
|
23
23
|
|
package/docs/PromoItemsEntity.md
CHANGED
|
@@ -6,14 +6,14 @@ PromoItemsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**promoId** | **number** | promoId | [
|
|
11
|
-
**price** | **number** | price | [
|
|
12
|
-
**discount** | **number** | discount | [
|
|
13
|
-
**sku** | **string** | sku | [
|
|
14
|
-
**quantity** | **number** | quantity | [
|
|
15
|
-
**bulkQuantity** | **number** | bulkQuantity | [
|
|
16
|
-
**bulkAdd** | **number** | bulkAdd | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**promoId** | **number** | promoId | [default to undefined]
|
|
11
|
+
**price** | **number** | price | [default to undefined]
|
|
12
|
+
**discount** | **number** | discount | [default to undefined]
|
|
13
|
+
**sku** | **string** | sku | [default to undefined]
|
|
14
|
+
**quantity** | **number** | quantity | [default to undefined]
|
|
15
|
+
**bulkQuantity** | **number** | bulkQuantity | [default to undefined]
|
|
16
|
+
**bulkAdd** | **number** | bulkAdd | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
package/docs/ProspectDTO.md
CHANGED
|
@@ -6,16 +6,16 @@ Prospect
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**companyName** | **string** | Company Name | [
|
|
9
|
+
**companyName** | **string** | Company Name | [default to undefined]
|
|
10
10
|
**telephone** | **string** | Telephone | [optional] [default to undefined]
|
|
11
11
|
**lastOrderDate** | **string** | Last Order Date | [optional] [default to undefined]
|
|
12
12
|
**callbackDate** | **string** | Call Back Date | [optional] [default to undefined]
|
|
13
|
-
**xeroId** | **string** | Xero ID | [
|
|
14
|
-
**removed** | **boolean** | Removed From Prospects | [
|
|
15
|
-
**status** | **string** | Status | [
|
|
16
|
-
**orderCount** | **number** | Order Count | [
|
|
17
|
-
**tcxOrderCount** | **number** | 3CX Order Count | [
|
|
18
|
-
**videoCount** | **number** | Branded Video Count | [
|
|
13
|
+
**xeroId** | **string** | Xero ID | [default to undefined]
|
|
14
|
+
**removed** | **boolean** | Removed From Prospects | [default to undefined]
|
|
15
|
+
**status** | **string** | Status | [default to undefined]
|
|
16
|
+
**orderCount** | **number** | Order Count | [default to undefined]
|
|
17
|
+
**tcxOrderCount** | **number** | 3CX Order Count | [default to undefined]
|
|
18
|
+
**videoCount** | **number** | Branded Video Count | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
package/docs/ProspectEntity.md
CHANGED
|
@@ -6,17 +6,17 @@ ProspectEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**status** | **number** | status | [
|
|
11
|
-
**customerId** | **number** | customerId | [
|
|
12
|
-
**companyName** | **string** | companyName | [
|
|
13
|
-
**contactName** | **string** | contactName | [
|
|
14
|
-
**telephone** | **string** | telephone | [
|
|
15
|
-
**email** | **string** | email | [
|
|
16
|
-
**reason** | **string** | reason | [
|
|
17
|
-
**lastOrderDate** | **string** | lastOrderDate | [
|
|
18
|
-
**followUpDate** | **string** | followUpDate | [
|
|
19
|
-
**notes** | **string** | notes | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**status** | **number** | status | [default to undefined]
|
|
11
|
+
**customerId** | **number** | customerId | [default to undefined]
|
|
12
|
+
**companyName** | **string** | companyName | [default to undefined]
|
|
13
|
+
**contactName** | **string** | contactName | [default to undefined]
|
|
14
|
+
**telephone** | **string** | telephone | [default to undefined]
|
|
15
|
+
**email** | **string** | email | [default to undefined]
|
|
16
|
+
**reason** | **string** | reason | [default to undefined]
|
|
17
|
+
**lastOrderDate** | **string** | lastOrderDate | [default to undefined]
|
|
18
|
+
**followUpDate** | **string** | followUpDate | [default to undefined]
|
|
19
|
+
**notes** | **string** | notes | [default to undefined]
|
|
20
20
|
|
|
21
21
|
## Example
|
|
22
22
|
|
|
@@ -6,9 +6,9 @@ Provisioning Group
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**groupName** | **string** | Provisioning Group Name | [
|
|
10
|
-
**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [
|
|
11
|
-
**auth** | **string** | Additional Authentication Secret | [
|
|
9
|
+
**groupName** | **string** | Provisioning Group Name | [default to undefined]
|
|
10
|
+
**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [default to undefined]
|
|
11
|
+
**auth** | **string** | Additional Authentication Secret | [default to undefined]
|
|
12
12
|
**id** | **number** | Provisioning Group ID | [optional] [default to undefined]
|
|
13
13
|
**customerId** | **number** | Owner ID | [optional] [default to undefined]
|
|
14
14
|
|
|
@@ -6,9 +6,9 @@ Provisioning Group Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**groupName** | **string** | Provisioning Group Name | [
|
|
10
|
-
**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [
|
|
11
|
-
**auth** | **string** | Additional Authentication Secret | [
|
|
9
|
+
**groupName** | **string** | Provisioning Group Name | [default to undefined]
|
|
10
|
+
**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [default to undefined]
|
|
11
|
+
**auth** | **string** | Additional Authentication Secret | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@ RMA Reason Request Model
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**reason** | **number** | RMA Reason | [
|
|
9
|
+
**reason** | **number** | RMA Reason | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -6,10 +6,10 @@ Azure Recordings Backup
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**name** | **string** | Storage Account Name | [
|
|
10
|
-
**key** | **string** | Storage Account Key | [
|
|
11
|
-
**connection_string** | **string** | Storage Account Connection String | [
|
|
12
|
-
**sasUrl** | **string** | SAS Url | [
|
|
9
|
+
**name** | **string** | Storage Account Name | [default to undefined]
|
|
10
|
+
**key** | **string** | Storage Account Key | [default to undefined]
|
|
11
|
+
**connection_string** | **string** | Storage Account Connection String | [default to undefined]
|
|
12
|
+
**sasUrl** | **string** | SAS Url | [default to undefined]
|
|
13
13
|
**recordings_path** | **string** | Recordings Path | [optional] [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
package/docs/RemoteStorageDTO.md
CHANGED
|
@@ -6,10 +6,10 @@ Remote Storage
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | AWS ID | [
|
|
10
|
-
**secret** | **string** | AWS Secret | [
|
|
11
|
-
**name** | **string** | AWS Bucket Name | [
|
|
12
|
-
**region** | **string** | AWS Region | [
|
|
9
|
+
**id** | **string** | AWS ID | [default to undefined]
|
|
10
|
+
**secret** | **string** | AWS Secret | [default to undefined]
|
|
11
|
+
**name** | **string** | AWS Bucket Name | [default to undefined]
|
|
12
|
+
**region** | **string** | AWS Region | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/ReportRequestDTO.md
CHANGED
|
@@ -6,7 +6,7 @@ Report Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**report** | **string** | Report | [
|
|
9
|
+
**report** | **string** | Report | [default to undefined]
|
|
10
10
|
**start** | **string** | Start | [optional] [default to undefined]
|
|
11
11
|
**end** | **string** | End | [optional] [default to undefined]
|
|
12
12
|
**month** | **number** | Month | [optional] [default to undefined]
|