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,16 +6,16 @@ Account Finance DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Account ID | [
|
|
10
|
-
**xeroId** | **string** | Account Xero ID | [
|
|
11
|
-
**accountNumber** | **string** | Account Number | [
|
|
12
|
-
**creditLimit** | **number** | Credit Limit | [
|
|
13
|
-
**balance** | **number** | Balance Used | [
|
|
14
|
-
**overdue** | **number** | Overdue Amount | [
|
|
15
|
-
**onHold** | **boolean** | On Hold | [
|
|
16
|
-
**priceList** | [**CustomerPriceListEnum**](CustomerPriceListEnum.md) | | [
|
|
17
|
-
**sipChannelCost** | **number** | SIP Trunk Channel Cost | [
|
|
18
|
-
**xeroUrl** | **string** | Xero Contact URL | [
|
|
9
|
+
**id** | **number** | Account ID | [default to undefined]
|
|
10
|
+
**xeroId** | **string** | Account Xero ID | [default to undefined]
|
|
11
|
+
**accountNumber** | **string** | Account Number | [default to undefined]
|
|
12
|
+
**creditLimit** | **number** | Credit Limit | [default to undefined]
|
|
13
|
+
**balance** | **number** | Balance Used | [default to undefined]
|
|
14
|
+
**overdue** | **number** | Overdue Amount | [default to undefined]
|
|
15
|
+
**onHold** | **boolean** | On Hold | [default to undefined]
|
|
16
|
+
**priceList** | [**CustomerPriceListEnum**](CustomerPriceListEnum.md) | | [default to undefined]
|
|
17
|
+
**sipChannelCost** | **number** | SIP Trunk Channel Cost | [default to undefined]
|
|
18
|
+
**xeroUrl** | **string** | Xero Contact URL | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -6,23 +6,23 @@ New Account Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**companyName** | **string** | Company Name | [
|
|
10
|
-
**firstName** | **string** | First Name | [
|
|
11
|
-
**lastName** | **string** | Last Name | [
|
|
12
|
-
**telephone** | **string** | Telephone | [
|
|
13
|
-
**addressLine1** | **string** | Address Line 1 | [
|
|
9
|
+
**companyName** | **string** | Company Name | [default to undefined]
|
|
10
|
+
**firstName** | **string** | First Name | [default to undefined]
|
|
11
|
+
**lastName** | **string** | Last Name | [default to undefined]
|
|
12
|
+
**telephone** | **string** | Telephone | [default to undefined]
|
|
13
|
+
**addressLine1** | **string** | Address Line 1 | [default to undefined]
|
|
14
14
|
**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
|
|
15
|
-
**town** | **string** | Town/City | [
|
|
16
|
-
**postCode** | **string** | Post Code | [
|
|
17
|
-
**country** | **string** | Country ISO | [
|
|
15
|
+
**town** | **string** | Town/City | [default to undefined]
|
|
16
|
+
**postCode** | **string** | Post Code | [default to undefined]
|
|
17
|
+
**country** | **string** | Country ISO | [default to undefined]
|
|
18
18
|
**companyNumber** | **string** | Company Registration Number | [optional] [default to undefined]
|
|
19
19
|
**preferredPbx** | **string** | Preferred PBX | [optional] [default to undefined]
|
|
20
20
|
**vatNumber** | **string** | VAT Number | [optional] [default to undefined]
|
|
21
|
-
**email** | **string** | Email Address | [
|
|
21
|
+
**email** | **string** | Email Address | [default to undefined]
|
|
22
22
|
**source** | **string** | Source | [optional] [default to undefined]
|
|
23
23
|
**creditRequired** | **number** | Credit Limit Required | [optional] [default to undefined]
|
|
24
|
-
**marketing** | **boolean** | Marketing Opt-In | [
|
|
25
|
-
**reseller** | **boolean** | Reseller | [
|
|
24
|
+
**marketing** | **boolean** | Marketing Opt-In | [default to false]
|
|
25
|
+
**reseller** | **boolean** | Reseller | [default to false]
|
|
26
26
|
|
|
27
27
|
## Example
|
|
28
28
|
|
|
@@ -6,9 +6,9 @@ Account Summary
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
10
|
-
**company** | **string** | Company | [
|
|
11
|
-
**xeroId** | **string** | Xero ID | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**company** | **string** | Company | [default to undefined]
|
|
11
|
+
**xeroId** | **string** | Xero ID | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,10 +6,10 @@ Accounts
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<CreditAccountEntity>**](CreditAccountEntity.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<CreditAccountEntity>**](CreditAccountEntity.md) | Results | [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/AddressDTO.md
CHANGED
|
@@ -7,12 +7,12 @@ Address
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**company** | **string** | Company | [optional] [default to undefined]
|
|
10
|
-
**addressLine1** | **string** | Address Line 1 | [
|
|
11
|
-
**addressLine2** | **string** | Address Line 2 | [
|
|
12
|
-
**city** | **string** | City | [
|
|
13
|
-
**region** | **string** | Region | [
|
|
14
|
-
**postalCode** | **string** | Postal Code | [
|
|
15
|
-
**iso** | **string** | Country | [
|
|
10
|
+
**addressLine1** | **string** | Address Line 1 | [default to undefined]
|
|
11
|
+
**addressLine2** | **string** | Address Line 2 | [default to undefined]
|
|
12
|
+
**city** | **string** | City | [default to undefined]
|
|
13
|
+
**region** | **string** | Region | [default to undefined]
|
|
14
|
+
**postalCode** | **string** | Postal Code | [default to undefined]
|
|
15
|
+
**iso** | **string** | Country | [default to undefined]
|
|
16
16
|
**phone** | **string** | Telephone | [optional] [default to undefined]
|
|
17
17
|
**name** | **string** | Name | [optional] [default to undefined]
|
|
18
18
|
|
package/docs/AddressModel.md
CHANGED
|
@@ -6,11 +6,11 @@ Order Address
|
|
|
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
|
**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
|
|
15
15
|
**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
|
|
16
16
|
**addressLine3** | **string** | Address Line 3 | [optional] [default to undefined]
|
|
@@ -6,10 +6,10 @@ Address Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**addressLine1** | **string** | Address Line 1 | [
|
|
10
|
-
**addressLine2** | **string** | Address Line 2 | [
|
|
11
|
-
**addressCity** | **string** | City | [
|
|
12
|
-
**addressPostcode** | **string** | Postal Code | [
|
|
9
|
+
**addressLine1** | **string** | Address Line 1 | [default to undefined]
|
|
10
|
+
**addressLine2** | **string** | Address Line 2 | [default to undefined]
|
|
11
|
+
**addressCity** | **string** | City | [default to undefined]
|
|
12
|
+
**addressPostcode** | **string** | Postal Code | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,10 +6,10 @@ Admin Customer RMA List Response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<AdminRmaSummaryDTO>**](AdminRmaSummaryDTO.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<AdminRmaSummaryDTO>**](AdminRmaSummaryDTO.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
|
|
|
@@ -16,13 +16,13 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
|
|
17
17
|
**asap** | **boolean** | Port Date ASAP | [optional] [default to undefined]
|
|
18
18
|
**comment** | **string** | Comment | [optional] [default to undefined]
|
|
19
|
-
**id** | **number** | Number Port ID | [
|
|
20
|
-
**customerId** | **number** | Reseller ID | [
|
|
21
|
-
**customerName** | **string** | Customer Name | [
|
|
22
|
-
**portDate** | **string** | Porting Date | [
|
|
23
|
-
**numberRanges** | [**Array<NumberPortRangeDTO>**](NumberPortRangeDTO.md) | Number Ranges | [
|
|
24
|
-
**status** | **number** | Status | [
|
|
25
|
-
**statusText** | **string** | Status Text | [
|
|
19
|
+
**id** | **number** | Number Port ID | [default to undefined]
|
|
20
|
+
**customerId** | **number** | Reseller ID | [default to undefined]
|
|
21
|
+
**customerName** | **string** | Customer Name | [default to undefined]
|
|
22
|
+
**portDate** | **string** | Porting Date | [default to undefined]
|
|
23
|
+
**numberRanges** | [**Array<NumberPortRangeDTO>**](NumberPortRangeDTO.md) | Number Ranges | [default to undefined]
|
|
24
|
+
**status** | **number** | Status | [default to undefined]
|
|
25
|
+
**statusText** | **string** | Status Text | [default to undefined]
|
|
26
26
|
**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
|
|
27
27
|
**notes** | [**Array<NumberPortNoteDTO>**](NumberPortNoteDTO.md) | Notes | [optional] [default to undefined]
|
|
28
28
|
**cloas** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
|
|
@@ -7,12 +7,12 @@ Admin 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
|
**customerId** | **number** | Customer ID | [optional] [default to undefined]
|
|
17
17
|
**contact** | **string** | Contact | [optional] [default to undefined]
|
|
18
18
|
**ignoreOnHold** | **boolean** | Ignore Customer On Hold | [optional] [default to false]
|
package/docs/AdminRmaDTO.md
CHANGED
|
@@ -6,26 +6,26 @@ Admin RMA
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | RMA ID | [
|
|
10
|
-
**contactName** | **string** | Contact Name | [
|
|
11
|
-
**contactEmail** | **string** | Contact Email | [
|
|
12
|
-
**orderId** | **number** | Associated Order ID | [
|
|
13
|
-
**reason** | **number** | RMA Reason | [
|
|
14
|
-
**faultReport** | **string** | Fault Report | [
|
|
15
|
-
**ticketId** | **number** | Ticket ID | [
|
|
16
|
-
**resolution** | **number** | RMA Resolution | [
|
|
17
|
-
**status** | **number** | RMA Status | [
|
|
18
|
-
**statusText** | **string** | RMA Status Text | [
|
|
19
|
-
**approved** | **boolean** | RMA Approval Status | [
|
|
9
|
+
**id** | **number** | RMA ID | [default to undefined]
|
|
10
|
+
**contactName** | **string** | Contact Name | [default to undefined]
|
|
11
|
+
**contactEmail** | **string** | Contact Email | [default to undefined]
|
|
12
|
+
**orderId** | **number** | Associated Order ID | [default to undefined]
|
|
13
|
+
**reason** | **number** | RMA Reason | [default to undefined]
|
|
14
|
+
**faultReport** | **string** | Fault Report | [default to undefined]
|
|
15
|
+
**ticketId** | **number** | Ticket ID | [default to undefined]
|
|
16
|
+
**resolution** | **number** | RMA Resolution | [default to undefined]
|
|
17
|
+
**status** | **number** | RMA Status | [default to undefined]
|
|
18
|
+
**statusText** | **string** | RMA Status Text | [default to undefined]
|
|
19
|
+
**approved** | **boolean** | RMA Approval Status | [default to undefined]
|
|
20
20
|
**address** | [**AddressDTO**](AddressDTO.md) | RMA Return Address | [optional] [default to undefined]
|
|
21
|
-
**customerId** | **number** | Customer ID | [
|
|
22
|
-
**xeroId** | **string** | Customer Xero ID | [
|
|
23
|
-
**customerName** | **string** | Customer Name | [
|
|
24
|
-
**createdAt** | **string** | Date Time | [
|
|
25
|
-
**items** | [**Array<AdminRmaItemDTO>**](AdminRmaItemDTO.md) | RMA Items | [
|
|
26
|
-
**notes** | [**Array<AdminRmaNoteDTO>**](AdminRmaNoteDTO.md) | RMA Notes | [
|
|
27
|
-
**replacementOrders** | [**Array<OrderSummaryDTO>**](OrderSummaryDTO.md) | Replacement Order | [
|
|
28
|
-
**creditNotes** | [**Array<CreditNoteDTO>**](CreditNoteDTO.md) | Credit Notes | [
|
|
21
|
+
**customerId** | **number** | Customer ID | [default to undefined]
|
|
22
|
+
**xeroId** | **string** | Customer Xero ID | [default to undefined]
|
|
23
|
+
**customerName** | **string** | Customer Name | [default to undefined]
|
|
24
|
+
**createdAt** | **string** | Date Time | [default to undefined]
|
|
25
|
+
**items** | [**Array<AdminRmaItemDTO>**](AdminRmaItemDTO.md) | RMA Items | [default to undefined]
|
|
26
|
+
**notes** | [**Array<AdminRmaNoteDTO>**](AdminRmaNoteDTO.md) | RMA Notes | [default to undefined]
|
|
27
|
+
**replacementOrders** | [**Array<OrderSummaryDTO>**](OrderSummaryDTO.md) | Replacement Order | [default to undefined]
|
|
28
|
+
**creditNotes** | [**Array<CreditNoteDTO>**](CreditNoteDTO.md) | Credit Notes | [default to undefined]
|
|
29
29
|
**collectionTrackingUrl** | **string** | Collection Tracking URL | [optional] [default to undefined]
|
|
30
30
|
**returnTrackingUrl** | **string** | Return Tracking URL | [optional] [default to undefined]
|
|
31
31
|
|
package/docs/AdminRmaItemDTO.md
CHANGED
|
@@ -6,14 +6,14 @@ Admin RMA Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | RMA Item ID | [
|
|
10
|
-
**itemId** | **number** | RMA Order Item ID | [
|
|
11
|
-
**itemName** | **string** | RMA Item Name | [
|
|
9
|
+
**id** | **number** | RMA Item ID | [default to undefined]
|
|
10
|
+
**itemId** | **number** | RMA Order Item ID | [default to undefined]
|
|
11
|
+
**itemName** | **string** | RMA Item Name | [default to undefined]
|
|
12
12
|
**macAddress** | **string** | RMA Item MAC Address | [optional] [default to undefined]
|
|
13
13
|
**serialNumber** | **string** | RMA Item Serial Number | [optional] [default to undefined]
|
|
14
|
-
**received** | **boolean** | RMA Item Received Status | [
|
|
15
|
-
**status** | **number** | RMA Item Status | [
|
|
16
|
-
**statusText** | **string** | RMA Item Status Text | [
|
|
14
|
+
**received** | **boolean** | RMA Item Received Status | [default to undefined]
|
|
15
|
+
**status** | **number** | RMA Item Status | [default to undefined]
|
|
16
|
+
**statusText** | **string** | RMA Item Status Text | [default to undefined]
|
|
17
17
|
**note** | **string** | RMA Item Note | [optional] [default to undefined]
|
|
18
18
|
**resolution** | **number** | RMA Item Resolution | [optional] [default to undefined]
|
|
19
19
|
**replacementSku** | **string** | RMA Item Replacement SKU | [optional] [default to undefined]
|
package/docs/AdminRmaNoteDTO.md
CHANGED
|
@@ -6,10 +6,10 @@ Admin RMA Note
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | RMA Note ID | [
|
|
10
|
-
**note** | **string** | Note Content | [
|
|
11
|
-
**createdBy** | **string** | Note Creator | [
|
|
12
|
-
**createdAt** | **string** | Date Time | [
|
|
9
|
+
**id** | **number** | RMA Note ID | [default to undefined]
|
|
10
|
+
**note** | **string** | Note Content | [default to undefined]
|
|
11
|
+
**createdBy** | **string** | Note Creator | [default to undefined]
|
|
12
|
+
**createdAt** | **string** | Date Time | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,12 +6,12 @@ Admin RMA Summary
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | RMA ID | [
|
|
10
|
-
**orderId** | **number** | Order ID | [
|
|
11
|
-
**orderReference** | **string** | Order Reference | [
|
|
12
|
-
**status** | **number** | RMA Status | [
|
|
13
|
-
**statusText** | **string** | Status Text | [
|
|
14
|
-
**items** | [**Array<RmaSummaryItemDTO>**](RmaSummaryItemDTO.md) | RMA Summary Items | [
|
|
9
|
+
**id** | **number** | RMA ID | [default to undefined]
|
|
10
|
+
**orderId** | **number** | Order ID | [default to undefined]
|
|
11
|
+
**orderReference** | **string** | Order Reference | [default to undefined]
|
|
12
|
+
**status** | **number** | RMA Status | [default to undefined]
|
|
13
|
+
**statusText** | **string** | Status Text | [default to undefined]
|
|
14
|
+
**items** | [**Array<RmaSummaryItemDTO>**](RmaSummaryItemDTO.md) | RMA Summary Items | [default to undefined]
|
|
15
15
|
**customerId** | **number** | RMA Customer ID | [optional] [default to undefined]
|
|
16
16
|
**customerName** | **string** | RMA Customer Name | [optional] [default to undefined]
|
|
17
17
|
**ticketId** | **number** | RMA Ticket ID | [optional] [default to undefined]
|
package/docs/AdminUserModel.md
CHANGED
|
@@ -6,16 +6,16 @@ Admin User
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
10
|
-
**firstName** | **string** | First Name | [
|
|
11
|
-
**lastName** | **string** | Last Name | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**firstName** | **string** | First Name | [default to undefined]
|
|
11
|
+
**lastName** | **string** | Last Name | [default to undefined]
|
|
12
12
|
**avatar** | **string** | Avatar | [optional] [default to undefined]
|
|
13
|
-
**role** | **number** | Role | [
|
|
13
|
+
**role** | **number** | Role | [default to undefined]
|
|
14
14
|
**email** | **string** | Email | [optional] [default to undefined]
|
|
15
15
|
**primaryHex** | **string** | Primary Colour | [optional] [default to undefined]
|
|
16
16
|
**secondaryHex** | **string** | Secondary Colour | [optional] [default to undefined]
|
|
17
17
|
**scopes** | **Array<string>** | Scopes | [optional] [default to undefined]
|
|
18
|
-
**permissions** | **Array<string>** | Groups | [
|
|
18
|
+
**permissions** | **Array<string>** | Groups | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -6,10 +6,10 @@ Agent Hours Graph
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**agentName** | **string** | Agent Name | [
|
|
10
|
-
**months** | [**Array<AgentHoursGraphMonthModel>**](AgentHoursGraphMonthModel.md) | Agent Hours By Month | [
|
|
11
|
-
**agentColour** | **string** | Agent Colour | [
|
|
12
|
-
**annualHours** | **number** | Annual Hours | [
|
|
9
|
+
**agentName** | **string** | Agent Name | [default to undefined]
|
|
10
|
+
**months** | [**Array<AgentHoursGraphMonthModel>**](AgentHoursGraphMonthModel.md) | Agent Hours By Month | [default to undefined]
|
|
11
|
+
**agentColour** | **string** | Agent Colour | [default to undefined]
|
|
12
|
+
**annualHours** | **number** | Annual Hours | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,8 +6,8 @@ Agent Hours Graph Month
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**ticketHours** | **number** | Month Ticket Hours | [
|
|
10
|
-
**timeEntryHours** | **number** | Month Time Entry Hours | [
|
|
9
|
+
**ticketHours** | **number** | Month Ticket Hours | [default to undefined]
|
|
10
|
+
**timeEntryHours** | **number** | Month Time Entry Hours | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/ApiLogEntity.md
CHANGED
|
@@ -6,18 +6,18 @@ API Log
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | ID | [
|
|
10
|
-
**timestamp** | **string** | Timestamp | [
|
|
11
|
-
**method** | **string** | HTTP Method | [
|
|
12
|
-
**uri** | **string** | URI | [
|
|
13
|
-
**client_ip** | **string** | Client IP | [
|
|
14
|
-
**request_headers** | **Array<string>** | Request Headers | [
|
|
15
|
-
**request_body** | **object** | Request Body | [
|
|
16
|
-
**client_id** | **string** | Client ID | [
|
|
17
|
-
**response_code** | **number** | HTTP Response Code | [
|
|
18
|
-
**response_headers** | **Array<string>** | Response Headers | [
|
|
19
|
-
**response_body** | **object** | Response Body | [
|
|
20
|
-
**http_origin** | **string** | HTTP Origin | [
|
|
9
|
+
**id** | **string** | ID | [default to undefined]
|
|
10
|
+
**timestamp** | **string** | Timestamp | [default to undefined]
|
|
11
|
+
**method** | **string** | HTTP Method | [default to undefined]
|
|
12
|
+
**uri** | **string** | URI | [default to undefined]
|
|
13
|
+
**client_ip** | **string** | Client IP | [default to undefined]
|
|
14
|
+
**request_headers** | **Array<string>** | Request Headers | [default to undefined]
|
|
15
|
+
**request_body** | **object** | Request Body | [default to undefined]
|
|
16
|
+
**client_id** | **string** | Client ID | [default to undefined]
|
|
17
|
+
**response_code** | **number** | HTTP Response Code | [default to undefined]
|
|
18
|
+
**response_headers** | **Array<string>** | Response Headers | [default to undefined]
|
|
19
|
+
**response_body** | **object** | Response Body | [default to undefined]
|
|
20
|
+
**http_origin** | **string** | HTTP Origin | [default to undefined]
|
|
21
21
|
|
|
22
22
|
## Example
|
|
23
23
|
|
package/docs/AreaCodeModel.md
CHANGED
|
@@ -6,8 +6,8 @@ UK Area Code
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | Area Code | [
|
|
10
|
-
**name** | **string** | Location | [
|
|
9
|
+
**code** | **string** | Area Code | [default to undefined]
|
|
10
|
+
**name** | **string** | Location | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/AttachmentModel.md
CHANGED
|
@@ -6,11 +6,11 @@ Ticket Attachment
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Attachment ID | [
|
|
10
|
-
**contentType** | **string** | Content Type | [
|
|
11
|
-
**size** | **string** | Size | [
|
|
12
|
-
**fileName** | **string** | File Name | [
|
|
13
|
-
**attachmentUrl** | **string** | Attachment URL | [
|
|
9
|
+
**id** | **number** | Attachment ID | [default to undefined]
|
|
10
|
+
**contentType** | **string** | Content Type | [default to undefined]
|
|
11
|
+
**size** | **string** | Size | [default to undefined]
|
|
12
|
+
**fileName** | **string** | File Name | [default to undefined]
|
|
13
|
+
**attachmentUrl** | **string** | Attachment URL | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/AttributeSetEnum.md
CHANGED
|
@@ -6,8 +6,8 @@ Attribute Set
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Attribute Set ID | [
|
|
10
|
-
**name** | **string** | Attribute Set Name | [
|
|
9
|
+
**id** | **number** | Attribute Set ID | [default to undefined]
|
|
10
|
+
**name** | **string** | Attribute Set Name | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/AuditLogEntity.md
CHANGED
|
@@ -6,15 +6,15 @@ AuditLogEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**action** | **string** | action | [
|
|
11
|
-
**type** | **string** | type | [
|
|
12
|
-
**identifier** | **string** | identifier | [
|
|
13
|
-
**user** | **string** | user | [
|
|
14
|
-
**timestamp** | **string** | timestamp | [
|
|
15
|
-
**beforeData** | **string** | beforeData | [
|
|
16
|
-
**afterData** | **string** | afterData | [
|
|
17
|
-
**description** | **string** | description | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**action** | **string** | action | [default to undefined]
|
|
11
|
+
**type** | **string** | type | [default to undefined]
|
|
12
|
+
**identifier** | **string** | identifier | [default to undefined]
|
|
13
|
+
**user** | **string** | user | [default to undefined]
|
|
14
|
+
**timestamp** | **string** | timestamp | [default to undefined]
|
|
15
|
+
**beforeData** | **string** | beforeData | [default to undefined]
|
|
16
|
+
**afterData** | **string** | afterData | [default to undefined]
|
|
17
|
+
**description** | **string** | description | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -6,7 +6,7 @@ OAuth Auth Code Response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | Auth Code | [
|
|
9
|
+
**code** | **string** | Auth Code | [default to undefined]
|
|
10
10
|
**state** | **string** | State | [optional] [default to undefined]
|
|
11
11
|
**redirect_uri** | **string** | Redirect URI | [optional] [default to undefined]
|
|
12
12
|
|
package/docs/AxisDataDTO.md
CHANGED
|
@@ -6,7 +6,7 @@ Graph Axis Data
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**type** | **string** | Type | [
|
|
9
|
+
**type** | **string** | Type | [default to undefined]
|
|
10
10
|
**data** | **Array<string>** | Data | [optional] [default to undefined]
|
|
11
11
|
**name** | **string** | Name | [optional] [default to undefined]
|
|
12
12
|
|
package/docs/BasicItemDTO.md
CHANGED
|
@@ -6,8 +6,8 @@ Basic Order Item
|
|
|
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
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/BasicProductDTO.md
CHANGED
|
@@ -6,8 +6,8 @@ Basic Product
|
|
|
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
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/BatchDTO.md
CHANGED
|
@@ -6,23 +6,23 @@ Batch DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**orderId** | **number** | orderId | [
|
|
11
|
-
**supplierId** | **number** | supplierId | [
|
|
12
|
-
**poNumber** | **string** | poNumber | [
|
|
13
|
-
**carriage** | **number** | carriage | [
|
|
14
|
-
**courier** | **string** | courier | [
|
|
15
|
-
**courierService** | **string** | courierService | [
|
|
16
|
-
**courierReference** | **string** | courierReference | [
|
|
17
|
-
**courierUnique** | **string** | courierUnique | [
|
|
18
|
-
**notes** | **string** | notes | [
|
|
19
|
-
**ordered** | **number** | ordered | [
|
|
20
|
-
**carriagePaid** | **number** | carriagePaid | [
|
|
21
|
-
**carriageRefunded** | **number** | carriageRefunded | [
|
|
22
|
-
**carriageRefundedDue** | **number** | carriageRefundedDue | [
|
|
23
|
-
**netdespatchLabel** | **string** | netdespatchLabel | [
|
|
24
|
-
**courierBoxes** | **number** | courierBoxes | [
|
|
25
|
-
**mac** | **string** | mac | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
11
|
+
**supplierId** | **number** | supplierId | [default to undefined]
|
|
12
|
+
**poNumber** | **string** | poNumber | [default to undefined]
|
|
13
|
+
**carriage** | **number** | carriage | [default to undefined]
|
|
14
|
+
**courier** | **string** | courier | [default to undefined]
|
|
15
|
+
**courierService** | **string** | courierService | [default to undefined]
|
|
16
|
+
**courierReference** | **string** | courierReference | [default to undefined]
|
|
17
|
+
**courierUnique** | **string** | courierUnique | [default to undefined]
|
|
18
|
+
**notes** | **string** | notes | [default to undefined]
|
|
19
|
+
**ordered** | **number** | ordered | [default to undefined]
|
|
20
|
+
**carriagePaid** | **number** | carriagePaid | [default to undefined]
|
|
21
|
+
**carriageRefunded** | **number** | carriageRefunded | [default to undefined]
|
|
22
|
+
**carriageRefundedDue** | **number** | carriageRefundedDue | [default to undefined]
|
|
23
|
+
**netdespatchLabel** | **string** | netdespatchLabel | [default to undefined]
|
|
24
|
+
**courierBoxes** | **number** | courierBoxes | [default to undefined]
|
|
25
|
+
**mac** | **string** | mac | [default to undefined]
|
|
26
26
|
**shipments** | [**Array<ShipmentDTO>**](ShipmentDTO.md) | Shipments | [optional] [default to undefined]
|
|
27
27
|
**items** | [**Array<OrderedItemModel>**](OrderedItemModel.md) | Items | [optional] [default to undefined]
|
|
28
28
|
**supplier** | [**SupplierModel**](SupplierModel.md) | | [optional] [default to undefined]
|
package/docs/BatchEntity.md
CHANGED
|
@@ -6,23 +6,23 @@ BatchesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**orderId** | **number** | orderId | [
|
|
11
|
-
**supplierId** | **number** | supplierId | [
|
|
12
|
-
**poNumber** | **string** | poNumber | [
|
|
13
|
-
**carriage** | **number** | carriage | [
|
|
14
|
-
**courier** | **string** | courier | [
|
|
15
|
-
**courierService** | **string** | courierService | [
|
|
16
|
-
**courierReference** | **string** | courierReference | [
|
|
17
|
-
**courierUnique** | **string** | courierUnique | [
|
|
18
|
-
**notes** | **string** | notes | [
|
|
19
|
-
**ordered** | **number** | ordered | [
|
|
20
|
-
**carriagePaid** | **number** | carriagePaid | [
|
|
21
|
-
**carriageRefunded** | **number** | carriageRefunded | [
|
|
22
|
-
**carriageRefundedDue** | **number** | carriageRefundedDue | [
|
|
23
|
-
**netdespatchLabel** | **string** | netdespatchLabel | [
|
|
24
|
-
**courierBoxes** | **number** | courierBoxes | [
|
|
25
|
-
**mac** | **string** | mac | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
11
|
+
**supplierId** | **number** | supplierId | [default to undefined]
|
|
12
|
+
**poNumber** | **string** | poNumber | [default to undefined]
|
|
13
|
+
**carriage** | **number** | carriage | [default to undefined]
|
|
14
|
+
**courier** | **string** | courier | [default to undefined]
|
|
15
|
+
**courierService** | **string** | courierService | [default to undefined]
|
|
16
|
+
**courierReference** | **string** | courierReference | [default to undefined]
|
|
17
|
+
**courierUnique** | **string** | courierUnique | [default to undefined]
|
|
18
|
+
**notes** | **string** | notes | [default to undefined]
|
|
19
|
+
**ordered** | **number** | ordered | [default to undefined]
|
|
20
|
+
**carriagePaid** | **number** | carriagePaid | [default to undefined]
|
|
21
|
+
**carriageRefunded** | **number** | carriageRefunded | [default to undefined]
|
|
22
|
+
**carriageRefundedDue** | **number** | carriageRefundedDue | [default to undefined]
|
|
23
|
+
**netdespatchLabel** | **string** | netdespatchLabel | [default to undefined]
|
|
24
|
+
**courierBoxes** | **number** | courierBoxes | [default to undefined]
|
|
25
|
+
**mac** | **string** | mac | [default to undefined]
|
|
26
26
|
|
|
27
27
|
## Example
|
|
28
28
|
|
package/docs/CallBarringModel.md
CHANGED
|
@@ -6,11 +6,11 @@ Call Barring
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**blockPremiumCalls** | **boolean** | Block Premium Calls | [
|
|
10
|
-
**blockMobileCalls** | **boolean** | Block Mobile Calls | [
|
|
11
|
-
**blockInternationalCalls** | **boolean** | Block International Calls | [
|
|
12
|
-
**block084Calls** | **boolean** | Block 084 Calls | [
|
|
13
|
-
**block087Calls** | **boolean** | Block 087 Calls | [
|
|
9
|
+
**blockPremiumCalls** | **boolean** | Block Premium Calls | [default to true]
|
|
10
|
+
**blockMobileCalls** | **boolean** | Block Mobile Calls | [default to false]
|
|
11
|
+
**blockInternationalCalls** | **boolean** | Block International Calls | [default to false]
|
|
12
|
+
**block084Calls** | **boolean** | Block 084 Calls | [default to false]
|
|
13
|
+
**block087Calls** | **boolean** | Block 087 Calls | [default to false]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|