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,10 +6,10 @@ Shipping Service
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**courier** | **string** | Courier | [
|
|
10
|
-
**code** | **string** | Code | [
|
|
11
|
-
**name** | **string** | Name | [
|
|
12
|
-
**description** | **string** | Description | [
|
|
9
|
+
**courier** | **string** | Courier | [default to undefined]
|
|
10
|
+
**code** | **string** | Code | [default to undefined]
|
|
11
|
+
**name** | **string** | Name | [default to undefined]
|
|
12
|
+
**description** | **string** | Description | [default to undefined]
|
|
13
13
|
**label** | **string** | Label | [optional] [default to undefined]
|
|
14
14
|
**price** | **number** | Price | [optional] [default to undefined]
|
|
15
15
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**services** | [**Array<ShippingServiceModel>**](ShippingServiceModel.md) | Services | [
|
|
8
|
+
**services** | [**Array<ShippingServiceModel>**](ShippingServiceModel.md) | Services | [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -6,11 +6,11 @@ Change Response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**changeId** | **string** | ID | [
|
|
10
|
-
**trunk** | [**SipTrunkEntity**](SipTrunkEntity.md) | | [
|
|
11
|
-
**type** | **string** | Type | [
|
|
12
|
-
**progress** | **number** | Progress | [
|
|
13
|
-
**provider** | **number** | Service Provider | [
|
|
9
|
+
**changeId** | **string** | ID | [default to undefined]
|
|
10
|
+
**trunk** | [**SipTrunkEntity**](SipTrunkEntity.md) | | [default to undefined]
|
|
11
|
+
**type** | **string** | Type | [default to undefined]
|
|
12
|
+
**progress** | **number** | Progress | [default to undefined]
|
|
13
|
+
**provider** | **number** | Service Provider | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,12 +6,12 @@ SIP Trunk Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**customer** | [**CustomerInformationModel**](CustomerInformationModel.md) | | [
|
|
10
|
-
**pbxIpAddress** | **string** | PBX IP Address | [
|
|
11
|
-
**channelCount** | **number** | Number of SIP channels | [
|
|
12
|
-
**callBarring** | [**CallBarringModel**](CallBarringModel.md) | | [
|
|
13
|
-
**fraudManagement** | [**FraudManagementModel**](FraudManagementModel.md) | | [
|
|
14
|
-
**ddiRanges** | [**DdiRangesRequestModel**](DdiRangesRequestModel.md) | | [
|
|
9
|
+
**customer** | [**CustomerInformationModel**](CustomerInformationModel.md) | | [default to undefined]
|
|
10
|
+
**pbxIpAddress** | **string** | PBX IP Address | [default to '0.0.0.0']
|
|
11
|
+
**channelCount** | **number** | Number of SIP channels | [default to 2]
|
|
12
|
+
**callBarring** | [**CallBarringModel**](CallBarringModel.md) | | [default to undefined]
|
|
13
|
+
**fraudManagement** | [**FraudManagementModel**](FraudManagementModel.md) | | [default to undefined]
|
|
14
|
+
**ddiRanges** | [**DdiRangesRequestModel**](DdiRangesRequestModel.md) | | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
package/docs/SipTrunkEntity.md
CHANGED
|
@@ -6,18 +6,18 @@ SIP Trunk
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | SIP Trunk ID | [
|
|
10
|
-
**ownerId** | **number** | Owner ID | [
|
|
11
|
-
**serviceId** | **number** | Service ID | [
|
|
12
|
-
**companyName** | **string** | Company Name | [
|
|
13
|
-
**endpointId** | **string** | Provider Endpoint ID | [
|
|
14
|
-
**channelCount** | **number** | Number of SIP channels | [
|
|
15
|
-
**pbxIpAddress** | **string** | PBX IP Address | [
|
|
16
|
-
**sbcName** | **string** | SBC Name | [
|
|
17
|
-
**registrarIpAddress** | **string** | SIP Server IP Address | [
|
|
18
|
-
**mainTrunkNumber** | **string** | Main Trunk Number | [
|
|
19
|
-
**complete** | **boolean** | Setup Complete | [
|
|
20
|
-
**owner** | **string** | Owner | [
|
|
9
|
+
**id** | **number** | SIP Trunk ID | [default to undefined]
|
|
10
|
+
**ownerId** | **number** | Owner ID | [default to undefined]
|
|
11
|
+
**serviceId** | **number** | Service ID | [default to undefined]
|
|
12
|
+
**companyName** | **string** | Company Name | [default to undefined]
|
|
13
|
+
**endpointId** | **string** | Provider Endpoint ID | [default to undefined]
|
|
14
|
+
**channelCount** | **number** | Number of SIP channels | [default to undefined]
|
|
15
|
+
**pbxIpAddress** | **string** | PBX IP Address | [default to undefined]
|
|
16
|
+
**sbcName** | **string** | SBC Name | [default to undefined]
|
|
17
|
+
**registrarIpAddress** | **string** | SIP Server IP Address | [default to undefined]
|
|
18
|
+
**mainTrunkNumber** | **string** | Main Trunk Number | [default to undefined]
|
|
19
|
+
**complete** | **boolean** | Setup Complete | [default to undefined]
|
|
20
|
+
**owner** | **string** | Owner | [default to undefined]
|
|
21
21
|
|
|
22
22
|
## Example
|
|
23
23
|
|
|
@@ -6,10 +6,10 @@ SIP Trunks
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<SipTrunkEntity>**](SipTrunkEntity.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<SipTrunkEntity>**](SipTrunkEntity.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/SmsAccountDTO.md
CHANGED
|
@@ -6,12 +6,12 @@ SMS Account
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sendUrl** | **string** | Send URL | [
|
|
10
|
-
**webhookUrl** | **string** | Webhook URL | [
|
|
11
|
-
**apiKey** | **string** | API Key | [
|
|
12
|
-
**numbers** | [**Array<SmsNumbersEntity>**](SmsNumbersEntity.md) | Numbers | [
|
|
13
|
-
**name** | **string** | Name | [
|
|
14
|
-
**whitelist** | [**Array<SmsWhitelistEntity>**](SmsWhitelistEntity.md) | Sender Whitelist | [
|
|
9
|
+
**sendUrl** | **string** | Send URL | [default to undefined]
|
|
10
|
+
**webhookUrl** | **string** | Webhook URL | [default to undefined]
|
|
11
|
+
**apiKey** | **string** | API Key | [default to undefined]
|
|
12
|
+
**numbers** | [**Array<SmsNumbersEntity>**](SmsNumbersEntity.md) | Numbers | [default to undefined]
|
|
13
|
+
**name** | **string** | Name | [default to undefined]
|
|
14
|
+
**whitelist** | [**Array<SmsWhitelistEntity>**](SmsWhitelistEntity.md) | Sender Whitelist | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
package/docs/SmsAccountEntity.md
CHANGED
|
@@ -6,13 +6,13 @@ SmsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | id | [
|
|
10
|
-
**provider** | **string** | provider | [
|
|
11
|
-
**creation** | **string** | creation | [
|
|
12
|
-
**customerId** | **number** | customerId | [
|
|
13
|
-
**webhookUrl** | **string** | webhookUrl | [
|
|
9
|
+
**id** | **string** | id | [default to undefined]
|
|
10
|
+
**provider** | **string** | provider | [default to undefined]
|
|
11
|
+
**creation** | **string** | creation | [default to undefined]
|
|
12
|
+
**customerId** | **number** | customerId | [default to undefined]
|
|
13
|
+
**webhookUrl** | **string** | webhookUrl | [default to undefined]
|
|
14
14
|
**trunkId** | **number** | trunkId | [optional] [default to undefined]
|
|
15
|
-
**name** | **string** | name | [
|
|
15
|
+
**name** | **string** | name | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -6,11 +6,11 @@ SMS Account Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**provider** | **number** | SMS Provider | [
|
|
10
|
-
**name** | **string** | Customer Name | [
|
|
11
|
-
**webhookUrl** | **string** | SMS Webhook | [
|
|
12
|
-
**iso** | **string** | Number Country | [
|
|
13
|
-
**type** | **string** | Number Type | [
|
|
9
|
+
**provider** | **number** | SMS Provider | [default to undefined]
|
|
10
|
+
**name** | **string** | Customer Name | [default to undefined]
|
|
11
|
+
**webhookUrl** | **string** | SMS Webhook | [default to undefined]
|
|
12
|
+
**iso** | **string** | Number Country | [default to undefined]
|
|
13
|
+
**type** | **string** | Number Type | [default to TypeEnum_Mobile]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/SmsDataModel.md
CHANGED
|
@@ -6,7 +6,7 @@ SMS Data Model
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**data** | [**SmsResponseModel**](SmsResponseModel.md) | | [
|
|
9
|
+
**data** | [**SmsResponseModel**](SmsResponseModel.md) | | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
package/docs/SmsMessageModel.md
CHANGED
|
@@ -6,9 +6,9 @@ SMS Message
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**from** | **string** | From Phone Number | [
|
|
10
|
-
**to** | **string** | To Phone Number | [
|
|
11
|
-
**text** | **string** | SMS Message | [
|
|
9
|
+
**from** | **string** | From Phone Number | [default to undefined]
|
|
10
|
+
**to** | **string** | To Phone Number | [default to undefined]
|
|
11
|
+
**text** | **string** | SMS Message | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/SmsNumbersEntity.md
CHANGED
|
@@ -6,8 +6,8 @@ SmsNumbersEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**smsId** | **string** | smsId | [
|
|
10
|
-
**number** | **string** | number | [
|
|
9
|
+
**smsId** | **string** | smsId | [default to undefined]
|
|
10
|
+
**number** | **string** | number | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/SmsPayloadModel.md
CHANGED
|
@@ -6,9 +6,9 @@ SMS Payload
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**to** | [**SmsPhoneNumberModel**](SmsPhoneNumberModel.md) | | [
|
|
10
|
-
**from** | [**SmsPhoneNumberModel**](SmsPhoneNumberModel.md) | | [
|
|
11
|
-
**id** | **string** | Message ID | [
|
|
9
|
+
**to** | [**SmsPhoneNumberModel**](SmsPhoneNumberModel.md) | | [default to undefined]
|
|
10
|
+
**from** | [**SmsPhoneNumberModel**](SmsPhoneNumberModel.md) | | [default to undefined]
|
|
11
|
+
**id** | **string** | Message ID | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@ SMS Phone Number
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**phone_number** | **string** | Phone Number | [
|
|
9
|
+
**phone_number** | **string** | Phone Number | [default to undefined]
|
|
10
10
|
**status** | **string** | status | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
package/docs/SmsResponseModel.md
CHANGED
|
@@ -6,9 +6,9 @@ SMS Response Model
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**to** | [**SmsPhoneNumberModel**](SmsPhoneNumberModel.md) | | [
|
|
10
|
-
**from** | [**SmsPhoneNumberModel**](SmsPhoneNumberModel.md) | | [
|
|
11
|
-
**id** | **string** | Message Id | [
|
|
9
|
+
**to** | [**SmsPhoneNumberModel**](SmsPhoneNumberModel.md) | | [default to undefined]
|
|
10
|
+
**from** | [**SmsPhoneNumberModel**](SmsPhoneNumberModel.md) | | [default to undefined]
|
|
11
|
+
**id** | **string** | Message Id | [default to undefined]
|
|
12
12
|
**event_type** | **string** | Event Type | [optional] [default to undefined]
|
|
13
13
|
**payload** | [**SmsPayloadModel**](SmsPayloadModel.md) | | [optional] [default to undefined]
|
|
14
14
|
|
|
@@ -6,8 +6,8 @@ SmsWhitelistEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**smsId** | **string** | smsId | [
|
|
10
|
-
**fqdn** | **string** | fqdn | [
|
|
9
|
+
**smsId** | **string** | smsId | [default to undefined]
|
|
10
|
+
**fqdn** | **string** | fqdn | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,10 +6,10 @@ DistCourierEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**company** | **string** | company | [
|
|
11
|
-
**name** | **string** | name | [
|
|
12
|
-
**email** | **string** | email | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**company** | **string** | company | [default to undefined]
|
|
11
|
+
**name** | **string** | name | [default to undefined]
|
|
12
|
+
**email** | **string** | email | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,10 +6,10 @@ Stock Order Deduction
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**orderId** | **number** | orderId | [
|
|
11
|
-
**amount** | **number** | amount | [
|
|
12
|
-
**reason** | **string** | reason | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
11
|
+
**amount** | **number** | amount | [default to undefined]
|
|
12
|
+
**reason** | **string** | reason | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,8 +6,8 @@ Stock Order Deduction Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**amount** | **number** | Amount | [
|
|
10
|
-
**reason** | **string** | Reason | [
|
|
9
|
+
**amount** | **number** | Amount | [default to undefined]
|
|
10
|
+
**reason** | **string** | Reason | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,10 +6,10 @@ DistDeductionsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**orderId** | **number** | orderId | [
|
|
11
|
-
**amount** | **number** | amount | [
|
|
12
|
-
**reason** | **string** | reason | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
11
|
+
**amount** | **number** | amount | [default to undefined]
|
|
12
|
+
**reason** | **string** | reason | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
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
|
|