@flowio/api-internal-prop-types 9.12.4 → 9.14.0

package/lib/api-internal.d.ts

@@ -273,6 +273,8 @@ declare namespace io.flow.experience.v0.enums {
   type ExperienceStatus = 'draft' | 'active' | 'archiving' | 'archived';
   type OrderErrorCode = 'generic_error' | 'order_item_not_available' | 'order_identifier_error' | 'authorization_invalid' | 'domestic_shipping_unavailable' | 'shipping_unavailable' | 'value_threshold_exceeded' | 'invalid_currency' | 'invalid_country' | 'invalid_region' | 'invalid_language' | 'item_out_of_stock' | 'gift_card_not_accepted' | 'total_changed';
   type OrderPaymentType = 'card' | 'online' | 'credit' | 'installment_plan' | 'cash_on_delivery';
+  type OrderRefundSummaryIncludes = 'duties' | 'vat' | 'shipping';
+  type OrderRefundSummaryPartialCharged = 'per_item' | 'for_order' | 'by_value_percentage' | 'by_quantity_percentage';
   type OrderStatus = 'open' | 'submitted';
   type OrderStorage = 'do_not_persist' | 'persist';
   type OrganizationPaymentMethodTag = 'deny';
@@ -1031,6 +1033,42 @@ declare namespace io.flow.experience.v0.models {
     readonly 'number': string;
   }
 
+  interface OrderRefundSummary {
+    readonly 'currency': string;
+    readonly 'amounts': io.flow.experience.v0.models.OrderRefundSummaryAmounts;
+  }
+
+  interface OrderRefundSummaryAmounts {
+    readonly 'balance': number;
+    readonly 'item_subtotal': number;
+    readonly 'discount'?: number;
+    readonly 'refund_total': number;
+    readonly 'shipping': number;
+    readonly 'vat': number;
+    readonly 'duty': number;
+  }
+
+  interface OrderRefundSummaryFullForm {
+    readonly 'discriminator': 'order_refund_summary_full_form';
+    readonly 'includes': io.flow.experience.v0.enums.OrderRefundSummaryIncludes[];
+  }
+
+  interface OrderRefundSummaryItem {
+    readonly 'number': string;
+    readonly 'quantity_to_refund': number;
+  }
+
+  interface OrderRefundSummaryPartialForm {
+    readonly 'discriminator': 'order_refund_summary_partial_form';
+    readonly 'includes': io.flow.experience.v0.models.OrderRefundSummaryPartialIncludes[];
+    readonly 'items': io.flow.experience.v0.models.OrderRefundSummaryItem[];
+  }
+
+  interface OrderRefundSummaryPartialIncludes {
+    readonly 'key': io.flow.experience.v0.enums.OrderRefundSummaryIncludes;
+    readonly 'charged': io.flow.experience.v0.enums.OrderRefundSummaryPartialCharged;
+  }
+
   interface OrderRuleReference {
     readonly 'id': string;
     readonly 'key': string;
@@ -1210,6 +1248,7 @@ declare namespace io.flow.experience.v0.unions {
   type OrderNumberGenerator = (io.flow.experience.v0.models.OrderNumberGeneratorUuid | io.flow.experience.v0.models.OrderNumberGeneratorHexadecimal | io.flow.experience.v0.models.OrderNumberGeneratorPrefixSuffix);
   type OrderPromotion = (io.flow.experience.v0.models.FreeShippingOrderPromotion);
   type OrderPromotionForm = (io.flow.experience.v0.models.FreeShippingOrderPromotionForm);
+  type OrderRefundSummaryForm = (io.flow.experience.v0.models.OrderRefundSummaryFullForm | io.flow.experience.v0.models.OrderRefundSummaryPartialForm);
 
   type PaymentMethodTag = ({
     discriminator: 'organization_payment_method_tag',
@@ -1581,64 +1620,6 @@ declare namespace io.flow.shopify.xborder.v0.models {
     readonly 'orders': io.flow.shopify.xborder.v0.models.ShopifyOrder[];
   }
 
-  interface ShopifyWebhookOrder {
-    readonly 'id': number;
-    readonly 'order_number': number;
-    readonly 'billing_address'?: io.flow.shopify.xborder.v0.models.ShopifyOrderAddress;
-    readonly 'browser_ip'?: string;
-    readonly 'buyer_accepts_marketing': boolean;
-    readonly 'cancel_reason'?: io.flow.shopify.xborder.v0.enums.ShopifyOrderCancelReason;
-    readonly 'cancelled_at'?: string;
-    readonly 'cart_token'?: string;
-    readonly 'client_details'?: io.flow.shopify.xborder.v0.models.ShopifyOrderClientDetail;
-    readonly 'closed_at'?: string;
-    readonly 'created_at': string;
-    readonly 'currency': string;
-    readonly 'total_discounts_set': io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
-    readonly 'total_duties_set'?: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
-    readonly 'original_total_duties_set'?: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
-    readonly 'total_price_set': io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
-    readonly 'subtotal_price_set': io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
-    readonly 'total_tax_set': io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
-    readonly 'total_line_items_price_set': io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
-    readonly 'customer': io.flow.shopify.xborder.v0.models.ShopifyOrderCustomer;
-    readonly 'customer_locale'?: string;
-    readonly 'discount_applications': io.flow.shopify.xborder.v0.models.ShopifyOrderDiscountApplication[];
-    readonly 'discount_codes': io.flow.shopify.xborder.v0.models.ShopifyOrderDiscountCode[];
-    readonly 'email'?: string;
-    readonly 'financial_status': io.flow.shopify.xborder.v0.enums.ShopifyOrderFinancialStatusType;
-    readonly 'fulfillments': io.flow.shopify.xborder.v0.models.ShopifyOrderFulfillment[];
-    readonly 'fulfillment_status'?: io.flow.shopify.xborder.v0.enums.ShopifyOrderFulfillmentStatusType;
-    readonly 'landing_site'?: string;
-    readonly 'line_items': io.flow.shopify.xborder.v0.models.ShopifyOrderLineItem[];
-    readonly 'location_id'?: number;
-    readonly 'name': string;
-    readonly 'note'?: string;
-    readonly 'note_attributes': io.flow.shopify.xborder.v0.models.ShopifyOrderAttribute[];
-    readonly 'number'?: number;
-    readonly 'payment_gateway_names': string[];
-    readonly 'processed_at'?: string;
-    readonly 'processing_method'?: io.flow.shopify.xborder.v0.enums.ShopifyOrderProcessingMethodType;
-    readonly 'referring_site'?: string;
-    readonly 'refunds': io.flow.shopify.xborder.v0.models.ShopifyOrderRefund[];
-    readonly 'shipping_address'?: io.flow.shopify.xborder.v0.models.ShopifyOrderAddress;
-    readonly 'shipping_lines'?: io.flow.shopify.xborder.v0.models.ShopifyOrderShippingLine[];
-    readonly 'source_name'?: string;
-    readonly 'tags'?: string;
-    readonly 'tax_lines': io.flow.shopify.xborder.v0.models.ShopifyOrderTaxLine[];
-    readonly 'taxes_included': boolean;
-    readonly 'token'?: string;
-    readonly 'total_weight'?: number;
-    readonly 'updated_at'?: string;
-    readonly 'user_id'?: number;
-    readonly 'order_status_url'?: string;
-    readonly 'inventory_behaviour'?: io.flow.shopify.xborder.v0.enums.ShopifyOrderInventoryBehaviour;
-    readonly 'gateway'?: string;
-    readonly 'transactions'?: io.flow.shopify.xborder.v0.models.ShopifyOrderTransaction[];
-    readonly 'send_receipt'?: boolean;
-    readonly 'metafields'?: io.flow.shopify.xborder.v0.models.ShopifyOrderMetafield[];
-  }
-
   interface ShopifyWebhookRequest {
     readonly 'topic': io.flow.shopify.xborder.v0.enums.ShopifyWebhookTopic;
     readonly 'address': string;
@@ -9467,11 +9448,15 @@ declare namespace io.flow.label.internal.v0.models {
     readonly 'id': string;
     readonly 'carrier': io.flow.fulfillment.v0.models.CarrierReference;
     readonly 'credentials': io.flow.tracking.internal.v0.unions.CarrierCredentials;
+    readonly 'q'?: string;
+    readonly 'position'?: number;
   }
 
   interface CarrierAccountForm {
     readonly 'carrier_id': string;
     readonly 'credentials': io.flow.tracking.internal.v0.unions.CarrierCredentials;
+    readonly 'q'?: string;
+    readonly 'position'?: number;
   }
 
   interface CarrierInvoice {
@@ -12196,6 +12181,7 @@ declare namespace io.flow.checkout.protocol.v0.enums {
   type CheckoutAddPaymentDetailsErrorCode = 'payment_failed' | 'authorization_form_not_supported' | 'authorization_invalid_amount' | 'authorization_invalid_currency' | 'authorization_amount_exceeds_balance' | 'address_street1_required';
   type CheckoutCreateAuthorizationDetailsErrorCode = 'checkout_not_found' | 'authorization_details_payment_not_found';
   type CheckoutCreateAuthorizationErrorCode = 'authorization_form_not_supported' | 'authorization_invalid_amount' | 'authorization_invalid_currency' | 'authorization_amount_exceeds_balance' | 'address_street1_required';
+  type CheckoutCreateBySessionByOrderErrorCode = 'session_not_found' | 'session_experience_required' | 'country_not_supported' | 'order_not_found';
   type CheckoutCreateBySessionErrorCode = 'session_not_found' | 'session_experience_required' | 'country_not_supported';
   type CheckoutDeleteAddressStreetErrorCode = 'address_line_number_invalid';
   type CheckoutDeleteLineErrorCode = 'line_not_found';
@@ -12295,6 +12281,15 @@ declare namespace io.flow.checkout.protocol.v0.models {
     readonly 'message': string;
   }
 
+  interface CheckoutCreateBySessionByOrderError {
+    readonly 'code': io.flow.checkout.protocol.v0.enums.CheckoutCreateBySessionByOrderErrorCode;
+    readonly 'message': string;
+  }
+
+  interface CheckoutCreateBySessionByOrderResponseError {
+    readonly 'errors': io.flow.checkout.protocol.v0.models.CheckoutCreateBySessionByOrderError[];
+  }
+
   interface CheckoutCreateBySessionError {
     readonly 'code': io.flow.checkout.protocol.v0.enums.CheckoutCreateBySessionErrorCode;
     readonly 'message': string;
@@ -14853,6 +14848,8 @@ declare namespace io.flow.checkout.backend.v0.enums {
 declare namespace io.flow.checkout.backend.v0.models {
   interface CheckoutAddress {
     readonly 'name'?: string;
+    readonly 'first_name'?: string;
+    readonly 'last_name'?: string;
     readonly 'country'?: string;
     readonly 'streets'?: string[];
     readonly 'city'?: string;
@@ -15271,6 +15268,10 @@ declare namespace io.flow.checkout.backend.v0.models {
     readonly 'deliveries': io.flow.checkout.backend.v0.models.CheckoutOrderDeliveries;
   }
 
+  interface CheckoutUrlParameters {
+    readonly 'confirmation_url'?: string;
+  }
+
   interface InternalAvailableDelivery {
     readonly 'id': string;
     readonly 'items': io.flow.fulfillment.v0.models.DeliveryItem[];
@@ -16073,7 +16074,7 @@ declare namespace io.flow.internal.v0.enums {
   type BillingStatementReviewStatus = 'approved' | 'pending';
   type BillingTransactionStatus = 'pending' | 'posted';
   type BillingTransactionType = 'manual' | 'subscription' | 'invoice' | 'transfer' | 'adjustment' | 'capture' | 'refund' | 'virtual_card_capture' | 'virtual_card_refund' | 'tax_remittance' | 'fully_subsidized_order' | 'credit_payment';
-  type BlazeCheckoutStep = 'contact' | 'shipping' | 'delivery' | 'payment';
+  type BlazeCheckoutStep = 'customer_info' | 'delivery' | 'payment';
   type BrowserBundleErrorCode = 'generic_error' | 'country_invalid';
   type CarrierLabelGenerationMethod = 'direct' | 'easypost';
   type CatalogImportType = 'catalog_items' | 'item_form_overlays' | 'item_prices' | 'price_book_items_import' | 'price_book_items_query_import';
@@ -16089,6 +16090,7 @@ declare namespace io.flow.internal.v0.enums {
   type CheckoutAssetType = 'stylesheet' | 'javascript';
   type CheckoutCreateAuthorizationDetailsErrorCode = 'checkout_not_found' | 'authorization_details_payment_not_found';
   type CheckoutCreateAuthorizationErrorCode = 'authorization_form_not_supported' | 'authorization_invalid_amount' | 'authorization_invalid_currency' | 'authorization_amount_exceeds_balance' | 'address_street1_required';
+  type CheckoutCreateBySessionByOrderErrorCode = 'session_not_found' | 'session_experience_required' | 'country_not_supported' | 'order_not_found';
   type CheckoutCreateBySessionErrorCode = 'session_not_found' | 'session_experience_required' | 'country_not_supported';
   type CheckoutDeleteAddressStreetErrorCode = 'address_line_number_invalid';
   type CheckoutDeleteLineErrorCode = 'line_not_found';
@@ -17229,11 +17231,15 @@ declare namespace io.flow.internal.v0.models {
     readonly 'id': string;
     readonly 'carrier': io.flow.fulfillment.v0.models.CarrierReference;
     readonly 'credentials': io.flow.tracking.internal.v0.unions.CarrierCredentials;
+    readonly 'q'?: string;
+    readonly 'position'?: number;
   }
 
   interface CarrierAccountForm {
     readonly 'carrier_id': string;
     readonly 'credentials': io.flow.tracking.internal.v0.unions.CarrierCredentials;
+    readonly 'q'?: string;
+    readonly 'position'?: number;
   }
 
   interface CarrierAccountUpserted {
@@ -17387,6 +17393,8 @@ declare namespace io.flow.internal.v0.models {
 
   interface CheckoutAddress {
     readonly 'name'?: string;
+    readonly 'first_name'?: string;
+    readonly 'last_name'?: string;
     readonly 'country'?: string;
     readonly 'streets'?: string[];
     readonly 'city'?: string;
@@ -17685,6 +17693,15 @@ declare namespace io.flow.internal.v0.models {
     readonly 'message': string;
   }
 
+  interface CheckoutCreateBySessionByOrderError {
+    readonly 'code': io.flow.internal.v0.enums.CheckoutCreateBySessionByOrderErrorCode;
+    readonly 'message': string;
+  }
+
+  interface CheckoutCreateBySessionByOrderResponseError {
+    readonly 'errors': io.flow.internal.v0.models.CheckoutCreateBySessionByOrderError[];
+  }
+
   interface CheckoutCreateBySessionError {
     readonly 'code': io.flow.internal.v0.enums.CheckoutCreateBySessionErrorCode;
     readonly 'message': string;
@@ -19097,6 +19114,10 @@ declare namespace io.flow.internal.v0.models {
     readonly 'type': io.flow.internal.v0.enums.CheckoutUrlType;
   }
 
+  interface CheckoutUrlParameters {
+    readonly 'confirmation_url'?: string;
+  }
+
   interface Cipher {
     readonly 'id': string;
     readonly 'attributes': Record<string, string>;
@@ -23761,6 +23782,16 @@ declare namespace io.flow.internal.v0.models {
     readonly 'organization_id': string;
     readonly 'shop': string;
     readonly 'created_at': string;
+    readonly 'api_key_masked': string;
+    readonly 'api_password_masked': string;
+    readonly 'shared_secret_masked': string;
+  }
+
+  interface ShopifyXborderShopForm {
+    readonly 'shop': string;
+    readonly 'api_key': string;
+    readonly 'api_password': string;
+    readonly 'shared_secret': string;
   }
 
   interface ShopifyCheckInventoryError {
@@ -25017,6 +25048,7 @@ export const checkoutAddressType: PropTypes.Requireable<io.flow.internal.v0.enum
 export const checkoutAssetType: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutAssetType>;
 export const checkoutCreateAuthorizationDetailsErrorCode: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutCreateAuthorizationDetailsErrorCode>;
 export const checkoutCreateAuthorizationErrorCode: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutCreateAuthorizationErrorCode>;
+export const checkoutCreateBySessionByOrderErrorCode: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutCreateBySessionByOrderErrorCode>;
 export const checkoutCreateBySessionErrorCode: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutCreateBySessionErrorCode>;
 export const checkoutDeleteAddressStreetErrorCode: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutDeleteAddressStreetErrorCode>;
 export const checkoutDeleteLineErrorCode: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutDeleteLineErrorCode>;
@@ -25382,6 +25414,8 @@ export const checkoutCreateAuthorizationDetailsRequestForm: PropTypes.Requireabl
 export const checkoutCreateAuthorizationDetailsResponseError: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateAuthorizationDetailsResponseError>;
 export const checkoutCreateAuthorizationDetailsResponseSuccess: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateAuthorizationDetailsResponseSuccess>;
 export const checkoutCreateAuthorizationError: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateAuthorizationError>;
+export const checkoutCreateBySessionByOrderError: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateBySessionByOrderError>;
+export const checkoutCreateBySessionByOrderResponseError: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateBySessionByOrderResponseError>;
 export const checkoutCreateBySessionError: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateBySessionError>;
 export const checkoutCreateBySessionRequestForm: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateBySessionRequestForm>;
 export const checkoutCreateBySessionResponseError: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateBySessionResponseError>;
@@ -25635,6 +25669,7 @@ export const checkoutSubmitOrderBundle: PropTypes.Requireable<io.flow.internal.v
 export const checkoutSubmitOrderForm: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutSubmitOrderForm>;
 export const checkoutSubmittedOrder: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutSubmittedOrder>;
 export const checkoutUrl: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutUrl>;
+export const checkoutUrlParameters: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutUrlParameters>;
 export const cipher: PropTypes.Requireable<io.flow.internal.v0.models.Cipher>;
 export const cipherForm: PropTypes.Requireable<io.flow.internal.v0.models.CipherForm>;
 export const cipherReference: PropTypes.Requireable<io.flow.internal.v0.models.CipherReference>;
@@ -26233,6 +26268,7 @@ export const shop: PropTypes.Requireable<io.flow.internal.v0.models.Shop>;
 export const shopForm: PropTypes.Requireable<io.flow.internal.v0.models.ShopForm>;
 export const shopVersion: PropTypes.Requireable<io.flow.internal.v0.models.ShopVersion>;
 export const shopifyXborderShop: PropTypes.Requireable<io.flow.internal.v0.models.ShopifyXborderShop>;
+export const shopifyXborderShopForm: PropTypes.Requireable<io.flow.internal.v0.models.ShopifyXborderShopForm>;
 export const shopifyCheckInventoryError: PropTypes.Requireable<io.flow.internal.v0.models.ShopifyCheckInventoryError>;
 export const shopifyCodeForm: PropTypes.Requireable<io.flow.internal.v0.models.ShopifyCodeForm>;
 export const shopifyExperienceShortId: PropTypes.Requireable<io.flow.internal.v0.models.ShopifyExperienceShortId>;