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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -273,6 +273,8 @@ declare namespace io.flow.experience.v0.enums {
273
273
  type ExperienceStatus = 'draft' | 'active' | 'archiving' | 'archived';
274
274
  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';
275
275
  type OrderPaymentType = 'card' | 'online' | 'credit' | 'installment_plan' | 'cash_on_delivery';
276
+ type OrderRefundSummaryIncludes = 'duties' | 'vat' | 'shipping';
277
+ type OrderRefundSummaryPartialCharged = 'per_item' | 'for_order' | 'by_value_percentage' | 'by_quantity_percentage';
276
278
  type OrderStatus = 'open' | 'submitted';
277
279
  type OrderStorage = 'do_not_persist' | 'persist';
278
280
  type OrganizationPaymentMethodTag = 'deny';
@@ -1031,6 +1033,42 @@ declare namespace io.flow.experience.v0.models {
1031
1033
  readonly 'number': string;
1032
1034
  }
1033
1035
 
1036
+ interface OrderRefundSummary {
1037
+ readonly 'currency': string;
1038
+ readonly 'amounts': io.flow.experience.v0.models.OrderRefundSummaryAmounts;
1039
+ }
1040
+
1041
+ interface OrderRefundSummaryAmounts {
1042
+ readonly 'balance': number;
1043
+ readonly 'item_subtotal': number;
1044
+ readonly 'discount'?: number;
1045
+ readonly 'refund_total': number;
1046
+ readonly 'shipping': number;
1047
+ readonly 'vat': number;
1048
+ readonly 'duty': number;
1049
+ }
1050
+
1051
+ interface OrderRefundSummaryFullForm {
1052
+ readonly 'discriminator': 'order_refund_summary_full_form';
1053
+ readonly 'includes': io.flow.experience.v0.enums.OrderRefundSummaryIncludes[];
1054
+ }
1055
+
1056
+ interface OrderRefundSummaryItem {
1057
+ readonly 'number': string;
1058
+ readonly 'quantity_to_refund': number;
1059
+ }
1060
+
1061
+ interface OrderRefundSummaryPartialForm {
1062
+ readonly 'discriminator': 'order_refund_summary_partial_form';
1063
+ readonly 'includes': io.flow.experience.v0.models.OrderRefundSummaryPartialIncludes[];
1064
+ readonly 'items': io.flow.experience.v0.models.OrderRefundSummaryItem[];
1065
+ }
1066
+
1067
+ interface OrderRefundSummaryPartialIncludes {
1068
+ readonly 'key': io.flow.experience.v0.enums.OrderRefundSummaryIncludes;
1069
+ readonly 'charged': io.flow.experience.v0.enums.OrderRefundSummaryPartialCharged;
1070
+ }
1071
+
1034
1072
  interface OrderRuleReference {
1035
1073
  readonly 'id': string;
1036
1074
  readonly 'key': string;
@@ -1210,6 +1248,7 @@ declare namespace io.flow.experience.v0.unions {
1210
1248
  type OrderNumberGenerator = (io.flow.experience.v0.models.OrderNumberGeneratorUuid | io.flow.experience.v0.models.OrderNumberGeneratorHexadecimal | io.flow.experience.v0.models.OrderNumberGeneratorPrefixSuffix);
1211
1249
  type OrderPromotion = (io.flow.experience.v0.models.FreeShippingOrderPromotion);
1212
1250
  type OrderPromotionForm = (io.flow.experience.v0.models.FreeShippingOrderPromotionForm);
1251
+ type OrderRefundSummaryForm = (io.flow.experience.v0.models.OrderRefundSummaryFullForm | io.flow.experience.v0.models.OrderRefundSummaryPartialForm);
1213
1252
 
1214
1253
  type PaymentMethodTag = ({
1215
1254
  discriminator: 'organization_payment_method_tag',
@@ -1581,64 +1620,6 @@ declare namespace io.flow.shopify.xborder.v0.models {
1581
1620
  readonly 'orders': io.flow.shopify.xborder.v0.models.ShopifyOrder[];
1582
1621
  }
1583
1622
 
1584
- interface ShopifyWebhookOrder {
1585
- readonly 'id': number;
1586
- readonly 'order_number': number;
1587
- readonly 'billing_address'?: io.flow.shopify.xborder.v0.models.ShopifyOrderAddress;
1588
- readonly 'browser_ip'?: string;
1589
- readonly 'buyer_accepts_marketing': boolean;
1590
- readonly 'cancel_reason'?: io.flow.shopify.xborder.v0.enums.ShopifyOrderCancelReason;
1591
- readonly 'cancelled_at'?: string;
1592
- readonly 'cart_token'?: string;
1593
- readonly 'client_details'?: io.flow.shopify.xborder.v0.models.ShopifyOrderClientDetail;
1594
- readonly 'closed_at'?: string;
1595
- readonly 'created_at': string;
1596
- readonly 'currency': string;
1597
- readonly 'total_discounts_set': io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1598
- readonly 'total_duties_set'?: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1599
- readonly 'original_total_duties_set'?: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1600
- readonly 'total_price_set': io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1601
- readonly 'subtotal_price_set': io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1602
- readonly 'total_tax_set': io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1603
- readonly 'total_line_items_price_set': io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1604
- readonly 'customer': io.flow.shopify.xborder.v0.models.ShopifyOrderCustomer;
1605
- readonly 'customer_locale'?: string;
1606
- readonly 'discount_applications': io.flow.shopify.xborder.v0.models.ShopifyOrderDiscountApplication[];
1607
- readonly 'discount_codes': io.flow.shopify.xborder.v0.models.ShopifyOrderDiscountCode[];
1608
- readonly 'email'?: string;
1609
- readonly 'financial_status': io.flow.shopify.xborder.v0.enums.ShopifyOrderFinancialStatusType;
1610
- readonly 'fulfillments': io.flow.shopify.xborder.v0.models.ShopifyOrderFulfillment[];
1611
- readonly 'fulfillment_status'?: io.flow.shopify.xborder.v0.enums.ShopifyOrderFulfillmentStatusType;
1612
- readonly 'landing_site'?: string;
1613
- readonly 'line_items': io.flow.shopify.xborder.v0.models.ShopifyOrderLineItem[];
1614
- readonly 'location_id'?: number;
1615
- readonly 'name': string;
1616
- readonly 'note'?: string;
1617
- readonly 'note_attributes': io.flow.shopify.xborder.v0.models.ShopifyOrderAttribute[];
1618
- readonly 'number'?: number;
1619
- readonly 'payment_gateway_names': string[];
1620
- readonly 'processed_at'?: string;
1621
- readonly 'processing_method'?: io.flow.shopify.xborder.v0.enums.ShopifyOrderProcessingMethodType;
1622
- readonly 'referring_site'?: string;
1623
- readonly 'refunds': io.flow.shopify.xborder.v0.models.ShopifyOrderRefund[];
1624
- readonly 'shipping_address'?: io.flow.shopify.xborder.v0.models.ShopifyOrderAddress;
1625
- readonly 'shipping_lines'?: io.flow.shopify.xborder.v0.models.ShopifyOrderShippingLine[];
1626
- readonly 'source_name'?: string;
1627
- readonly 'tags'?: string;
1628
- readonly 'tax_lines': io.flow.shopify.xborder.v0.models.ShopifyOrderTaxLine[];
1629
- readonly 'taxes_included': boolean;
1630
- readonly 'token'?: string;
1631
- readonly 'total_weight'?: number;
1632
- readonly 'updated_at'?: string;
1633
- readonly 'user_id'?: number;
1634
- readonly 'order_status_url'?: string;
1635
- readonly 'inventory_behaviour'?: io.flow.shopify.xborder.v0.enums.ShopifyOrderInventoryBehaviour;
1636
- readonly 'gateway'?: string;
1637
- readonly 'transactions'?: io.flow.shopify.xborder.v0.models.ShopifyOrderTransaction[];
1638
- readonly 'send_receipt'?: boolean;
1639
- readonly 'metafields'?: io.flow.shopify.xborder.v0.models.ShopifyOrderMetafield[];
1640
- }
1641
-
1642
1623
  interface ShopifyWebhookRequest {
1643
1624
  readonly 'topic': io.flow.shopify.xborder.v0.enums.ShopifyWebhookTopic;
1644
1625
  readonly 'address': string;
@@ -9467,11 +9448,15 @@ declare namespace io.flow.label.internal.v0.models {
9467
9448
  readonly 'id': string;
9468
9449
  readonly 'carrier': io.flow.fulfillment.v0.models.CarrierReference;
9469
9450
  readonly 'credentials': io.flow.tracking.internal.v0.unions.CarrierCredentials;
9451
+ readonly 'q'?: string;
9452
+ readonly 'position'?: number;
9470
9453
  }
9471
9454
 
9472
9455
  interface CarrierAccountForm {
9473
9456
  readonly 'carrier_id': string;
9474
9457
  readonly 'credentials': io.flow.tracking.internal.v0.unions.CarrierCredentials;
9458
+ readonly 'q'?: string;
9459
+ readonly 'position'?: number;
9475
9460
  }
9476
9461
 
9477
9462
  interface CarrierInvoice {
@@ -12196,6 +12181,7 @@ declare namespace io.flow.checkout.protocol.v0.enums {
12196
12181
  type CheckoutAddPaymentDetailsErrorCode = 'payment_failed' | 'authorization_form_not_supported' | 'authorization_invalid_amount' | 'authorization_invalid_currency' | 'authorization_amount_exceeds_balance' | 'address_street1_required';
12197
12182
  type CheckoutCreateAuthorizationDetailsErrorCode = 'checkout_not_found' | 'authorization_details_payment_not_found';
12198
12183
  type CheckoutCreateAuthorizationErrorCode = 'authorization_form_not_supported' | 'authorization_invalid_amount' | 'authorization_invalid_currency' | 'authorization_amount_exceeds_balance' | 'address_street1_required';
12184
+ type CheckoutCreateBySessionByOrderErrorCode = 'session_not_found' | 'session_experience_required' | 'country_not_supported' | 'order_not_found';
12199
12185
  type CheckoutCreateBySessionErrorCode = 'session_not_found' | 'session_experience_required' | 'country_not_supported';
12200
12186
  type CheckoutDeleteAddressStreetErrorCode = 'address_line_number_invalid';
12201
12187
  type CheckoutDeleteLineErrorCode = 'line_not_found';
@@ -12295,6 +12281,15 @@ declare namespace io.flow.checkout.protocol.v0.models {
12295
12281
  readonly 'message': string;
12296
12282
  }
12297
12283
 
12284
+ interface CheckoutCreateBySessionByOrderError {
12285
+ readonly 'code': io.flow.checkout.protocol.v0.enums.CheckoutCreateBySessionByOrderErrorCode;
12286
+ readonly 'message': string;
12287
+ }
12288
+
12289
+ interface CheckoutCreateBySessionByOrderResponseError {
12290
+ readonly 'errors': io.flow.checkout.protocol.v0.models.CheckoutCreateBySessionByOrderError[];
12291
+ }
12292
+
12298
12293
  interface CheckoutCreateBySessionError {
12299
12294
  readonly 'code': io.flow.checkout.protocol.v0.enums.CheckoutCreateBySessionErrorCode;
12300
12295
  readonly 'message': string;
@@ -16073,7 +16068,7 @@ declare namespace io.flow.internal.v0.enums {
16073
16068
  type BillingStatementReviewStatus = 'approved' | 'pending';
16074
16069
  type BillingTransactionStatus = 'pending' | 'posted';
16075
16070
  type BillingTransactionType = 'manual' | 'subscription' | 'invoice' | 'transfer' | 'adjustment' | 'capture' | 'refund' | 'virtual_card_capture' | 'virtual_card_refund' | 'tax_remittance' | 'fully_subsidized_order' | 'credit_payment';
16076
- type BlazeCheckoutStep = 'contact' | 'shipping' | 'delivery' | 'payment';
16071
+ type BlazeCheckoutStep = 'customer_info' | 'delivery' | 'payment';
16077
16072
  type BrowserBundleErrorCode = 'generic_error' | 'country_invalid';
16078
16073
  type CarrierLabelGenerationMethod = 'direct' | 'easypost';
16079
16074
  type CatalogImportType = 'catalog_items' | 'item_form_overlays' | 'item_prices' | 'price_book_items_import' | 'price_book_items_query_import';
@@ -16089,6 +16084,7 @@ declare namespace io.flow.internal.v0.enums {
16089
16084
  type CheckoutAssetType = 'stylesheet' | 'javascript';
16090
16085
  type CheckoutCreateAuthorizationDetailsErrorCode = 'checkout_not_found' | 'authorization_details_payment_not_found';
16091
16086
  type CheckoutCreateAuthorizationErrorCode = 'authorization_form_not_supported' | 'authorization_invalid_amount' | 'authorization_invalid_currency' | 'authorization_amount_exceeds_balance' | 'address_street1_required';
16087
+ type CheckoutCreateBySessionByOrderErrorCode = 'session_not_found' | 'session_experience_required' | 'country_not_supported' | 'order_not_found';
16092
16088
  type CheckoutCreateBySessionErrorCode = 'session_not_found' | 'session_experience_required' | 'country_not_supported';
16093
16089
  type CheckoutDeleteAddressStreetErrorCode = 'address_line_number_invalid';
16094
16090
  type CheckoutDeleteLineErrorCode = 'line_not_found';
@@ -17229,11 +17225,15 @@ declare namespace io.flow.internal.v0.models {
17229
17225
  readonly 'id': string;
17230
17226
  readonly 'carrier': io.flow.fulfillment.v0.models.CarrierReference;
17231
17227
  readonly 'credentials': io.flow.tracking.internal.v0.unions.CarrierCredentials;
17228
+ readonly 'q'?: string;
17229
+ readonly 'position'?: number;
17232
17230
  }
17233
17231
 
17234
17232
  interface CarrierAccountForm {
17235
17233
  readonly 'carrier_id': string;
17236
17234
  readonly 'credentials': io.flow.tracking.internal.v0.unions.CarrierCredentials;
17235
+ readonly 'q'?: string;
17236
+ readonly 'position'?: number;
17237
17237
  }
17238
17238
 
17239
17239
  interface CarrierAccountUpserted {
@@ -17685,6 +17685,15 @@ declare namespace io.flow.internal.v0.models {
17685
17685
  readonly 'message': string;
17686
17686
  }
17687
17687
 
17688
+ interface CheckoutCreateBySessionByOrderError {
17689
+ readonly 'code': io.flow.internal.v0.enums.CheckoutCreateBySessionByOrderErrorCode;
17690
+ readonly 'message': string;
17691
+ }
17692
+
17693
+ interface CheckoutCreateBySessionByOrderResponseError {
17694
+ readonly 'errors': io.flow.internal.v0.models.CheckoutCreateBySessionByOrderError[];
17695
+ }
17696
+
17688
17697
  interface CheckoutCreateBySessionError {
17689
17698
  readonly 'code': io.flow.internal.v0.enums.CheckoutCreateBySessionErrorCode;
17690
17699
  readonly 'message': string;
@@ -23761,6 +23770,16 @@ declare namespace io.flow.internal.v0.models {
23761
23770
  readonly 'organization_id': string;
23762
23771
  readonly 'shop': string;
23763
23772
  readonly 'created_at': string;
23773
+ readonly 'api_key_masked': string;
23774
+ readonly 'api_password_masked': string;
23775
+ readonly 'shared_secret_masked': string;
23776
+ }
23777
+
23778
+ interface ShopifyXborderShopForm {
23779
+ readonly 'shop': string;
23780
+ readonly 'api_key': string;
23781
+ readonly 'api_password': string;
23782
+ readonly 'shared_secret': string;
23764
23783
  }
23765
23784
 
23766
23785
  interface ShopifyCheckInventoryError {
@@ -25017,6 +25036,7 @@ export const checkoutAddressType: PropTypes.Requireable<io.flow.internal.v0.enum
25017
25036
  export const checkoutAssetType: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutAssetType>;
25018
25037
  export const checkoutCreateAuthorizationDetailsErrorCode: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutCreateAuthorizationDetailsErrorCode>;
25019
25038
  export const checkoutCreateAuthorizationErrorCode: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutCreateAuthorizationErrorCode>;
25039
+ export const checkoutCreateBySessionByOrderErrorCode: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutCreateBySessionByOrderErrorCode>;
25020
25040
  export const checkoutCreateBySessionErrorCode: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutCreateBySessionErrorCode>;
25021
25041
  export const checkoutDeleteAddressStreetErrorCode: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutDeleteAddressStreetErrorCode>;
25022
25042
  export const checkoutDeleteLineErrorCode: PropTypes.Requireable<io.flow.internal.v0.enums.CheckoutDeleteLineErrorCode>;
@@ -25382,6 +25402,8 @@ export const checkoutCreateAuthorizationDetailsRequestForm: PropTypes.Requireabl
25382
25402
  export const checkoutCreateAuthorizationDetailsResponseError: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateAuthorizationDetailsResponseError>;
25383
25403
  export const checkoutCreateAuthorizationDetailsResponseSuccess: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateAuthorizationDetailsResponseSuccess>;
25384
25404
  export const checkoutCreateAuthorizationError: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateAuthorizationError>;
25405
+ export const checkoutCreateBySessionByOrderError: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateBySessionByOrderError>;
25406
+ export const checkoutCreateBySessionByOrderResponseError: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateBySessionByOrderResponseError>;
25385
25407
  export const checkoutCreateBySessionError: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateBySessionError>;
25386
25408
  export const checkoutCreateBySessionRequestForm: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateBySessionRequestForm>;
25387
25409
  export const checkoutCreateBySessionResponseError: PropTypes.Requireable<io.flow.internal.v0.models.CheckoutCreateBySessionResponseError>;
@@ -26233,6 +26255,7 @@ export const shop: PropTypes.Requireable<io.flow.internal.v0.models.Shop>;
26233
26255
  export const shopForm: PropTypes.Requireable<io.flow.internal.v0.models.ShopForm>;
26234
26256
  export const shopVersion: PropTypes.Requireable<io.flow.internal.v0.models.ShopVersion>;
26235
26257
  export const shopifyXborderShop: PropTypes.Requireable<io.flow.internal.v0.models.ShopifyXborderShop>;
26258
+ export const shopifyXborderShopForm: PropTypes.Requireable<io.flow.internal.v0.models.ShopifyXborderShopForm>;
26236
26259
  export const shopifyCheckInventoryError: PropTypes.Requireable<io.flow.internal.v0.models.ShopifyCheckInventoryError>;
26237
26260
  export const shopifyCodeForm: PropTypes.Requireable<io.flow.internal.v0.models.ShopifyCodeForm>;
26238
26261
  export const shopifyExperienceShortId: PropTypes.Requireable<io.flow.internal.v0.models.ShopifyExperienceShortId>;