@flowio/types 11.24.93 → 11.24.95

package/src/api.ts

@@ -1461,6 +1461,27 @@ declare namespace io.flow.shopify.external.v0.enums {
   type ShopifyCustomerState = 'disabled' | 'invited' | 'enabled';
   type ShopifyDiscountPaginationDirection = 'next' | 'prev';
   type ShopifyGiftCardStatus = 'any' | 'enabled' | 'disabled';
+  type ShopifyPlanName =
+    | 'basic'
+    | 'business'
+    | 'cancelled'
+    | 'dormant'
+    | 'enterprise'
+    | 'fraudulent'
+    | 'frozen'
+    | 'npo_full'
+    | 'npo_lite'
+    | 'open_learning'
+    | 'paid_trial'
+    | 'professional'
+    | 'retail'
+    | 'shopify_alumni'
+    | 'shopify_plus'
+    | 'staff'
+    | 'staff_business'
+    | 'starter'
+    | 'starter_2022'
+    | 'unlimited';
   type ShopifyProcessingMethodType =
     | 'checkout'
     | 'direct'
@@ -1677,7 +1698,7 @@ declare namespace io.flow.shopify.external.v0.models {
     readonly id: number;
     readonly product_id: number;
     readonly variant_ids: number[];
-    readonly src: string;
+    readonly src?: string;
     readonly position: number;
     readonly created_at: string;
     readonly updated_at: string;
@@ -2289,6 +2310,12 @@ declare namespace io.flow.shopify.external.v0.models {
     readonly carrier_identifier?: string;
   }
 
+  interface ShopifyShopUpdate {
+    readonly id: number;
+    readonly plan_display_name: string;
+    readonly plan_name: io.flow.shopify.external.v0.enums.ShopifyPlanName;
+  }
+
   interface ShopifyTaxLine {
     readonly price: string;
     readonly rate: number;
@@ -2886,6 +2913,8 @@ declare namespace io.flow.v0.enums {
     | 'notification_deleted_v2'
     | 'manifested_label_upserted'
     | 'manifested_label_deleted'
+    | 'label_processing_modification_upserted'
+    | 'label_processing_modification_deleted'
     | 'local_item_upserted'
     | 'local_item_deleted'
     | 'merchant_application_upserted'
@@ -3533,6 +3562,8 @@ declare namespace io.flow.v0.enums {
     | 'shipping_label_service'
     | 'shipping_label_revenue_share'
     | 'trueup'
+    | 'trueup_base'
+    | 'trueup_surcharge'
     | 'carrier_charge'
     | 'carrier_charge_revenue_share'
     | 'platform_fee'
@@ -3545,8 +3576,9 @@ declare namespace io.flow.v0.enums {
     | 'channel_billed'
     | 'order_service'
     | 'virtual_card_capture'
-    | 'virtual_card_refund';
-  type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
+    | 'virtual_card_refund'
+    | 'failed_payout';
+  type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl' | 'ups';
   type TrueupSurchargeType =
     | 'fuel'
     | 'remote_area'
@@ -3558,7 +3590,13 @@ declare namespace io.flow.v0.enums {
     | 'security'
     | 'eei_filing'
     | 'fixed_ddp'
-    | 'fixed_currency_conversion';
+    | 'fixed_currency_conversion'
+    | 'prohibited_item'
+    | 'undeliverable_shipment'
+    | 'signature_required'
+    | 'direct_delivery'
+    | 'saturday_stop'
+    | 'residential_extended_area_pickup';
   type UnitOfLength = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'meter';
   type UnitOfMeasurement =
     | 'millimeter'
@@ -5965,6 +6003,7 @@ declare namespace io.flow.v0.models {
 
   interface DeactivationPutForm {
     readonly reason: string;
+    readonly deactivate_at?: string;
   }
 
   interface DeadWeight {
@@ -8082,6 +8121,29 @@ declare namespace io.flow.v0.models {
     readonly number: string;
   }
 
+  interface LabelProcessingModification {
+    readonly id: string;
+    readonly modifications: string[];
+    readonly destination: io.flow.v0.models.ShippingAddress;
+    readonly destination_provided_to_carrier?: io.flow.v0.models.ShippingAddress;
+  }
+
+  interface LabelProcessingModificationDeleted {
+    readonly discriminator: 'label_processing_modification_deleted';
+    readonly event_id: string;
+    readonly timestamp: string;
+    readonly organization: string;
+    readonly id: string;
+  }
+
+  interface LabelProcessingModificationUpserted {
+    readonly discriminator: 'label_processing_modification_upserted';
+    readonly event_id: string;
+    readonly timestamp: string;
+    readonly organization: string;
+    readonly label_processing_modification: io.flow.v0.models.LabelProcessingModification;
+  }
+
   interface LabelReference {
     readonly id: string;
   }
@@ -8553,6 +8615,7 @@ declare namespace io.flow.v0.models {
   interface MerchantDeactivated {
     readonly discriminator: 'merchant_deactivated';
     readonly reason: string;
+    readonly deactivate_at?: string;
   }
 
   interface MerchantDisabled {
@@ -9896,6 +9959,7 @@ declare namespace io.flow.v0.models {
     readonly currency: string;
     readonly base_amount?: number;
     readonly base_currency?: string;
+    readonly reference?: string;
   }
 
   interface PaymentAuthorizationStatus {
@@ -9909,6 +9973,7 @@ declare namespace io.flow.v0.models {
     readonly currency: string;
     readonly base_amount?: number;
     readonly base_currency?: string;
+    readonly reference?: string;
     readonly created_at: string;
     readonly updated_at: string;
     readonly status: io.flow.v0.models.PaymentCaptureStatus;
@@ -9917,6 +9982,7 @@ declare namespace io.flow.v0.models {
   interface PaymentCaptureForm {
     readonly amount?: number;
     readonly currency?: string;
+    readonly reference?: string;
     readonly attributes?: Record<string, string>;
   }
 
@@ -10065,6 +10131,7 @@ declare namespace io.flow.v0.models {
     readonly device_fingerprint_details: io.flow.v0.unions.DeviceFingerprintDetails;
     readonly cvv?: string;
     readonly stored_details_card?: io.flow.v0.unions.PaymentMethodStoredDetailsCard;
+    readonly reference?: string;
   }
 
   interface PaymentMethodDataAuthorizeGooglepay {
@@ -10100,42 +10167,43 @@ declare namespace io.flow.v0.models {
 
   interface PaymentMethodDataInitAfterpay {
     readonly type: 'init_afterpay';
-    readonly placeholder?: string;
+    readonly reference?: string;
   }
 
   interface PaymentMethodDataInitApplepay {
     readonly type: 'init_applepay';
-    readonly placeholder?: string;
+    readonly reference?: string;
   }
 
   interface PaymentMethodDataInitBancontact {
     readonly type: 'init_bancontact';
-    readonly placeholder?: string;
+    readonly reference?: string;
   }
 
   interface PaymentMethodDataInitGooglepay {
     readonly type: 'init_googlepay';
-    readonly placeholder?: string;
+    readonly reference?: string;
   }
 
   interface PaymentMethodDataInitIdeal {
     readonly type: 'init_ideal';
     readonly issuer?: string;
+    readonly reference?: string;
   }
 
   interface PaymentMethodDataInitKlarna {
     readonly type: 'init_klarna';
-    readonly placeholder?: string;
+    readonly reference?: string;
   }
 
   interface PaymentMethodDataInitPaypal {
     readonly type: 'init_paypal';
-    readonly placeholder?: string;
+    readonly reference?: string;
   }
 
   interface PaymentMethodDataInitSofort {
     readonly type: 'init_sofort';
-    readonly placeholder?: string;
+    readonly reference?: string;
   }
 
   interface PaymentMethodDataOptionLogoSvg {
@@ -10255,7 +10323,7 @@ declare namespace io.flow.v0.models {
   }
 
   interface PaymentOrderDetailsLineItem {
-    readonly id: string;
+    readonly id?: string;
     readonly description: string;
     readonly quantity: number;
     readonly amount: number;
@@ -10343,6 +10411,7 @@ declare namespace io.flow.v0.models {
     readonly currency: string;
     readonly base_amount?: number;
     readonly base_currency?: string;
+    readonly reference?: string;
     readonly created_at: string;
     readonly updated_at: string;
     readonly status: io.flow.v0.models.PaymentRefundStatus;
@@ -10351,6 +10420,7 @@ declare namespace io.flow.v0.models {
   interface PaymentRefundForm {
     readonly amount?: number;
     readonly currency?: string;
+    readonly reference?: string;
   }
 
   interface PaymentRefundStatus {
@@ -10458,6 +10528,7 @@ declare namespace io.flow.v0.models {
     readonly currency: string;
     readonly base_amount?: number;
     readonly base_currency?: string;
+    readonly reference?: string;
     readonly created_at: string;
     readonly updated_at: string;
     readonly status: io.flow.v0.models.PaymentReversalStatus;
@@ -10466,6 +10537,7 @@ declare namespace io.flow.v0.models {
   interface PaymentReversalForm {
     readonly amount?: number;
     readonly currency?: string;
+    readonly reference?: string;
   }
 
   interface PaymentReversalStatus {
@@ -10917,7 +10989,7 @@ declare namespace io.flow.v0.models {
     readonly event_id: string;
     readonly timestamp: string;
     readonly organization: string;
-    readonly product_restriction_result: io.flow.v0.models.ProductRestrictionResult;
+    readonly id: string;
   }
 
   interface ProductRestrictionResultUpserted {
@@ -13456,17 +13528,14 @@ declare namespace io.flow.v0.models {
     readonly carrier_id: string;
     readonly carrier_tracking_number: string;
     readonly revenue_share_percentage: number;
-    readonly outbound?: io.flow.v0.models.TransactionMetadataCarrierChargeOutbound;
-  }
-
-  interface TransactionMetadataCarrierChargeOutbound {
-    readonly transaction_id: string;
+    readonly outbound?: io.flow.v0.models.TransactionMetadataOutboundTransaction;
   }
 
   interface TransactionMetadataChannel {
     readonly discriminator: 'channel';
     readonly method: string;
     readonly card?: io.flow.v0.models.TransactionMetadataChannelCardMetadata;
+    readonly organization_transaction: io.flow.v0.models.TransactionReference;
   }
 
   interface TransactionMetadataChannelCardMetadata {
@@ -13479,6 +13548,15 @@ declare namespace io.flow.v0.models {
     readonly country: string;
   }
 
+  interface TransactionMetadataFailedPayout {
+    readonly discriminator: 'failed_payout';
+    readonly failed_payout: io.flow.v0.models.TransactionMetadataFailedPayoutReference;
+  }
+
+  interface TransactionMetadataFailedPayoutReference {
+    readonly id: string;
+  }
+
   interface TransactionMetadataManual {
     readonly discriminator: 'manual';
     readonly description: string;
@@ -13490,6 +13568,16 @@ declare namespace io.flow.v0.models {
     readonly id: string;
   }
 
+  interface TransactionMetadataOutboundTransaction {
+    readonly transaction_id: string;
+  }
+
+  interface TransactionMetadataPaymentTransaction {
+    readonly discriminator: 'payment_transaction';
+    readonly id?: string;
+    readonly key?: string;
+  }
+
   interface TransactionMetadataShippingLabel {
     readonly discriminator: 'shipping_label';
     readonly request_method?: io.flow.v0.enums.LabelRequestMethod;
@@ -13509,6 +13597,22 @@ declare namespace io.flow.v0.models {
     readonly actual: io.flow.v0.models.TransactionMetadataTrueupData;
   }
 
+  interface TransactionMetadataTrueupBase {
+    readonly discriminator: 'trueup_base';
+    readonly original: io.flow.v0.models.TransactionMetadataOriginalTransaction;
+    readonly estimate: io.flow.v0.models.TransactionMetadataTrueupBaseData;
+    readonly actual: io.flow.v0.models.TransactionMetadataTrueupBaseData;
+  }
+
+  interface TransactionMetadataTrueupBaseData {
+    readonly source: io.flow.v0.enums.TrueupSource;
+    readonly weights: io.flow.v0.models.TrueupLabelWeights;
+    readonly units: io.flow.v0.models.TrueupLabelUnits;
+    readonly base: io.flow.v0.models.TrueupLabelBaseV2;
+    readonly fuel?: io.flow.v0.models.TrueupLabelFuel;
+    readonly total: number;
+  }
+
   interface TransactionMetadataTrueupData {
     readonly source: io.flow.v0.enums.TrueupSource;
     readonly units: io.flow.v0.models.TrueupLabelUnits;
@@ -13519,6 +13623,18 @@ declare namespace io.flow.v0.models {
     readonly dimensional?: io.flow.v0.models.DimensionalWeight;
   }
 
+  interface TransactionMetadataTrueupSurcharge {
+    readonly discriminator: 'trueup_surcharge';
+    readonly original: io.flow.v0.models.TransactionMetadataOriginalTransaction;
+    readonly estimate: io.flow.v0.models.TransactionMetadataTrueupSurchargeData;
+    readonly actual: io.flow.v0.models.TransactionMetadataTrueupSurchargeData;
+  }
+
+  interface TransactionMetadataTrueupSurchargeData {
+    readonly source: io.flow.v0.enums.TrueupSource;
+    readonly surcharge: io.flow.v0.models.TrueupLabelSurcharge;
+  }
+
   interface TransactionNetworkDetailsCard {
     readonly network_transaction_id?: string;
     readonly network?: io.flow.v0.enums.CardType;
@@ -13556,6 +13672,20 @@ declare namespace io.flow.v0.models {
     readonly weight: number;
   }
 
+  interface TrueupLabelBaseV2 {
+    readonly amount: number;
+  }
+
+  interface TrueupLabelBaseWeight {
+    readonly weight: number;
+  }
+
+  interface TrueupLabelFuel {
+    readonly amount: number;
+    readonly percentage?: number;
+    readonly per_weight_unit?: number;
+  }
+
   interface TrueupLabelSurcharge {
     readonly amount: number;
     readonly type: io.flow.v0.enums.TrueupSurchargeType;
@@ -13568,6 +13698,12 @@ declare namespace io.flow.v0.models {
     readonly length?: io.flow.v0.enums.UnitOfLength;
   }
 
+  interface TrueupLabelWeights {
+    readonly base: io.flow.v0.models.TrueupLabelBaseWeight;
+    readonly dead?: io.flow.v0.models.DeadWeight;
+    readonly dimensional?: io.flow.v0.models.DimensionalWeight;
+  }
+
   interface UltimateBeneficiaryOwner {
     readonly name: string;
     readonly dob: string;
@@ -13669,11 +13805,6 @@ declare namespace io.flow.v0.models {
     readonly virtual_card_capture: io.flow.v0.models.VirtualCardCapture;
   }
 
-  interface VirtualCardForm {
-    readonly limit: io.flow.v0.models.Money;
-    readonly attributes?: Record<string, string>;
-  }
-
   interface VirtualCardReference {
     readonly id: string;
   }
@@ -14034,6 +14165,8 @@ declare namespace io.flow.v0.unions {
     | io.flow.v0.models.NotificationDeletedV2
     | io.flow.v0.models.ManifestedLabelUpserted
     | io.flow.v0.models.ManifestedLabelDeleted
+    | io.flow.v0.models.LabelProcessingModificationUpserted
+    | io.flow.v0.models.LabelProcessingModificationDeleted
     | io.flow.v0.models.LocalItemUpserted
     | io.flow.v0.models.LocalItemDeleted
     | io.flow.v0.models.MerchantApplicationUpserted
@@ -14408,8 +14541,12 @@ declare namespace io.flow.v0.unions {
     | io.flow.v0.models.TransactionMetadataShippingLabel
     | io.flow.v0.models.TransactionMetadataChannel
     | io.flow.v0.models.TransactionMetadataTrueup
+    | io.flow.v0.models.TransactionMetadataTrueupBase
+    | io.flow.v0.models.TransactionMetadataTrueupSurcharge
     | io.flow.v0.models.TransactionMetadataCarrierCharge
-    | io.flow.v0.models.TransactionMetadataManual;
+    | io.flow.v0.models.TransactionMetadataManual
+    | io.flow.v0.models.TransactionMetadataFailedPayout
+    | io.flow.v0.models.TransactionMetadataPaymentTransaction;
 }
 
 export type AbandonedOrderEmailSettings =
@@ -15392,6 +15529,12 @@ export type LabelDeletedV2 = io.flow.v0.models.LabelDeletedV2;
 export type LabelFormatDeleted = io.flow.v0.models.LabelFormatDeleted;
 export type LabelFormatUpserted = io.flow.v0.models.LabelFormatUpserted;
 export type LabelOrderSummary = io.flow.v0.models.LabelOrderSummary;
+export type LabelProcessingModification =
+  io.flow.v0.models.LabelProcessingModification;
+export type LabelProcessingModificationDeleted =
+  io.flow.v0.models.LabelProcessingModificationDeleted;
+export type LabelProcessingModificationUpserted =
+  io.flow.v0.models.LabelProcessingModificationUpserted;
 export type LabelReference = io.flow.v0.models.LabelReference;
 export type LabelRequestMethod = io.flow.v0.enums.LabelRequestMethod;
 export type LabelSurcharge = io.flow.v0.models.LabelSurcharge;
@@ -16558,26 +16701,40 @@ export type TransactionDetailsCard = io.flow.v0.models.TransactionDetailsCard;
 export type TransactionMetadata = io.flow.v0.unions.TransactionMetadata;
 export type TransactionMetadataCarrierCharge =
   io.flow.v0.models.TransactionMetadataCarrierCharge;
-export type TransactionMetadataCarrierChargeOutbound =
-  io.flow.v0.models.TransactionMetadataCarrierChargeOutbound;
 export type TransactionMetadataChannel =
   io.flow.v0.models.TransactionMetadataChannel;
 export type TransactionMetadataChannelCardMetadata =
   io.flow.v0.models.TransactionMetadataChannelCardMetadata;
 export type TransactionMetadataChannelCardMetadataIssuerSummary =
   io.flow.v0.models.TransactionMetadataChannelCardMetadataIssuerSummary;
+export type TransactionMetadataFailedPayout =
+  io.flow.v0.models.TransactionMetadataFailedPayout;
+export type TransactionMetadataFailedPayoutReference =
+  io.flow.v0.models.TransactionMetadataFailedPayoutReference;
 export type TransactionMetadataManual =
   io.flow.v0.models.TransactionMetadataManual;
 export type TransactionMetadataOriginalTransaction =
   io.flow.v0.models.TransactionMetadataOriginalTransaction;
+export type TransactionMetadataOutboundTransaction =
+  io.flow.v0.models.TransactionMetadataOutboundTransaction;
+export type TransactionMetadataPaymentTransaction =
+  io.flow.v0.models.TransactionMetadataPaymentTransaction;
 export type TransactionMetadataShippingLabel =
   io.flow.v0.models.TransactionMetadataShippingLabel;
 export type TransactionMetadataShippingLabelCarrier =
   io.flow.v0.models.TransactionMetadataShippingLabelCarrier;
 export type TransactionMetadataTrueup =
   io.flow.v0.models.TransactionMetadataTrueup;
+export type TransactionMetadataTrueupBase =
+  io.flow.v0.models.TransactionMetadataTrueupBase;
+export type TransactionMetadataTrueupBaseData =
+  io.flow.v0.models.TransactionMetadataTrueupBaseData;
 export type TransactionMetadataTrueupData =
   io.flow.v0.models.TransactionMetadataTrueupData;
+export type TransactionMetadataTrueupSurcharge =
+  io.flow.v0.models.TransactionMetadataTrueupSurcharge;
+export type TransactionMetadataTrueupSurchargeData =
+  io.flow.v0.models.TransactionMetadataTrueupSurchargeData;
 export type TransactionNetworkDetailsCard =
   io.flow.v0.models.TransactionNetworkDetailsCard;
 export type TransactionReference = io.flow.v0.models.TransactionReference;
@@ -16586,8 +16743,12 @@ export type TransactionUpserted = io.flow.v0.models.TransactionUpserted;
 export type TransitEstimate = io.flow.v0.models.TransitEstimate;
 export type TransitWindow = io.flow.v0.models.TransitWindow;
 export type TrueupLabelBase = io.flow.v0.models.TrueupLabelBase;
+export type TrueupLabelBaseV2 = io.flow.v0.models.TrueupLabelBaseV2;
+export type TrueupLabelBaseWeight = io.flow.v0.models.TrueupLabelBaseWeight;
+export type TrueupLabelFuel = io.flow.v0.models.TrueupLabelFuel;
 export type TrueupLabelSurcharge = io.flow.v0.models.TrueupLabelSurcharge;
 export type TrueupLabelUnits = io.flow.v0.models.TrueupLabelUnits;
+export type TrueupLabelWeights = io.flow.v0.models.TrueupLabelWeights;
 export type TrueupSource = io.flow.v0.enums.TrueupSource;
 export type TrueupSurchargeType = io.flow.v0.enums.TrueupSurchargeType;
 export type UltimateBeneficiaryOwner =
@@ -16619,7 +16780,6 @@ export type VirtualCardCaptureUpserted =
   io.flow.v0.models.VirtualCardCaptureUpserted;
 export type VirtualCardCaptureVersion =
   io.flow.v0.models.VirtualCardCaptureVersion;
-export type VirtualCardForm = io.flow.v0.models.VirtualCardForm;
 export type VirtualCardReference = io.flow.v0.models.VirtualCardReference;
 export type VirtualCardRefund = io.flow.v0.models.VirtualCardRefund;
 export type VirtualCardRefundDeleted =