@flowio/types 11.24.94 → 11.24.95

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/src/api.ts CHANGED
@@ -2913,6 +2913,8 @@ declare namespace io.flow.v0.enums {
2913
2913
  | 'notification_deleted_v2'
2914
2914
  | 'manifested_label_upserted'
2915
2915
  | 'manifested_label_deleted'
2916
+ | 'label_processing_modification_upserted'
2917
+ | 'label_processing_modification_deleted'
2916
2918
  | 'local_item_upserted'
2917
2919
  | 'local_item_deleted'
2918
2920
  | 'merchant_application_upserted'
@@ -3560,9 +3562,10 @@ declare namespace io.flow.v0.enums {
3560
3562
  | 'shipping_label_service'
3561
3563
  | 'shipping_label_revenue_share'
3562
3564
  | 'trueup'
3565
+ | 'trueup_base'
3566
+ | 'trueup_surcharge'
3563
3567
  | 'carrier_charge'
3564
3568
  | 'carrier_charge_revenue_share'
3565
- | 'carrier_fee'
3566
3569
  | 'platform_fee'
3567
3570
  | 'tax'
3568
3571
  | 'duty'
@@ -3573,8 +3576,9 @@ declare namespace io.flow.v0.enums {
3573
3576
  | 'channel_billed'
3574
3577
  | 'order_service'
3575
3578
  | 'virtual_card_capture'
3576
- | 'virtual_card_refund';
3577
- type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
3579
+ | 'virtual_card_refund'
3580
+ | 'failed_payout';
3581
+ type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl' | 'ups';
3578
3582
  type TrueupSurchargeType =
3579
3583
  | 'fuel'
3580
3584
  | 'remote_area'
@@ -3586,7 +3590,13 @@ declare namespace io.flow.v0.enums {
3586
3590
  | 'security'
3587
3591
  | 'eei_filing'
3588
3592
  | 'fixed_ddp'
3589
- | 'fixed_currency_conversion';
3593
+ | 'fixed_currency_conversion'
3594
+ | 'prohibited_item'
3595
+ | 'undeliverable_shipment'
3596
+ | 'signature_required'
3597
+ | 'direct_delivery'
3598
+ | 'saturday_stop'
3599
+ | 'residential_extended_area_pickup';
3590
3600
  type UnitOfLength = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'meter';
3591
3601
  type UnitOfMeasurement =
3592
3602
  | 'millimeter'
@@ -8111,6 +8121,29 @@ declare namespace io.flow.v0.models {
8111
8121
  readonly number: string;
8112
8122
  }
8113
8123
 
8124
+ interface LabelProcessingModification {
8125
+ readonly id: string;
8126
+ readonly modifications: string[];
8127
+ readonly destination: io.flow.v0.models.ShippingAddress;
8128
+ readonly destination_provided_to_carrier?: io.flow.v0.models.ShippingAddress;
8129
+ }
8130
+
8131
+ interface LabelProcessingModificationDeleted {
8132
+ readonly discriminator: 'label_processing_modification_deleted';
8133
+ readonly event_id: string;
8134
+ readonly timestamp: string;
8135
+ readonly organization: string;
8136
+ readonly id: string;
8137
+ }
8138
+
8139
+ interface LabelProcessingModificationUpserted {
8140
+ readonly discriminator: 'label_processing_modification_upserted';
8141
+ readonly event_id: string;
8142
+ readonly timestamp: string;
8143
+ readonly organization: string;
8144
+ readonly label_processing_modification: io.flow.v0.models.LabelProcessingModification;
8145
+ }
8146
+
8114
8147
  interface LabelReference {
8115
8148
  readonly id: string;
8116
8149
  }
@@ -13498,21 +13531,11 @@ declare namespace io.flow.v0.models {
13498
13531
  readonly outbound?: io.flow.v0.models.TransactionMetadataOutboundTransaction;
13499
13532
  }
13500
13533
 
13501
- interface TransactionMetadataCarrierFee {
13502
- readonly discriminator: 'carrier_fee';
13503
- readonly outbound: io.flow.v0.models.TransactionMetadataOutboundTransaction;
13504
- readonly estimate: io.flow.v0.models.TransactionMetadataCarrierFeeData;
13505
- readonly actual: io.flow.v0.models.TransactionMetadataCarrierFeeData;
13506
- }
13507
-
13508
- interface TransactionMetadataCarrierFeeData {
13509
- readonly surcharges: io.flow.v0.models.TrueupLabelSurcharge[];
13510
- }
13511
-
13512
13534
  interface TransactionMetadataChannel {
13513
13535
  readonly discriminator: 'channel';
13514
13536
  readonly method: string;
13515
13537
  readonly card?: io.flow.v0.models.TransactionMetadataChannelCardMetadata;
13538
+ readonly organization_transaction: io.flow.v0.models.TransactionReference;
13516
13539
  }
13517
13540
 
13518
13541
  interface TransactionMetadataChannelCardMetadata {
@@ -13525,6 +13548,15 @@ declare namespace io.flow.v0.models {
13525
13548
  readonly country: string;
13526
13549
  }
13527
13550
 
13551
+ interface TransactionMetadataFailedPayout {
13552
+ readonly discriminator: 'failed_payout';
13553
+ readonly failed_payout: io.flow.v0.models.TransactionMetadataFailedPayoutReference;
13554
+ }
13555
+
13556
+ interface TransactionMetadataFailedPayoutReference {
13557
+ readonly id: string;
13558
+ }
13559
+
13528
13560
  interface TransactionMetadataManual {
13529
13561
  readonly discriminator: 'manual';
13530
13562
  readonly description: string;
@@ -13542,6 +13574,7 @@ declare namespace io.flow.v0.models {
13542
13574
 
13543
13575
  interface TransactionMetadataPaymentTransaction {
13544
13576
  readonly discriminator: 'payment_transaction';
13577
+ readonly id?: string;
13545
13578
  readonly key?: string;
13546
13579
  }
13547
13580
 
@@ -13564,6 +13597,22 @@ declare namespace io.flow.v0.models {
13564
13597
  readonly actual: io.flow.v0.models.TransactionMetadataTrueupData;
13565
13598
  }
13566
13599
 
13600
+ interface TransactionMetadataTrueupBase {
13601
+ readonly discriminator: 'trueup_base';
13602
+ readonly original: io.flow.v0.models.TransactionMetadataOriginalTransaction;
13603
+ readonly estimate: io.flow.v0.models.TransactionMetadataTrueupBaseData;
13604
+ readonly actual: io.flow.v0.models.TransactionMetadataTrueupBaseData;
13605
+ }
13606
+
13607
+ interface TransactionMetadataTrueupBaseData {
13608
+ readonly source: io.flow.v0.enums.TrueupSource;
13609
+ readonly weights: io.flow.v0.models.TrueupLabelWeights;
13610
+ readonly units: io.flow.v0.models.TrueupLabelUnits;
13611
+ readonly base: io.flow.v0.models.TrueupLabelBaseV2;
13612
+ readonly fuel?: io.flow.v0.models.TrueupLabelFuel;
13613
+ readonly total: number;
13614
+ }
13615
+
13567
13616
  interface TransactionMetadataTrueupData {
13568
13617
  readonly source: io.flow.v0.enums.TrueupSource;
13569
13618
  readonly units: io.flow.v0.models.TrueupLabelUnits;
@@ -13574,6 +13623,18 @@ declare namespace io.flow.v0.models {
13574
13623
  readonly dimensional?: io.flow.v0.models.DimensionalWeight;
13575
13624
  }
13576
13625
 
13626
+ interface TransactionMetadataTrueupSurcharge {
13627
+ readonly discriminator: 'trueup_surcharge';
13628
+ readonly original: io.flow.v0.models.TransactionMetadataOriginalTransaction;
13629
+ readonly estimate: io.flow.v0.models.TransactionMetadataTrueupSurchargeData;
13630
+ readonly actual: io.flow.v0.models.TransactionMetadataTrueupSurchargeData;
13631
+ }
13632
+
13633
+ interface TransactionMetadataTrueupSurchargeData {
13634
+ readonly source: io.flow.v0.enums.TrueupSource;
13635
+ readonly surcharge: io.flow.v0.models.TrueupLabelSurcharge;
13636
+ }
13637
+
13577
13638
  interface TransactionNetworkDetailsCard {
13578
13639
  readonly network_transaction_id?: string;
13579
13640
  readonly network?: io.flow.v0.enums.CardType;
@@ -13611,6 +13672,20 @@ declare namespace io.flow.v0.models {
13611
13672
  readonly weight: number;
13612
13673
  }
13613
13674
 
13675
+ interface TrueupLabelBaseV2 {
13676
+ readonly amount: number;
13677
+ }
13678
+
13679
+ interface TrueupLabelBaseWeight {
13680
+ readonly weight: number;
13681
+ }
13682
+
13683
+ interface TrueupLabelFuel {
13684
+ readonly amount: number;
13685
+ readonly percentage?: number;
13686
+ readonly per_weight_unit?: number;
13687
+ }
13688
+
13614
13689
  interface TrueupLabelSurcharge {
13615
13690
  readonly amount: number;
13616
13691
  readonly type: io.flow.v0.enums.TrueupSurchargeType;
@@ -13623,6 +13698,12 @@ declare namespace io.flow.v0.models {
13623
13698
  readonly length?: io.flow.v0.enums.UnitOfLength;
13624
13699
  }
13625
13700
 
13701
+ interface TrueupLabelWeights {
13702
+ readonly base: io.flow.v0.models.TrueupLabelBaseWeight;
13703
+ readonly dead?: io.flow.v0.models.DeadWeight;
13704
+ readonly dimensional?: io.flow.v0.models.DimensionalWeight;
13705
+ }
13706
+
13626
13707
  interface UltimateBeneficiaryOwner {
13627
13708
  readonly name: string;
13628
13709
  readonly dob: string;
@@ -14084,6 +14165,8 @@ declare namespace io.flow.v0.unions {
14084
14165
  | io.flow.v0.models.NotificationDeletedV2
14085
14166
  | io.flow.v0.models.ManifestedLabelUpserted
14086
14167
  | io.flow.v0.models.ManifestedLabelDeleted
14168
+ | io.flow.v0.models.LabelProcessingModificationUpserted
14169
+ | io.flow.v0.models.LabelProcessingModificationDeleted
14087
14170
  | io.flow.v0.models.LocalItemUpserted
14088
14171
  | io.flow.v0.models.LocalItemDeleted
14089
14172
  | io.flow.v0.models.MerchantApplicationUpserted
@@ -14458,9 +14541,11 @@ declare namespace io.flow.v0.unions {
14458
14541
  | io.flow.v0.models.TransactionMetadataShippingLabel
14459
14542
  | io.flow.v0.models.TransactionMetadataChannel
14460
14543
  | io.flow.v0.models.TransactionMetadataTrueup
14544
+ | io.flow.v0.models.TransactionMetadataTrueupBase
14545
+ | io.flow.v0.models.TransactionMetadataTrueupSurcharge
14461
14546
  | io.flow.v0.models.TransactionMetadataCarrierCharge
14462
- | io.flow.v0.models.TransactionMetadataCarrierFee
14463
14547
  | io.flow.v0.models.TransactionMetadataManual
14548
+ | io.flow.v0.models.TransactionMetadataFailedPayout
14464
14549
  | io.flow.v0.models.TransactionMetadataPaymentTransaction;
14465
14550
  }
14466
14551
 
@@ -15444,6 +15529,12 @@ export type LabelDeletedV2 = io.flow.v0.models.LabelDeletedV2;
15444
15529
  export type LabelFormatDeleted = io.flow.v0.models.LabelFormatDeleted;
15445
15530
  export type LabelFormatUpserted = io.flow.v0.models.LabelFormatUpserted;
15446
15531
  export type LabelOrderSummary = io.flow.v0.models.LabelOrderSummary;
15532
+ export type LabelProcessingModification =
15533
+ io.flow.v0.models.LabelProcessingModification;
15534
+ export type LabelProcessingModificationDeleted =
15535
+ io.flow.v0.models.LabelProcessingModificationDeleted;
15536
+ export type LabelProcessingModificationUpserted =
15537
+ io.flow.v0.models.LabelProcessingModificationUpserted;
15447
15538
  export type LabelReference = io.flow.v0.models.LabelReference;
15448
15539
  export type LabelRequestMethod = io.flow.v0.enums.LabelRequestMethod;
15449
15540
  export type LabelSurcharge = io.flow.v0.models.LabelSurcharge;
@@ -16610,16 +16701,16 @@ export type TransactionDetailsCard = io.flow.v0.models.TransactionDetailsCard;
16610
16701
  export type TransactionMetadata = io.flow.v0.unions.TransactionMetadata;
16611
16702
  export type TransactionMetadataCarrierCharge =
16612
16703
  io.flow.v0.models.TransactionMetadataCarrierCharge;
16613
- export type TransactionMetadataCarrierFee =
16614
- io.flow.v0.models.TransactionMetadataCarrierFee;
16615
- export type TransactionMetadataCarrierFeeData =
16616
- io.flow.v0.models.TransactionMetadataCarrierFeeData;
16617
16704
  export type TransactionMetadataChannel =
16618
16705
  io.flow.v0.models.TransactionMetadataChannel;
16619
16706
  export type TransactionMetadataChannelCardMetadata =
16620
16707
  io.flow.v0.models.TransactionMetadataChannelCardMetadata;
16621
16708
  export type TransactionMetadataChannelCardMetadataIssuerSummary =
16622
16709
  io.flow.v0.models.TransactionMetadataChannelCardMetadataIssuerSummary;
16710
+ export type TransactionMetadataFailedPayout =
16711
+ io.flow.v0.models.TransactionMetadataFailedPayout;
16712
+ export type TransactionMetadataFailedPayoutReference =
16713
+ io.flow.v0.models.TransactionMetadataFailedPayoutReference;
16623
16714
  export type TransactionMetadataManual =
16624
16715
  io.flow.v0.models.TransactionMetadataManual;
16625
16716
  export type TransactionMetadataOriginalTransaction =
@@ -16634,8 +16725,16 @@ export type TransactionMetadataShippingLabelCarrier =
16634
16725
  io.flow.v0.models.TransactionMetadataShippingLabelCarrier;
16635
16726
  export type TransactionMetadataTrueup =
16636
16727
  io.flow.v0.models.TransactionMetadataTrueup;
16728
+ export type TransactionMetadataTrueupBase =
16729
+ io.flow.v0.models.TransactionMetadataTrueupBase;
16730
+ export type TransactionMetadataTrueupBaseData =
16731
+ io.flow.v0.models.TransactionMetadataTrueupBaseData;
16637
16732
  export type TransactionMetadataTrueupData =
16638
16733
  io.flow.v0.models.TransactionMetadataTrueupData;
16734
+ export type TransactionMetadataTrueupSurcharge =
16735
+ io.flow.v0.models.TransactionMetadataTrueupSurcharge;
16736
+ export type TransactionMetadataTrueupSurchargeData =
16737
+ io.flow.v0.models.TransactionMetadataTrueupSurchargeData;
16639
16738
  export type TransactionNetworkDetailsCard =
16640
16739
  io.flow.v0.models.TransactionNetworkDetailsCard;
16641
16740
  export type TransactionReference = io.flow.v0.models.TransactionReference;
@@ -16644,8 +16743,12 @@ export type TransactionUpserted = io.flow.v0.models.TransactionUpserted;
16644
16743
  export type TransitEstimate = io.flow.v0.models.TransitEstimate;
16645
16744
  export type TransitWindow = io.flow.v0.models.TransitWindow;
16646
16745
  export type TrueupLabelBase = io.flow.v0.models.TrueupLabelBase;
16746
+ export type TrueupLabelBaseV2 = io.flow.v0.models.TrueupLabelBaseV2;
16747
+ export type TrueupLabelBaseWeight = io.flow.v0.models.TrueupLabelBaseWeight;
16748
+ export type TrueupLabelFuel = io.flow.v0.models.TrueupLabelFuel;
16647
16749
  export type TrueupLabelSurcharge = io.flow.v0.models.TrueupLabelSurcharge;
16648
16750
  export type TrueupLabelUnits = io.flow.v0.models.TrueupLabelUnits;
16751
+ export type TrueupLabelWeights = io.flow.v0.models.TrueupLabelWeights;
16649
16752
  export type TrueupSource = io.flow.v0.enums.TrueupSource;
16650
16753
  export type TrueupSurchargeType = io.flow.v0.enums.TrueupSurchargeType;
16651
16754
  export type UltimateBeneficiaryOwner =