yellowgrid-api-ts 3.2.276 → 3.2.278
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +37 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +79 -0
- package/api.ts +6448 -2386
- package/common.ts +2 -2
- package/dist/api.d.ts +5989 -3577
- package/dist/api.js +6189 -2600
- package/dist/models/ReasonEnum.d.ts +18 -0
- package/dist/models/ReasonEnum.js +20 -0
- package/dist/models/ResolutionEnum.d.ts +18 -0
- package/dist/models/ResolutionEnum.js +20 -0
- package/dist/models/RmaItemCreditTypeEnum.d.ts +13 -0
- package/dist/models/RmaItemCreditTypeEnum.js +15 -0
- package/dist/models/RmaItemResolutionEnum.d.ts +28 -0
- package/dist/models/RmaItemResolutionEnum.js +30 -0
- package/dist/models/RmaItemStatusEnum.d.ts +18 -0
- package/dist/models/RmaItemStatusEnum.js +20 -0
- package/dist/models/RmaStatusEnum.d.ts +33 -0
- package/dist/models/RmaStatusEnum.js +35 -0
- 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 +10 -10
- package/docs/AccountFinanceDTO.md +10 -10
- package/docs/AccountRequestModel.md +11 -11
- package/docs/AccountSummaryDTO.md +3 -3
- package/docs/AccountsApi.md +48 -0
- package/docs/AccountsResponseModel.md +4 -4
- package/docs/AddressDTO.md +12 -6
- package/docs/AddressModel.md +5 -5
- package/docs/AddressRequestModel.md +4 -4
- package/docs/AdminCustomerRmasModel.md +27 -0
- package/docs/AdminNumberPortDTO.md +7 -7
- package/docs/AdminOrderRequestDTO.md +4 -4
- package/docs/AdminRmaDTO.md +67 -0
- package/docs/AdminRmaItemDTO.md +51 -0
- package/docs/AdminRmaNoteDTO.md +27 -0
- package/docs/AdminRmaSummaryDTO.md +39 -0
- 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/BrandedVideoSummaryDTO.md +47 -0
- package/docs/BrandedVideosApi.md +424 -0
- package/docs/BrandedVideosSummariesModel.md +27 -0
- package/docs/CallBarringModel.md +5 -5
- package/docs/ClientDetailsModel.md +7 -7
- package/docs/ClientModel.md +4 -4
- package/docs/CollectionDateDTO.md +27 -0
- package/docs/CollectionDatesRequestDTO.md +23 -0
- 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 +5 -1
- package/docs/CreditNoteEntity.md +5 -5
- package/docs/CreditNoteItemDTO.md +3 -1
- package/docs/CreditNoteItemEntity.md +7 -5
- package/docs/CreditNoteItemModel.md +7 -5
- 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 +27 -0
- 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 +21 -0
- 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 +21 -0
- package/docs/LinkedOrderEntity.md +2 -2
- package/docs/MFARequiredModel.md +2 -2
- package/docs/MacAddressDTO.md +2 -2
- package/docs/MacAddressRequestModel.md +21 -0
- package/docs/MonthlyUsageModel.md +2 -2
- package/docs/MultiTenantChangeResponseModel.md +4 -4
- package/docs/NameRequestModel.md +21 -0
- package/docs/NavigationModel.md +4 -4
- package/docs/NoteRequestModel.md +21 -0
- 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/OAuth20Api.md +3 -3
- 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/OrdersApi.md +55 -0
- 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 +27 -0
- package/docs/ProductSerialInfoModel.md +3 -3
- package/docs/ProductSummaryDTO.md +2 -2
- package/docs/PromoCodesEntity.md +8 -8
- package/docs/PromoItemModel.md +8 -8
- package/docs/PromoItemsEntity.md +8 -8
- package/docs/PromoModel.md +8 -8
- package/docs/PromoSummariesModel.md +4 -4
- package/docs/PromoSummaryDTO.md +3 -3
- 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/RMAApi.md +1749 -0
- package/docs/ReasonRequestModel.md +21 -0
- package/docs/RecordingBackupAzureModel.md +4 -4
- package/docs/RemoteStorageDTO.md +4 -4
- package/docs/ReportRequestDTO.md +1 -1
- package/docs/ResolutionRequestModel.md +21 -0
- package/docs/ResourceNotReadyException.md +3 -3
- package/docs/RmaCollectionDTO.md +27 -0
- package/docs/RmaCreditItemRequestDTO.md +25 -0
- package/docs/RmaDTO.md +47 -0
- package/docs/RmaItemDTO.md +35 -0
- package/docs/RmaItemRequestDTO.md +25 -0
- package/docs/RmaOrderDTO.md +33 -0
- package/docs/RmaOrderItemDTO.md +37 -0
- package/docs/RmaOrderSummaryDTO.md +25 -0
- package/docs/RmaReplacementOrderItemDTO.md +23 -0
- package/docs/RmaReplacementOrderRequestDTO.md +21 -0
- package/docs/RmaRequestDTO.md +36 -0
- package/docs/RmaReturnDTO.md +31 -0
- package/docs/RmaSummaryDTO.md +31 -0
- package/docs/RmaSummaryItemDTO.md +23 -0
- 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 +21 -0
- 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/ShippingApi.md +56 -0
- 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/ThumbnailDTO.md +25 -0
- 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/VideoRequestEntity.md +51 -0
- package/docs/XeroLogEntity.md +10 -10
- package/git_push.sh +14 -17
- package/models/ReasonEnum.ts +19 -0
- package/models/ResolutionEnum.ts +19 -0
- package/models/RmaItemCreditTypeEnum.ts +14 -0
- package/models/RmaItemResolutionEnum.ts +29 -0
- package/models/RmaItemStatusEnum.ts +19 -0
- package/models/RmaStatusEnum.ts +34 -0
- package/openapitools.json +1 -1
- package/package.json +1 -1
package/docs/StockOrderEntity.md
CHANGED
|
@@ -6,28 +6,28 @@ DistOrderEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**status** | **number** | status | [
|
|
11
|
-
**orderDate** | **string** | orderDate | [
|
|
12
|
-
**supplierId** | **number** | manId | [
|
|
13
|
-
**poNumber** | **string** | poNumber | [
|
|
14
|
-
**exchangeRate** | **number** | exchRate | [
|
|
15
|
-
**total** | **number** | total | [
|
|
16
|
-
**supplierEmailSent** | **string** | manEmailSent | [
|
|
17
|
-
**paid** | **number** | paid | [
|
|
18
|
-
**weight** | **number** | weight | [
|
|
19
|
-
**dimensions** | **number** | dims | [
|
|
20
|
-
**supplierInvoice** | **string** | manInv | [
|
|
21
|
-
**courierId** | **number** | courierId | [
|
|
22
|
-
**deliveryMethod** | **string** | delMethod | [
|
|
23
|
-
**deliveryType** | **string** | delType | [
|
|
24
|
-
**courierQuote** | **string** | courierQuote | [
|
|
25
|
-
**deliveryCost** | **number** | delCost | [
|
|
26
|
-
**deliveryDuty** | **number** | delDuty | [
|
|
27
|
-
**deliveryPaid** | **number** | delPaid | [
|
|
28
|
-
**dutyPaid** | **number** | dutyPaid | [
|
|
29
|
-
**shipmentId** | **string** | delId | [
|
|
30
|
-
**deliveryDate** | **string** | delDate | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**status** | **number** | status | [default to undefined]
|
|
11
|
+
**orderDate** | **string** | orderDate | [default to undefined]
|
|
12
|
+
**supplierId** | **number** | manId | [default to undefined]
|
|
13
|
+
**poNumber** | **string** | poNumber | [default to undefined]
|
|
14
|
+
**exchangeRate** | **number** | exchRate | [default to undefined]
|
|
15
|
+
**total** | **number** | total | [default to undefined]
|
|
16
|
+
**supplierEmailSent** | **string** | manEmailSent | [default to undefined]
|
|
17
|
+
**paid** | **number** | paid | [default to undefined]
|
|
18
|
+
**weight** | **number** | weight | [default to undefined]
|
|
19
|
+
**dimensions** | **number** | dims | [default to undefined]
|
|
20
|
+
**supplierInvoice** | **string** | manInv | [default to undefined]
|
|
21
|
+
**courierId** | **number** | courierId | [default to undefined]
|
|
22
|
+
**deliveryMethod** | **string** | delMethod | [default to undefined]
|
|
23
|
+
**deliveryType** | **string** | delType | [default to undefined]
|
|
24
|
+
**courierQuote** | **string** | courierQuote | [default to undefined]
|
|
25
|
+
**deliveryCost** | **number** | delCost | [default to undefined]
|
|
26
|
+
**deliveryDuty** | **number** | delDuty | [default to undefined]
|
|
27
|
+
**deliveryPaid** | **number** | delPaid | [default to undefined]
|
|
28
|
+
**dutyPaid** | **number** | dutyPaid | [default to undefined]
|
|
29
|
+
**shipmentId** | **string** | delId | [default to undefined]
|
|
30
|
+
**deliveryDate** | **string** | delDate | [default to undefined]
|
|
31
31
|
|
|
32
32
|
## Example
|
|
33
33
|
|
|
@@ -6,13 +6,13 @@ DistItemsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**orderId** | **number** | orderId | [
|
|
11
|
-
**itemId** | **number** | itemId | [
|
|
12
|
-
**note** | **string** | note | [
|
|
13
|
-
**quantity** | **number** | quantity | [
|
|
14
|
-
**price** | **number** | price | [
|
|
15
|
-
**received** | **number** | received | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
11
|
+
**itemId** | **number** | itemId | [default to undefined]
|
|
12
|
+
**note** | **string** | note | [default to undefined]
|
|
13
|
+
**quantity** | **number** | quantity | [default to undefined]
|
|
14
|
+
**price** | **number** | price | [default to undefined]
|
|
15
|
+
**received** | **number** | received | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -6,13 +6,13 @@ Stock Order Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**orderId** | **number** | orderId | [
|
|
11
|
-
**itemId** | **number** | itemId | [
|
|
12
|
-
**note** | **string** | note | [
|
|
13
|
-
**quantity** | **number** | quantity | [
|
|
14
|
-
**price** | **number** | price | [
|
|
15
|
-
**received** | **number** | received | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
11
|
+
**itemId** | **number** | itemId | [default to undefined]
|
|
12
|
+
**note** | **string** | note | [default to undefined]
|
|
13
|
+
**quantity** | **number** | quantity | [default to undefined]
|
|
14
|
+
**price** | **number** | price | [default to undefined]
|
|
15
|
+
**received** | **number** | received | [default to undefined]
|
|
16
16
|
**sku** | **string** | | [optional] [default to undefined]
|
|
17
17
|
**title** | **string** | | [optional] [default to undefined]
|
|
18
18
|
|
|
@@ -6,10 +6,10 @@ Stock Order Item Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [
|
|
10
|
-
**quantity** | **number** | Quantity | [
|
|
11
|
-
**price** | **number** | Price | [
|
|
12
|
-
**note** | **string** | Item Note | [
|
|
9
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
10
|
+
**quantity** | **number** | Quantity | [default to undefined]
|
|
11
|
+
**price** | **number** | Price | [default to undefined]
|
|
12
|
+
**note** | **string** | Item Note | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/StockOrderModel.md
CHANGED
|
@@ -6,21 +6,21 @@ Stock Order
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
10
|
-
**reference** | **string** | Reference | [
|
|
11
|
-
**poNumber** | **string** | Purchase Order Number | [
|
|
12
|
-
**supplierId** | **number** | Supplier ID | [
|
|
13
|
-
**deliveryDate** | **string** | Delivery Due Date | [
|
|
14
|
-
**shipmentId** | **string** | Tracking ID | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**reference** | **string** | Reference | [default to undefined]
|
|
11
|
+
**poNumber** | **string** | Purchase Order Number | [default to undefined]
|
|
12
|
+
**supplierId** | **number** | Supplier ID | [default to undefined]
|
|
13
|
+
**deliveryDate** | **string** | Delivery Due Date | [default to undefined]
|
|
14
|
+
**shipmentId** | **string** | Tracking ID | [default to undefined]
|
|
15
15
|
**deliveryMethod** | **string** | Delivery Method | [optional] [default to undefined]
|
|
16
|
-
**deliveryCost** | **number** | Delivery Cost | [
|
|
17
|
-
**exchangeRate** | **number** | Exchange Rate | [
|
|
18
|
-
**weight** | **number** | Weight | [
|
|
19
|
-
**dimensions** | **number** | dimensions | [
|
|
20
|
-
**paid** | **number** | Status | [
|
|
21
|
-
**totals** | [**OrderTotalModel**](OrderTotalModel.md) | | [
|
|
22
|
-
**items** | [**Array<StockOrderItemModel>**](StockOrderItemModel.md) | items | [
|
|
23
|
-
**deductions** | [**Array<StockOrderDeductionsEntity>**](StockOrderDeductionsEntity.md) | deductions | [
|
|
16
|
+
**deliveryCost** | **number** | Delivery Cost | [default to undefined]
|
|
17
|
+
**exchangeRate** | **number** | Exchange Rate | [default to undefined]
|
|
18
|
+
**weight** | **number** | Weight | [default to undefined]
|
|
19
|
+
**dimensions** | **number** | dimensions | [default to undefined]
|
|
20
|
+
**paid** | **number** | Status | [default to undefined]
|
|
21
|
+
**totals** | [**OrderTotalModel**](OrderTotalModel.md) | | [default to undefined]
|
|
22
|
+
**items** | [**Array<StockOrderItemModel>**](StockOrderItemModel.md) | items | [default to undefined]
|
|
23
|
+
**deductions** | [**Array<StockOrderDeductionsEntity>**](StockOrderDeductionsEntity.md) | deductions | [default to undefined]
|
|
24
24
|
|
|
25
25
|
## Example
|
|
26
26
|
|
|
@@ -6,12 +6,12 @@ DistPricesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**manufacturerId** | **number** | manId | [
|
|
11
|
-
**sku** | **string** | sku | [
|
|
12
|
-
**title** | **string** | title | [
|
|
13
|
-
**price** | **number** | price | [
|
|
14
|
-
**carton** | **number** | carton | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**manufacturerId** | **number** | manId | [default to undefined]
|
|
11
|
+
**sku** | **string** | sku | [default to undefined]
|
|
12
|
+
**title** | **string** | title | [default to undefined]
|
|
13
|
+
**price** | **number** | price | [default to undefined]
|
|
14
|
+
**carton** | **number** | carton | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -6,9 +6,9 @@ Stock Order Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**supplierId** | **number** | Supplier ID | [
|
|
10
|
-
**items** | [**Array<StockOrderItemRequestModel>**](StockOrderItemRequestModel.md) | Items | [
|
|
11
|
-
**deductions** | [**Array<StockOrderDeductionRequestModel>**](StockOrderDeductionRequestModel.md) | Deductions | [
|
|
9
|
+
**supplierId** | **number** | Supplier ID | [default to undefined]
|
|
10
|
+
**items** | [**Array<StockOrderItemRequestModel>**](StockOrderItemRequestModel.md) | Items | [default to undefined]
|
|
11
|
+
**deductions** | [**Array<StockOrderDeductionRequestModel>**](StockOrderDeductionRequestModel.md) | Deductions | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,15 +6,15 @@ DistManufacturerEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**company** | **string** | company | [
|
|
11
|
-
**name** | **string** | name | [
|
|
12
|
-
**address** | **string** | address | [
|
|
13
|
-
**email** | **string** | email | [
|
|
14
|
-
**cur** | **string** | cur | [
|
|
15
|
-
**tariff** | **string** | tariff | [
|
|
16
|
-
**xeroId** | **string** | xeroAccNo | [
|
|
17
|
-
**supplierId** | **number** | supplierId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**company** | **string** | company | [default to undefined]
|
|
11
|
+
**name** | **string** | name | [default to undefined]
|
|
12
|
+
**address** | **string** | address | [default to undefined]
|
|
13
|
+
**email** | **string** | email | [default to undefined]
|
|
14
|
+
**cur** | **string** | cur | [default to undefined]
|
|
15
|
+
**tariff** | **string** | tariff | [default to undefined]
|
|
16
|
+
**xeroId** | **string** | xeroAccNo | [default to undefined]
|
|
17
|
+
**supplierId** | **number** | supplierId | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -6,15 +6,15 @@ Stock Order Supplier
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**company** | **string** | company | [
|
|
11
|
-
**name** | **string** | name | [
|
|
12
|
-
**address** | **string** | address | [
|
|
13
|
-
**email** | **string** | email | [
|
|
14
|
-
**cur** | **string** | cur | [
|
|
15
|
-
**tariff** | **string** | tariff | [
|
|
16
|
-
**xeroId** | **string** | xeroAccNo | [
|
|
17
|
-
**supplierId** | **number** | supplierId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**company** | **string** | company | [default to undefined]
|
|
11
|
+
**name** | **string** | name | [default to undefined]
|
|
12
|
+
**address** | **string** | address | [default to undefined]
|
|
13
|
+
**email** | **string** | email | [default to undefined]
|
|
14
|
+
**cur** | **string** | cur | [default to undefined]
|
|
15
|
+
**tariff** | **string** | tariff | [default to undefined]
|
|
16
|
+
**xeroId** | **string** | xeroAccNo | [default to undefined]
|
|
17
|
+
**supplierId** | **number** | supplierId | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
package/docs/StockOrdersModel.md
CHANGED
|
@@ -6,10 +6,10 @@ Stock Orders
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<StockOrderModel>**](StockOrderModel.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<StockOrderModel>**](StockOrderModel.md) | Results | [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,12 +6,12 @@ Stock Product
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**manufacturerId** | **number** | manId | [
|
|
11
|
-
**sku** | **string** | sku | [
|
|
12
|
-
**title** | **string** | title | [
|
|
13
|
-
**price** | **number** | price | [
|
|
14
|
-
**carton** | **number** | carton | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**manufacturerId** | **number** | manId | [default to undefined]
|
|
11
|
+
**sku** | **string** | sku | [default to undefined]
|
|
12
|
+
**title** | **string** | title | [default to undefined]
|
|
13
|
+
**price** | **number** | price | [default to undefined]
|
|
14
|
+
**carton** | **number** | carton | [default to undefined]
|
|
15
15
|
**manufacturer** | [**StockOrderSupplierModel**](StockOrderSupplierModel.md) | | [optional] [default to undefined]
|
|
16
16
|
**attributeSet** | [**AttributeSetEnum**](AttributeSetEnum.md) | | [optional] [default to undefined]
|
|
17
17
|
**stock** | **number** | Current Quantity | [optional] [default to undefined]
|
|
@@ -6,7 +6,7 @@ Stock Product Price
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**priceList** | [**CustomerPriceListEnum**](CustomerPriceListEnum.md) | | [
|
|
9
|
+
**priceList** | [**CustomerPriceListEnum**](CustomerPriceListEnum.md) | | [default to undefined]
|
|
10
10
|
**price** | **number** | Price (£) | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -6,10 +6,10 @@ Stock Products
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<StockProductSummaryModel>**](StockProductSummaryModel.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<StockProductSummaryModel>**](StockProductSummaryModel.md) | Results | [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,12 +6,12 @@ Stock Product Summary
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**manufacturerId** | **number** | manId | [
|
|
11
|
-
**sku** | **string** | sku | [
|
|
12
|
-
**title** | **string** | title | [
|
|
13
|
-
**price** | **number** | price | [
|
|
14
|
-
**carton** | **number** | carton | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**manufacturerId** | **number** | manId | [default to undefined]
|
|
11
|
+
**sku** | **string** | sku | [default to undefined]
|
|
12
|
+
**title** | **string** | title | [default to undefined]
|
|
13
|
+
**price** | **number** | price | [default to undefined]
|
|
14
|
+
**carton** | **number** | carton | [default to undefined]
|
|
15
15
|
**manufacturer** | [**StockOrderSupplierModel**](StockOrderSupplierModel.md) | | [optional] [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
@@ -6,12 +6,12 @@ Stock Report Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**title** | **string** | Title | [
|
|
10
|
-
**sku** | **string** | SKU | [
|
|
11
|
-
**quantity** | **number** | In Stock | [
|
|
12
|
-
**currency** | **string** | Currency | [
|
|
13
|
-
**basePrice** | **number** | Cost Price | [
|
|
14
|
-
**totalValue** | **number** | Line Total | [
|
|
9
|
+
**title** | **string** | Title | [default to undefined]
|
|
10
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
11
|
+
**quantity** | **number** | In Stock | [default to undefined]
|
|
12
|
+
**currency** | **string** | Currency | [default to undefined]
|
|
13
|
+
**basePrice** | **number** | Cost Price | [default to undefined]
|
|
14
|
+
**totalValue** | **number** | Line Total | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
package/docs/StockReportModel.md
CHANGED
|
@@ -6,11 +6,11 @@ Stock Report
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**products** | [**Array<StockReportItemModel>**](StockReportItemModel.md) | Items | [
|
|
10
|
-
**unitsInStock** | **number** | Units In Stock | [
|
|
11
|
-
**usdStock** | **number** | Value Of USD Stock | [
|
|
12
|
-
**gbpStock** | **number** | Value Of GBP Stock | [
|
|
13
|
-
**totalStockGbp** | **number** | Total value of stock in GBP | [
|
|
9
|
+
**products** | [**Array<StockReportItemModel>**](StockReportItemModel.md) | Items | [default to undefined]
|
|
10
|
+
**unitsInStock** | **number** | Units In Stock | [default to undefined]
|
|
11
|
+
**usdStock** | **number** | Value Of USD Stock | [default to undefined]
|
|
12
|
+
**gbpStock** | **number** | Value Of GBP Stock | [default to undefined]
|
|
13
|
+
**totalStockGbp** | **number** | Total value of stock in GBP | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,14 +6,14 @@ StockTransactionsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**sku** | **string** | sku | [
|
|
11
|
-
**initialStock** | **number** | initialStock | [
|
|
12
|
-
**action** | **string** | action | [
|
|
13
|
-
**quantity** | **number** | quantity | [
|
|
14
|
-
**currentStock** | **number** | currentStock | [
|
|
15
|
-
**timestamp** | **string** | timestamp | [
|
|
16
|
-
**user** | **number** | user | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**sku** | **string** | sku | [default to undefined]
|
|
11
|
+
**initialStock** | **number** | initialStock | [default to undefined]
|
|
12
|
+
**action** | **string** | action | [default to undefined]
|
|
13
|
+
**quantity** | **number** | quantity | [default to undefined]
|
|
14
|
+
**currentStock** | **number** | currentStock | [default to undefined]
|
|
15
|
+
**timestamp** | **string** | timestamp | [default to undefined]
|
|
16
|
+
**user** | **number** | user | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
package/docs/SupplierEntity.md
CHANGED
|
@@ -6,15 +6,15 @@ SuppliersEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**name** | **string** | name | [
|
|
11
|
-
**shortName** | **string** | nameShort | [
|
|
12
|
-
**email** | **string** | email | [
|
|
13
|
-
**phone** | **string** | phone | [
|
|
14
|
-
**defaultCourier** | **string** | defaultCourier | [
|
|
15
|
-
**defaultCarriage** | **number** | defaultCarriage | [
|
|
16
|
-
**accountNumber** | **string** | account | [
|
|
17
|
-
**xeroAccountNumber** | **string** | internalAccount | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**name** | **string** | name | [default to undefined]
|
|
11
|
+
**shortName** | **string** | nameShort | [default to undefined]
|
|
12
|
+
**email** | **string** | email | [default to undefined]
|
|
13
|
+
**phone** | **string** | phone | [default to undefined]
|
|
14
|
+
**defaultCourier** | **string** | defaultCourier | [default to undefined]
|
|
15
|
+
**defaultCarriage** | **number** | defaultCarriage | [default to undefined]
|
|
16
|
+
**accountNumber** | **string** | account | [default to undefined]
|
|
17
|
+
**xeroAccountNumber** | **string** | internalAccount | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -6,14 +6,14 @@ SupplierItemsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**supplierId** | **number** | supplierId | [
|
|
11
|
-
**sku** | **string** | sku | [
|
|
12
|
-
**title** | **string** | title | [
|
|
13
|
-
**itemOptions** | **string** | itemOptions | [
|
|
14
|
-
**itemPrice** | **number** | itemPrice | [
|
|
15
|
-
**itemType** | **number** | itemType | [
|
|
16
|
-
**supplierSku** | **string** | supplierSku | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**supplierId** | **number** | supplierId | [default to undefined]
|
|
11
|
+
**sku** | **string** | sku | [default to undefined]
|
|
12
|
+
**title** | **string** | title | [default to undefined]
|
|
13
|
+
**itemOptions** | **string** | itemOptions | [default to undefined]
|
|
14
|
+
**itemPrice** | **number** | itemPrice | [default to undefined]
|
|
15
|
+
**itemType** | **number** | itemType | [default to undefined]
|
|
16
|
+
**supplierSku** | **string** | supplierSku | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
@@ -6,14 +6,14 @@ Supplier Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**supplierId** | **number** | supplierId | [
|
|
11
|
-
**sku** | **string** | sku | [
|
|
12
|
-
**title** | **string** | title | [
|
|
13
|
-
**itemOptions** | **string** | itemOptions | [
|
|
14
|
-
**itemPrice** | **number** | itemPrice | [
|
|
15
|
-
**itemType** | **number** | itemType | [
|
|
16
|
-
**supplierSku** | **string** | supplierSku | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**supplierId** | **number** | supplierId | [default to undefined]
|
|
11
|
+
**sku** | **string** | sku | [default to undefined]
|
|
12
|
+
**title** | **string** | title | [default to undefined]
|
|
13
|
+
**itemOptions** | **string** | itemOptions | [default to undefined]
|
|
14
|
+
**itemPrice** | **number** | itemPrice | [default to undefined]
|
|
15
|
+
**itemType** | **number** | itemType | [default to undefined]
|
|
16
|
+
**supplierSku** | **string** | supplierSku | [default to undefined]
|
|
17
17
|
**supplier** | [**SupplierModel**](SupplierModel.md) | | [optional] [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
@@ -6,7 +6,7 @@ Supplier Item Results
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Results | [
|
|
9
|
+
**results** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Results | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
package/docs/SupplierModel.md
CHANGED
|
@@ -6,15 +6,15 @@ Supplier
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**name** | **string** | name | [
|
|
11
|
-
**shortName** | **string** | nameShort | [
|
|
12
|
-
**email** | **string** | email | [
|
|
13
|
-
**phone** | **string** | phone | [
|
|
14
|
-
**defaultCourier** | **string** | defaultCourier | [
|
|
15
|
-
**defaultCarriage** | **number** | defaultCarriage | [
|
|
16
|
-
**accountNumber** | **string** | account | [
|
|
17
|
-
**xeroAccountNumber** | **string** | internalAccount | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**name** | **string** | name | [default to undefined]
|
|
11
|
+
**shortName** | **string** | nameShort | [default to undefined]
|
|
12
|
+
**email** | **string** | email | [default to undefined]
|
|
13
|
+
**phone** | **string** | phone | [default to undefined]
|
|
14
|
+
**defaultCourier** | **string** | defaultCourier | [default to undefined]
|
|
15
|
+
**defaultCarriage** | **number** | defaultCarriage | [default to undefined]
|
|
16
|
+
**accountNumber** | **string** | account | [default to undefined]
|
|
17
|
+
**xeroAccountNumber** | **string** | internalAccount | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -6,9 +6,9 @@ Supplier Product
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [
|
|
10
|
-
**description** | **string** | Description | [
|
|
11
|
-
**items** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Items | [
|
|
9
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
10
|
+
**description** | **string** | Description | [default to undefined]
|
|
11
|
+
**items** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Items | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,10 +6,10 @@ Supplier Product Results
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<SupplierProductModel>**](SupplierProductModel.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<SupplierProductModel>**](SupplierProductModel.md) | Results | [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,17 +6,17 @@ Telephony Support Ticket
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Ticket ID | [
|
|
10
|
-
**status** | **string** | Ticket status | [
|
|
11
|
-
**statusId** | **number** | Ticket status ID | [
|
|
12
|
-
**subject** | **string** | Ticket subject | [
|
|
9
|
+
**id** | **number** | Ticket ID | [default to undefined]
|
|
10
|
+
**status** | **string** | Ticket status | [default to undefined]
|
|
11
|
+
**statusId** | **number** | Ticket status ID | [default to undefined]
|
|
12
|
+
**subject** | **string** | Ticket subject | [default to undefined]
|
|
13
13
|
**supportEmail** | **string** | Support email address | [optional] [default to undefined]
|
|
14
|
-
**toEmails** | **Array<string>** | Recipient emails | [
|
|
15
|
-
**description** | **string** | Ticket description (HTML) | [
|
|
16
|
-
**descriptionText** | **string** | Ticket description (plain text) | [
|
|
17
|
-
**createdAt** | **string** | Creation timestamp | [
|
|
18
|
-
**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [
|
|
19
|
-
**conversations** | [**Array<ConversationModel>**](ConversationModel.md) | Conversations | [
|
|
14
|
+
**toEmails** | **Array<string>** | Recipient emails | [default to undefined]
|
|
15
|
+
**description** | **string** | Ticket description (HTML) | [default to undefined]
|
|
16
|
+
**descriptionText** | **string** | Ticket description (plain text) | [default to undefined]
|
|
17
|
+
**createdAt** | **string** | Creation timestamp | [default to undefined]
|
|
18
|
+
**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [default to undefined]
|
|
19
|
+
**conversations** | [**Array<ConversationModel>**](ConversationModel.md) | Conversations | [default to undefined]
|
|
20
20
|
|
|
21
21
|
## Example
|
|
22
22
|
|
package/docs/TableDTO.md
CHANGED
|
@@ -6,9 +6,9 @@ Table
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**title** | **string** | Title | [
|
|
10
|
-
**headers** | [**TableRowDTO**](TableRowDTO.md) | | [
|
|
11
|
-
**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [
|
|
9
|
+
**title** | **string** | Title | [default to undefined]
|
|
10
|
+
**headers** | [**TableRowDTO**](TableRowDTO.md) | | [default to undefined]
|
|
11
|
+
**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/TableDataDTO.md
CHANGED
|
@@ -6,14 +6,14 @@ TableAttribsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**ownerId** | **string** | ownerId | [
|
|
10
|
-
**dbTable** | **string** | table | [
|
|
11
|
-
**orderingField** | **string** | orderingField | [
|
|
12
|
-
**asc** | **number** | asc | [
|
|
13
|
-
**perPage** | **number** | perPage | [
|
|
14
|
-
**currPage** | **number** | currPage | [
|
|
15
|
-
**filter** | **string** | filter | [
|
|
16
|
-
**page** | **number** | page | [
|
|
9
|
+
**ownerId** | **string** | ownerId | [default to undefined]
|
|
10
|
+
**dbTable** | **string** | table | [default to undefined]
|
|
11
|
+
**orderingField** | **string** | orderingField | [default to undefined]
|
|
12
|
+
**asc** | **number** | asc | [default to undefined]
|
|
13
|
+
**perPage** | **number** | perPage | [default to undefined]
|
|
14
|
+
**currPage** | **number** | currPage | [default to undefined]
|
|
15
|
+
**filter** | **string** | filter | [default to undefined]
|
|
16
|
+
**page** | **number** | page | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
package/docs/TableRowDTO.md
CHANGED
|
@@ -6,7 +6,7 @@ Table Row
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**data** | [**Array<TableDataDTO>**](TableDataDTO.md) | Table Data | [
|
|
9
|
+
**data** | [**Array<TableDataDTO>**](TableDataDTO.md) | Table Data | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|