@flowio/types 4.0.0 → 5.0.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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2017 Flow Commerce
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -10717,8 +10717,8 @@ declare namespace io.flow.internal.v0.models {
10717
10717
  readonly id: string;
10718
10718
  }
10719
10719
  interface BrowserBundlePaymentMethodForm {
10720
- readonly experience_key?: string;
10721
- readonly country?: string;
10720
+ readonly experience_key: string;
10721
+ readonly country: string;
10722
10722
  }
10723
10723
  interface BrowserBundlePaymentMethods {
10724
10724
  readonly displayed?: io.flow.internal.v0.models.BrowserBundlePaymentMethod[];
@@ -10814,6 +10814,7 @@ declare namespace io.flow.internal.v0.models {
10814
10814
  readonly id: string;
10815
10815
  readonly organization: io.flow.common.v0.models.OrganizationSummary;
10816
10816
  readonly builder: io.flow.experience.v0.models.OrderBuilder;
10817
+ readonly platform: io.flow.internal.v0.models.CheckoutPlatformData;
10817
10818
  readonly content: io.flow.internal.v0.models.CheckoutContent;
10818
10819
  readonly destinations: io.flow.reference.v0.models.Country[];
10819
10820
  readonly optins: io.flow.optin.internal.v0.models.OptinPrompt[];
@@ -10951,6 +10952,9 @@ declare namespace io.flow.internal.v0.models {
10951
10952
  readonly default: io.flow.internal.v0.models.ApmContent;
10952
10953
  readonly paypal?: io.flow.internal.v0.models.ApmContent;
10953
10954
  }
10955
+ interface CheckoutPlatformData {
10956
+ readonly order_number?: string;
10957
+ }
10954
10958
  interface CheckoutRedirect {
10955
10959
  readonly method: io.flow.internal.v0.enums.CheckoutRedirectMethod;
10956
10960
  readonly url: string;
@@ -11100,6 +11104,7 @@ declare namespace io.flow.internal.v0.models {
11100
11104
  readonly iso_3166_2: string;
11101
11105
  readonly iso_3166_3: string;
11102
11106
  readonly name: string;
11107
+ readonly default_currency?: string;
11103
11108
  }
11104
11109
  interface CountryPickerCurrency {
11105
11110
  readonly iso_4217_3: string;
@@ -11479,11 +11484,12 @@ declare namespace io.flow.internal.v0.models {
11479
11484
  readonly carrier: string;
11480
11485
  readonly carrier_tracking_number: string;
11481
11486
  readonly status: io.flow.tracking.v0.enums.TrackingStatus;
11482
- readonly timestamp: string;
11487
+ readonly created_at: string;
11483
11488
  readonly delivery_estimate?: string;
11484
11489
  readonly description?: string;
11485
11490
  }
11486
11491
  interface ExportTrackingLabelEvent {
11492
+ readonly id: string;
11487
11493
  readonly address?: io.flow.common.v0.models.Address;
11488
11494
  readonly carrier: string;
11489
11495
  readonly carrier_timestamp: string;
@@ -12798,32 +12804,6 @@ declare namespace io.flow.internal.v0.models {
12798
12804
  readonly name: string;
12799
12805
  readonly schema_compatibility: io.flow.internal.v0.enums.MarketingGatewaySchemaCompatibility;
12800
12806
  }
12801
- interface MultiProductItem {
12802
- readonly item_id: string;
12803
- readonly item_number: string;
12804
- readonly product_id?: string;
12805
- readonly organization_id: string;
12806
- readonly sub_items: io.flow.internal.v0.models.MultiProductSubItem[];
12807
- }
12808
- interface MultiProductItemForm {
12809
- readonly sub_item_forms: io.flow.internal.v0.models.MultiProductSubItemForm[];
12810
- }
12811
- interface MultiProductSubItem {
12812
- readonly id: string;
12813
- readonly origin: string;
12814
- readonly composition_proportion: number;
12815
- readonly description: string;
12816
- readonly hs6_code?: string;
12817
- readonly phrase_id?: string;
12818
- readonly customs_description?: string;
12819
- readonly classification_status: io.flow.internal.v0.enums.ItemClassificationStatus;
12820
- }
12821
- interface MultiProductSubItemForm {
12822
- readonly composition_proportion: number;
12823
- readonly origin: string;
12824
- readonly description: string;
12825
- readonly customs_description: string;
12826
- }
12827
12807
  interface NextBillingStatement {
12828
12808
  readonly date: string;
12829
12809
  readonly amount: io.flow.common.v0.models.Price;
@@ -14990,6 +14970,7 @@ export declare type CheckoutOrderForm = io.flow.internal.v0.models.CheckoutOrder
14990
14970
  export declare type CheckoutOrderNumberForm = io.flow.internal.v0.models.CheckoutOrderNumberForm;
14991
14971
  export declare type CheckoutPayment = io.flow.internal.v0.models.CheckoutPayment;
14992
14972
  export declare type CheckoutPaymentContent = io.flow.internal.v0.models.CheckoutPaymentContent;
14973
+ export declare type CheckoutPlatformData = io.flow.internal.v0.models.CheckoutPlatformData;
14993
14974
  export declare type CheckoutPromptBehavior = io.flow.internal.v0.enums.CheckoutPromptBehavior;
14994
14975
  export declare type CheckoutRedirect = io.flow.internal.v0.models.CheckoutRedirect;
14995
14976
  export declare type CheckoutRedirectMethod = io.flow.internal.v0.enums.CheckoutRedirectMethod;
@@ -15381,10 +15362,6 @@ export declare type MarketingGatewayProductsStatusCount = io.flow.internal.v0.mo
15381
15362
  export declare type MarketingGatewaySchemaCompatibility = io.flow.internal.v0.enums.MarketingGatewaySchemaCompatibility;
15382
15363
  export declare type MarketingGatewaySchemaSummary = io.flow.internal.v0.models.MarketingGatewaySchemaSummary;
15383
15364
  export declare type MarketingGatewaySyncStatus = io.flow.internal.v0.enums.MarketingGatewaySyncStatus;
15384
- export declare type MultiProductItem = io.flow.internal.v0.models.MultiProductItem;
15385
- export declare type MultiProductItemForm = io.flow.internal.v0.models.MultiProductItemForm;
15386
- export declare type MultiProductSubItem = io.flow.internal.v0.models.MultiProductSubItem;
15387
- export declare type MultiProductSubItemForm = io.flow.internal.v0.models.MultiProductSubItemForm;
15388
15365
  export declare type NextBillingStatement = io.flow.internal.v0.models.NextBillingStatement;
15389
15366
  export declare type NextInstallment = io.flow.internal.v0.models.NextInstallment;
15390
15367
  export declare type NextInstallmentDeleted = io.flow.internal.v0.models.NextInstallmentDeleted;
package/dist/api.d.ts CHANGED
@@ -862,7 +862,7 @@ declare namespace io.flow.v0.enums {
862
862
  type EcommercePlatformType = 'commercetools' | 'custom' | 'magento' | 'shopify' | 'sfcc' | 'solidus' | 'workarea';
863
863
  type EconomicTitleLocation = 'high_seas' | 'origination' | 'destination';
864
864
  type Environment = 'sandbox' | 'production';
865
- type EventType = 'attribute_upserted' | 'attribute_deleted' | 'attribute_upserted_v2' | 'attribute_deleted_v2' | 'catalog_upserted' | 'catalog_deleted' | 'subcatalog_upserted' | 'subcatalog_deleted' | 'catalog_item_upserted' | 'catalog_item_deleted' | 'catalog_item_upserted_v2' | 'catalog_item_deleted_v2' | 'subcatalog_item_upserted' | 'subcatalog_item_deleted' | 'b2b_invoice_upserted' | 'b2b_invoice_deleted' | 'b2b_credit_memo_upserted' | 'b2b_credit_memo_deleted' | 'consumer_invoice_upserted' | 'consumer_invoice_deleted' | 'credit_memo_upserted' | 'credit_memo_deleted' | 'crossdock_shipment_upserted' | 'rate_deleted' | 'rate_upserted' | 'rate_deleted_v3' | 'rate_upserted_v3' | 'customer_upserted' | 'customer_deleted' | 'customer_address_book_contact_upserted' | 'customer_address_book_contact_deleted' | 'available_promotions_upserted' | 'available_promotions_deleted' | 'available_promotions_upserted_v2' | 'available_promotions_deleted_v2' | 'allocation_deleted_v2' | 'allocation_upserted_v2' | 'currency_format_deleted' | 'currency_format_upserted' | 'experience_deleted' | 'experience_upserted' | 'experience_deleted_v2' | 'experience_upserted_v2' | 'experience_price_book_mapping_deleted' | 'experience_price_book_mapping_upserted' | 'experience_logistics_settings_upserted' | 'experience_logistics_settings_deleted' | 'item_margin_deleted' | 'item_margin_upserted' | 'item_sales_margin_deleted' | 'item_sales_margin_upserted' | 'label_format_deleted' | 'label_format_upserted' | 'order_deleted' | 'order_upserted' | 'order_deleted_v2' | 'order_upserted_v2' | 'order_identifier_deleted' | 'order_identifier_upserted' | 'order_identifier_deleted_v2' | 'order_identifier_upserted_v2' | 'order_identifier_upserted_v3' | 'pricing_deleted' | 'pricing_upserted' | 'order_service_change_request' | 'fraud_status_changed' | 'center_upserted' | 'center_deleted' | 'shipping_configuration_upserted' | 'shipping_configuration_deleted' | 'tier_upserted_v2' | 'tier_deleted_v2' | 'shipping_lane_upserted' | 'shipping_lane_deleted' | 'shipping_configuration_item_availability_upserted' | 'shipping_configuration_item_availability_deleted' | 'shipping_configuration_item_shipping_pricing_upserted' | 'shipping_configuration_item_shipping_pricing_deleted' | 'hs6_code_upserted' | 'hs6_code_deleted' | 'hs10_code_upserted' | 'hs10_code_deleted' | 'item_origin_upserted' | 'item_origin_deleted' | 'harmonized_item_upserted' | 'harmonized_item_deleted' | 'harmonized_landed_cost_upserted' | 'fully_harmonized_item_upserted' | 'rule_upserted' | 'rule_deleted' | 'serial_upserted' | 'serial_deleted' | 'snapshot_upserted' | 'snapshot_deleted' | 'label_upserted' | 'notification_upserted' | 'notification_deleted' | 'manifested_label_upserted' | 'manifested_label_deleted' | 'local_item_upserted' | 'local_item_deleted' | 'checkout_optin_responses_upserted' | 'checkout_optin_responses_deleted' | 'browse_optin_responses_upserted' | 'browse_optin_responses_deleted' | 'order_placed' | 'order_placed_v2' | 'ready_to_fulfill' | 'membership_upserted_v2' | 'membership_deleted_v2' | 'organization_upserted' | 'organization_deleted' | 'organization_upserted_v2' | 'organization_deleted_v2' | 'organization_short_id_upserted' | 'organization_short_id_deleted' | 'organization_default_configurations_upserted' | 'organization_default_configurations_deleted' | 'ecommerce_platform_upserted' | 'ecommerce_platform_deleted' | 'authorization_deleted_v2' | 'authorization_status_changed' | 'card_authorization_upserted_v2' | 'card_authorization_deleted_v2' | 'online_authorization_upserted_v2' | 'online_authorization_deleted_v2' | 'capture_upserted_v2' | 'capture_deleted' | 'card_upserted_v2' | 'card_deleted' | 'payment_upserted' | 'payment_deleted' | 'refund_upserted_v2' | 'refund_deleted_v2' | 'refund_capture_upserted_v2' | 'reversal_upserted' | 'reversal_deleted' | 'capture_identifier_upserted' | 'capture_identifier_deleted' | 'refund_identifier_upserted' | 'refund_identifier_deleted' | 'virtual_card_capture_upserted' | 'virtual_card_capture_deleted' | 'virtual_card_refund_upserted' | 'virtual_card_refund_deleted' | 'price_book_upserted' | 'price_book_deleted' | 'price_book_item_upserted' | 'price_book_item_deleted' | 'organization_rates_published' | 'organization_countries_published' | 'ratecard_lane_upserted' | 'ratecard_lane_deleted' | 'ratecard_upserted' | 'ratecard_deleted' | 'return_upserted' | 'return_deleted' | 'shopify_localization_setting_upserted' | 'shopify_localization_setting_deleted' | 'targeting_item_upserted' | 'targeting_item_upserted_v2' | 'targeting_item_deleted' | 'targeting_item_deleted_v3' | 'tracking_label_event_upserted';
865
+ type EventType = 'attribute_upserted' | 'attribute_deleted' | 'attribute_upserted_v2' | 'attribute_deleted_v2' | 'catalog_upserted' | 'catalog_deleted' | 'subcatalog_upserted' | 'subcatalog_deleted' | 'catalog_item_upserted' | 'catalog_item_deleted' | 'catalog_item_upserted_v2' | 'catalog_item_deleted_v2' | 'subcatalog_item_upserted' | 'subcatalog_item_deleted' | 'b2b_invoice_upserted' | 'b2b_invoice_deleted' | 'b2b_credit_memo_upserted' | 'b2b_credit_memo_deleted' | 'consumer_invoice_upserted' | 'consumer_invoice_deleted' | 'credit_memo_upserted' | 'credit_memo_deleted' | 'crossdock_shipment_upserted' | 'rate_deleted' | 'rate_upserted' | 'rate_deleted_v3' | 'rate_upserted_v3' | 'customer_upserted' | 'customer_deleted' | 'customer_address_book_contact_upserted' | 'customer_address_book_contact_deleted' | 'email_notification_upserted' | 'email_notification_deleted' | 'available_promotions_upserted' | 'available_promotions_deleted' | 'available_promotions_upserted_v2' | 'available_promotions_deleted_v2' | 'allocation_deleted_v2' | 'allocation_upserted_v2' | 'currency_format_deleted' | 'currency_format_upserted' | 'experience_deleted' | 'experience_upserted' | 'experience_deleted_v2' | 'experience_upserted_v2' | 'experience_price_book_mapping_deleted' | 'experience_price_book_mapping_upserted' | 'experience_logistics_settings_upserted' | 'experience_logistics_settings_deleted' | 'item_margin_deleted' | 'item_margin_upserted' | 'item_sales_margin_deleted' | 'item_sales_margin_upserted' | 'label_format_deleted' | 'label_format_upserted' | 'order_deleted' | 'order_upserted' | 'order_deleted_v2' | 'order_upserted_v2' | 'order_identifier_deleted' | 'order_identifier_upserted' | 'order_identifier_deleted_v2' | 'order_identifier_upserted_v2' | 'order_identifier_upserted_v3' | 'pricing_deleted' | 'pricing_upserted' | 'order_service_change_request' | 'fraud_status_changed' | 'center_upserted' | 'center_deleted' | 'shipping_configuration_upserted' | 'shipping_configuration_deleted' | 'tier_upserted_v2' | 'tier_deleted_v2' | 'shipping_lane_upserted' | 'shipping_lane_deleted' | 'shipping_configuration_item_availability_upserted' | 'shipping_configuration_item_availability_deleted' | 'shipping_configuration_item_shipping_pricing_upserted' | 'shipping_configuration_item_shipping_pricing_deleted' | 'hs6_code_upserted' | 'hs6_code_deleted' | 'hs10_code_upserted' | 'hs10_code_deleted' | 'item_origin_upserted' | 'item_origin_deleted' | 'harmonized_landed_cost_upserted' | 'fully_harmonized_item_upserted' | 'rule_upserted' | 'rule_deleted' | 'serial_upserted' | 'serial_deleted' | 'snapshot_upserted' | 'snapshot_deleted' | 'label_upserted' | 'notification_upserted' | 'notification_deleted' | 'manifested_label_upserted' | 'manifested_label_deleted' | 'local_item_upserted' | 'local_item_deleted' | 'checkout_optin_responses_upserted' | 'checkout_optin_responses_deleted' | 'browse_optin_responses_upserted' | 'browse_optin_responses_deleted' | 'order_placed' | 'order_placed_v2' | 'ready_to_fulfill' | 'membership_upserted_v2' | 'membership_deleted_v2' | 'organization_upserted' | 'organization_deleted' | 'organization_upserted_v2' | 'organization_deleted_v2' | 'organization_short_id_upserted' | 'organization_short_id_deleted' | 'organization_default_configurations_upserted' | 'organization_default_configurations_deleted' | 'ecommerce_platform_upserted' | 'ecommerce_platform_deleted' | 'authorization_deleted_v2' | 'authorization_status_changed' | 'card_authorization_upserted_v2' | 'card_authorization_deleted_v2' | 'online_authorization_upserted_v2' | 'online_authorization_deleted_v2' | 'capture_upserted_v2' | 'capture_deleted' | 'card_upserted_v2' | 'card_deleted' | 'payment_upserted' | 'payment_deleted' | 'refund_upserted_v2' | 'refund_deleted_v2' | 'refund_capture_upserted_v2' | 'reversal_upserted' | 'reversal_deleted' | 'capture_identifier_upserted' | 'capture_identifier_deleted' | 'refund_identifier_upserted' | 'refund_identifier_deleted' | 'virtual_card_capture_upserted' | 'virtual_card_capture_deleted' | 'virtual_card_refund_upserted' | 'virtual_card_refund_deleted' | 'price_book_upserted' | 'price_book_deleted' | 'price_book_item_upserted' | 'price_book_item_deleted' | 'organization_rates_published' | 'organization_countries_published' | 'ratecard_lane_upserted' | 'ratecard_lane_deleted' | 'ratecard_upserted' | 'ratecard_deleted' | 'return_upserted' | 'return_deleted' | 'shopify_localization_setting_upserted' | 'shopify_localization_setting_deleted' | 'targeting_item_upserted' | 'targeting_item_upserted_v2' | 'targeting_item_deleted' | 'targeting_item_deleted_v3' | 'tracking_label_event_upserted';
866
866
  type ExceptionType = 'open' | 'closed';
867
867
  type ExclusionRuleState = 'current' | 'deleting' | 'updating';
868
868
  type ExperienceCloneStatus = 'pending' | 'updating' | 'completed' | 'failed';
@@ -1617,6 +1617,7 @@ declare namespace io.flow.v0.models {
1617
1617
  readonly order_number: string;
1618
1618
  readonly amount: number;
1619
1619
  readonly currency: string;
1620
+ readonly browser_info?: io.flow.v0.models.BrowserInfo;
1620
1621
  }
1621
1622
  interface CardPaymentSourceForm {
1622
1623
  readonly customer_number: string;
@@ -2535,6 +2536,41 @@ declare namespace io.flow.v0.models {
2535
2536
  readonly organization: string;
2536
2537
  readonly ecommerce_platform: io.flow.v0.models.EcommercePlatform;
2537
2538
  }
2539
+ interface EmailNotification {
2540
+ readonly id: string;
2541
+ readonly to: io.flow.v0.models.EmailRecipient;
2542
+ readonly created_at: string;
2543
+ readonly data: io.flow.v0.unions.EmailNotificationData;
2544
+ }
2545
+ interface EmailNotificationDataRefund {
2546
+ readonly order: io.flow.v0.models.OrderSummary;
2547
+ readonly refund: io.flow.v0.models.OrderSummary;
2548
+ readonly payment: io.flow.v0.models.EmailPaymentSummary;
2549
+ }
2550
+ interface EmailNotificationDeleted {
2551
+ readonly event_id: string;
2552
+ readonly timestamp: string;
2553
+ readonly organization: string;
2554
+ readonly notification: io.flow.v0.models.EmailNotification;
2555
+ }
2556
+ interface EmailNotificationForm {
2557
+ readonly to: io.flow.v0.models.EmailRecipient;
2558
+ readonly created_at: string;
2559
+ readonly data: io.flow.v0.unions.EmailNotificationData;
2560
+ }
2561
+ interface EmailNotificationUpserted {
2562
+ readonly event_id: string;
2563
+ readonly timestamp: string;
2564
+ readonly organization: string;
2565
+ readonly notification: io.flow.v0.models.EmailNotification;
2566
+ }
2567
+ interface EmailPaymentSummary {
2568
+ readonly refund: io.flow.v0.models.Refund;
2569
+ }
2570
+ interface EmailRecipient {
2571
+ readonly email: string;
2572
+ readonly name?: io.flow.v0.models.Name;
2573
+ }
2538
2574
  interface EmailVerification {
2539
2575
  readonly email: string;
2540
2576
  }
@@ -3050,12 +3086,6 @@ declare namespace io.flow.v0.models {
3050
3086
  };
3051
3087
  readonly description?: string;
3052
3088
  }
3053
- interface HarmonizedItemDeleted {
3054
- readonly event_id: string;
3055
- readonly timestamp: string;
3056
- readonly organization: string;
3057
- readonly number: string;
3058
- }
3059
3089
  interface HarmonizedItemForm {
3060
3090
  readonly name: string;
3061
3091
  readonly number: string;
@@ -3082,18 +3112,6 @@ declare namespace io.flow.v0.models {
3082
3112
  readonly number: string;
3083
3113
  readonly description?: string;
3084
3114
  }
3085
- interface HarmonizedItemUpserted {
3086
- readonly event_id: string;
3087
- readonly timestamp: string;
3088
- readonly organization: string;
3089
- readonly number: string;
3090
- readonly name: string;
3091
- readonly categories: string[];
3092
- readonly attributes: {
3093
- [key: string]: string;
3094
- };
3095
- readonly description?: string;
3096
- }
3097
3115
  interface HarmonizedLandedCost {
3098
3116
  readonly address: io.flow.v0.models.Address;
3099
3117
  readonly items: io.flow.v0.models.HarmonizedLandedCostItem[];
@@ -4458,13 +4476,15 @@ declare namespace io.flow.v0.models {
4458
4476
  readonly primary?: boolean;
4459
4477
  }
4460
4478
  interface OrderSummary {
4479
+ readonly number: string;
4461
4480
  readonly subtotal: io.flow.v0.models.OrderSummaryPriceDetail;
4462
- readonly shipping: io.flow.v0.models.OrderSummaryPriceDetail;
4481
+ readonly shipping?: io.flow.v0.models.OrderSummaryPriceDetail;
4463
4482
  readonly tax?: io.flow.v0.models.OrderSummaryPriceDetail;
4464
4483
  readonly duty?: io.flow.v0.models.OrderSummaryPriceDetail;
4465
4484
  readonly insurance?: io.flow.v0.models.OrderSummaryPriceDetail;
4466
4485
  readonly discount?: io.flow.v0.models.OrderSummaryPriceDetail;
4467
4486
  readonly surcharges?: io.flow.v0.models.OrderSummaryPriceDetail;
4487
+ readonly adjustment?: io.flow.v0.models.OrderSummaryPriceDetail;
4468
4488
  readonly total: io.flow.v0.models.OrderSummaryPriceDetail;
4469
4489
  readonly lines: io.flow.v0.models.OrderSummaryLineItem[];
4470
4490
  }
@@ -4481,6 +4501,9 @@ declare namespace io.flow.v0.models {
4481
4501
  readonly discount?: io.flow.v0.models.Price;
4482
4502
  readonly tax?: io.flow.v0.models.OrderSummaryLevy;
4483
4503
  readonly duty?: io.flow.v0.models.OrderSummaryLevy;
4504
+ readonly price_attributes: {
4505
+ [key: string]: io.flow.v0.models.Price;
4506
+ };
4484
4507
  }
4485
4508
  interface OrderSummaryLevy {
4486
4509
  readonly rate: number;
@@ -4493,6 +4516,9 @@ declare namespace io.flow.v0.models {
4493
4516
  readonly tax?: io.flow.v0.models.OrderSummaryLevy;
4494
4517
  readonly duty?: io.flow.v0.models.OrderSummaryLevy;
4495
4518
  readonly total: io.flow.v0.models.Price;
4519
+ readonly price_attributes: {
4520
+ [key: string]: io.flow.v0.models.Price;
4521
+ };
4496
4522
  }
4497
4523
  interface OrderSummaryPriceDetail {
4498
4524
  readonly price: io.flow.v0.models.Price;
@@ -7130,6 +7156,9 @@ declare namespace io.flow.v0.unions {
7130
7156
  } & io.flow.v0.models.CatalogItemDocument | {
7131
7157
  discriminator: 'harmonization_document';
7132
7158
  } & io.flow.v0.models.HarmonizationDocument;
7159
+ type EmailNotificationData = {
7160
+ discriminator: 'refund';
7161
+ } & io.flow.v0.models.EmailNotificationDataRefund;
7133
7162
  type Event = {
7134
7163
  discriminator: 'attribute_upserted';
7135
7164
  } & io.flow.v0.models.AttributeUpserted | {
@@ -7193,6 +7222,10 @@ declare namespace io.flow.v0.unions {
7193
7222
  } & io.flow.v0.models.CustomerAddressBookContactUpserted | {
7194
7223
  discriminator: 'customer_address_book_contact_deleted';
7195
7224
  } & io.flow.v0.models.CustomerAddressBookContactDeleted | {
7225
+ discriminator: 'email_notification_upserted';
7226
+ } & io.flow.v0.models.EmailNotificationUpserted | {
7227
+ discriminator: 'email_notification_deleted';
7228
+ } & io.flow.v0.models.EmailNotificationDeleted | {
7196
7229
  discriminator: 'available_promotions_upserted';
7197
7230
  } & io.flow.v0.models.AvailablePromotionsUpserted | {
7198
7231
  discriminator: 'available_promotions_deleted';
@@ -7299,10 +7332,6 @@ declare namespace io.flow.v0.unions {
7299
7332
  } & io.flow.v0.models.ItemOriginUpserted | {
7300
7333
  discriminator: 'item_origin_deleted';
7301
7334
  } & io.flow.v0.models.ItemOriginDeleted | {
7302
- discriminator: 'harmonized_item_upserted';
7303
- } & io.flow.v0.models.HarmonizedItemUpserted | {
7304
- discriminator: 'harmonized_item_deleted';
7305
- } & io.flow.v0.models.HarmonizedItemDeleted | {
7306
7335
  discriminator: 'harmonized_landed_cost_upserted';
7307
7336
  } & io.flow.v0.models.HarmonizedLandedCostUpserted | {
7308
7337
  discriminator: 'fully_harmonized_item_upserted';
@@ -8050,6 +8079,14 @@ export declare type EcommercePlatformDeleted = io.flow.v0.models.EcommercePlatfo
8050
8079
  export declare type EcommercePlatformType = io.flow.v0.enums.EcommercePlatformType;
8051
8080
  export declare type EcommercePlatformUpserted = io.flow.v0.models.EcommercePlatformUpserted;
8052
8081
  export declare type EconomicTitleLocation = io.flow.v0.enums.EconomicTitleLocation;
8082
+ export declare type EmailNotification = io.flow.v0.models.EmailNotification;
8083
+ export declare type EmailNotificationData = io.flow.v0.unions.EmailNotificationData;
8084
+ export declare type EmailNotificationDataRefund = io.flow.v0.models.EmailNotificationDataRefund;
8085
+ export declare type EmailNotificationDeleted = io.flow.v0.models.EmailNotificationDeleted;
8086
+ export declare type EmailNotificationForm = io.flow.v0.models.EmailNotificationForm;
8087
+ export declare type EmailNotificationUpserted = io.flow.v0.models.EmailNotificationUpserted;
8088
+ export declare type EmailPaymentSummary = io.flow.v0.models.EmailPaymentSummary;
8089
+ export declare type EmailRecipient = io.flow.v0.models.EmailRecipient;
8053
8090
  export declare type EmailVerification = io.flow.v0.models.EmailVerification;
8054
8091
  export declare type Environment = io.flow.v0.enums.Environment;
8055
8092
  export declare type EstimatedDimensions = io.flow.v0.models.EstimatedDimensions;
@@ -8181,11 +8218,9 @@ export declare type HarmonizationOverviewExportType = io.flow.v0.models.Harmoniz
8181
8218
  export declare type HarmonizedCategory = io.flow.v0.models.HarmonizedCategory;
8182
8219
  export declare type HarmonizedCategoryReference = io.flow.v0.models.HarmonizedCategoryReference;
8183
8220
  export declare type HarmonizedItem = io.flow.v0.models.HarmonizedItem;
8184
- export declare type HarmonizedItemDeleted = io.flow.v0.models.HarmonizedItemDeleted;
8185
8221
  export declare type HarmonizedItemForm = io.flow.v0.models.HarmonizedItemForm;
8186
8222
  export declare type HarmonizedItemPutForm = io.flow.v0.models.HarmonizedItemPutForm;
8187
8223
  export declare type HarmonizedItemReference = io.flow.v0.models.HarmonizedItemReference;
8188
- export declare type HarmonizedItemUpserted = io.flow.v0.models.HarmonizedItemUpserted;
8189
8224
  export declare type HarmonizedLandedCost = io.flow.v0.models.HarmonizedLandedCost;
8190
8225
  export declare type HarmonizedLandedCostForm = io.flow.v0.models.HarmonizedLandedCostForm;
8191
8226
  export declare type HarmonizedLandedCostItem = io.flow.v0.models.HarmonizedLandedCostItem;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flowio/types",
3
- "version": "4.0.0",
3
+ "version": "5.0.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",
@@ -26,5 +26,6 @@
26
26
  "devDependencies": {
27
27
  "prettier": "^1.18.2",
28
28
  "typescript": "^3.6.3"
29
- }
29
+ },
30
+ "gitHead": "4ad9c425f2a16826ec2358433e88e5da6eb740f3"
30
31
  }
@@ -13564,8 +13564,8 @@ declare namespace io.flow.internal.v0.models {
13564
13564
  }
13565
13565
 
13566
13566
  interface BrowserBundlePaymentMethodForm {
13567
- readonly experience_key?: string;
13568
- readonly country?: string;
13567
+ readonly experience_key: string;
13568
+ readonly country: string;
13569
13569
  }
13570
13570
 
13571
13571
  interface BrowserBundlePaymentMethods {
@@ -13680,6 +13680,7 @@ declare namespace io.flow.internal.v0.models {
13680
13680
  readonly id: string;
13681
13681
  readonly organization: io.flow.common.v0.models.OrganizationSummary;
13682
13682
  readonly builder: io.flow.experience.v0.models.OrderBuilder;
13683
+ readonly platform: io.flow.internal.v0.models.CheckoutPlatformData;
13683
13684
  readonly content: io.flow.internal.v0.models.CheckoutContent;
13684
13685
  readonly destinations: io.flow.reference.v0.models.Country[];
13685
13686
  readonly optins: io.flow.optin.internal.v0.models.OptinPrompt[];
@@ -13839,6 +13840,10 @@ declare namespace io.flow.internal.v0.models {
13839
13840
  readonly paypal?: io.flow.internal.v0.models.ApmContent;
13840
13841
  }
13841
13842
 
13843
+ interface CheckoutPlatformData {
13844
+ readonly order_number?: string;
13845
+ }
13846
+
13842
13847
  interface CheckoutRedirect {
13843
13848
  readonly method: io.flow.internal.v0.enums.CheckoutRedirectMethod;
13844
13849
  readonly url: string;
@@ -14013,6 +14018,7 @@ declare namespace io.flow.internal.v0.models {
14013
14018
  readonly iso_3166_2: string;
14014
14019
  readonly iso_3166_3: string;
14015
14020
  readonly name: string;
14021
+ readonly default_currency?: string;
14016
14022
  }
14017
14023
 
14018
14024
  interface CountryPickerCurrency {
@@ -14457,12 +14463,13 @@ declare namespace io.flow.internal.v0.models {
14457
14463
  readonly carrier: string;
14458
14464
  readonly carrier_tracking_number: string;
14459
14465
  readonly status: io.flow.tracking.v0.enums.TrackingStatus;
14460
- readonly timestamp: string;
14466
+ readonly created_at: string;
14461
14467
  readonly delivery_estimate?: string;
14462
14468
  readonly description?: string;
14463
14469
  }
14464
14470
 
14465
14471
  interface ExportTrackingLabelEvent {
14472
+ readonly id: string;
14466
14473
  readonly address?: io.flow.common.v0.models.Address;
14467
14474
  readonly carrier: string;
14468
14475
  readonly carrier_timestamp: string;
@@ -16000,36 +16007,6 @@ declare namespace io.flow.internal.v0.models {
16000
16007
  readonly schema_compatibility: io.flow.internal.v0.enums.MarketingGatewaySchemaCompatibility;
16001
16008
  }
16002
16009
 
16003
- interface MultiProductItem {
16004
- readonly item_id: string;
16005
- readonly item_number: string;
16006
- readonly product_id?: string;
16007
- readonly organization_id: string;
16008
- readonly sub_items: io.flow.internal.v0.models.MultiProductSubItem[];
16009
- }
16010
-
16011
- interface MultiProductItemForm {
16012
- readonly sub_item_forms: io.flow.internal.v0.models.MultiProductSubItemForm[];
16013
- }
16014
-
16015
- interface MultiProductSubItem {
16016
- readonly id: string;
16017
- readonly origin: string;
16018
- readonly composition_proportion: number;
16019
- readonly description: string;
16020
- readonly hs6_code?: string;
16021
- readonly phrase_id?: string;
16022
- readonly customs_description?: string;
16023
- readonly classification_status: io.flow.internal.v0.enums.ItemClassificationStatus;
16024
- }
16025
-
16026
- interface MultiProductSubItemForm {
16027
- readonly composition_proportion: number;
16028
- readonly origin: string;
16029
- readonly description: string;
16030
- readonly customs_description: string;
16031
- }
16032
-
16033
16010
  interface NextBillingStatement {
16034
16011
  readonly date: string;
16035
16012
  readonly amount: io.flow.common.v0.models.Price;
@@ -18728,6 +18705,7 @@ export type CheckoutOrderForm = io.flow.internal.v0.models.CheckoutOrderForm;
18728
18705
  export type CheckoutOrderNumberForm = io.flow.internal.v0.models.CheckoutOrderNumberForm;
18729
18706
  export type CheckoutPayment = io.flow.internal.v0.models.CheckoutPayment;
18730
18707
  export type CheckoutPaymentContent = io.flow.internal.v0.models.CheckoutPaymentContent;
18708
+ export type CheckoutPlatformData = io.flow.internal.v0.models.CheckoutPlatformData;
18731
18709
  export type CheckoutPromptBehavior = io.flow.internal.v0.enums.CheckoutPromptBehavior;
18732
18710
  export type CheckoutRedirect = io.flow.internal.v0.models.CheckoutRedirect;
18733
18711
  export type CheckoutRedirectMethod = io.flow.internal.v0.enums.CheckoutRedirectMethod;
@@ -19119,10 +19097,6 @@ export type MarketingGatewayProductsStatusCount = io.flow.internal.v0.models.Mar
19119
19097
  export type MarketingGatewaySchemaCompatibility = io.flow.internal.v0.enums.MarketingGatewaySchemaCompatibility;
19120
19098
  export type MarketingGatewaySchemaSummary = io.flow.internal.v0.models.MarketingGatewaySchemaSummary;
19121
19099
  export type MarketingGatewaySyncStatus = io.flow.internal.v0.enums.MarketingGatewaySyncStatus;
19122
- export type MultiProductItem = io.flow.internal.v0.models.MultiProductItem;
19123
- export type MultiProductItemForm = io.flow.internal.v0.models.MultiProductItemForm;
19124
- export type MultiProductSubItem = io.flow.internal.v0.models.MultiProductSubItem;
19125
- export type MultiProductSubItemForm = io.flow.internal.v0.models.MultiProductSubItemForm;
19126
19100
  export type NextBillingStatement = io.flow.internal.v0.models.NextBillingStatement;
19127
19101
  export type NextInstallment = io.flow.internal.v0.models.NextInstallment;
19128
19102
  export type NextInstallmentDeleted = io.flow.internal.v0.models.NextInstallmentDeleted;
package/src/api.ts CHANGED
@@ -1194,6 +1194,8 @@ declare namespace io.flow.v0.enums {
1194
1194
  | 'customer_deleted'
1195
1195
  | 'customer_address_book_contact_upserted'
1196
1196
  | 'customer_address_book_contact_deleted'
1197
+ | 'email_notification_upserted'
1198
+ | 'email_notification_deleted'
1197
1199
  | 'available_promotions_upserted'
1198
1200
  | 'available_promotions_deleted'
1199
1201
  | 'available_promotions_upserted_v2'
@@ -1247,8 +1249,6 @@ declare namespace io.flow.v0.enums {
1247
1249
  | 'hs10_code_deleted'
1248
1250
  | 'item_origin_upserted'
1249
1251
  | 'item_origin_deleted'
1250
- | 'harmonized_item_upserted'
1251
- | 'harmonized_item_deleted'
1252
1252
  | 'harmonized_landed_cost_upserted'
1253
1253
  | 'fully_harmonized_item_upserted'
1254
1254
  | 'rule_upserted'
@@ -2372,6 +2372,7 @@ declare namespace io.flow.v0.models {
2372
2372
  readonly order_number: string;
2373
2373
  readonly amount: number;
2374
2374
  readonly currency: string;
2375
+ readonly browser_info?: io.flow.v0.models.BrowserInfo;
2375
2376
  }
2376
2377
 
2377
2378
  interface CardPaymentSourceForm {
@@ -3442,6 +3443,48 @@ declare namespace io.flow.v0.models {
3442
3443
  readonly ecommerce_platform: io.flow.v0.models.EcommercePlatform;
3443
3444
  }
3444
3445
 
3446
+ interface EmailNotification {
3447
+ readonly id: string;
3448
+ readonly to: io.flow.v0.models.EmailRecipient;
3449
+ readonly created_at: string;
3450
+ readonly data: io.flow.v0.unions.EmailNotificationData;
3451
+ }
3452
+
3453
+ interface EmailNotificationDataRefund {
3454
+ readonly order: io.flow.v0.models.OrderSummary;
3455
+ readonly refund: io.flow.v0.models.OrderSummary;
3456
+ readonly payment: io.flow.v0.models.EmailPaymentSummary;
3457
+ }
3458
+
3459
+ interface EmailNotificationDeleted {
3460
+ readonly event_id: string;
3461
+ readonly timestamp: string;
3462
+ readonly organization: string;
3463
+ readonly notification: io.flow.v0.models.EmailNotification;
3464
+ }
3465
+
3466
+ interface EmailNotificationForm {
3467
+ readonly to: io.flow.v0.models.EmailRecipient;
3468
+ readonly created_at: string;
3469
+ readonly data: io.flow.v0.unions.EmailNotificationData;
3470
+ }
3471
+
3472
+ interface EmailNotificationUpserted {
3473
+ readonly event_id: string;
3474
+ readonly timestamp: string;
3475
+ readonly organization: string;
3476
+ readonly notification: io.flow.v0.models.EmailNotification;
3477
+ }
3478
+
3479
+ interface EmailPaymentSummary {
3480
+ readonly refund: io.flow.v0.models.Refund;
3481
+ }
3482
+
3483
+ interface EmailRecipient {
3484
+ readonly email: string;
3485
+ readonly name?: io.flow.v0.models.Name;
3486
+ }
3487
+
3445
3488
  interface EmailVerification {
3446
3489
  readonly email: string;
3447
3490
  }
@@ -4054,13 +4097,6 @@ declare namespace io.flow.v0.models {
4054
4097
  readonly description?: string;
4055
4098
  }
4056
4099
 
4057
- interface HarmonizedItemDeleted {
4058
- readonly event_id: string;
4059
- readonly timestamp: string;
4060
- readonly organization: string;
4061
- readonly number: string;
4062
- }
4063
-
4064
4100
  interface HarmonizedItemForm {
4065
4101
  readonly name: string;
4066
4102
  readonly number: string;
@@ -4090,19 +4126,6 @@ declare namespace io.flow.v0.models {
4090
4126
  readonly description?: string;
4091
4127
  }
4092
4128
 
4093
- interface HarmonizedItemUpserted {
4094
- readonly event_id: string;
4095
- readonly timestamp: string;
4096
- readonly organization: string;
4097
- readonly number: string;
4098
- readonly name: string;
4099
- readonly categories: string[];
4100
- readonly attributes: {
4101
- [key: string]: string;
4102
- };
4103
- readonly description?: string;
4104
- }
4105
-
4106
4129
  interface HarmonizedLandedCost {
4107
4130
  readonly address: io.flow.v0.models.Address;
4108
4131
  readonly items: io.flow.v0.models.HarmonizedLandedCostItem[];
@@ -5678,13 +5701,15 @@ declare namespace io.flow.v0.models {
5678
5701
  }
5679
5702
 
5680
5703
  interface OrderSummary {
5704
+ readonly number: string;
5681
5705
  readonly subtotal: io.flow.v0.models.OrderSummaryPriceDetail;
5682
- readonly shipping: io.flow.v0.models.OrderSummaryPriceDetail;
5706
+ readonly shipping?: io.flow.v0.models.OrderSummaryPriceDetail;
5683
5707
  readonly tax?: io.flow.v0.models.OrderSummaryPriceDetail;
5684
5708
  readonly duty?: io.flow.v0.models.OrderSummaryPriceDetail;
5685
5709
  readonly insurance?: io.flow.v0.models.OrderSummaryPriceDetail;
5686
5710
  readonly discount?: io.flow.v0.models.OrderSummaryPriceDetail;
5687
5711
  readonly surcharges?: io.flow.v0.models.OrderSummaryPriceDetail;
5712
+ readonly adjustment?: io.flow.v0.models.OrderSummaryPriceDetail;
5688
5713
  readonly total: io.flow.v0.models.OrderSummaryPriceDetail;
5689
5714
  readonly lines: io.flow.v0.models.OrderSummaryLineItem[];
5690
5715
  }
@@ -5703,6 +5728,9 @@ declare namespace io.flow.v0.models {
5703
5728
  readonly discount?: io.flow.v0.models.Price;
5704
5729
  readonly tax?: io.flow.v0.models.OrderSummaryLevy;
5705
5730
  readonly duty?: io.flow.v0.models.OrderSummaryLevy;
5731
+ readonly price_attributes: {
5732
+ [key: string]: io.flow.v0.models.Price;
5733
+ };
5706
5734
  }
5707
5735
 
5708
5736
  interface OrderSummaryLevy {
@@ -5717,6 +5745,9 @@ declare namespace io.flow.v0.models {
5717
5745
  readonly tax?: io.flow.v0.models.OrderSummaryLevy;
5718
5746
  readonly duty?: io.flow.v0.models.OrderSummaryLevy;
5719
5747
  readonly total: io.flow.v0.models.Price;
5748
+ readonly price_attributes: {
5749
+ [key: string]: io.flow.v0.models.Price;
5750
+ };
5720
5751
  }
5721
5752
 
5722
5753
  interface OrderSummaryPriceDetail {
@@ -8826,6 +8857,10 @@ declare namespace io.flow.v0.unions {
8826
8857
  discriminator: 'harmonization_document';
8827
8858
  } & io.flow.v0.models.HarmonizationDocument;
8828
8859
 
8860
+ type EmailNotificationData = {
8861
+ discriminator: 'refund';
8862
+ } & io.flow.v0.models.EmailNotificationDataRefund;
8863
+
8829
8864
  type Event =
8830
8865
  | {
8831
8866
  discriminator: 'attribute_upserted';
@@ -8920,6 +8955,12 @@ declare namespace io.flow.v0.unions {
8920
8955
  | {
8921
8956
  discriminator: 'customer_address_book_contact_deleted';
8922
8957
  } & io.flow.v0.models.CustomerAddressBookContactDeleted
8958
+ | {
8959
+ discriminator: 'email_notification_upserted';
8960
+ } & io.flow.v0.models.EmailNotificationUpserted
8961
+ | {
8962
+ discriminator: 'email_notification_deleted';
8963
+ } & io.flow.v0.models.EmailNotificationDeleted
8923
8964
  | {
8924
8965
  discriminator: 'available_promotions_upserted';
8925
8966
  } & io.flow.v0.models.AvailablePromotionsUpserted
@@ -9079,12 +9120,6 @@ declare namespace io.flow.v0.unions {
9079
9120
  | {
9080
9121
  discriminator: 'item_origin_deleted';
9081
9122
  } & io.flow.v0.models.ItemOriginDeleted
9082
- | {
9083
- discriminator: 'harmonized_item_upserted';
9084
- } & io.flow.v0.models.HarmonizedItemUpserted
9085
- | {
9086
- discriminator: 'harmonized_item_deleted';
9087
- } & io.flow.v0.models.HarmonizedItemDeleted
9088
9123
  | {
9089
9124
  discriminator: 'harmonized_landed_cost_upserted';
9090
9125
  } & io.flow.v0.models.HarmonizedLandedCostUpserted
@@ -10063,6 +10098,14 @@ export type EcommercePlatformDeleted = io.flow.v0.models.EcommercePlatformDelete
10063
10098
  export type EcommercePlatformType = io.flow.v0.enums.EcommercePlatformType;
10064
10099
  export type EcommercePlatformUpserted = io.flow.v0.models.EcommercePlatformUpserted;
10065
10100
  export type EconomicTitleLocation = io.flow.v0.enums.EconomicTitleLocation;
10101
+ export type EmailNotification = io.flow.v0.models.EmailNotification;
10102
+ export type EmailNotificationData = io.flow.v0.unions.EmailNotificationData;
10103
+ export type EmailNotificationDataRefund = io.flow.v0.models.EmailNotificationDataRefund;
10104
+ export type EmailNotificationDeleted = io.flow.v0.models.EmailNotificationDeleted;
10105
+ export type EmailNotificationForm = io.flow.v0.models.EmailNotificationForm;
10106
+ export type EmailNotificationUpserted = io.flow.v0.models.EmailNotificationUpserted;
10107
+ export type EmailPaymentSummary = io.flow.v0.models.EmailPaymentSummary;
10108
+ export type EmailRecipient = io.flow.v0.models.EmailRecipient;
10066
10109
  export type EmailVerification = io.flow.v0.models.EmailVerification;
10067
10110
  export type Environment = io.flow.v0.enums.Environment;
10068
10111
  export type EstimatedDimensions = io.flow.v0.models.EstimatedDimensions;
@@ -10194,11 +10237,9 @@ export type HarmonizationOverviewExportType = io.flow.v0.models.HarmonizationOve
10194
10237
  export type HarmonizedCategory = io.flow.v0.models.HarmonizedCategory;
10195
10238
  export type HarmonizedCategoryReference = io.flow.v0.models.HarmonizedCategoryReference;
10196
10239
  export type HarmonizedItem = io.flow.v0.models.HarmonizedItem;
10197
- export type HarmonizedItemDeleted = io.flow.v0.models.HarmonizedItemDeleted;
10198
10240
  export type HarmonizedItemForm = io.flow.v0.models.HarmonizedItemForm;
10199
10241
  export type HarmonizedItemPutForm = io.flow.v0.models.HarmonizedItemPutForm;
10200
10242
  export type HarmonizedItemReference = io.flow.v0.models.HarmonizedItemReference;
10201
- export type HarmonizedItemUpserted = io.flow.v0.models.HarmonizedItemUpserted;
10202
10243
  export type HarmonizedLandedCost = io.flow.v0.models.HarmonizedLandedCost;
10203
10244
  export type HarmonizedLandedCostForm = io.flow.v0.models.HarmonizedLandedCostForm;
10204
10245
  export type HarmonizedLandedCostItem = io.flow.v0.models.HarmonizedLandedCostItem;