@flowio/api-types 0.0.260 → 0.0.262

package/generated/io.flow.label.v0.label.d.ts

@@ -1,4 +1,5 @@
 declare namespace io.flow.label.v0.enums {
+  type CommercialInvoiceMode = 'direct' | 'indirect';
   type CostEstimateSource = 'flow' | 'channel';
   type Direction = 'outbound' | 'return';
   type LabelRequestMethod = 'flow_web_sync' | 'channel_web_async' | 'direct_api_sync' | 'direct_api_async' | 'bridge_api_sync' | 'partner_api_sync' | 'notification_requiring_crossdock' | 'flow_simulation_sync' | 'autogenerated';

package/generated/io.flow.merchant.onboarding.v0.merchant-onboarding.d.ts

@@ -6,6 +6,77 @@ declare namespace io.flow.merchant.onboarding.v0.enums {
 }
 
 declare namespace io.flow.merchant.onboarding.v0.models {
+  interface CommonMerchantApplication {
+    readonly 'discriminator': 'common_merchant_application';
+    readonly 'id': string;
+    readonly 'organization_id': string;
+    readonly 'organization_reference': io.flow.merchant.onboarding.v0.models.OnboardingOrganizationReference;
+    readonly 'status': io.flow.merchant.onboarding.v0.enums.OnboardingApplicationStatus;
+    readonly 'company'?: io.flow.merchant.onboarding.v0.models.MerchantInfo;
+    readonly 'indirect_tax'?: io.flow.merchant.onboarding.v0.models.IndirectTax;
+    readonly 'ultimate_beneficiary_owner'?: io.flow.merchant.onboarding.v0.models.UltimateBeneficiaryOwner;
+    readonly 'business_url'?: string;
+    readonly 'business_description'?: string;
+    readonly 'business_address'?: io.flow.common.v0.models.Address;
+    readonly 'refund_percentage'?: number;
+    readonly 'chargeback_percentage'?: number;
+    readonly 'beneficiary_details'?: io.flow.merchant.onboarding.v0.models.MerchantOnboardingBeneficiaryDetails;
+    readonly 'other_trade_sector'?: string;
+    readonly 'center_contact'?: io.flow.merchant.onboarding.v0.models.OperationsContact;
+    readonly 'center_address'?: io.flow.common.v0.models.Address;
+    readonly 'average_order_weight'?: number;
+    readonly 'average_order_weight_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
+    readonly 'package_dimensions'?: io.flow.common.v0.models.Dimension[];
+    readonly 'monthly_average'?: io.flow.merchant.onboarding.v0.models.MonthlyAverage;
+    readonly 'default_country_of_origin'?: string;
+    readonly 'rate_card': string;
+    readonly 'shop'?: io.flow.merchant.onboarding.v0.models.Shop;
+    readonly 'created_at': string;
+    readonly 'last_year_xborder_gmv'?: io.flow.common.v0.models.Money;
+    readonly 'last_month_xborder_gmv'?: io.flow.common.v0.models.Money;
+    readonly 'average_order_value'?: io.flow.common.v0.models.Money;
+    readonly 'mcc_codes'?: number[];
+  }
+
+  interface CommonMerchantApplicationForm {
+    readonly 'discriminator': 'common_merchant_application_form';
+    readonly 'company'?: io.flow.merchant.onboarding.v0.models.MerchantInfo;
+    readonly 'indirect_tax'?: io.flow.merchant.onboarding.v0.models.IndirectTax;
+    readonly 'ultimate_beneficiary_owner'?: io.flow.merchant.onboarding.v0.models.UltimateBeneficiaryOwner;
+    readonly 'business_url'?: string;
+    readonly 'business_description'?: string;
+    readonly 'business_address'?: io.flow.common.v0.models.Address;
+    readonly 'refund_percentage'?: number;
+    readonly 'chargeback_percentage'?: number;
+    readonly 'beneficiary_details'?: io.flow.merchant.onboarding.v0.models.MerchantOnboardingBeneficiaryDetails;
+    readonly 'other_trade_sector'?: string;
+    readonly 'center_contact'?: io.flow.merchant.onboarding.v0.models.OperationsContact;
+    readonly 'center_address'?: io.flow.common.v0.models.Address;
+    readonly 'average_order_weight'?: number;
+    readonly 'average_order_weight_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
+    readonly 'package_dimensions'?: io.flow.common.v0.models.Dimension[];
+    readonly 'monthly_average_volume_amount'?: number;
+    readonly 'monthly_average_volume_currency'?: string;
+    readonly 'monthly_average_number_transactions'?: number;
+    readonly 'default_country_of_origin'?: string;
+    readonly 'shop'?: io.flow.merchant.onboarding.v0.models.Shop;
+    readonly 'rate_card'?: string;
+    readonly 'last_year_xborder_gmv'?: io.flow.common.v0.models.Money;
+    readonly 'last_month_xborder_gmv'?: io.flow.common.v0.models.Money;
+    readonly 'average_order_value'?: io.flow.common.v0.models.Money;
+    readonly 'mcc_codes'?: number[];
+  }
+
+  interface CommonMerchantApplicationPutForm {
+    readonly 'discriminator': 'common_merchant_application_put_form';
+    readonly 'status'?: io.flow.merchant.onboarding.v0.enums.OnboardingApplicationStatus;
+  }
+
+  interface CommonMerchantApplicationsSummary {
+    readonly 'discriminator': 'common_merchant_applications_summary';
+    readonly 'total': number;
+  }
+
   interface IndirectTax {
     readonly 'number'?: string;
     readonly 'id'?: string;
@@ -22,6 +93,7 @@ declare namespace io.flow.merchant.onboarding.v0.models {
     readonly 'region'?: io.flow.merchant.onboarding.v0.enums.RegionType;
     readonly 'region_value'?: string;
     readonly 'category_code'?: string;
+    readonly 'description'?: string;
   }
 
   interface MerchantOnboardingAddress {
@@ -33,6 +105,17 @@ declare namespace io.flow.merchant.onboarding.v0.models {
     readonly 'country'?: string;
   }
 
+  interface MerchantOnboardingBeneficiaryDetails {
+    readonly 'name'?: string;
+    readonly 'address'?: io.flow.common.v0.models.Address;
+    readonly 'phone'?: string;
+    readonly 'email'?: string;
+    readonly 'bank_account_number'?: string;
+    readonly 'bank_routing_number'?: string;
+    readonly 'bank_name'?: string;
+    readonly 'bank_address'?: io.flow.common.v0.models.Address;
+  }
+
   interface MonthlyAverage {
     readonly 'volume'?: io.flow.merchant.onboarding.v0.models.MonthlyAverageVolume;
     readonly 'number_transactions'?: number;
@@ -97,6 +180,7 @@ declare namespace io.flow.merchant.onboarding.v0.models {
     readonly 'third_party_logistics_partners'?: io.flow.merchant.onboarding.v0.models.ThirdPartyLogisticsPartner[];
     readonly 'center_contact'?: io.flow.merchant.onboarding.v0.models.OperationsContact;
     readonly 'average_order_weight'?: number;
+    readonly 'average_order_weight_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
     readonly 'package_dimensions'?: io.flow.common.v0.models.Dimension[];
     readonly 'monthly_average'?: io.flow.merchant.onboarding.v0.models.MonthlyAverage;
     readonly 'default_country_of_origin'?: string;
@@ -130,6 +214,7 @@ declare namespace io.flow.merchant.onboarding.v0.models {
     readonly 'third_party_logistics_partners'?: io.flow.merchant.onboarding.v0.models.ThirdPartyLogisticsPartner[];
     readonly 'center_contact'?: io.flow.merchant.onboarding.v0.models.OperationsContact;
     readonly 'average_order_weight'?: number;
+    readonly 'average_order_weight_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
     readonly 'package_dimensions'?: io.flow.common.v0.models.Dimension[];
     readonly 'monthly_average_volume_amount'?: number;
     readonly 'monthly_average_volume_currency'?: string;
@@ -170,8 +255,8 @@ declare namespace io.flow.merchant.onboarding.v0.models {
 }
 
 declare namespace io.flow.merchant.onboarding.v0.unions {
-  type MerchantApplication = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplication);
-  type MerchantApplicationForm = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationForm);
-  type MerchantApplicationPutForm = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationPutForm);
-  type MerchantApplicationsSummary = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationsSummary);
+  type MerchantApplication = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplication | io.flow.merchant.onboarding.v0.models.CommonMerchantApplication);
+  type MerchantApplicationForm = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationForm | io.flow.merchant.onboarding.v0.models.CommonMerchantApplicationForm);
+  type MerchantApplicationPutForm = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationPutForm | io.flow.merchant.onboarding.v0.models.CommonMerchantApplicationPutForm);
+  type MerchantApplicationsSummary = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationsSummary | io.flow.merchant.onboarding.v0.models.CommonMerchantApplicationsSummary);
 }

package/generated/io.flow.organization.v0.organization.d.ts

@@ -110,6 +110,22 @@ declare namespace io.flow.organization.v0.models {
     readonly 'status'?: io.flow.common.v0.enums.OrganizationStatus;
   }
 
+  interface OrganizationTaxRegistration {
+    readonly 'id': string;
+    readonly 'organization': io.flow.common.v0.models.OrganizationSummary;
+    readonly 'address': io.flow.common.v0.models.BillingAddress;
+    readonly 'registration': io.flow.organization.v0.models.TaxRegistrationDetail;
+    readonly 'self_billing_agreement': io.flow.organization.v0.models.SelfBillingAgreement;
+  }
+
+  interface OrganizationTaxRegistrationForm {
+    readonly 'tax_number': string;
+    readonly 'country': string;
+    readonly 'province'?: string;
+    readonly 'self_billing_agreement_effective_at': string;
+    readonly 'self_billing_agreement_expires_at'?: string;
+  }
+
   interface OrganizationVersion {
     readonly 'id': string;
     readonly 'timestamp': string;
@@ -126,4 +142,16 @@ declare namespace io.flow.organization.v0.models {
   interface RegionSettingForm {
     readonly 'status': io.flow.common.v0.enums.AvailabilityStatus;
   }
+
+  interface SelfBillingAgreement {
+    readonly 'effective_at': string;
+    readonly 'expires_at': string;
+  }
+
+  interface TaxRegistrationDetail {
+    readonly 'tax_number': string;
+    readonly 'country': string;
+    readonly 'tax_code': string;
+    readonly 'province'?: string;
+  }
 }

package/generated/io.flow.payment.gateway.v0.payment-gateway.d.ts

@@ -614,6 +614,7 @@ declare namespace io.flow.payment.gateway.v0.models {
     readonly 'supported_actions': io.flow.payment.gateway.v0.enums.PaymentActionType[];
     readonly 'payment_capture_option'?: io.flow.payment.gateway.v0.unions.PaymentCaptureOption;
     readonly 'review'?: io.flow.payment.gateway.v0.models.PaymentRequestReview;
+    readonly 'client_secret'?: string;
   }
 
   interface PaymentRequestCancellationReasonOrderMissing {

package/generated/io.flow.ratecard.v0.ratecard.d.ts

@@ -78,6 +78,7 @@ declare namespace io.flow.ratecard.v0.models {
     readonly 'amount': io.flow.common.v0.models.Money;
     readonly 'origin_region'?: io.flow.ratecard.v0.models.RatecardRegionReference;
     readonly 'destination_region'?: io.flow.ratecard.v0.models.RatecardRegionReference;
+    readonly 'destination_regions'?: io.flow.ratecard.v0.models.RatecardRegionReference[];
     readonly 'interval_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
   }
 
@@ -282,6 +283,7 @@ declare namespace io.flow.ratecard.v0.models {
     readonly 'center_id'?: string;
     readonly 'taxes_owed'?: io.flow.common.v0.models.Money;
     readonly 'duties_owed'?: io.flow.common.v0.models.Money;
+    readonly 'commercial_invoice_mode'?: io.flow.label.v0.enums.CommercialInvoiceMode;
   }
 
   interface RatecardEstimateSummaryForm {
@@ -501,6 +503,43 @@ declare namespace io.flow.ratecard.v0.models {
     readonly 'from': number;
     readonly 'to': number;
   }
+
+  interface ShippingRateEstimate {
+    readonly 'origin_address': io.flow.common.v0.models.Address;
+    readonly 'destination_address': io.flow.common.v0.models.Address;
+    readonly 'shipping_date_time': string;
+    readonly 'services': string[];
+    readonly 'available': io.flow.ratecard.v0.models.ShippingRateEstimateAvailable[];
+    readonly 'unavailable'?: io.flow.ratecard.v0.models.ShippingRateEstimateUnavailable[];
+  }
+
+  interface ShippingRateEstimateAvailable {
+    readonly 'service': io.flow.ratecard.v0.models.RatecardServiceSummary;
+    readonly 'delivered_duty': io.flow.common.v0.enums.DeliveredDuty;
+    readonly 'shipment_window': io.flow.ratecard.v0.models.ShipmentWindow;
+    readonly 'total_amount': io.flow.common.v0.models.Money;
+    readonly 'base_amount': io.flow.common.v0.models.Money;
+    readonly 'fees': io.flow.ratecard.v0.unions.RatecardFee[];
+    readonly 'dimensional_weight'?: io.flow.common.v0.models.Measurement;
+    readonly 'gravitational_weight'?: io.flow.common.v0.models.Measurement;
+    readonly 'weight_break'?: number;
+  }
+
+  interface ShippingRateEstimateRequest {
+    readonly 'origin_address': io.flow.common.v0.models.Address;
+    readonly 'destination_address': io.flow.common.v0.models.Address;
+    readonly 'package_dimensions': io.flow.common.v0.models.Dimension;
+    readonly 'shipping_date_time': string;
+    readonly 'delivered_duty'?: io.flow.common.v0.enums.DeliveredDuty;
+    readonly 'duties_owed'?: io.flow.common.v0.models.Money;
+    readonly 'taxes_owed'?: io.flow.common.v0.models.Money;
+    readonly 'line_items'?: io.flow.common.v0.models.LineItemForm[];
+  }
+
+  interface ShippingRateEstimateUnavailable {
+    readonly 'service': string;
+    readonly 'reason': string;
+  }
 }
 
 declare namespace io.flow.ratecard.v0.unions {

package/generated/io.flow.restrictions.v0.restrictions.d.ts

@@ -0,0 +1,40 @@
+declare namespace io.flow.restrictions.v0.enums {
+  type RestrictedReviewStatus = 'in_review' | 'reviewed';
+  type RestrictionEnvironment = 'sandbox' | 'production' | 'qa';
+  type ReviewStatus = 'high_risk_in_review' | 'low_risk_in_review' | 'reviewed';
+}
+
+declare namespace io.flow.restrictions.v0.models {
+  interface CarrierRestrictions {
+    readonly 'carrier': string;
+    readonly 'regions': string[];
+  }
+
+  interface NeedsActionAttributes {
+    readonly 'reason_code': string;
+    readonly 'category_metafield_handles': string[];
+    readonly 'require_msds'?: boolean;
+  }
+
+  interface ProductRestrictionResult {
+    readonly 'id': string;
+    readonly 'product_id': string;
+    readonly 'item_numbers': string[];
+    readonly 'prohibited_regions': string[];
+    readonly 'sellability_restricted_regions'?: string[];
+    readonly 'reasons_per_region'?: io.flow.restrictions.v0.models.ReasonsPerRegion[];
+    readonly 'review_status'?: io.flow.restrictions.v0.enums.ReviewStatus;
+    readonly 'rules'?: string[];
+    readonly 'updated_by'?: string;
+    readonly 'product_restriction_id'?: string;
+    readonly 'hs_code'?: string;
+    readonly 'restricted_regions_by_type'?: io.flow.sellability.v0.models.SellabilityRegionResult[];
+    readonly 'needs_action_attributes'?: io.flow.restrictions.v0.models.NeedsActionAttributes[];
+  }
+
+  interface ReasonsPerRegion {
+    readonly 'region': string;
+    readonly 'reasons': string[];
+    readonly 'review_status': io.flow.restrictions.v0.enums.RestrictedReviewStatus;
+  }
+}

package/generated/io.flow.sellability.v0.sellability.d.ts

@@ -2,6 +2,9 @@ declare namespace io.flow.sellability.v0.enums {
   type RuleEffectType = 'market' | 'dhl' | 'dhl_ecommerce' | 'ups';
   type SellabilityErrorCode = 'insufficient_details' | 'ineligible_category' | 'wait_for_high_fidelity' | 'external_service_unavailable';
   type SellabilityRequestStatus = 'commit';
+  type SellabilityResultErrorCode = 'insufficient_details' | 'generic_error';
+  type SellabilityResultStatus = 'in_review' | 'succeeded' | 'failed';
+  type SellabilityScreeningMode = 'pre_onboarding' | 'default_on' | 'active';
 }
 
 declare namespace io.flow.sellability.v0.models {
@@ -11,10 +14,11 @@ declare namespace io.flow.sellability.v0.models {
     readonly 'product_id'?: string;
     readonly 'request_id': string;
     readonly 'hs6_code': string;
-    readonly 'restricted_regions': io.flow.sellability.v0.models.SellablilityRegionResult[];
+    readonly 'restricted_regions': io.flow.sellability.v0.models.SellabilityRegionResult[];
   }
 
   interface ProductSellabilityForm {
+    readonly 'discriminator': 'product_sellability_form';
     readonly 'shop_id': string;
     readonly 'product_id'?: string;
     readonly 'name': string;
@@ -25,12 +29,64 @@ declare namespace io.flow.sellability.v0.models {
     readonly 'dry_run'?: boolean;
   }
 
+  interface ProductSellabilityResult {
+    readonly 'merchant_id'?: string;
+    readonly 'product_id': string;
+    readonly 'restricted_regions': io.flow.sellability.v0.models.SellabilityRestrictedRegion[];
+    readonly 'needs_action_attributes'?: io.flow.sellability.v0.models.SellabilityNeedsActionAttributes[];
+    readonly 'request_id'?: string;
+  }
+
   interface SellabilityError {
     readonly 'discriminator': 'sellability_error';
     readonly 'code': io.flow.sellability.v0.enums.SellabilityErrorCode;
     readonly 'messages': string[];
   }
 
+  interface SellabilityNeedsActionAttributes {
+    readonly 'reason_code': string;
+    readonly 'category_metafield_handles': string[];
+    readonly 'require_msds'?: boolean;
+  }
+
+  interface SellabilityRegionResult {
+    readonly 'type': io.flow.sellability.v0.enums.RuleEffectType;
+    readonly 'regions': string[];
+  }
+
+  interface SellabilityRegionWithReasons {
+    readonly 'region': string;
+    readonly 'reasons': string[];
+  }
+
+  interface SellabilityRestrictedRegion {
+    readonly 'type': io.flow.sellability.v0.enums.RuleEffectType;
+    readonly 'regions_with_reasons': io.flow.sellability.v0.models.SellabilityRegionWithReasons[];
+  }
+
+  interface SellabilityScreening {
+    readonly 'discriminator': 'sellability_screening';
+    readonly 'sellability_result'?: io.flow.sellability.v0.models.ProductSellabilityResult;
+    readonly 'request_id': string;
+    readonly 'status': io.flow.sellability.v0.enums.SellabilityResultStatus;
+    readonly 'error_code'?: io.flow.sellability.v0.enums.SellabilityResultErrorCode;
+    readonly 'error_message'?: string;
+  }
+
+  interface SellabilityScreeningForm {
+    readonly 'discriminator': 'sellability_screening_form';
+    readonly 'merchant_id': string;
+    readonly 'product_id': string;
+    readonly 'name': string;
+    readonly 'price': io.flow.common.v0.models.Money;
+    readonly 'description': string;
+    readonly 'taxonomy_category': io.flow.product.v0.models.ProductTaxonomyCategory;
+    readonly 'mode': io.flow.sellability.v0.enums.SellabilityScreeningMode;
+    readonly 'catalog_size'?: number;
+    readonly 'relative_ranking'?: number;
+    readonly 'dry_run'?: boolean;
+  }
+
   interface SellablilityRegionResult {
     readonly 'type': io.flow.sellability.v0.enums.RuleEffectType;
     readonly 'regions': string[];
@@ -38,5 +94,6 @@ declare namespace io.flow.sellability.v0.models {
 }
 
 declare namespace io.flow.sellability.v0.unions {
-  type SellabilityResponse = (io.flow.sellability.v0.models.ProductSellability | io.flow.sellability.v0.models.SellabilityError);
+  type SellabilityRequest = (io.flow.sellability.v0.models.ProductSellabilityForm | io.flow.sellability.v0.models.SellabilityScreeningForm);
+  type SellabilityResponse = (io.flow.sellability.v0.models.ProductSellability | io.flow.sellability.v0.models.SellabilityError | io.flow.sellability.v0.models.SellabilityScreening);
 }

package/generated/io.flow.shopify.markets.internal.v0.shopify-markets-internal.d.ts

@@ -160,6 +160,14 @@ declare namespace io.flow.shopify.markets.internal.v0.models {
     readonly 'shopify': io.flow.shopify.markets.internal.v0.models.ShopifyMarketsShopifyOrderMetrics;
     readonly 'internal': io.flow.shopify.markets.internal.v0.models.ShopifyMarketsInternalOrderMetrics;
     readonly 'discrepancy_data': io.flow.shopify.markets.internal.v0.models.ShopifyMarketsDiscrepancyData;
+    readonly 'organization_metrics'?: io.flow.shopify.markets.internal.v0.models.ShopifyMarketsOrganizationOrderMetrics[];
+  }
+
+  interface ShopifyMarketsOrganizationOrderMetrics {
+    readonly 'organization_id': string;
+    readonly 'shopify_order_count': number;
+    readonly 'internal_order_count': number;
+    readonly 'discrepancy_count'?: number;
   }
 
   interface ShopifyMarketsQueuedRecord {

package/generated/io.flow.shopify.markets.v0.shopify-markets.d.ts

@@ -308,6 +308,7 @@ declare namespace io.flow.shopify.markets.v0.models {
     readonly 'metafields'?: io.flow.shopify.markets.v0.models.ShopifyOrderMetafield[];
     readonly 'merchant_of_record_app_id'?: number;
     readonly 'total_shipping_price_set'?: io.flow.shopify.markets.v0.models.ShopifyOrderMoneySet;
+    readonly 'current_shipping_price_set'?: io.flow.shopify.markets.v0.models.ShopifyOrderMoneySet;
     readonly 'total_tip_received'?: string;
   }