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
|
@@ -6,17 +6,17 @@ ShipmentAddressEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**shipmentId** | **number** | shipmentId | [
|
|
11
|
-
**shipName** | **string** | shipName | [
|
|
12
|
-
**shipCompany** | **string** | shipCompany | [
|
|
13
|
-
**shipAddress1** | **string** | shipAddress1 | [
|
|
14
|
-
**shipAddress2** | **string** | shipAddress2 | [
|
|
15
|
-
**shipCity** | **string** | shipCity | [
|
|
16
|
-
**shipStateRegion** | **string** | shipStateRegion | [
|
|
17
|
-
**shipPostalCode** | **string** | shipPostalCode | [
|
|
18
|
-
**shipCountry** | **string** | shipCountry | [
|
|
19
|
-
**shipPhoneNumber** | **string** | shipPhoneNumber | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**shipmentId** | **number** | shipmentId | [default to undefined]
|
|
11
|
+
**shipName** | **string** | shipName | [default to undefined]
|
|
12
|
+
**shipCompany** | **string** | shipCompany | [default to undefined]
|
|
13
|
+
**shipAddress1** | **string** | shipAddress1 | [default to undefined]
|
|
14
|
+
**shipAddress2** | **string** | shipAddress2 | [default to undefined]
|
|
15
|
+
**shipCity** | **string** | shipCity | [default to undefined]
|
|
16
|
+
**shipStateRegion** | **string** | shipStateRegion | [default to undefined]
|
|
17
|
+
**shipPostalCode** | **string** | shipPostalCode | [default to undefined]
|
|
18
|
+
**shipCountry** | **string** | shipCountry | [default to undefined]
|
|
19
|
+
**shipPhoneNumber** | **string** | shipPhoneNumber | [default to undefined]
|
|
20
20
|
|
|
21
21
|
## Example
|
|
22
22
|
|
package/docs/ShipmentDTO.md
CHANGED
|
@@ -12,10 +12,10 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**reference** | **string** | Courier Reference | [optional] [default to undefined]
|
|
13
13
|
**tracking** | **string** | Courier Tracking | [optional] [default to undefined]
|
|
14
14
|
**trackingUrl** | **string** | Courier Tracking URL | [optional] [default to undefined]
|
|
15
|
-
**requestedDate** | **string** | Date Time | [
|
|
16
|
-
**scannedItems** | [**Array<ScannedItemModel>**](ScannedItemModel.md) | Scanned Items | [
|
|
17
|
-
**items** | [**Array<ShipmentItemModel>**](ShipmentItemModel.md) | Items | [
|
|
18
|
-
**address** | [**AddressModel**](AddressModel.md) | | [
|
|
15
|
+
**requestedDate** | **string** | Date Time | [default to undefined]
|
|
16
|
+
**scannedItems** | [**Array<ScannedItemModel>**](ScannedItemModel.md) | Scanned Items | [default to undefined]
|
|
17
|
+
**items** | [**Array<ShipmentItemModel>**](ShipmentItemModel.md) | Items | [default to undefined]
|
|
18
|
+
**address** | [**AddressModel**](AddressModel.md) | | [default to undefined]
|
|
19
19
|
**boxes** | **number** | Boxes Shipped | [optional] [default to undefined]
|
|
20
20
|
|
|
21
21
|
## Example
|
package/docs/ShipmentEntity.md
CHANGED
|
@@ -6,18 +6,18 @@ ShipmentsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**batchId** | **number** | batchId | [
|
|
11
|
-
**courier** | **string** | courier | [
|
|
12
|
-
**courierService** | **string** | courierService | [
|
|
13
|
-
**courierServiceDesc** | **string** | courierServiceDesc | [
|
|
14
|
-
**courierReference** | **string** | courierReference | [
|
|
15
|
-
**courierTracking** | **string** | courierTracking | [
|
|
16
|
-
**courierBoxes** | **number** | courierBoxes | [
|
|
17
|
-
**scannedData** | **string** | mac | [
|
|
18
|
-
**dateShipped** | **string** | date | [
|
|
19
|
-
**requestDate** | **string** | requestDate | [
|
|
20
|
-
**provId** | **number** | provId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**batchId** | **number** | batchId | [default to undefined]
|
|
11
|
+
**courier** | **string** | courier | [default to undefined]
|
|
12
|
+
**courierService** | **string** | courierService | [default to undefined]
|
|
13
|
+
**courierServiceDesc** | **string** | courierServiceDesc | [default to undefined]
|
|
14
|
+
**courierReference** | **string** | courierReference | [default to undefined]
|
|
15
|
+
**courierTracking** | **string** | courierTracking | [default to undefined]
|
|
16
|
+
**courierBoxes** | **number** | courierBoxes | [default to undefined]
|
|
17
|
+
**scannedData** | **string** | mac | [default to undefined]
|
|
18
|
+
**dateShipped** | **string** | date | [default to undefined]
|
|
19
|
+
**requestDate** | **string** | requestDate | [default to undefined]
|
|
20
|
+
**provId** | **number** | provId | [default to undefined]
|
|
21
21
|
|
|
22
22
|
## Example
|
|
23
23
|
|
package/docs/ShipmentItemDTO.md
CHANGED
|
@@ -6,8 +6,8 @@ Shipment Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**itemId** | **number** | Item ID | [
|
|
10
|
-
**quantity** | **number** | Quantity | [
|
|
9
|
+
**itemId** | **number** | Item ID | [default to undefined]
|
|
10
|
+
**quantity** | **number** | Quantity | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,11 +6,11 @@ ShipmentItemsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**shipmentId** | **number** | shipmentId | [
|
|
11
|
-
**batchId** | **number** | batchId | [
|
|
12
|
-
**quantity** | **number** | quantity | [
|
|
13
|
-
**itemId** | **number** | item | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**shipmentId** | **number** | shipmentId | [default to undefined]
|
|
11
|
+
**batchId** | **number** | batchId | [default to undefined]
|
|
12
|
+
**quantity** | **number** | quantity | [default to undefined]
|
|
13
|
+
**itemId** | **number** | item | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,11 +6,11 @@ Shipment Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**shipmentId** | **number** | shipmentId | [
|
|
11
|
-
**batchId** | **number** | batchId | [
|
|
12
|
-
**quantity** | **number** | quantity | [
|
|
13
|
-
**itemId** | **number** | item | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**shipmentId** | **number** | shipmentId | [default to undefined]
|
|
11
|
+
**batchId** | **number** | batchId | [default to undefined]
|
|
12
|
+
**quantity** | **number** | quantity | [default to undefined]
|
|
13
|
+
**itemId** | **number** | item | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/ShipmentModel.md
CHANGED
|
@@ -6,18 +6,18 @@ Shipment
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**batchId** | **number** | batchId | [
|
|
11
|
-
**courier** | **string** | courier | [
|
|
12
|
-
**courierService** | **string** | courierService | [
|
|
13
|
-
**courierServiceDesc** | **string** | courierServiceDesc | [
|
|
14
|
-
**courierReference** | **string** | courierReference | [
|
|
15
|
-
**courierTracking** | **string** | courierTracking | [
|
|
16
|
-
**courierBoxes** | **number** | courierBoxes | [
|
|
17
|
-
**scannedData** | **string** | mac | [
|
|
18
|
-
**dateShipped** | **string** | date | [
|
|
19
|
-
**requestDate** | **string** | requestDate | [
|
|
20
|
-
**provId** | **number** | provId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**batchId** | **number** | batchId | [default to undefined]
|
|
11
|
+
**courier** | **string** | courier | [default to undefined]
|
|
12
|
+
**courierService** | **string** | courierService | [default to undefined]
|
|
13
|
+
**courierServiceDesc** | **string** | courierServiceDesc | [default to undefined]
|
|
14
|
+
**courierReference** | **string** | courierReference | [default to undefined]
|
|
15
|
+
**courierTracking** | **string** | courierTracking | [default to undefined]
|
|
16
|
+
**courierBoxes** | **number** | courierBoxes | [default to undefined]
|
|
17
|
+
**scannedData** | **string** | mac | [default to undefined]
|
|
18
|
+
**dateShipped** | **string** | date | [default to undefined]
|
|
19
|
+
**requestDate** | **string** | requestDate | [default to undefined]
|
|
20
|
+
**provId** | **number** | provId | [default to undefined]
|
|
21
21
|
|
|
22
22
|
## Example
|
|
23
23
|
|
|
@@ -6,12 +6,12 @@ Shipment Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**courier** | **string** | Courier | [
|
|
9
|
+
**courier** | **string** | Courier | [default to undefined]
|
|
10
10
|
**address** | [**AddressModel**](AddressModel.md) | Address | [optional] [default to undefined]
|
|
11
|
-
**scannedLines** | **Array<string>** | Scanned Lines | [
|
|
12
|
-
**service** | **string** | Service | [
|
|
11
|
+
**scannedLines** | **Array<string>** | Scanned Lines | [default to undefined]
|
|
12
|
+
**service** | **string** | Service | [default to undefined]
|
|
13
13
|
**shipDate** | **string** | Ship Date | [optional] [default to undefined]
|
|
14
|
-
**items** | [**Array<ShipmentItemDTO>**](ShipmentItemDTO.md) | Items | [
|
|
14
|
+
**items** | [**Array<ShipmentItemDTO>**](ShipmentItemDTO.md) | Items | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
package/docs/ShippingApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *https://bitbucket.org*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**postGetAdminShippingServices**](#postgetadminshippingservices) | **POST** /admin/shipping/services | Get Shipping Services|
|
|
8
|
+
|[**postGetCollectionDates**](#postgetcollectiondates) | **POST** /shipping/collections/dates | |
|
|
8
9
|
|[**postGetShippingServices**](#postgetshippingservices) | **POST** /shipping/services | Get Shipping Services|
|
|
9
10
|
|
|
10
11
|
# **postGetAdminShippingServices**
|
|
@@ -65,6 +66,61 @@ No authorization required
|
|
|
65
66
|
|
|
66
67
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
67
68
|
|
|
69
|
+
# **postGetCollectionDates**
|
|
70
|
+
> Array<CollectionDateDTO> postGetCollectionDates()
|
|
71
|
+
|
|
72
|
+
Get Collection Dates
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import {
|
|
78
|
+
ShippingApi,
|
|
79
|
+
Configuration,
|
|
80
|
+
CollectionDatesRequestDTO
|
|
81
|
+
} from 'yellowgrid-api-ts';
|
|
82
|
+
|
|
83
|
+
const configuration = new Configuration();
|
|
84
|
+
const apiInstance = new ShippingApi(configuration);
|
|
85
|
+
|
|
86
|
+
let collectionDatesRequestDTO: CollectionDatesRequestDTO; //Collection Dates Request (optional)
|
|
87
|
+
|
|
88
|
+
const { status, data } = await apiInstance.postGetCollectionDates(
|
|
89
|
+
collectionDatesRequestDTO
|
|
90
|
+
);
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Parameters
|
|
94
|
+
|
|
95
|
+
|Name | Type | Description | Notes|
|
|
96
|
+
|------------- | ------------- | ------------- | -------------|
|
|
97
|
+
| **collectionDatesRequestDTO** | **CollectionDatesRequestDTO**| Collection Dates Request | |
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
### Return type
|
|
101
|
+
|
|
102
|
+
**Array<CollectionDateDTO>**
|
|
103
|
+
|
|
104
|
+
### Authorization
|
|
105
|
+
|
|
106
|
+
No authorization required
|
|
107
|
+
|
|
108
|
+
### HTTP request headers
|
|
109
|
+
|
|
110
|
+
- **Content-Type**: application/json
|
|
111
|
+
- **Accept**: application/json
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
### HTTP response details
|
|
115
|
+
| Status code | Description | Response headers |
|
|
116
|
+
|-------------|-------------|------------------|
|
|
117
|
+
|**200** | Collection Dates | - |
|
|
118
|
+
|**400** | Bad Request | - |
|
|
119
|
+
|**401** | Unauthorised | - |
|
|
120
|
+
|**403** | Access Denied | - |
|
|
121
|
+
|
|
122
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
123
|
+
|
|
68
124
|
# **postGetShippingServices**
|
|
69
125
|
> ShippingServicesModel postGetShippingServices()
|
|
70
126
|
|
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**service** | [**ShippingServiceModel**](ShippingServiceModel.md) | | [
|
|
9
|
-
**id** | **string** | ID/Number | [
|
|
10
|
-
**trackingNumber** | **string** | Tracking Number | [
|
|
11
|
-
**parcelIds** | **Array<string>** | Parcels | [
|
|
8
|
+
**service** | [**ShippingServiceModel**](ShippingServiceModel.md) | | [default to undefined]
|
|
9
|
+
**id** | **string** | ID/Number | [default to undefined]
|
|
10
|
+
**trackingNumber** | **string** | Tracking Number | [default to undefined]
|
|
11
|
+
**parcelIds** | **Array<string>** | Parcels | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,9 +6,9 @@ Shipping Information
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**items** | [**Array<BasicItemDTO>**](BasicItemDTO.md) | Items | [
|
|
10
|
-
**postalCode** | **string** | Destination Post Code | [
|
|
11
|
-
**iso** | **string** | Destination ISO | [
|
|
9
|
+
**items** | [**Array<BasicItemDTO>**](BasicItemDTO.md) | Items | [default to undefined]
|
|
10
|
+
**postalCode** | **string** | Destination Post Code | [default to undefined]
|
|
11
|
+
**iso** | **string** | Destination ISO | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**courier** | **string** | Courier | [
|
|
9
|
-
**service** | **string** | Courier Service | [
|
|
10
|
-
**boxes** | **number** | Boxes | [
|
|
8
|
+
**courier** | **string** | Courier | [default to undefined]
|
|
9
|
+
**service** | **string** | Courier Service | [default to undefined]
|
|
10
|
+
**boxes** | **number** | Boxes | [default to undefined]
|
|
11
11
|
**printer** | **number** | Printer | [optional] [default to undefined]
|
|
12
12
|
**shipment** | [**ShipmentRequestDTO**](ShipmentRequestDTO.md) | | [optional] [default to undefined]
|
|
13
13
|
|
|
@@ -6,8 +6,8 @@ Shipping Service
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**courier** | **string** | Courier | [
|
|
10
|
-
**serviceName** | **string** | Service Name | [
|
|
9
|
+
**courier** | **string** | Courier | [default to undefined]
|
|
10
|
+
**serviceName** | **string** | Service Name | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -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
|
|