@flowio/api-types 0.0.224 → 0.0.225

package/generated/io.flow.organization.onboarding.state.v0.organization-onboarding-state.d.ts

@@ -11,6 +11,7 @@ declare namespace io.flow.organization.onboarding.state.v0.models {
 
   interface DeactivationPutForm {
     readonly 'reason': string;
+    readonly 'deactivate_at'?: string;
   }
 
   interface InComplianceReview {
@@ -26,6 +27,7 @@ declare namespace io.flow.organization.onboarding.state.v0.models {
   interface MerchantDeactivated {
     readonly 'discriminator': 'merchant_deactivated';
     readonly 'reason': string;
+    readonly 'deactivate_at'?: string;
   }
 
   interface MerchantDisabled {

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

@@ -189,6 +189,7 @@ declare namespace io.flow.payment.gateway.v0.models {
     readonly 'currency': string;
     readonly 'base_amount'?: number;
     readonly 'base_currency'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentAuthorizationStatus {
@@ -202,6 +203,7 @@ declare namespace io.flow.payment.gateway.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.payment.gateway.v0.models.PaymentCaptureStatus;
@@ -210,6 +212,7 @@ declare namespace io.flow.payment.gateway.v0.models {
   interface PaymentCaptureForm {
     readonly 'amount'?: number;
     readonly 'currency'?: string;
+    readonly 'reference'?: string;
     readonly 'attributes'?: Record<string, string>;
   }
 
@@ -325,6 +328,7 @@ declare namespace io.flow.payment.gateway.v0.models {
     readonly 'device_fingerprint_details': io.flow.payment.gateway.v0.unions.DeviceFingerprintDetails;
     readonly 'cvv'?: string;
     readonly 'stored_details_card'?: io.flow.payment.gateway.v0.unions.PaymentMethodStoredDetailsCard;
+    readonly 'reference'?: string;
   }
 
   interface PaymentMethodDataAuthorizeGooglepay {
@@ -360,42 +364,43 @@ declare namespace io.flow.payment.gateway.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 {
@@ -482,7 +487,7 @@ declare namespace io.flow.payment.gateway.v0.models {
   }
 
   interface PaymentOrderDetailsLineItem {
-    readonly 'id': string;
+    readonly 'id'?: string;
     readonly 'description': string;
     readonly 'quantity': number;
     readonly 'amount': number;
@@ -510,6 +515,7 @@ declare namespace io.flow.payment.gateway.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.payment.gateway.v0.models.PaymentRefundStatus;
@@ -518,6 +524,7 @@ declare namespace io.flow.payment.gateway.v0.models {
   interface PaymentRefundForm {
     readonly 'amount'?: number;
     readonly 'currency'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentRefundStatus {
@@ -584,6 +591,7 @@ declare namespace io.flow.payment.gateway.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.payment.gateway.v0.models.PaymentReversalStatus;
@@ -592,6 +600,7 @@ declare namespace io.flow.payment.gateway.v0.models {
   interface PaymentReversalForm {
     readonly 'amount'?: number;
     readonly 'currency'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentReversalStatus {

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

@@ -833,15 +833,6 @@ declare namespace io.flow.payment.internal.v0.models {
     readonly 'id': string;
     readonly 'description': string;
   }
-
-  interface VirtualCardProvider {
-    readonly 'id': string;
-    readonly 'organization_id': string;
-    readonly 'provider': string;
-    readonly 'attributes'?: Record<string, string>;
-    readonly 'created_at': string;
-    readonly 'updated_at': string;
-  }
 }
 
 declare namespace io.flow.payment.internal.v0.unions {

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

@@ -915,11 +915,6 @@ declare namespace io.flow.payment.v0.models {
     readonly 'virtual_card_capture': io.flow.payment.v0.models.VirtualCardCapture;
   }
 
-  interface VirtualCardForm {
-    readonly 'limit': io.flow.common.v0.models.Money;
-    readonly 'attributes'?: Record<string, string>;
-  }
-
   interface VirtualCardReference {
     readonly 'id': string;
   }

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

@@ -24,6 +24,7 @@ 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' | 'manual' | 'offsite' | 'express';
   type ShopifyTransactionErrorCode = 'incorrect_number' | 'invalid_number' | 'invalid_expiry_date' | 'invalid_cvc' | 'expired_card' | 'incorrect_cvc' | 'incorrect_zip' | 'incorrect_address' | 'card_declined' | 'processing_error' | 'call_issuer' | 'pick_up_card';
   type ShopifyTransactionStatus = 'pending' | 'failure' | 'success' | 'error';
@@ -172,7 +173,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;
@@ -784,6 +785,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;

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

@@ -45,6 +45,10 @@ declare namespace io.flow.shopify.markets.internal.v0.models {
     readonly 'flow_authorization'?: io.flow.payment.v0.unions.Authorization;
   }
 
+  interface MarketsOrderSummary {
+    readonly 'id': string;
+  }
+
   interface OrderValidationError {
     readonly 'message': string;
     readonly 'reason': io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceRejectionReason;
@@ -117,6 +121,7 @@ declare namespace io.flow.shopify.markets.internal.v0.models {
     readonly 'api_key_masked'?: string;
     readonly 'api_password_masked'?: string;
     readonly 'access_token_masked'?: string;
+    readonly 'shopify_plan_name'?: io.flow.shopify.external.v0.enums.ShopifyPlanName;
   }
 
   interface ShopifyMarketsShopForm {
@@ -127,6 +132,7 @@ declare namespace io.flow.shopify.markets.internal.v0.models {
     readonly 'api_key'?: string;
     readonly 'api_password'?: string;
     readonly 'access_token'?: string;
+    readonly 'shopify_plan_name'?: io.flow.shopify.external.v0.enums.ShopifyPlanName;
   }
 
   interface ShopifyMarketsShopSummary {

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

@@ -32,7 +32,7 @@ declare namespace io.flow.shopify.markets.v0.enums {
   type ShopifyOrderValueType = 'string' | 'integer';
   type ShopifyTaxExemptions = 'EXEMPT_ALL' | 'CA_STATUS_CARD_EXEMPTION' | 'CA_DIPLOMAT_EXEMPTION' | 'CA_BC_RESELLER_EXEMPTION' | 'CA_MB_RESELLER_EXEMPTION' | 'CA_SK_RESELLER_EXEMPTION' | 'CA_BC_COMMERCIAL_FISHERY_EXEMPTION' | 'CA_MB_COMMERCIAL_FISHERY_EXEMPTION' | 'CA_NS_COMMERCIAL_FISHERY_EXEMPTION' | 'CA_PE_COMMERCIAL_FISHERY_EXEMPTION' | 'CA_SK_COMMERCIAL_FISHERY_EXEMPTION' | 'CA_BC_PRODUCTION_AND_MACHINERY_EXEMPTION' | 'CA_SK_PRODUCTION_AND_MACHINERY_EXEMPTION' | 'CA_BC_SUB_CONTRACTOR_EXEMPTION' | 'CA_SK_SUB_CONTRACTOR_EXEMPTION' | 'CA_BC_CONTRACTOR_EXEMPTION' | 'CA_SK_CONTRACTOR_EXEMPTION' | 'CA_ON_PURCHASE_EXEMPTION' | 'CA_MB_FARMER_EXEMPTION' | 'CA_NS_FARMER_EXEMPTION' | 'CA_SK_FARMER_EXEMPTION';
   type ShopifyWebhookFormat = 'json' | 'xml';
-  type ShopifyWebhookTopic = 'customers/redact' | 'customers/data_request' | 'locations/create' | 'locations/update' | 'locations/delete' | 'order_transactions/create' | 'orders/cancelled' | 'orders/create' | 'orders/fulfilled' | 'orders/paid' | 'orders/partially_fulfilled' | 'orders/updated' | 'orders/delete' | 'orders/edited' | 'products/create' | 'products/delete' | 'products/update' | 'inventory_items/create' | 'inventory_items/update' | 'inventory_items/delete' | 'refunds/create' | 'fulfillment_events/create' | 'fulfillment_events/delete' | 'shop/redact' | 'themes/create' | 'themes/publish' | 'themes/update' | 'bulk_operations/finish';
+  type ShopifyWebhookTopic = 'customers/redact' | 'customers/data_request' | 'locations/create' | 'locations/update' | 'locations/delete' | 'order_transactions/create' | 'orders/cancelled' | 'orders/create' | 'orders/fulfilled' | 'orders/paid' | 'orders/partially_fulfilled' | 'orders/updated' | 'orders/delete' | 'orders/edited' | 'products/create' | 'products/delete' | 'products/update' | 'inventory_items/create' | 'inventory_items/update' | 'inventory_items/delete' | 'refunds/create' | 'fulfillment_events/create' | 'fulfillment_events/delete' | 'shop/redact' | 'themes/create' | 'themes/publish' | 'themes/update' | 'bulk_operations/finish' | 'shop/update';
 }
 
 declare namespace io.flow.shopify.markets.v0.models {

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

@@ -201,7 +201,7 @@ declare namespace io.flow.v0.enums {
   type TrackingStatus = 'label_created' | 'pending' | 'info_received' | 'picked_up' | 'in_transit' | 'out_for_delivery' | 'attempt_fail' | 'delivered' | 'exception' | 'returned' | 'expired';
   type TradeAgreementName = 'USMCA' | 'T-MEC' | 'CUSMA' | 'TCA';
   type TradeAgreementStatus = 'supported' | 'not_supported';
-  type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | 'carrier_charge' | 'carrier_charge_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
+  type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | 'carrier_charge' | 'carrier_charge_revenue_share' | 'carrier_fee' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
   type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
   type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction' | 'security' | 'eei_filing' | 'fixed_ddp' | 'fixed_currency_conversion';
   type UnitOfLength = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'meter';
@@ -2589,6 +2589,7 @@ declare namespace io.flow.v0.models {
 
   interface DeactivationPutForm {
     readonly 'reason': string;
+    readonly 'deactivate_at'?: string;
   }
 
   interface DeadWeight {
@@ -5174,6 +5175,7 @@ declare namespace io.flow.v0.models {
   interface MerchantDeactivated {
     readonly 'discriminator': 'merchant_deactivated';
     readonly 'reason': string;
+    readonly 'deactivate_at'?: string;
   }
 
   interface MerchantDisabled {
@@ -6517,6 +6519,7 @@ declare namespace io.flow.v0.models {
     readonly 'currency': string;
     readonly 'base_amount'?: number;
     readonly 'base_currency'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentAuthorizationStatus {
@@ -6530,6 +6533,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;
@@ -6538,6 +6542,7 @@ declare namespace io.flow.v0.models {
   interface PaymentCaptureForm {
     readonly 'amount'?: number;
     readonly 'currency'?: string;
+    readonly 'reference'?: string;
     readonly 'attributes'?: Record<string, string>;
   }
 
@@ -6686,6 +6691,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 {
@@ -6721,42 +6727,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 {
@@ -6876,7 +6883,7 @@ declare namespace io.flow.v0.models {
   }
 
   interface PaymentOrderDetailsLineItem {
-    readonly 'id': string;
+    readonly 'id'?: string;
     readonly 'description': string;
     readonly 'quantity': number;
     readonly 'amount': number;
@@ -6964,6 +6971,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;
@@ -6972,6 +6980,7 @@ declare namespace io.flow.v0.models {
   interface PaymentRefundForm {
     readonly 'amount'?: number;
     readonly 'currency'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentRefundStatus {
@@ -7079,6 +7088,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;
@@ -7087,6 +7097,7 @@ declare namespace io.flow.v0.models {
   interface PaymentReversalForm {
     readonly 'amount'?: number;
     readonly 'currency'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentReversalStatus {
@@ -7535,7 +7546,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 {
@@ -10074,11 +10085,18 @@ 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;
+    readonly 'outbound'?: io.flow.v0.models.TransactionMetadataOutboundTransaction;
   }
 
-  interface TransactionMetadataCarrierChargeOutbound {
-    readonly 'transaction_id': string;
+  interface TransactionMetadataCarrierFee {
+    readonly 'discriminator': 'carrier_fee';
+    readonly 'outbound': io.flow.v0.models.TransactionMetadataOutboundTransaction;
+    readonly 'estimate': io.flow.v0.models.TransactionMetadataCarrierFeeData;
+    readonly 'actual': io.flow.v0.models.TransactionMetadataCarrierFeeData;
+  }
+
+  interface TransactionMetadataCarrierFeeData {
+    readonly 'surcharges': io.flow.v0.models.TrueupLabelSurcharge[];
   }
 
   interface TransactionMetadataChannel {
@@ -10108,6 +10126,15 @@ declare namespace io.flow.v0.models {
     readonly 'id': string;
   }
 
+  interface TransactionMetadataOutboundTransaction {
+    readonly 'transaction_id': string;
+  }
+
+  interface TransactionMetadataPaymentTransaction {
+    readonly 'discriminator': 'payment_transaction';
+    readonly 'key'?: string;
+  }
+
   interface TransactionMetadataShippingLabel {
     readonly 'discriminator': 'shipping_label';
     readonly 'request_method'?: io.flow.v0.enums.LabelRequestMethod;
@@ -10287,11 +10314,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;
   }
@@ -10526,5 +10548,5 @@ declare namespace io.flow.v0.unions {
   type Token = (io.flow.v0.models.ChannelToken | io.flow.v0.models.OrganizationToken | io.flow.v0.models.OrganizationTokenV2 | io.flow.v0.models.PartnerToken);
   type TokenReference = (io.flow.v0.models.ChannelTokenReference | io.flow.v0.models.OrganizationTokenReference | io.flow.v0.models.OrganizationTokenV2Reference | io.flow.v0.models.PartnerTokenReference);
   type TransactionDetails = (io.flow.v0.models.TransactionDetailsCard);
-  type TransactionMetadata = (io.flow.v0.models.TransactionMetadataShippingLabel | io.flow.v0.models.TransactionMetadataChannel | io.flow.v0.models.TransactionMetadataTrueup | io.flow.v0.models.TransactionMetadataCarrierCharge | io.flow.v0.models.TransactionMetadataManual);
+  type TransactionMetadata = (io.flow.v0.models.TransactionMetadataShippingLabel | io.flow.v0.models.TransactionMetadataChannel | io.flow.v0.models.TransactionMetadataTrueup | io.flow.v0.models.TransactionMetadataCarrierCharge | io.flow.v0.models.TransactionMetadataCarrierFee | io.flow.v0.models.TransactionMetadataManual | io.flow.v0.models.TransactionMetadataPaymentTransaction);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowio/api-types",
-  "version": "0.0.224",
+  "version": "0.0.225",
   "description": "Global TypeScript typings for Flow Commerce API",
   "repository": {
     "type": "git",
@@ -14,5 +14,5 @@
   "scripts": {
     "generate": "apibuilder update && node scripts/generate-index.js"
   },
-  "gitHead": "ff49ab933b35b85abe4cb678cd3e1d799b67cdcf"
+  "gitHead": "237a816e178ccd4501b30aaf454fb6a93392afd9"
 }