@flowio/types 11.24.112 → 11.24.113

package/src/api.ts

@@ -237,6 +237,12 @@ declare namespace io.flow.stripe.v0.enums {
     | 'fraudulent'
     | 'requested_by_customer'
     | 'void_invoice';
+  type CapabilityStatus =
+    | 'active'
+    | 'disabled'
+    | 'inactive'
+    | 'pending'
+    | 'unrequested';
   type CaptureMethod = 'automatic' | 'manual';
   type CardBrand =
     | 'American Express'
@@ -261,6 +267,17 @@ declare namespace io.flow.stripe.v0.enums {
   type CheckOutcome = 'pass' | 'fail' | 'unavailable' | 'unchecked';
   type CodeVerificationStatus = 'pending' | 'succeeded' | 'failed';
   type ConfirmationMethod = 'automatic' | 'manual';
+  type ConnectReportReportingCategory =
+    | 'charge'
+    | 'refund'
+    | 'payout_reversal'
+    | 'transfer'
+    | 'transfer_reversal';
+  type ConnectReportShopPlan = 'shopify_plus' | 'standard';
+  type ConnectReportTransferType =
+    | 'ManagedMarketsRefundDebit'
+    | 'ManagedMarketsDutiesAndTaxesAdjustmentDebit'
+    | 'ManagedMarketsDisputedAmountDebit';
   type DeclineCode =
     | 'approve_with_id'
     | 'call_issuer'
@@ -430,6 +447,7 @@ declare namespace io.flow.stripe.v0.enums {
     | 'rate_limit_error'
     | 'validation_error';
   type EventType =
+    | 'capability.updated'
     | 'charge.captured'
     | 'charge.failed'
     | 'charge.pending'
@@ -714,6 +732,17 @@ declare namespace io.flow.stripe.v0.models {
     readonly type: io.flow.stripe.v0.enums.ApplePayType;
   }
 
+  interface Capability {
+    readonly id: string;
+    readonly account: string;
+    readonly requested: boolean;
+    readonly requirements: any /*object*/;
+    readonly status: io.flow.stripe.v0.enums.CapabilityStatus;
+    readonly object: string;
+    readonly future_requirements: any /*object*/;
+    readonly requested_at?: number;
+  }
+
   interface Card {
     readonly id: string;
     readonly object: string;
@@ -857,6 +886,46 @@ declare namespace io.flow.stripe.v0.models {
     readonly status: io.flow.stripe.v0.enums.CodeVerificationStatus;
   }
 
+  interface ConnectReportRecord {
+    readonly created_utc: string;
+    readonly charge_id?: string;
+    readonly payment_intent_id?: string;
+    readonly gross: number;
+    readonly fee: number;
+    readonly net: number;
+    readonly currency: string;
+    readonly connected_account: string;
+    readonly reporting_category: io.flow.stripe.v0.enums.ConnectReportReportingCategory;
+    readonly dispute_reason?: io.flow.stripe.v0.enums.DisputeReason;
+    readonly available_on_utc: string;
+    readonly automatic_payout_effective_at_utc?: string;
+    readonly source_id?: string;
+    readonly customer_facing_amount?: number;
+    readonly customer_facing_currency?: string;
+    readonly payment_method_type?: string;
+    readonly card_brand?: string;
+    readonly statement_descriptor?: string;
+    readonly payment_metadata?: io.flow.stripe.v0.models.ConnectReportRecordPaymentMetadata;
+    readonly transfer_metadata?: any /*object*/;
+  }
+
+  interface ConnectReportRecordPaymentMetadata {
+    readonly shop_id?: number;
+    readonly shop_plan?: io.flow.stripe.v0.enums.ConnectReportShopPlan;
+    readonly checkout_id?: string;
+    readonly order_id?: number;
+    readonly order_transaction_id?: number;
+    readonly transfer_type?: io.flow.stripe.v0.enums.ConnectReportTransferType;
+    readonly transfer_exchange_rate?: number;
+    readonly charge_total?: number;
+    readonly charge_currency?: string;
+    readonly charge_exchange_rate?: number;
+    readonly duties?: number;
+    readonly import_taxes?: number;
+    readonly mor_fee?: number;
+    readonly fx_fee?: number;
+  }
+
   interface Customer {
     readonly id: string;
     readonly object: string;
@@ -3097,6 +3166,9 @@ declare namespace io.flow.common.v0.enums {
     | 'inch'
     | 'foot'
     | 'cubic_inch'
+    | 'cubic_foot'
+    | 'cubic_millimeter'
+    | 'cubic_centimeter'
     | 'cubic_meter'
     | 'gram'
     | 'kilogram'
@@ -4914,29 +4986,6 @@ declare namespace io.flow.tech.onboarding.playground.v0.models {
   }
 }
 
-declare namespace io.flow.currency.v0.models {
-  interface Rate {
-    readonly id: string;
-    readonly base: string;
-    readonly target: string;
-    readonly effective_at: string;
-    readonly value: number;
-  }
-
-  interface RateForm {
-    readonly base: string;
-    readonly target: string;
-    readonly effective_at: string;
-  }
-
-  interface RateVersion {
-    readonly id: string;
-    readonly timestamp: string;
-    readonly type: io.flow.common.v0.enums.ChangeType;
-    readonly rate: io.flow.currency.v0.models.Rate;
-  }
-}
-
 declare namespace io.flow.organization.v0.enums {
   type CountryPickerSource = 'experience' | 'destination';
   type EcommercePlatformType =
@@ -5996,6 +6045,69 @@ declare namespace io.flow.query.builder.v0.unions {
     | io.flow.query.builder.v0.models.QueryFilterUnstructuredForm;
 }
 
+declare namespace io.flow.sellability.v0.enums {
+  type RuleEffectType = 'market' | 'dhl' | 'dhl_ecommerce' | 'ups';
+  type SellabilityErrorCode = 'insufficient_details' | 'ineligible_category';
+}
+
+declare namespace io.flow.sellability.v0.models {
+  interface ProductSellability {
+    readonly shop_id: string;
+    readonly product_id?: string;
+    readonly request_id: string;
+    readonly hs6_code: string;
+    readonly restricted_regions: io.flow.sellability.v0.models.SellablilityRegionResult[];
+  }
+
+  interface ProductSellabilityForm {
+    readonly shop_id: string;
+    readonly product_id?: string;
+    readonly request_id: string;
+    readonly name: string;
+    readonly price: io.flow.sellability.v0.models.ProductSellabilityPrice;
+    readonly description: string;
+    readonly taxonomy_category: io.flow.product.v0.models.ProductTaxonomyCategory;
+  }
+
+  interface ProductSellabilityPrice {
+    readonly currency: string;
+    readonly amount: number;
+  }
+
+  interface SellabilityError {
+    readonly code: io.flow.sellability.v0.enums.SellabilityErrorCode;
+    readonly messages: string[];
+  }
+
+  interface SellablilityRegionResult {
+    readonly type: io.flow.sellability.v0.enums.RuleEffectType;
+    readonly regions: string[];
+  }
+}
+
+declare namespace io.flow.currency.v0.models {
+  interface Rate {
+    readonly id: string;
+    readonly base: string;
+    readonly target: string;
+    readonly effective_at: string;
+    readonly value: number;
+  }
+
+  interface RateForm {
+    readonly base: string;
+    readonly target: string;
+    readonly effective_at: string;
+  }
+
+  interface RateVersion {
+    readonly id: string;
+    readonly timestamp: string;
+    readonly type: io.flow.common.v0.enums.ChangeType;
+    readonly rate: io.flow.currency.v0.models.Rate;
+  }
+}
+
 declare namespace io.flow.v0.enums {
   type AbandonedOrderPromotionStatus = 'active' | 'inactive';
   type AbandonedOrderSettingStatus = 'active' | 'inactive';
@@ -6209,8 +6321,6 @@ declare namespace io.flow.v0.enums {
   type EconomicTitleLocation = 'high_seas' | 'origination' | 'destination';
   type EntityIdentifierType = 'ioss' | 'voec' | 'zaz';
   type Environment = 'sandbox' | 'production';
-  type EstimateOrigin = 'Shopify' | 'GlobalE' | 'Aftership' | 'Carrier';
-  type EstimateType = 'Estimated' | 'Final';
   type EventType =
     | 'test_upserted'
     | 'generate_load'
@@ -6330,8 +6440,6 @@ declare namespace io.flow.v0.enums {
     | 'ge_item_inserted'
     | 'ge_item_updated'
     | 'ge_item_deleted'
-    | 'ge_product_restriction_result_upserted'
-    | 'ge_product_restriction_result_deleted'
     | 'hs6_code_upserted'
     | 'hs6_code_deleted'
     | 'hs10_code_upserted'
@@ -6457,6 +6565,11 @@ declare namespace io.flow.v0.enums {
   type FulfillmentMethodType = 'fulfillment_method';
   type FulfillmentMethodValue = 'digital' | 'physical';
   type FulfillmentRouting = 'fulfilled_from_center' | 'fulfillment_service';
+  type GeCatalogItemIngestionResponse =
+    | 'ge_catalog_item_ingestion_success'
+    | 'ge_catalog_item_ingestion_failure';
+  type GeEnvironment = 'production' | 'sandbox';
+  type GeEventType = 'restriction_result' | 'ingestion_result';
   type GenericErrorCode = 'generic_error' | 'client_error' | 'server_error';
   type GoodsSupply = 'export' | 'intra_community' | 'local';
   type HolidayCalendar = 'us_bank_holidays' | 'jewish_holidays';
@@ -6667,7 +6780,7 @@ declare namespace io.flow.v0.enums {
     | 'by_quantity_percentage';
   type OrderStatus = 'open' | 'submitted';
   type OrderStorage = 'do_not_persist' | 'persist';
-  type OrderType = 'standard' | 'replacement';
+  type OrderType = 'standard' | 'replacement' | 'edit';
   type OrganizationPaymentMethodTag = 'deny';
   type OrganizationStatus =
     | 'active'
@@ -6717,6 +6830,7 @@ declare namespace io.flow.v0.enums {
     | 'fraudulent'
     | 'error'
     | 'payment_checks_declined';
+  type PaymentFeeType = 'fx' | 'mor';
   type PaymentMethodCapability = 'credit' | 'debit';
   type PaymentMethodDataOptionType = 'ideal_issuer_option';
   type PaymentMethodRuleContentKey = 'description';
@@ -7071,8 +7185,7 @@ declare namespace io.flow.v0.enums {
     | 'failed_payout'
     | 'tax_refund'
     | 'non_l4l_tax_duty_fx'
-    | 'ge_revenue_share'
-    | 'tax_duty_delta';
+    | 'ge_revenue_share';
   type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl' | 'ups';
   type TrueupSurchargeType =
     | 'fuel'
@@ -7100,6 +7213,9 @@ declare namespace io.flow.v0.enums {
     | 'inch'
     | 'foot'
     | 'cubic_inch'
+    | 'cubic_foot'
+    | 'cubic_millimeter'
+    | 'cubic_centimeter'
     | 'cubic_meter'
     | 'gram'
     | 'kilogram'
@@ -7107,7 +7223,12 @@ declare namespace io.flow.v0.enums {
     | 'ounce'
     | 'pound';
   type UnitOfTime = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute';
-  type UnitOfVolume = 'cubic_inch' | 'cubic_meter';
+  type UnitOfVolume =
+    | 'cubic_inch'
+    | 'cubic_foot'
+    | 'cubic_millimeter'
+    | 'cubic_centimeter'
+    | 'cubic_meter';
   type UnitOfWeight = 'gram' | 'kilogram' | 'ounce' | 'pound';
   type UpdatePolicy = 'auto' | 'queue' | 'discard';
   type UserStatus = 'pending' | 'active' | 'inactive';
@@ -8106,6 +8227,7 @@ declare namespace io.flow.v0.models {
     readonly attributes?: Record<string, string>;
     readonly status?: io.flow.v0.enums.CaptureStatus;
     readonly base?: io.flow.v0.models.Money;
+    readonly fees?: io.flow.v0.models.PaymentFee[];
   }
 
   interface CaptureDeleted {
@@ -9863,6 +9985,7 @@ declare namespace io.flow.v0.models {
   interface DutiesTaxesPaidSurchargeServiceFee {
     readonly discriminator: 'duties_taxes_paid_surcharge_service_fee';
     readonly amount: io.flow.v0.models.Money;
+    readonly destination_countries?: string[];
     readonly starts_at?: string;
     readonly ends_at?: string;
   }
@@ -10022,15 +10145,6 @@ declare namespace io.flow.v0.models {
     readonly issuing_country?: string;
   }
 
-  interface Estimate {
-    readonly id: string;
-    readonly organization_id: string;
-    readonly label_id: string;
-    readonly estimate: io.flow.v0.models.ShippingLabelHopSummary;
-    readonly type: io.flow.v0.enums.EstimateType;
-    readonly origin?: io.flow.v0.enums.EstimateOrigin;
-  }
-
   interface EstimatedDimensions {
     readonly depth: io.flow.v0.models.Measurement;
     readonly length: io.flow.v0.models.Measurement;
@@ -10424,6 +10538,12 @@ declare namespace io.flow.v0.models {
     readonly export: io.flow.v0.models.Export;
   }
 
+  interface ExternalCard {
+    readonly discriminator: 'external_card';
+    readonly id: string;
+    readonly type?: io.flow.v0.enums.CardType;
+  }
+
   interface FeeDeduction {
     readonly type: io.flow.v0.enums.FeeDeductionType;
     readonly amount: number;
@@ -10722,6 +10842,45 @@ declare namespace io.flow.v0.models {
     readonly landed_costs: io.flow.v0.models.LaneLandedCost[];
   }
 
+  interface GeCatalogItemIngestionResult {
+    readonly discriminator: 'ge_catalog_item_ingestion_result';
+    readonly event_id: string;
+    readonly event_type: io.flow.v0.enums.GeEventType;
+    readonly environment: io.flow.v0.enums.GeEnvironment;
+    readonly timestamp: string;
+    readonly source: string;
+    readonly response: io.flow.v0.enums.GeCatalogItemIngestionResponse;
+    readonly message: string;
+  }
+
+  interface GeCatalogItemInput {
+    readonly event_id: string;
+    readonly number: string;
+    readonly organization_id: string;
+    readonly name: string;
+    readonly description: string;
+    readonly price: io.flow.v0.models.GeInputPrice;
+    readonly attributes: io.flow.v0.models.GeInputAttributes;
+    readonly locale: string;
+    readonly id: string;
+    readonly categories: string[];
+    readonly created_at: string;
+    readonly updated_at: string;
+    readonly images: string[];
+  }
+
+  interface GeInputAttributes {
+    readonly country_of_origin: string;
+    readonly ge_hs6_code: string;
+    readonly product_id: string;
+  }
+
+  interface GeInputPrice {
+    readonly amount: number;
+    readonly currency: string;
+    readonly label: string;
+  }
+
   interface GeItemDeleted {
     readonly discriminator: 'ge_item_deleted';
     readonly event_id: string;
@@ -10746,19 +10905,23 @@ declare namespace io.flow.v0.models {
     readonly item: io.flow.v0.models.Item;
   }
 
-  interface GeProductRestrictionResultDeleted {
-    readonly discriminator: 'ge_product_restriction_result_deleted';
+  interface GeProductRestrictionResultDelete {
+    readonly discriminator: 'ge_product_restriction_result_delete';
+    readonly organization: string;
     readonly event_id: string;
+    readonly event_type: io.flow.v0.enums.GeEventType;
+    readonly environment: io.flow.v0.enums.GeEnvironment;
     readonly timestamp: string;
-    readonly organization: string;
     readonly id: string;
   }
 
-  interface GeProductRestrictionResultUpserted {
-    readonly discriminator: 'ge_product_restriction_result_upserted';
+  interface GeProductRestrictionResultUpsert {
+    readonly discriminator: 'ge_product_restriction_result_upsert';
+    readonly organization: string;
     readonly event_id: string;
+    readonly event_type: io.flow.v0.enums.GeEventType;
+    readonly environment: io.flow.v0.enums.GeEnvironment;
     readonly timestamp: string;
-    readonly organization: string;
     readonly ge_product_restriction_result: io.flow.v0.models.ProductRestrictionResult;
   }
 
@@ -13470,6 +13633,12 @@ declare namespace io.flow.v0.models {
     readonly failure_message: string;
   }
 
+  interface PaymentFee {
+    readonly type: io.flow.v0.enums.PaymentFeeType;
+    readonly money: io.flow.v0.models.Money;
+    readonly base?: io.flow.v0.models.Money;
+  }
+
   interface PaymentInformation {
     readonly amount_refundable?: number;
     readonly amount_refunded?: number;
@@ -14477,6 +14646,7 @@ declare namespace io.flow.v0.models {
     readonly updated_by?: string;
     readonly product_restriction_id?: string;
     readonly hs_code?: string;
+    readonly restricted_regions_by_type?: io.flow.sellability.v0.models.SellablilityRegionResult[];
   }
 
   interface ProductRestrictionResultDeleted {
@@ -17434,8 +17604,6 @@ declare namespace io.flow.v0.unions {
     | io.flow.v0.models.GeItemInserted
     | io.flow.v0.models.GeItemUpdated
     | io.flow.v0.models.GeItemDeleted
-    | io.flow.v0.models.GeProductRestrictionResultUpserted
-    | io.flow.v0.models.GeProductRestrictionResultDeleted
     | io.flow.v0.models.Hs6CodeUpserted
     | io.flow.v0.models.Hs6CodeDeleted
     | io.flow.v0.models.Hs10CodeUpserted
@@ -17526,7 +17694,8 @@ declare namespace io.flow.v0.unions {
   type ExpandableCard =
     | io.flow.v0.models.Card
     | io.flow.v0.models.CardReference
-    | io.flow.v0.models.CardSummary;
+    | io.flow.v0.models.CardSummary
+    | io.flow.v0.models.ExternalCard;
   type ExpandableCenter =
     | io.flow.v0.models.Center
     | io.flow.v0.models.CenterReference;
@@ -17582,6 +17751,10 @@ declare namespace io.flow.v0.unions {
   type GatewayAuthenticationData = io.flow.v0.models.StripeAuthenticationData;
   type GatewayAuthenticationDataForm =
     io.flow.v0.models.StripeAuthenticationDataForm;
+  type GeRestrictionEvent =
+    | io.flow.v0.models.GeProductRestrictionResultUpsert
+    | io.flow.v0.models.GeProductRestrictionResultDelete
+    | io.flow.v0.models.GeCatalogItemIngestionResult;
   type InlineActionConfiguration =
     io.flow.v0.models.BrowserInlineActionConfiguration;
   type InputSpecificationLimitation =
@@ -18465,9 +18638,6 @@ export type Entity = io.flow.v0.unions.Entity;
 export type EntityIdentifier = io.flow.v0.models.EntityIdentifier;
 export type EntityIdentifierType = io.flow.v0.enums.EntityIdentifierType;
 export type Environment = io.flow.v0.enums.Environment;
-export type Estimate = io.flow.v0.models.Estimate;
-export type EstimateOrigin = io.flow.v0.enums.EstimateOrigin;
-export type EstimateType = io.flow.v0.enums.EstimateType;
 export type EstimatedDimensions = io.flow.v0.models.EstimatedDimensions;
 export type EstimatedWindow = io.flow.v0.models.EstimatedWindow;
 export type Event = io.flow.v0.unions.Event;
@@ -18577,6 +18747,7 @@ export type ExportStatus = io.flow.v0.enums.ExportStatus;
 export type ExportType = io.flow.v0.unions.ExportType;
 export type ExportVersion = io.flow.v0.models.ExportVersion;
 export type ExporterOfRecord = io.flow.v0.enums.ExporterOfRecord;
+export type ExternalCard = io.flow.v0.models.ExternalCard;
 export type FeeDeduction = io.flow.v0.models.FeeDeduction;
 export type FeeDeductionType = io.flow.v0.enums.FeeDeductionType;
 export type FeeWeight = io.flow.v0.models.FeeWeight;
@@ -18660,13 +18831,23 @@ export type GatewayAuthenticationData =
   io.flow.v0.unions.GatewayAuthenticationData;
 export type GatewayAuthenticationDataForm =
   io.flow.v0.unions.GatewayAuthenticationDataForm;
+export type GeCatalogItemIngestionResponse =
+  io.flow.v0.enums.GeCatalogItemIngestionResponse;
+export type GeCatalogItemIngestionResult =
+  io.flow.v0.models.GeCatalogItemIngestionResult;
+export type GeCatalogItemInput = io.flow.v0.models.GeCatalogItemInput;
+export type GeEnvironment = io.flow.v0.enums.GeEnvironment;
+export type GeEventType = io.flow.v0.enums.GeEventType;
+export type GeInputAttributes = io.flow.v0.models.GeInputAttributes;
+export type GeInputPrice = io.flow.v0.models.GeInputPrice;
 export type GeItemDeleted = io.flow.v0.models.GeItemDeleted;
 export type GeItemInserted = io.flow.v0.models.GeItemInserted;
 export type GeItemUpdated = io.flow.v0.models.GeItemUpdated;
-export type GeProductRestrictionResultDeleted =
-  io.flow.v0.models.GeProductRestrictionResultDeleted;
-export type GeProductRestrictionResultUpserted =
-  io.flow.v0.models.GeProductRestrictionResultUpserted;
+export type GeProductRestrictionResultDelete =
+  io.flow.v0.models.GeProductRestrictionResultDelete;
+export type GeProductRestrictionResultUpsert =
+  io.flow.v0.models.GeProductRestrictionResultUpsert;
+export type GeRestrictionEvent = io.flow.v0.unions.GeRestrictionEvent;
 export type GenerateLoad = io.flow.v0.models.GenerateLoad;
 export type GenericError = io.flow.v0.models.GenericError;
 export type GenericErrorCode = io.flow.v0.enums.GenericErrorCode;
@@ -19216,6 +19397,8 @@ export type PaymentError = io.flow.v0.models.PaymentError;
 export type PaymentErrorCode = io.flow.v0.enums.PaymentErrorCode;
 export type PaymentFailure = io.flow.v0.models.PaymentFailure;
 export type PaymentFailureCode = io.flow.v0.enums.PaymentFailureCode;
+export type PaymentFee = io.flow.v0.models.PaymentFee;
+export type PaymentFeeType = io.flow.v0.enums.PaymentFeeType;
 export type PaymentForm = io.flow.v0.unions.PaymentForm;
 export type PaymentInformation = io.flow.v0.models.PaymentInformation;
 export type PaymentMethod = io.flow.v0.models.PaymentMethod;