@flowio/types 11.12.4 → 11.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.
@@ -232,6 +232,8 @@ declare namespace io.flow.experience.v0.enums {
232
232
  type ExperienceStatus = 'draft' | 'active' | 'archiving' | 'archived';
233
233
  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';
234
234
  type OrderPaymentType = 'card' | 'online' | 'credit' | 'installment_plan' | 'cash_on_delivery';
235
+ type OrderRefundSummaryIncludes = 'duties' | 'vat' | 'shipping';
236
+ type OrderRefundSummaryPartialCharged = 'per_item' | 'for_order' | 'by_value_percentage' | 'by_quantity_percentage';
235
237
  type OrderStatus = 'open' | 'submitted';
236
238
  type OrderStorage = 'do_not_persist' | 'persist';
237
239
  type OrganizationPaymentMethodTag = 'deny';
@@ -882,6 +884,36 @@ declare namespace io.flow.experience.v0.models {
882
884
  readonly id: string;
883
885
  readonly number: string;
884
886
  }
887
+ interface OrderRefundSummary {
888
+ readonly currency: string;
889
+ readonly amounts: io.flow.experience.v0.models.OrderRefundSummaryAmounts;
890
+ }
891
+ interface OrderRefundSummaryAmounts {
892
+ readonly balance: number;
893
+ readonly item_subtotal: number;
894
+ readonly discount?: number;
895
+ readonly refund_total: number;
896
+ readonly shipping: number;
897
+ readonly vat: number;
898
+ readonly duty: number;
899
+ }
900
+ interface OrderRefundSummaryFullForm {
901
+ readonly discriminator: 'order_refund_summary_full_form';
902
+ readonly includes: io.flow.experience.v0.enums.OrderRefundSummaryIncludes[];
903
+ }
904
+ interface OrderRefundSummaryItem {
905
+ readonly number: string;
906
+ readonly quantity_to_refund: number;
907
+ }
908
+ interface OrderRefundSummaryPartialForm {
909
+ readonly discriminator: 'order_refund_summary_partial_form';
910
+ readonly includes: io.flow.experience.v0.models.OrderRefundSummaryPartialIncludes[];
911
+ readonly items: io.flow.experience.v0.models.OrderRefundSummaryItem[];
912
+ }
913
+ interface OrderRefundSummaryPartialIncludes {
914
+ readonly key: io.flow.experience.v0.enums.OrderRefundSummaryIncludes;
915
+ readonly charged: io.flow.experience.v0.enums.OrderRefundSummaryPartialCharged;
916
+ }
885
917
  interface OrderRuleReference {
886
918
  readonly id: string;
887
919
  readonly key: string;
@@ -1035,6 +1067,7 @@ declare namespace io.flow.experience.v0.unions {
1035
1067
  type OrderNumberGenerator = io.flow.experience.v0.models.OrderNumberGeneratorUuid | io.flow.experience.v0.models.OrderNumberGeneratorHexadecimal | io.flow.experience.v0.models.OrderNumberGeneratorPrefixSuffix;
1036
1068
  type OrderPromotion = io.flow.experience.v0.models.FreeShippingOrderPromotion;
1037
1069
  type OrderPromotionForm = io.flow.experience.v0.models.FreeShippingOrderPromotionForm;
1070
+ type OrderRefundSummaryForm = io.flow.experience.v0.models.OrderRefundSummaryFullForm | io.flow.experience.v0.models.OrderRefundSummaryPartialForm;
1038
1071
  type PaymentMethodTag = {
1039
1072
  discriminator: 'organization_payment_method_tag';
1040
1073
  value: io.flow.experience.v0.enums.OrganizationPaymentMethodTag;
@@ -1376,63 +1409,6 @@ declare namespace io.flow.shopify.xborder.v0.models {
1376
1409
  interface ShopifyOrdersWrapper {
1377
1410
  readonly orders: io.flow.shopify.xborder.v0.models.ShopifyOrder[];
1378
1411
  }
1379
- interface ShopifyWebhookOrder {
1380
- readonly id: number;
1381
- readonly order_number: number;
1382
- readonly billing_address?: io.flow.shopify.xborder.v0.models.ShopifyOrderAddress;
1383
- readonly browser_ip?: string;
1384
- readonly buyer_accepts_marketing: boolean;
1385
- readonly cancel_reason?: io.flow.shopify.xborder.v0.enums.ShopifyOrderCancelReason;
1386
- readonly cancelled_at?: string;
1387
- readonly cart_token?: string;
1388
- readonly client_details?: io.flow.shopify.xborder.v0.models.ShopifyOrderClientDetail;
1389
- readonly closed_at?: string;
1390
- readonly created_at: string;
1391
- readonly currency: string;
1392
- readonly total_discounts_set: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1393
- readonly total_duties_set?: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1394
- readonly original_total_duties_set?: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1395
- readonly total_price_set: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1396
- readonly subtotal_price_set: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1397
- readonly total_tax_set: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1398
- readonly total_line_items_price_set: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1399
- readonly customer: io.flow.shopify.xborder.v0.models.ShopifyOrderCustomer;
1400
- readonly customer_locale?: string;
1401
- readonly discount_applications: io.flow.shopify.xborder.v0.models.ShopifyOrderDiscountApplication[];
1402
- readonly discount_codes: io.flow.shopify.xborder.v0.models.ShopifyOrderDiscountCode[];
1403
- readonly email?: string;
1404
- readonly financial_status: io.flow.shopify.xborder.v0.enums.ShopifyOrderFinancialStatusType;
1405
- readonly fulfillments: io.flow.shopify.xborder.v0.models.ShopifyOrderFulfillment[];
1406
- readonly fulfillment_status?: io.flow.shopify.xborder.v0.enums.ShopifyOrderFulfillmentStatusType;
1407
- readonly landing_site?: string;
1408
- readonly line_items: io.flow.shopify.xborder.v0.models.ShopifyOrderLineItem[];
1409
- readonly location_id?: number;
1410
- readonly name: string;
1411
- readonly note?: string;
1412
- readonly note_attributes: io.flow.shopify.xborder.v0.models.ShopifyOrderAttribute[];
1413
- readonly number?: number;
1414
- readonly payment_gateway_names: string[];
1415
- readonly processed_at?: string;
1416
- readonly processing_method?: io.flow.shopify.xborder.v0.enums.ShopifyOrderProcessingMethodType;
1417
- readonly referring_site?: string;
1418
- readonly refunds: io.flow.shopify.xborder.v0.models.ShopifyOrderRefund[];
1419
- readonly shipping_address?: io.flow.shopify.xborder.v0.models.ShopifyOrderAddress;
1420
- readonly shipping_lines?: io.flow.shopify.xborder.v0.models.ShopifyOrderShippingLine[];
1421
- readonly source_name?: string;
1422
- readonly tags?: string;
1423
- readonly tax_lines: io.flow.shopify.xborder.v0.models.ShopifyOrderTaxLine[];
1424
- readonly taxes_included: boolean;
1425
- readonly token?: string;
1426
- readonly total_weight?: number;
1427
- readonly updated_at?: string;
1428
- readonly user_id?: number;
1429
- readonly order_status_url?: string;
1430
- readonly inventory_behaviour?: io.flow.shopify.xborder.v0.enums.ShopifyOrderInventoryBehaviour;
1431
- readonly gateway?: string;
1432
- readonly transactions?: io.flow.shopify.xborder.v0.models.ShopifyOrderTransaction[];
1433
- readonly send_receipt?: boolean;
1434
- readonly metafields?: io.flow.shopify.xborder.v0.models.ShopifyOrderMetafield[];
1435
- }
1436
1412
  interface ShopifyWebhookRequest {
1437
1413
  readonly topic: io.flow.shopify.xborder.v0.enums.ShopifyWebhookTopic;
1438
1414
  readonly address: string;
@@ -8263,10 +8239,14 @@ declare namespace io.flow.label.internal.v0.models {
8263
8239
  readonly id: string;
8264
8240
  readonly carrier: io.flow.fulfillment.v0.models.CarrierReference;
8265
8241
  readonly credentials: io.flow.tracking.internal.v0.unions.CarrierCredentials;
8242
+ readonly q?: string;
8243
+ readonly position?: number;
8266
8244
  }
8267
8245
  interface CarrierAccountForm {
8268
8246
  readonly carrier_id: string;
8269
8247
  readonly credentials: io.flow.tracking.internal.v0.unions.CarrierCredentials;
8248
+ readonly q?: string;
8249
+ readonly position?: number;
8270
8250
  }
8271
8251
  interface CarrierInvoice {
8272
8252
  readonly number: string;
@@ -10612,6 +10592,7 @@ declare namespace io.flow.checkout.protocol.v0.enums {
10612
10592
  type CheckoutAddPaymentDetailsErrorCode = 'payment_failed' | 'authorization_form_not_supported' | 'authorization_invalid_amount' | 'authorization_invalid_currency' | 'authorization_amount_exceeds_balance' | 'address_street1_required';
10613
10593
  type CheckoutCreateAuthorizationDetailsErrorCode = 'checkout_not_found' | 'authorization_details_payment_not_found';
10614
10594
  type CheckoutCreateAuthorizationErrorCode = 'authorization_form_not_supported' | 'authorization_invalid_amount' | 'authorization_invalid_currency' | 'authorization_amount_exceeds_balance' | 'address_street1_required';
10595
+ type CheckoutCreateBySessionByOrderErrorCode = 'session_not_found' | 'session_experience_required' | 'country_not_supported' | 'order_not_found';
10615
10596
  type CheckoutCreateBySessionErrorCode = 'session_not_found' | 'session_experience_required' | 'country_not_supported';
10616
10597
  type CheckoutDeleteAddressStreetErrorCode = 'address_line_number_invalid';
10617
10598
  type CheckoutDeleteLineErrorCode = 'line_not_found';
@@ -10699,6 +10680,13 @@ declare namespace io.flow.checkout.protocol.v0.models {
10699
10680
  readonly code: io.flow.checkout.protocol.v0.enums.CheckoutCreateAuthorizationErrorCode;
10700
10681
  readonly message: string;
10701
10682
  }
10683
+ interface CheckoutCreateBySessionByOrderError {
10684
+ readonly code: io.flow.checkout.protocol.v0.enums.CheckoutCreateBySessionByOrderErrorCode;
10685
+ readonly message: string;
10686
+ }
10687
+ interface CheckoutCreateBySessionByOrderResponseError {
10688
+ readonly errors: io.flow.checkout.protocol.v0.models.CheckoutCreateBySessionByOrderError[];
10689
+ }
10702
10690
  interface CheckoutCreateBySessionError {
10703
10691
  readonly code: io.flow.checkout.protocol.v0.enums.CheckoutCreateBySessionErrorCode;
10704
10692
  readonly message: string;
@@ -13892,7 +13880,7 @@ declare namespace io.flow.internal.v0.enums {
13892
13880
  type BillingStatementReviewStatus = 'approved' | 'pending';
13893
13881
  type BillingTransactionStatus = 'pending' | 'posted';
13894
13882
  type BillingTransactionType = 'manual' | 'subscription' | 'invoice' | 'transfer' | 'adjustment' | 'capture' | 'refund' | 'virtual_card_capture' | 'virtual_card_refund' | 'tax_remittance' | 'fully_subsidized_order' | 'credit_payment';
13895
- type BlazeCheckoutStep = 'contact' | 'shipping' | 'delivery' | 'payment';
13883
+ type BlazeCheckoutStep = 'customer_info' | 'delivery' | 'payment';
13896
13884
  type BrowserBundleErrorCode = 'generic_error' | 'country_invalid';
13897
13885
  type CarrierLabelGenerationMethod = 'direct' | 'easypost';
13898
13886
  type CatalogImportType = 'catalog_items' | 'item_form_overlays' | 'item_prices' | 'price_book_items_import' | 'price_book_items_query_import';
@@ -13908,6 +13896,7 @@ declare namespace io.flow.internal.v0.enums {
13908
13896
  type CheckoutAssetType = 'stylesheet' | 'javascript';
13909
13897
  type CheckoutCreateAuthorizationDetailsErrorCode = 'checkout_not_found' | 'authorization_details_payment_not_found';
13910
13898
  type CheckoutCreateAuthorizationErrorCode = 'authorization_form_not_supported' | 'authorization_invalid_amount' | 'authorization_invalid_currency' | 'authorization_amount_exceeds_balance' | 'address_street1_required';
13899
+ type CheckoutCreateBySessionByOrderErrorCode = 'session_not_found' | 'session_experience_required' | 'country_not_supported' | 'order_not_found';
13911
13900
  type CheckoutCreateBySessionErrorCode = 'session_not_found' | 'session_experience_required' | 'country_not_supported';
13912
13901
  type CheckoutDeleteAddressStreetErrorCode = 'address_line_number_invalid';
13913
13902
  type CheckoutDeleteLineErrorCode = 'line_not_found';
@@ -14910,10 +14899,14 @@ declare namespace io.flow.internal.v0.models {
14910
14899
  readonly id: string;
14911
14900
  readonly carrier: io.flow.fulfillment.v0.models.CarrierReference;
14912
14901
  readonly credentials: io.flow.tracking.internal.v0.unions.CarrierCredentials;
14902
+ readonly q?: string;
14903
+ readonly position?: number;
14913
14904
  }
14914
14905
  interface CarrierAccountForm {
14915
14906
  readonly carrier_id: string;
14916
14907
  readonly credentials: io.flow.tracking.internal.v0.unions.CarrierCredentials;
14908
+ readonly q?: string;
14909
+ readonly position?: number;
14917
14910
  }
14918
14911
  interface CarrierAccountUpserted {
14919
14912
  readonly discriminator: 'carrier_account_upserted';
@@ -15289,6 +15282,13 @@ declare namespace io.flow.internal.v0.models {
15289
15282
  readonly code: io.flow.internal.v0.enums.CheckoutCreateAuthorizationErrorCode;
15290
15283
  readonly message: string;
15291
15284
  }
15285
+ interface CheckoutCreateBySessionByOrderError {
15286
+ readonly code: io.flow.internal.v0.enums.CheckoutCreateBySessionByOrderErrorCode;
15287
+ readonly message: string;
15288
+ }
15289
+ interface CheckoutCreateBySessionByOrderResponseError {
15290
+ readonly errors: io.flow.internal.v0.models.CheckoutCreateBySessionByOrderError[];
15291
+ }
15292
15292
  interface CheckoutCreateBySessionError {
15293
15293
  readonly code: io.flow.internal.v0.enums.CheckoutCreateBySessionErrorCode;
15294
15294
  readonly message: string;
@@ -20515,6 +20515,15 @@ declare namespace io.flow.internal.v0.models {
20515
20515
  readonly organization_id: string;
20516
20516
  readonly shop: string;
20517
20517
  readonly created_at: string;
20518
+ readonly api_key_masked: string;
20519
+ readonly api_password_masked: string;
20520
+ readonly shared_secret_masked: string;
20521
+ }
20522
+ interface ShopifyXborderShopForm {
20523
+ readonly shop: string;
20524
+ readonly api_key: string;
20525
+ readonly api_password: string;
20526
+ readonly shared_secret: string;
20518
20527
  }
20519
20528
  interface ShopifyCheckInventoryError {
20520
20529
  readonly code: io.flow.internal.v0.enums.ShopifyCheckInventoryErrorCode;
@@ -21841,6 +21850,9 @@ export declare type CheckoutCreateAuthorizationDetailsResponseError = io.flow.in
21841
21850
  export declare type CheckoutCreateAuthorizationDetailsResponseSuccess = io.flow.internal.v0.models.CheckoutCreateAuthorizationDetailsResponseSuccess;
21842
21851
  export declare type CheckoutCreateAuthorizationError = io.flow.internal.v0.models.CheckoutCreateAuthorizationError;
21843
21852
  export declare type CheckoutCreateAuthorizationErrorCode = io.flow.internal.v0.enums.CheckoutCreateAuthorizationErrorCode;
21853
+ export declare type CheckoutCreateBySessionByOrderError = io.flow.internal.v0.models.CheckoutCreateBySessionByOrderError;
21854
+ export declare type CheckoutCreateBySessionByOrderErrorCode = io.flow.internal.v0.enums.CheckoutCreateBySessionByOrderErrorCode;
21855
+ export declare type CheckoutCreateBySessionByOrderResponseError = io.flow.internal.v0.models.CheckoutCreateBySessionByOrderResponseError;
21844
21856
  export declare type CheckoutCreateBySessionError = io.flow.internal.v0.models.CheckoutCreateBySessionError;
21845
21857
  export declare type CheckoutCreateBySessionErrorCode = io.flow.internal.v0.enums.CheckoutCreateBySessionErrorCode;
21846
21858
  export declare type CheckoutCreateBySessionRequestForm = io.flow.internal.v0.models.CheckoutCreateBySessionRequestForm;
@@ -22923,6 +22935,7 @@ export declare type Shop = io.flow.internal.v0.models.Shop;
22923
22935
  export declare type ShopForm = io.flow.internal.v0.models.ShopForm;
22924
22936
  export declare type ShopVersion = io.flow.internal.v0.models.ShopVersion;
22925
22937
  export declare type ShopifyXborderShop = io.flow.internal.v0.models.ShopifyXborderShop;
22938
+ export declare type ShopifyXborderShopForm = io.flow.internal.v0.models.ShopifyXborderShopForm;
22926
22939
  export declare type ShopifyCheckInventoryError = io.flow.internal.v0.models.ShopifyCheckInventoryError;
22927
22940
  export declare type ShopifyCheckInventoryErrorCode = io.flow.internal.v0.enums.ShopifyCheckInventoryErrorCode;
22928
22941
  export declare type ShopifyCodeForm = io.flow.internal.v0.models.ShopifyCodeForm;
package/dist/api.d.ts CHANGED
@@ -901,6 +901,8 @@ declare namespace io.flow.v0.enums {
901
901
  type OrderPaymentType = 'card' | 'online' | 'credit' | 'installment_plan' | 'cash_on_delivery';
902
902
  type OrderPriceDetailComponentKey = 'adjustment' | 'vat_deminimis' | 'duty_deminimis' | 'duties_item_price' | 'duties_freight' | 'duties_insurance' | 'vat_item_price' | 'vat_freight' | 'vat_insurance' | 'vat_duties_item_price' | 'vat_duties_freight' | 'vat_duties_insurance' | 'item_price' | 'item_discount' | 'rounding' | 'insurance' | 'shipping' | 'shipping_discount' | 'order_discount' | 'subtotal_percent_sales_margin' | 'subtotal_vat_percent_sales_margin' | 'subtotal_duty_percent_sales_margin' | 'vat_subsidy' | 'duty_subsidy' | 'remote_area_surcharge' | 'fuel_surcharge' | 'emergency_situation_surcharge';
903
903
  type OrderPriceDetailKey = 'adjustment' | 'subtotal' | 'vat' | 'duty' | 'shipping' | 'insurance' | 'discount' | 'surcharges';
904
+ type OrderRefundSummaryIncludes = 'duties' | 'vat' | 'shipping';
905
+ type OrderRefundSummaryPartialCharged = 'per_item' | 'for_order' | 'by_value_percentage' | 'by_quantity_percentage';
904
906
  type OrderStatus = 'open' | 'submitted';
905
907
  type OrderStorage = 'do_not_persist' | 'persist';
906
908
  type OrganizationPaymentMethodTag = 'deny';
@@ -1040,6 +1042,7 @@ declare namespace io.flow.v0.models {
1040
1042
  readonly type: 'capture';
1041
1043
  readonly expires_at?: string;
1042
1044
  readonly amount_awaiting_capture?: number;
1045
+ readonly currency?: string;
1043
1046
  }
1044
1047
  interface ActionDisplayInlineWindow {
1045
1048
  readonly type: 'display_inline_window';
@@ -4903,6 +4906,36 @@ declare namespace io.flow.v0.models {
4903
4906
  readonly id: string;
4904
4907
  readonly number: string;
4905
4908
  }
4909
+ interface OrderRefundSummary {
4910
+ readonly currency: string;
4911
+ readonly amounts: io.flow.v0.models.OrderRefundSummaryAmounts;
4912
+ }
4913
+ interface OrderRefundSummaryAmounts {
4914
+ readonly balance: number;
4915
+ readonly item_subtotal: number;
4916
+ readonly discount?: number;
4917
+ readonly refund_total: number;
4918
+ readonly shipping: number;
4919
+ readonly vat: number;
4920
+ readonly duty: number;
4921
+ }
4922
+ interface OrderRefundSummaryFullForm {
4923
+ readonly discriminator: 'order_refund_summary_full_form';
4924
+ readonly includes: io.flow.v0.enums.OrderRefundSummaryIncludes[];
4925
+ }
4926
+ interface OrderRefundSummaryItem {
4927
+ readonly number: string;
4928
+ readonly quantity_to_refund: number;
4929
+ }
4930
+ interface OrderRefundSummaryPartialForm {
4931
+ readonly discriminator: 'order_refund_summary_partial_form';
4932
+ readonly includes: io.flow.v0.models.OrderRefundSummaryPartialIncludes[];
4933
+ readonly items: io.flow.v0.models.OrderRefundSummaryItem[];
4934
+ }
4935
+ interface OrderRefundSummaryPartialIncludes {
4936
+ readonly key: io.flow.v0.enums.OrderRefundSummaryIncludes;
4937
+ readonly charged: io.flow.v0.enums.OrderRefundSummaryPartialCharged;
4938
+ }
4906
4939
  interface OrderRuleReference {
4907
4940
  readonly id: string;
4908
4941
  readonly key: string;
@@ -5445,6 +5478,7 @@ declare namespace io.flow.v0.models {
5445
5478
  readonly type: 'card';
5446
5479
  readonly merchant_of_record: io.flow.v0.enums.MerchantOfRecord;
5447
5480
  readonly last_four: string;
5481
+ readonly card_type: io.flow.v0.enums.CardType;
5448
5482
  }
5449
5483
  interface PaymentMethodSummaryGooglepay {
5450
5484
  readonly type: 'googlepay';
@@ -7924,6 +7958,7 @@ declare namespace io.flow.v0.unions {
7924
7958
  type OrderNumberGenerator = io.flow.v0.models.OrderNumberGeneratorUuid | io.flow.v0.models.OrderNumberGeneratorHexadecimal | io.flow.v0.models.OrderNumberGeneratorPrefixSuffix;
7925
7959
  type OrderPromotion = io.flow.v0.models.FreeShippingOrderPromotion;
7926
7960
  type OrderPromotionForm = io.flow.v0.models.FreeShippingOrderPromotionForm;
7961
+ type OrderRefundSummaryForm = io.flow.v0.models.OrderRefundSummaryFullForm | io.flow.v0.models.OrderRefundSummaryPartialForm;
7927
7962
  type PartnerCenterFee = io.flow.v0.models.CommercialInvoiceFee | io.flow.v0.models.InboundCartonFee | io.flow.v0.models.OutboundCartonFee;
7928
7963
  type Payment = io.flow.v0.models.PaymentPaypal | io.flow.v0.models.PaymentCryptopay;
7929
7964
  type PaymentForm = io.flow.v0.models.MerchantOfRecordPaymentForm;
@@ -8738,6 +8773,15 @@ export declare type OrderPromotionForm = io.flow.v0.unions.OrderPromotionForm;
8738
8773
  export declare type OrderPromotionTrigger = io.flow.v0.models.OrderPromotionTrigger;
8739
8774
  export declare type OrderPutForm = io.flow.v0.models.OrderPutForm;
8740
8775
  export declare type OrderReference = io.flow.v0.models.OrderReference;
8776
+ export declare type OrderRefundSummary = io.flow.v0.models.OrderRefundSummary;
8777
+ export declare type OrderRefundSummaryAmounts = io.flow.v0.models.OrderRefundSummaryAmounts;
8778
+ export declare type OrderRefundSummaryForm = io.flow.v0.unions.OrderRefundSummaryForm;
8779
+ export declare type OrderRefundSummaryFullForm = io.flow.v0.models.OrderRefundSummaryFullForm;
8780
+ export declare type OrderRefundSummaryIncludes = io.flow.v0.enums.OrderRefundSummaryIncludes;
8781
+ export declare type OrderRefundSummaryItem = io.flow.v0.models.OrderRefundSummaryItem;
8782
+ export declare type OrderRefundSummaryPartialCharged = io.flow.v0.enums.OrderRefundSummaryPartialCharged;
8783
+ export declare type OrderRefundSummaryPartialForm = io.flow.v0.models.OrderRefundSummaryPartialForm;
8784
+ export declare type OrderRefundSummaryPartialIncludes = io.flow.v0.models.OrderRefundSummaryPartialIncludes;
8741
8785
  export declare type OrderRuleReference = io.flow.v0.models.OrderRuleReference;
8742
8786
  export declare type OrderRulesSummary = io.flow.v0.models.OrderRulesSummary;
8743
8787
  export declare type OrderServiceChange = io.flow.v0.models.OrderServiceChange;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flowio/types",
3
- "version": "11.12.4",
3
+ "version": "11.13.0",
4
4
  "description": "TypeScript type definitions for custom types found in Flow API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -25,5 +25,5 @@
25
25
  "maintainers": [
26
26
  "Christian Muñoz <christian.munoz@flow.io>"
27
27
  ],
28
- "gitHead": "1b8fac5c9de3d7554d9755ad44bbd8b4a17de278"
28
+ "gitHead": "462c26f90ea96f2f4a3a44d1d71ebeb3238f1239"
29
29
  }
@@ -351,6 +351,12 @@ declare namespace io.flow.experience.v0.enums {
351
351
  | 'credit'
352
352
  | 'installment_plan'
353
353
  | 'cash_on_delivery';
354
+ type OrderRefundSummaryIncludes = 'duties' | 'vat' | 'shipping';
355
+ type OrderRefundSummaryPartialCharged =
356
+ | 'per_item'
357
+ | 'for_order'
358
+ | 'by_value_percentage'
359
+ | 'by_quantity_percentage';
354
360
  type OrderStatus = 'open' | 'submitted';
355
361
  type OrderStorage = 'do_not_persist' | 'persist';
356
362
  type OrganizationPaymentMethodTag = 'deny';
@@ -1109,6 +1115,42 @@ declare namespace io.flow.experience.v0.models {
1109
1115
  readonly number: string;
1110
1116
  }
1111
1117
 
1118
+ interface OrderRefundSummary {
1119
+ readonly currency: string;
1120
+ readonly amounts: io.flow.experience.v0.models.OrderRefundSummaryAmounts;
1121
+ }
1122
+
1123
+ interface OrderRefundSummaryAmounts {
1124
+ readonly balance: number;
1125
+ readonly item_subtotal: number;
1126
+ readonly discount?: number;
1127
+ readonly refund_total: number;
1128
+ readonly shipping: number;
1129
+ readonly vat: number;
1130
+ readonly duty: number;
1131
+ }
1132
+
1133
+ interface OrderRefundSummaryFullForm {
1134
+ readonly discriminator: 'order_refund_summary_full_form';
1135
+ readonly includes: io.flow.experience.v0.enums.OrderRefundSummaryIncludes[];
1136
+ }
1137
+
1138
+ interface OrderRefundSummaryItem {
1139
+ readonly number: string;
1140
+ readonly quantity_to_refund: number;
1141
+ }
1142
+
1143
+ interface OrderRefundSummaryPartialForm {
1144
+ readonly discriminator: 'order_refund_summary_partial_form';
1145
+ readonly includes: io.flow.experience.v0.models.OrderRefundSummaryPartialIncludes[];
1146
+ readonly items: io.flow.experience.v0.models.OrderRefundSummaryItem[];
1147
+ }
1148
+
1149
+ interface OrderRefundSummaryPartialIncludes {
1150
+ readonly key: io.flow.experience.v0.enums.OrderRefundSummaryIncludes;
1151
+ readonly charged: io.flow.experience.v0.enums.OrderRefundSummaryPartialCharged;
1152
+ }
1153
+
1112
1154
  interface OrderRuleReference {
1113
1155
  readonly id: string;
1114
1156
  readonly key: string;
@@ -1299,6 +1341,9 @@ declare namespace io.flow.experience.v0.unions {
1299
1341
  | io.flow.experience.v0.models.OrderNumberGeneratorPrefixSuffix;
1300
1342
  type OrderPromotion = io.flow.experience.v0.models.FreeShippingOrderPromotion;
1301
1343
  type OrderPromotionForm = io.flow.experience.v0.models.FreeShippingOrderPromotionForm;
1344
+ type OrderRefundSummaryForm =
1345
+ | io.flow.experience.v0.models.OrderRefundSummaryFullForm
1346
+ | io.flow.experience.v0.models.OrderRefundSummaryPartialForm;
1302
1347
 
1303
1348
  type PaymentMethodTag =
1304
1349
  | {
@@ -1753,64 +1798,6 @@ declare namespace io.flow.shopify.xborder.v0.models {
1753
1798
  readonly orders: io.flow.shopify.xborder.v0.models.ShopifyOrder[];
1754
1799
  }
1755
1800
 
1756
- interface ShopifyWebhookOrder {
1757
- readonly id: number;
1758
- readonly order_number: number;
1759
- readonly billing_address?: io.flow.shopify.xborder.v0.models.ShopifyOrderAddress;
1760
- readonly browser_ip?: string;
1761
- readonly buyer_accepts_marketing: boolean;
1762
- readonly cancel_reason?: io.flow.shopify.xborder.v0.enums.ShopifyOrderCancelReason;
1763
- readonly cancelled_at?: string;
1764
- readonly cart_token?: string;
1765
- readonly client_details?: io.flow.shopify.xborder.v0.models.ShopifyOrderClientDetail;
1766
- readonly closed_at?: string;
1767
- readonly created_at: string;
1768
- readonly currency: string;
1769
- readonly total_discounts_set: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1770
- readonly total_duties_set?: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1771
- readonly original_total_duties_set?: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1772
- readonly total_price_set: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1773
- readonly subtotal_price_set: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1774
- readonly total_tax_set: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1775
- readonly total_line_items_price_set: io.flow.shopify.xborder.v0.models.ShopifyOrderMoneySet;
1776
- readonly customer: io.flow.shopify.xborder.v0.models.ShopifyOrderCustomer;
1777
- readonly customer_locale?: string;
1778
- readonly discount_applications: io.flow.shopify.xborder.v0.models.ShopifyOrderDiscountApplication[];
1779
- readonly discount_codes: io.flow.shopify.xborder.v0.models.ShopifyOrderDiscountCode[];
1780
- readonly email?: string;
1781
- readonly financial_status: io.flow.shopify.xborder.v0.enums.ShopifyOrderFinancialStatusType;
1782
- readonly fulfillments: io.flow.shopify.xborder.v0.models.ShopifyOrderFulfillment[];
1783
- readonly fulfillment_status?: io.flow.shopify.xborder.v0.enums.ShopifyOrderFulfillmentStatusType;
1784
- readonly landing_site?: string;
1785
- readonly line_items: io.flow.shopify.xborder.v0.models.ShopifyOrderLineItem[];
1786
- readonly location_id?: number;
1787
- readonly name: string;
1788
- readonly note?: string;
1789
- readonly note_attributes: io.flow.shopify.xborder.v0.models.ShopifyOrderAttribute[];
1790
- readonly number?: number;
1791
- readonly payment_gateway_names: string[];
1792
- readonly processed_at?: string;
1793
- readonly processing_method?: io.flow.shopify.xborder.v0.enums.ShopifyOrderProcessingMethodType;
1794
- readonly referring_site?: string;
1795
- readonly refunds: io.flow.shopify.xborder.v0.models.ShopifyOrderRefund[];
1796
- readonly shipping_address?: io.flow.shopify.xborder.v0.models.ShopifyOrderAddress;
1797
- readonly shipping_lines?: io.flow.shopify.xborder.v0.models.ShopifyOrderShippingLine[];
1798
- readonly source_name?: string;
1799
- readonly tags?: string;
1800
- readonly tax_lines: io.flow.shopify.xborder.v0.models.ShopifyOrderTaxLine[];
1801
- readonly taxes_included: boolean;
1802
- readonly token?: string;
1803
- readonly total_weight?: number;
1804
- readonly updated_at?: string;
1805
- readonly user_id?: number;
1806
- readonly order_status_url?: string;
1807
- readonly inventory_behaviour?: io.flow.shopify.xborder.v0.enums.ShopifyOrderInventoryBehaviour;
1808
- readonly gateway?: string;
1809
- readonly transactions?: io.flow.shopify.xborder.v0.models.ShopifyOrderTransaction[];
1810
- readonly send_receipt?: boolean;
1811
- readonly metafields?: io.flow.shopify.xborder.v0.models.ShopifyOrderMetafield[];
1812
- }
1813
-
1814
1801
  interface ShopifyWebhookRequest {
1815
1802
  readonly topic: io.flow.shopify.xborder.v0.enums.ShopifyWebhookTopic;
1816
1803
  readonly address: string;
@@ -10714,11 +10701,15 @@ declare namespace io.flow.label.internal.v0.models {
10714
10701
  readonly id: string;
10715
10702
  readonly carrier: io.flow.fulfillment.v0.models.CarrierReference;
10716
10703
  readonly credentials: io.flow.tracking.internal.v0.unions.CarrierCredentials;
10704
+ readonly q?: string;
10705
+ readonly position?: number;
10717
10706
  }
10718
10707
 
10719
10708
  interface CarrierAccountForm {
10720
10709
  readonly carrier_id: string;
10721
10710
  readonly credentials: io.flow.tracking.internal.v0.unions.CarrierCredentials;
10711
+ readonly q?: string;
10712
+ readonly position?: number;
10722
10713
  }
10723
10714
 
10724
10715
  interface CarrierInvoice {
@@ -13695,6 +13686,11 @@ declare namespace io.flow.checkout.protocol.v0.enums {
13695
13686
  | 'authorization_invalid_currency'
13696
13687
  | 'authorization_amount_exceeds_balance'
13697
13688
  | 'address_street1_required';
13689
+ type CheckoutCreateBySessionByOrderErrorCode =
13690
+ | 'session_not_found'
13691
+ | 'session_experience_required'
13692
+ | 'country_not_supported'
13693
+ | 'order_not_found';
13698
13694
  type CheckoutCreateBySessionErrorCode =
13699
13695
  | 'session_not_found'
13700
13696
  | 'session_experience_required'
@@ -13932,6 +13928,15 @@ declare namespace io.flow.checkout.protocol.v0.models {
13932
13928
  readonly message: string;
13933
13929
  }
13934
13930
 
13931
+ interface CheckoutCreateBySessionByOrderError {
13932
+ readonly code: io.flow.checkout.protocol.v0.enums.CheckoutCreateBySessionByOrderErrorCode;
13933
+ readonly message: string;
13934
+ }
13935
+
13936
+ interface CheckoutCreateBySessionByOrderResponseError {
13937
+ readonly errors: io.flow.checkout.protocol.v0.models.CheckoutCreateBySessionByOrderError[];
13938
+ }
13939
+
13935
13940
  interface CheckoutCreateBySessionError {
13936
13941
  readonly code: io.flow.checkout.protocol.v0.enums.CheckoutCreateBySessionErrorCode;
13937
13942
  readonly message: string;
@@ -18093,7 +18098,7 @@ declare namespace io.flow.internal.v0.enums {
18093
18098
  | 'tax_remittance'
18094
18099
  | 'fully_subsidized_order'
18095
18100
  | 'credit_payment';
18096
- type BlazeCheckoutStep = 'contact' | 'shipping' | 'delivery' | 'payment';
18101
+ type BlazeCheckoutStep = 'customer_info' | 'delivery' | 'payment';
18097
18102
  type BrowserBundleErrorCode = 'generic_error' | 'country_invalid';
18098
18103
  type CarrierLabelGenerationMethod = 'direct' | 'easypost';
18099
18104
  type CatalogImportType =
@@ -18144,6 +18149,11 @@ declare namespace io.flow.internal.v0.enums {
18144
18149
  | 'authorization_invalid_currency'
18145
18150
  | 'authorization_amount_exceeds_balance'
18146
18151
  | 'address_street1_required';
18152
+ type CheckoutCreateBySessionByOrderErrorCode =
18153
+ | 'session_not_found'
18154
+ | 'session_experience_required'
18155
+ | 'country_not_supported'
18156
+ | 'order_not_found';
18147
18157
  type CheckoutCreateBySessionErrorCode =
18148
18158
  | 'session_not_found'
18149
18159
  | 'session_experience_required'
@@ -19772,11 +19782,15 @@ declare namespace io.flow.internal.v0.models {
19772
19782
  readonly id: string;
19773
19783
  readonly carrier: io.flow.fulfillment.v0.models.CarrierReference;
19774
19784
  readonly credentials: io.flow.tracking.internal.v0.unions.CarrierCredentials;
19785
+ readonly q?: string;
19786
+ readonly position?: number;
19775
19787
  }
19776
19788
 
19777
19789
  interface CarrierAccountForm {
19778
19790
  readonly carrier_id: string;
19779
19791
  readonly credentials: io.flow.tracking.internal.v0.unions.CarrierCredentials;
19792
+ readonly q?: string;
19793
+ readonly position?: number;
19780
19794
  }
19781
19795
 
19782
19796
  interface CarrierAccountUpserted {
@@ -20228,6 +20242,15 @@ declare namespace io.flow.internal.v0.models {
20228
20242
  readonly message: string;
20229
20243
  }
20230
20244
 
20245
+ interface CheckoutCreateBySessionByOrderError {
20246
+ readonly code: io.flow.internal.v0.enums.CheckoutCreateBySessionByOrderErrorCode;
20247
+ readonly message: string;
20248
+ }
20249
+
20250
+ interface CheckoutCreateBySessionByOrderResponseError {
20251
+ readonly errors: io.flow.internal.v0.models.CheckoutCreateBySessionByOrderError[];
20252
+ }
20253
+
20231
20254
  interface CheckoutCreateBySessionError {
20232
20255
  readonly code: io.flow.internal.v0.enums.CheckoutCreateBySessionErrorCode;
20233
20256
  readonly message: string;
@@ -26328,6 +26351,16 @@ declare namespace io.flow.internal.v0.models {
26328
26351
  readonly organization_id: string;
26329
26352
  readonly shop: string;
26330
26353
  readonly created_at: string;
26354
+ readonly api_key_masked: string;
26355
+ readonly api_password_masked: string;
26356
+ readonly shared_secret_masked: string;
26357
+ }
26358
+
26359
+ interface ShopifyXborderShopForm {
26360
+ readonly shop: string;
26361
+ readonly api_key: string;
26362
+ readonly api_password: string;
26363
+ readonly shared_secret: string;
26331
26364
  }
26332
26365
 
26333
26366
  interface ShopifyCheckInventoryError {
@@ -28381,6 +28414,9 @@ export type CheckoutCreateAuthorizationDetailsResponseError = io.flow.internal.v
28381
28414
  export type CheckoutCreateAuthorizationDetailsResponseSuccess = io.flow.internal.v0.models.CheckoutCreateAuthorizationDetailsResponseSuccess;
28382
28415
  export type CheckoutCreateAuthorizationError = io.flow.internal.v0.models.CheckoutCreateAuthorizationError;
28383
28416
  export type CheckoutCreateAuthorizationErrorCode = io.flow.internal.v0.enums.CheckoutCreateAuthorizationErrorCode;
28417
+ export type CheckoutCreateBySessionByOrderError = io.flow.internal.v0.models.CheckoutCreateBySessionByOrderError;
28418
+ export type CheckoutCreateBySessionByOrderErrorCode = io.flow.internal.v0.enums.CheckoutCreateBySessionByOrderErrorCode;
28419
+ export type CheckoutCreateBySessionByOrderResponseError = io.flow.internal.v0.models.CheckoutCreateBySessionByOrderResponseError;
28384
28420
  export type CheckoutCreateBySessionError = io.flow.internal.v0.models.CheckoutCreateBySessionError;
28385
28421
  export type CheckoutCreateBySessionErrorCode = io.flow.internal.v0.enums.CheckoutCreateBySessionErrorCode;
28386
28422
  export type CheckoutCreateBySessionRequestForm = io.flow.internal.v0.models.CheckoutCreateBySessionRequestForm;
@@ -29463,6 +29499,7 @@ export type Shop = io.flow.internal.v0.models.Shop;
29463
29499
  export type ShopForm = io.flow.internal.v0.models.ShopForm;
29464
29500
  export type ShopVersion = io.flow.internal.v0.models.ShopVersion;
29465
29501
  export type ShopifyXborderShop = io.flow.internal.v0.models.ShopifyXborderShop;
29502
+ export type ShopifyXborderShopForm = io.flow.internal.v0.models.ShopifyXborderShopForm;
29466
29503
  export type ShopifyCheckInventoryError = io.flow.internal.v0.models.ShopifyCheckInventoryError;
29467
29504
  export type ShopifyCheckInventoryErrorCode = io.flow.internal.v0.enums.ShopifyCheckInventoryErrorCode;
29468
29505
  export type ShopifyCodeForm = io.flow.internal.v0.models.ShopifyCodeForm;
package/src/api.ts CHANGED
@@ -1494,6 +1494,12 @@ declare namespace io.flow.v0.enums {
1494
1494
  | 'insurance'
1495
1495
  | 'discount'
1496
1496
  | 'surcharges';
1497
+ type OrderRefundSummaryIncludes = 'duties' | 'vat' | 'shipping';
1498
+ type OrderRefundSummaryPartialCharged =
1499
+ | 'per_item'
1500
+ | 'for_order'
1501
+ | 'by_value_percentage'
1502
+ | 'by_quantity_percentage';
1497
1503
  type OrderStatus = 'open' | 'submitted';
1498
1504
  type OrderStorage = 'do_not_persist' | 'persist';
1499
1505
  type OrganizationPaymentMethodTag = 'deny';
@@ -1793,6 +1799,7 @@ declare namespace io.flow.v0.models {
1793
1799
  readonly type: 'capture';
1794
1800
  readonly expires_at?: string;
1795
1801
  readonly amount_awaiting_capture?: number;
1802
+ readonly currency?: string;
1796
1803
  }
1797
1804
 
1798
1805
  interface ActionDisplayInlineWindow {
@@ -6284,6 +6291,42 @@ declare namespace io.flow.v0.models {
6284
6291
  readonly number: string;
6285
6292
  }
6286
6293
 
6294
+ interface OrderRefundSummary {
6295
+ readonly currency: string;
6296
+ readonly amounts: io.flow.v0.models.OrderRefundSummaryAmounts;
6297
+ }
6298
+
6299
+ interface OrderRefundSummaryAmounts {
6300
+ readonly balance: number;
6301
+ readonly item_subtotal: number;
6302
+ readonly discount?: number;
6303
+ readonly refund_total: number;
6304
+ readonly shipping: number;
6305
+ readonly vat: number;
6306
+ readonly duty: number;
6307
+ }
6308
+
6309
+ interface OrderRefundSummaryFullForm {
6310
+ readonly discriminator: 'order_refund_summary_full_form';
6311
+ readonly includes: io.flow.v0.enums.OrderRefundSummaryIncludes[];
6312
+ }
6313
+
6314
+ interface OrderRefundSummaryItem {
6315
+ readonly number: string;
6316
+ readonly quantity_to_refund: number;
6317
+ }
6318
+
6319
+ interface OrderRefundSummaryPartialForm {
6320
+ readonly discriminator: 'order_refund_summary_partial_form';
6321
+ readonly includes: io.flow.v0.models.OrderRefundSummaryPartialIncludes[];
6322
+ readonly items: io.flow.v0.models.OrderRefundSummaryItem[];
6323
+ }
6324
+
6325
+ interface OrderRefundSummaryPartialIncludes {
6326
+ readonly key: io.flow.v0.enums.OrderRefundSummaryIncludes;
6327
+ readonly charged: io.flow.v0.enums.OrderRefundSummaryPartialCharged;
6328
+ }
6329
+
6287
6330
  interface OrderRuleReference {
6288
6331
  readonly id: string;
6289
6332
  readonly key: string;
@@ -6916,6 +6959,7 @@ declare namespace io.flow.v0.models {
6916
6959
  readonly type: 'card';
6917
6960
  readonly merchant_of_record: io.flow.v0.enums.MerchantOfRecord;
6918
6961
  readonly last_four: string;
6962
+ readonly card_type: io.flow.v0.enums.CardType;
6919
6963
  }
6920
6964
 
6921
6965
  interface PaymentMethodSummaryGooglepay {
@@ -10069,6 +10113,9 @@ declare namespace io.flow.v0.unions {
10069
10113
  | io.flow.v0.models.OrderNumberGeneratorPrefixSuffix;
10070
10114
  type OrderPromotion = io.flow.v0.models.FreeShippingOrderPromotion;
10071
10115
  type OrderPromotionForm = io.flow.v0.models.FreeShippingOrderPromotionForm;
10116
+ type OrderRefundSummaryForm =
10117
+ | io.flow.v0.models.OrderRefundSummaryFullForm
10118
+ | io.flow.v0.models.OrderRefundSummaryPartialForm;
10072
10119
  type PartnerCenterFee =
10073
10120
  | io.flow.v0.models.CommercialInvoiceFee
10074
10121
  | io.flow.v0.models.InboundCartonFee
@@ -10966,6 +11013,15 @@ export type OrderPromotionForm = io.flow.v0.unions.OrderPromotionForm;
10966
11013
  export type OrderPromotionTrigger = io.flow.v0.models.OrderPromotionTrigger;
10967
11014
  export type OrderPutForm = io.flow.v0.models.OrderPutForm;
10968
11015
  export type OrderReference = io.flow.v0.models.OrderReference;
11016
+ export type OrderRefundSummary = io.flow.v0.models.OrderRefundSummary;
11017
+ export type OrderRefundSummaryAmounts = io.flow.v0.models.OrderRefundSummaryAmounts;
11018
+ export type OrderRefundSummaryForm = io.flow.v0.unions.OrderRefundSummaryForm;
11019
+ export type OrderRefundSummaryFullForm = io.flow.v0.models.OrderRefundSummaryFullForm;
11020
+ export type OrderRefundSummaryIncludes = io.flow.v0.enums.OrderRefundSummaryIncludes;
11021
+ export type OrderRefundSummaryItem = io.flow.v0.models.OrderRefundSummaryItem;
11022
+ export type OrderRefundSummaryPartialCharged = io.flow.v0.enums.OrderRefundSummaryPartialCharged;
11023
+ export type OrderRefundSummaryPartialForm = io.flow.v0.models.OrderRefundSummaryPartialForm;
11024
+ export type OrderRefundSummaryPartialIncludes = io.flow.v0.models.OrderRefundSummaryPartialIncludes;
10969
11025
  export type OrderRuleReference = io.flow.v0.models.OrderRuleReference;
10970
11026
  export type OrderRulesSummary = io.flow.v0.models.OrderRulesSummary;
10971
11027
  export type OrderServiceChange = io.flow.v0.models.OrderServiceChange;