@flowio/types 5.0.0 → 6.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/dist/api.d.ts +39 -15
- package/package.json +2 -2
- package/src/api.ts +42 -18
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' | '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' | '
|
|
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' | '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';
|
|
@@ -921,6 +921,7 @@ declare namespace io.flow.v0.enums {
|
|
|
921
921
|
type PriceBookStatus = 'draft' | 'published' | 'archived';
|
|
922
922
|
type PriceDetailComponentKey = 'base_price' | 'discount' | 'currency_margin' | 'percent_item_margin' | 'fixed_item_margin' | 'duties_item_price' | 'duties_added_margin' | 'duties_rounding' | 'duties_deminimis' | 'vat_item_price' | 'vat_added_margin' | 'vat_rounding' | 'vat_duties_item_price' | 'vat_duties_added_margin' | 'vat_duties_rounding' | 'vat_deminimis' | 'item_price_percent_sales_margin' | 'margins_percent_sales_margin' | 'rounding_percent_sales_margin' | 'vat_percent_sales_margin' | 'vat_duty_percent_sales_margin' | 'duty_percent_sales_margin';
|
|
923
923
|
type PriceDetailKey = 'item_price' | 'margins' | 'vat' | 'duty' | 'rounding' | 'adjustment';
|
|
924
|
+
type PriceFacetBoundary = 'min' | 'max';
|
|
924
925
|
type PricingLevySetting = 'included' | 'displayed' | 'ignored';
|
|
925
926
|
type PromotionTriggerType = 'automatic' | 'order_subtotal';
|
|
926
927
|
type ProvinceType = 'city' | 'dependency' | 'district' | 'emirate' | 'entity' | 'municipality' | 'outlying_area' | 'parish' | 'province' | 'state' | 'territory' | 'other';
|
|
@@ -1494,6 +1495,7 @@ declare namespace io.flow.v0.models {
|
|
|
1494
1495
|
interface CaptureIdentifier {
|
|
1495
1496
|
readonly id: string;
|
|
1496
1497
|
readonly capture: io.flow.v0.models.CaptureReference;
|
|
1498
|
+
readonly name: string;
|
|
1497
1499
|
readonly identifier: string;
|
|
1498
1500
|
readonly primary: boolean;
|
|
1499
1501
|
}
|
|
@@ -2002,6 +2004,7 @@ declare namespace io.flow.v0.models {
|
|
|
2002
2004
|
readonly item_number: string;
|
|
2003
2005
|
readonly quantity: number;
|
|
2004
2006
|
readonly unit_price: number;
|
|
2007
|
+
readonly unit_discount?: number;
|
|
2005
2008
|
readonly unit_tax?: io.flow.v0.models.ConsumerInvoiceLevyForm;
|
|
2006
2009
|
readonly unit_duty?: io.flow.v0.models.ConsumerInvoiceLevyForm;
|
|
2007
2010
|
}
|
|
@@ -2013,6 +2016,7 @@ declare namespace io.flow.v0.models {
|
|
|
2013
2016
|
}
|
|
2014
2017
|
interface ConsumerInvoiceLineShippingForm {
|
|
2015
2018
|
readonly price: number;
|
|
2019
|
+
readonly discount?: number;
|
|
2016
2020
|
readonly tax?: io.flow.v0.models.ConsumerInvoiceLevyForm;
|
|
2017
2021
|
readonly duty?: io.flow.v0.models.ConsumerInvoiceLevyForm;
|
|
2018
2022
|
}
|
|
@@ -2544,7 +2548,7 @@ declare namespace io.flow.v0.models {
|
|
|
2544
2548
|
}
|
|
2545
2549
|
interface EmailNotificationDataRefund {
|
|
2546
2550
|
readonly order: io.flow.v0.models.OrderSummary;
|
|
2547
|
-
readonly
|
|
2551
|
+
readonly return: io.flow.v0.models.OrderSummary;
|
|
2548
2552
|
readonly payment: io.flow.v0.models.EmailPaymentSummary;
|
|
2549
2553
|
}
|
|
2550
2554
|
interface EmailNotificationDeleted {
|
|
@@ -2767,6 +2771,19 @@ declare namespace io.flow.v0.models {
|
|
|
2767
2771
|
readonly organization: string;
|
|
2768
2772
|
readonly experience_price_book_mapping: io.flow.v0.models.ExperiencePriceBookMapping;
|
|
2769
2773
|
}
|
|
2774
|
+
interface ExperiencePriceFacetConversion {
|
|
2775
|
+
readonly request: io.flow.v0.models.ExperiencePriceFacetConversionRequest;
|
|
2776
|
+
readonly price: io.flow.v0.models.PriceWithBase;
|
|
2777
|
+
}
|
|
2778
|
+
interface ExperiencePriceFacetConversionRequest {
|
|
2779
|
+
readonly boundary: io.flow.v0.enums.PriceFacetBoundary;
|
|
2780
|
+
readonly value: number;
|
|
2781
|
+
readonly base: string;
|
|
2782
|
+
readonly local: string;
|
|
2783
|
+
}
|
|
2784
|
+
interface ExperiencePriceFacetConversionResponse {
|
|
2785
|
+
readonly facets: io.flow.v0.models.ExperiencePriceFacetConversion[];
|
|
2786
|
+
}
|
|
2770
2787
|
interface ExperienceReference {
|
|
2771
2788
|
readonly key: string;
|
|
2772
2789
|
}
|
|
@@ -3210,6 +3227,7 @@ declare namespace io.flow.v0.models {
|
|
|
3210
3227
|
}
|
|
3211
3228
|
interface IdentifierForm {
|
|
3212
3229
|
readonly primary?: boolean;
|
|
3230
|
+
readonly name?: string;
|
|
3213
3231
|
}
|
|
3214
3232
|
interface Image {
|
|
3215
3233
|
readonly url: string;
|
|
@@ -4291,6 +4309,7 @@ declare namespace io.flow.v0.models {
|
|
|
4291
4309
|
interface OrderIdentifier {
|
|
4292
4310
|
readonly id: string;
|
|
4293
4311
|
readonly order: io.flow.v0.models.OrderReference;
|
|
4312
|
+
readonly name: string;
|
|
4294
4313
|
readonly identifier: string;
|
|
4295
4314
|
readonly primary: boolean;
|
|
4296
4315
|
readonly number?: string;
|
|
@@ -4308,12 +4327,14 @@ declare namespace io.flow.v0.models {
|
|
|
4308
4327
|
}
|
|
4309
4328
|
interface OrderIdentifierForm {
|
|
4310
4329
|
readonly order: string;
|
|
4330
|
+
readonly name?: string;
|
|
4311
4331
|
readonly identifier?: string;
|
|
4312
4332
|
readonly number?: string;
|
|
4313
4333
|
readonly primary?: boolean;
|
|
4314
4334
|
}
|
|
4315
4335
|
interface OrderIdentifierPutForm {
|
|
4316
4336
|
readonly order: string;
|
|
4337
|
+
readonly name?: string;
|
|
4317
4338
|
readonly primary?: boolean;
|
|
4318
4339
|
}
|
|
4319
4340
|
interface OrderIdentifierUpserted {
|
|
@@ -4411,6 +4432,7 @@ declare namespace io.flow.v0.models {
|
|
|
4411
4432
|
readonly name?: string;
|
|
4412
4433
|
readonly rate?: number;
|
|
4413
4434
|
readonly accuracy?: io.flow.v0.enums.PriceAccuracy;
|
|
4435
|
+
readonly rate_label?: string;
|
|
4414
4436
|
}
|
|
4415
4437
|
interface OrderPriceDetailComponent {
|
|
4416
4438
|
readonly key: io.flow.v0.enums.OrderPriceDetailComponentKey;
|
|
@@ -4473,6 +4495,7 @@ declare namespace io.flow.v0.models {
|
|
|
4473
4495
|
}
|
|
4474
4496
|
interface OrderSubmissionIdentifierForm {
|
|
4475
4497
|
readonly identifier: string;
|
|
4498
|
+
readonly name?: string;
|
|
4476
4499
|
readonly primary?: boolean;
|
|
4477
4500
|
}
|
|
4478
4501
|
interface OrderSummary {
|
|
@@ -4487,6 +4510,12 @@ declare namespace io.flow.v0.models {
|
|
|
4487
4510
|
readonly adjustment?: io.flow.v0.models.OrderSummaryPriceDetail;
|
|
4488
4511
|
readonly total: io.flow.v0.models.OrderSummaryPriceDetail;
|
|
4489
4512
|
readonly lines: io.flow.v0.models.OrderSummaryLineItem[];
|
|
4513
|
+
readonly identifiers?: io.flow.v0.models.OrderSummaryIdentifier[];
|
|
4514
|
+
}
|
|
4515
|
+
interface OrderSummaryIdentifier {
|
|
4516
|
+
readonly name: string;
|
|
4517
|
+
readonly identifier: string;
|
|
4518
|
+
readonly primary: boolean;
|
|
4490
4519
|
}
|
|
4491
4520
|
interface OrderSummaryImage {
|
|
4492
4521
|
readonly url: string;
|
|
@@ -4507,6 +4536,7 @@ declare namespace io.flow.v0.models {
|
|
|
4507
4536
|
}
|
|
4508
4537
|
interface OrderSummaryLevy {
|
|
4509
4538
|
readonly rate: number;
|
|
4539
|
+
readonly rate_label?: string;
|
|
4510
4540
|
readonly value: io.flow.v0.models.Price;
|
|
4511
4541
|
}
|
|
4512
4542
|
interface OrderSummaryLineItem {
|
|
@@ -4524,6 +4554,7 @@ declare namespace io.flow.v0.models {
|
|
|
4524
4554
|
readonly price: io.flow.v0.models.Price;
|
|
4525
4555
|
readonly name?: string;
|
|
4526
4556
|
readonly rate?: number;
|
|
4557
|
+
readonly rate_label?: string;
|
|
4527
4558
|
}
|
|
4528
4559
|
interface OrderUpserted {
|
|
4529
4560
|
readonly event_id: string;
|
|
@@ -4586,15 +4617,6 @@ declare namespace io.flow.v0.models {
|
|
|
4586
4617
|
interface OrganizationConfigurationReference {
|
|
4587
4618
|
readonly id: string;
|
|
4588
4619
|
}
|
|
4589
|
-
interface OrganizationCountriesData {
|
|
4590
|
-
readonly available: string[];
|
|
4591
|
-
}
|
|
4592
|
-
interface OrganizationCountriesPublished {
|
|
4593
|
-
readonly event_id: string;
|
|
4594
|
-
readonly timestamp: string;
|
|
4595
|
-
readonly organization: string;
|
|
4596
|
-
readonly data: io.flow.v0.models.OrganizationCountriesData;
|
|
4597
|
-
}
|
|
4598
4620
|
interface OrganizationCurrencySetting {
|
|
4599
4621
|
readonly id: string;
|
|
4600
4622
|
readonly base: string;
|
|
@@ -5561,6 +5583,7 @@ declare namespace io.flow.v0.models {
|
|
|
5561
5583
|
interface RefundIdentifier {
|
|
5562
5584
|
readonly id: string;
|
|
5563
5585
|
readonly refund: io.flow.v0.models.RefundReference;
|
|
5586
|
+
readonly name: string;
|
|
5564
5587
|
readonly identifier: string;
|
|
5565
5588
|
readonly primary: boolean;
|
|
5566
5589
|
}
|
|
@@ -7460,8 +7483,6 @@ declare namespace io.flow.v0.unions {
|
|
|
7460
7483
|
} & io.flow.v0.models.PriceBookItemDeleted | {
|
|
7461
7484
|
discriminator: 'organization_rates_published';
|
|
7462
7485
|
} & io.flow.v0.models.OrganizationRatesPublished | {
|
|
7463
|
-
discriminator: 'organization_countries_published';
|
|
7464
|
-
} & io.flow.v0.models.OrganizationCountriesPublished | {
|
|
7465
7486
|
discriminator: 'ratecard_lane_upserted';
|
|
7466
7487
|
} & io.flow.v0.models.RatecardLaneUpserted | {
|
|
7467
7488
|
discriminator: 'ratecard_lane_deleted';
|
|
@@ -8137,6 +8158,9 @@ export declare type ExperiencePriceBookMappingDeleted = io.flow.v0.models.Experi
|
|
|
8137
8158
|
export declare type ExperiencePriceBookMappingForm = io.flow.v0.models.ExperiencePriceBookMappingForm;
|
|
8138
8159
|
export declare type ExperiencePriceBookMappingPutForm = io.flow.v0.models.ExperiencePriceBookMappingPutForm;
|
|
8139
8160
|
export declare type ExperiencePriceBookMappingUpserted = io.flow.v0.models.ExperiencePriceBookMappingUpserted;
|
|
8161
|
+
export declare type ExperiencePriceFacetConversion = io.flow.v0.models.ExperiencePriceFacetConversion;
|
|
8162
|
+
export declare type ExperiencePriceFacetConversionRequest = io.flow.v0.models.ExperiencePriceFacetConversionRequest;
|
|
8163
|
+
export declare type ExperiencePriceFacetConversionResponse = io.flow.v0.models.ExperiencePriceFacetConversionResponse;
|
|
8140
8164
|
export declare type ExperienceReference = io.flow.v0.models.ExperienceReference;
|
|
8141
8165
|
export declare type ExperienceSettings = io.flow.v0.models.ExperienceSettings;
|
|
8142
8166
|
export declare type ExperienceStatus = io.flow.v0.enums.ExperienceStatus;
|
|
@@ -8469,6 +8493,7 @@ export declare type OrderStatus = io.flow.v0.enums.OrderStatus;
|
|
|
8469
8493
|
export declare type OrderSubmissionForm = io.flow.v0.models.OrderSubmissionForm;
|
|
8470
8494
|
export declare type OrderSubmissionIdentifierForm = io.flow.v0.models.OrderSubmissionIdentifierForm;
|
|
8471
8495
|
export declare type OrderSummary = io.flow.v0.models.OrderSummary;
|
|
8496
|
+
export declare type OrderSummaryIdentifier = io.flow.v0.models.OrderSummaryIdentifier;
|
|
8472
8497
|
export declare type OrderSummaryImage = io.flow.v0.models.OrderSummaryImage;
|
|
8473
8498
|
export declare type OrderSummaryItem = io.flow.v0.models.OrderSummaryItem;
|
|
8474
8499
|
export declare type OrderSummaryLevy = io.flow.v0.models.OrderSummaryLevy;
|
|
@@ -8481,8 +8506,6 @@ export declare type Organization = io.flow.v0.models.Organization;
|
|
|
8481
8506
|
export declare type OrganizationAuthorization = io.flow.v0.models.OrganizationAuthorization;
|
|
8482
8507
|
export declare type OrganizationAuthorizationForm = io.flow.v0.models.OrganizationAuthorizationForm;
|
|
8483
8508
|
export declare type OrganizationConfigurationReference = io.flow.v0.models.OrganizationConfigurationReference;
|
|
8484
|
-
export declare type OrganizationCountriesData = io.flow.v0.models.OrganizationCountriesData;
|
|
8485
|
-
export declare type OrganizationCountriesPublished = io.flow.v0.models.OrganizationCountriesPublished;
|
|
8486
8509
|
export declare type OrganizationCurrencySetting = io.flow.v0.models.OrganizationCurrencySetting;
|
|
8487
8510
|
export declare type OrganizationCurrencySettingForm = io.flow.v0.models.OrganizationCurrencySettingForm;
|
|
8488
8511
|
export declare type OrganizationCurrencySettingVersion = io.flow.v0.models.OrganizationCurrencySettingVersion;
|
|
@@ -8584,6 +8607,7 @@ export declare type PriceDetailComponentKey = io.flow.v0.enums.PriceDetailCompon
|
|
|
8584
8607
|
export declare type PriceDetailKey = io.flow.v0.enums.PriceDetailKey;
|
|
8585
8608
|
export declare type PriceDetails = io.flow.v0.models.PriceDetails;
|
|
8586
8609
|
export declare type PriceEquation = io.flow.v0.models.PriceEquation;
|
|
8610
|
+
export declare type PriceFacetBoundary = io.flow.v0.enums.PriceFacetBoundary;
|
|
8587
8611
|
export declare type PriceForm = io.flow.v0.models.PriceForm;
|
|
8588
8612
|
export declare type PriceSource = io.flow.v0.unions.PriceSource;
|
|
8589
8613
|
export declare type PriceSourceCatalog = io.flow.v0.models.PriceSourceCatalog;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flowio/types",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "6.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",
|
|
@@ -27,5 +27,5 @@
|
|
|
27
27
|
"prettier": "^1.18.2",
|
|
28
28
|
"typescript": "^3.6.3"
|
|
29
29
|
},
|
|
30
|
-
"gitHead": "
|
|
30
|
+
"gitHead": "616e112b78f12a40dccbb97b7c6cc695d5c1ad80"
|
|
31
31
|
}
|
package/src/api.ts
CHANGED
|
@@ -1313,7 +1313,6 @@ declare namespace io.flow.v0.enums {
|
|
|
1313
1313
|
| 'price_book_item_upserted'
|
|
1314
1314
|
| 'price_book_item_deleted'
|
|
1315
1315
|
| 'organization_rates_published'
|
|
1316
|
-
| 'organization_countries_published'
|
|
1317
1316
|
| 'ratecard_lane_upserted'
|
|
1318
1317
|
| 'ratecard_lane_deleted'
|
|
1319
1318
|
| 'ratecard_upserted'
|
|
@@ -1528,6 +1527,7 @@ declare namespace io.flow.v0.enums {
|
|
|
1528
1527
|
| 'duty'
|
|
1529
1528
|
| 'rounding'
|
|
1530
1529
|
| 'adjustment';
|
|
1530
|
+
type PriceFacetBoundary = 'min' | 'max';
|
|
1531
1531
|
type PricingLevySetting = 'included' | 'displayed' | 'ignored';
|
|
1532
1532
|
type PromotionTriggerType = 'automatic' | 'order_subtotal';
|
|
1533
1533
|
type ProvinceType =
|
|
@@ -2233,6 +2233,7 @@ declare namespace io.flow.v0.models {
|
|
|
2233
2233
|
interface CaptureIdentifier {
|
|
2234
2234
|
readonly id: string;
|
|
2235
2235
|
readonly capture: io.flow.v0.models.CaptureReference;
|
|
2236
|
+
readonly name: string;
|
|
2236
2237
|
readonly identifier: string;
|
|
2237
2238
|
readonly primary: boolean;
|
|
2238
2239
|
}
|
|
@@ -2821,6 +2822,7 @@ declare namespace io.flow.v0.models {
|
|
|
2821
2822
|
readonly item_number: string;
|
|
2822
2823
|
readonly quantity: number;
|
|
2823
2824
|
readonly unit_price: number;
|
|
2825
|
+
readonly unit_discount?: number;
|
|
2824
2826
|
readonly unit_tax?: io.flow.v0.models.ConsumerInvoiceLevyForm;
|
|
2825
2827
|
readonly unit_duty?: io.flow.v0.models.ConsumerInvoiceLevyForm;
|
|
2826
2828
|
}
|
|
@@ -2834,6 +2836,7 @@ declare namespace io.flow.v0.models {
|
|
|
2834
2836
|
|
|
2835
2837
|
interface ConsumerInvoiceLineShippingForm {
|
|
2836
2838
|
readonly price: number;
|
|
2839
|
+
readonly discount?: number;
|
|
2837
2840
|
readonly tax?: io.flow.v0.models.ConsumerInvoiceLevyForm;
|
|
2838
2841
|
readonly duty?: io.flow.v0.models.ConsumerInvoiceLevyForm;
|
|
2839
2842
|
}
|
|
@@ -3452,7 +3455,7 @@ declare namespace io.flow.v0.models {
|
|
|
3452
3455
|
|
|
3453
3456
|
interface EmailNotificationDataRefund {
|
|
3454
3457
|
readonly order: io.flow.v0.models.OrderSummary;
|
|
3455
|
-
readonly
|
|
3458
|
+
readonly return: io.flow.v0.models.OrderSummary;
|
|
3456
3459
|
readonly payment: io.flow.v0.models.EmailPaymentSummary;
|
|
3457
3460
|
}
|
|
3458
3461
|
|
|
@@ -3717,6 +3720,22 @@ declare namespace io.flow.v0.models {
|
|
|
3717
3720
|
readonly experience_price_book_mapping: io.flow.v0.models.ExperiencePriceBookMapping;
|
|
3718
3721
|
}
|
|
3719
3722
|
|
|
3723
|
+
interface ExperiencePriceFacetConversion {
|
|
3724
|
+
readonly request: io.flow.v0.models.ExperiencePriceFacetConversionRequest;
|
|
3725
|
+
readonly price: io.flow.v0.models.PriceWithBase;
|
|
3726
|
+
}
|
|
3727
|
+
|
|
3728
|
+
interface ExperiencePriceFacetConversionRequest {
|
|
3729
|
+
readonly boundary: io.flow.v0.enums.PriceFacetBoundary;
|
|
3730
|
+
readonly value: number;
|
|
3731
|
+
readonly base: string;
|
|
3732
|
+
readonly local: string;
|
|
3733
|
+
}
|
|
3734
|
+
|
|
3735
|
+
interface ExperiencePriceFacetConversionResponse {
|
|
3736
|
+
readonly facets: io.flow.v0.models.ExperiencePriceFacetConversion[];
|
|
3737
|
+
}
|
|
3738
|
+
|
|
3720
3739
|
interface ExperienceReference {
|
|
3721
3740
|
readonly key: string;
|
|
3722
3741
|
}
|
|
@@ -4239,6 +4258,7 @@ declare namespace io.flow.v0.models {
|
|
|
4239
4258
|
|
|
4240
4259
|
interface IdentifierForm {
|
|
4241
4260
|
readonly primary?: boolean;
|
|
4261
|
+
readonly name?: string;
|
|
4242
4262
|
}
|
|
4243
4263
|
|
|
4244
4264
|
interface Image {
|
|
@@ -5484,6 +5504,7 @@ declare namespace io.flow.v0.models {
|
|
|
5484
5504
|
interface OrderIdentifier {
|
|
5485
5505
|
readonly id: string;
|
|
5486
5506
|
readonly order: io.flow.v0.models.OrderReference;
|
|
5507
|
+
readonly name: string;
|
|
5487
5508
|
readonly identifier: string;
|
|
5488
5509
|
readonly primary: boolean;
|
|
5489
5510
|
readonly number?: string;
|
|
@@ -5504,6 +5525,7 @@ declare namespace io.flow.v0.models {
|
|
|
5504
5525
|
|
|
5505
5526
|
interface OrderIdentifierForm {
|
|
5506
5527
|
readonly order: string;
|
|
5528
|
+
readonly name?: string;
|
|
5507
5529
|
readonly identifier?: string;
|
|
5508
5530
|
readonly number?: string;
|
|
5509
5531
|
readonly primary?: boolean;
|
|
@@ -5511,6 +5533,7 @@ declare namespace io.flow.v0.models {
|
|
|
5511
5533
|
|
|
5512
5534
|
interface OrderIdentifierPutForm {
|
|
5513
5535
|
readonly order: string;
|
|
5536
|
+
readonly name?: string;
|
|
5514
5537
|
readonly primary?: boolean;
|
|
5515
5538
|
}
|
|
5516
5539
|
|
|
@@ -5623,6 +5646,7 @@ declare namespace io.flow.v0.models {
|
|
|
5623
5646
|
readonly name?: string;
|
|
5624
5647
|
readonly rate?: number;
|
|
5625
5648
|
readonly accuracy?: io.flow.v0.enums.PriceAccuracy;
|
|
5649
|
+
readonly rate_label?: string;
|
|
5626
5650
|
}
|
|
5627
5651
|
|
|
5628
5652
|
interface OrderPriceDetailComponent {
|
|
@@ -5697,6 +5721,7 @@ declare namespace io.flow.v0.models {
|
|
|
5697
5721
|
|
|
5698
5722
|
interface OrderSubmissionIdentifierForm {
|
|
5699
5723
|
readonly identifier: string;
|
|
5724
|
+
readonly name?: string;
|
|
5700
5725
|
readonly primary?: boolean;
|
|
5701
5726
|
}
|
|
5702
5727
|
|
|
@@ -5712,6 +5737,13 @@ declare namespace io.flow.v0.models {
|
|
|
5712
5737
|
readonly adjustment?: io.flow.v0.models.OrderSummaryPriceDetail;
|
|
5713
5738
|
readonly total: io.flow.v0.models.OrderSummaryPriceDetail;
|
|
5714
5739
|
readonly lines: io.flow.v0.models.OrderSummaryLineItem[];
|
|
5740
|
+
readonly identifiers?: io.flow.v0.models.OrderSummaryIdentifier[];
|
|
5741
|
+
}
|
|
5742
|
+
|
|
5743
|
+
interface OrderSummaryIdentifier {
|
|
5744
|
+
readonly name: string;
|
|
5745
|
+
readonly identifier: string;
|
|
5746
|
+
readonly primary: boolean;
|
|
5715
5747
|
}
|
|
5716
5748
|
|
|
5717
5749
|
interface OrderSummaryImage {
|
|
@@ -5735,6 +5767,7 @@ declare namespace io.flow.v0.models {
|
|
|
5735
5767
|
|
|
5736
5768
|
interface OrderSummaryLevy {
|
|
5737
5769
|
readonly rate: number;
|
|
5770
|
+
readonly rate_label?: string;
|
|
5738
5771
|
readonly value: io.flow.v0.models.Price;
|
|
5739
5772
|
}
|
|
5740
5773
|
|
|
@@ -5754,6 +5787,7 @@ declare namespace io.flow.v0.models {
|
|
|
5754
5787
|
readonly price: io.flow.v0.models.Price;
|
|
5755
5788
|
readonly name?: string;
|
|
5756
5789
|
readonly rate?: number;
|
|
5790
|
+
readonly rate_label?: string;
|
|
5757
5791
|
}
|
|
5758
5792
|
|
|
5759
5793
|
interface OrderUpserted {
|
|
@@ -5824,17 +5858,6 @@ declare namespace io.flow.v0.models {
|
|
|
5824
5858
|
readonly id: string;
|
|
5825
5859
|
}
|
|
5826
5860
|
|
|
5827
|
-
interface OrganizationCountriesData {
|
|
5828
|
-
readonly available: string[];
|
|
5829
|
-
}
|
|
5830
|
-
|
|
5831
|
-
interface OrganizationCountriesPublished {
|
|
5832
|
-
readonly event_id: string;
|
|
5833
|
-
readonly timestamp: string;
|
|
5834
|
-
readonly organization: string;
|
|
5835
|
-
readonly data: io.flow.v0.models.OrganizationCountriesData;
|
|
5836
|
-
}
|
|
5837
|
-
|
|
5838
5861
|
interface OrganizationCurrencySetting {
|
|
5839
5862
|
readonly id: string;
|
|
5840
5863
|
readonly base: string;
|
|
@@ -6956,6 +6979,7 @@ declare namespace io.flow.v0.models {
|
|
|
6956
6979
|
interface RefundIdentifier {
|
|
6957
6980
|
readonly id: string;
|
|
6958
6981
|
readonly refund: io.flow.v0.models.RefundReference;
|
|
6982
|
+
readonly name: string;
|
|
6959
6983
|
readonly identifier: string;
|
|
6960
6984
|
readonly primary: boolean;
|
|
6961
6985
|
}
|
|
@@ -9312,9 +9336,6 @@ declare namespace io.flow.v0.unions {
|
|
|
9312
9336
|
| {
|
|
9313
9337
|
discriminator: 'organization_rates_published';
|
|
9314
9338
|
} & io.flow.v0.models.OrganizationRatesPublished
|
|
9315
|
-
| {
|
|
9316
|
-
discriminator: 'organization_countries_published';
|
|
9317
|
-
} & io.flow.v0.models.OrganizationCountriesPublished
|
|
9318
9339
|
| {
|
|
9319
9340
|
discriminator: 'ratecard_lane_upserted';
|
|
9320
9341
|
} & io.flow.v0.models.RatecardLaneUpserted
|
|
@@ -10156,6 +10177,9 @@ export type ExperiencePriceBookMappingDeleted = io.flow.v0.models.ExperiencePric
|
|
|
10156
10177
|
export type ExperiencePriceBookMappingForm = io.flow.v0.models.ExperiencePriceBookMappingForm;
|
|
10157
10178
|
export type ExperiencePriceBookMappingPutForm = io.flow.v0.models.ExperiencePriceBookMappingPutForm;
|
|
10158
10179
|
export type ExperiencePriceBookMappingUpserted = io.flow.v0.models.ExperiencePriceBookMappingUpserted;
|
|
10180
|
+
export type ExperiencePriceFacetConversion = io.flow.v0.models.ExperiencePriceFacetConversion;
|
|
10181
|
+
export type ExperiencePriceFacetConversionRequest = io.flow.v0.models.ExperiencePriceFacetConversionRequest;
|
|
10182
|
+
export type ExperiencePriceFacetConversionResponse = io.flow.v0.models.ExperiencePriceFacetConversionResponse;
|
|
10159
10183
|
export type ExperienceReference = io.flow.v0.models.ExperienceReference;
|
|
10160
10184
|
export type ExperienceSettings = io.flow.v0.models.ExperienceSettings;
|
|
10161
10185
|
export type ExperienceStatus = io.flow.v0.enums.ExperienceStatus;
|
|
@@ -10488,6 +10512,7 @@ export type OrderStatus = io.flow.v0.enums.OrderStatus;
|
|
|
10488
10512
|
export type OrderSubmissionForm = io.flow.v0.models.OrderSubmissionForm;
|
|
10489
10513
|
export type OrderSubmissionIdentifierForm = io.flow.v0.models.OrderSubmissionIdentifierForm;
|
|
10490
10514
|
export type OrderSummary = io.flow.v0.models.OrderSummary;
|
|
10515
|
+
export type OrderSummaryIdentifier = io.flow.v0.models.OrderSummaryIdentifier;
|
|
10491
10516
|
export type OrderSummaryImage = io.flow.v0.models.OrderSummaryImage;
|
|
10492
10517
|
export type OrderSummaryItem = io.flow.v0.models.OrderSummaryItem;
|
|
10493
10518
|
export type OrderSummaryLevy = io.flow.v0.models.OrderSummaryLevy;
|
|
@@ -10500,8 +10525,6 @@ export type Organization = io.flow.v0.models.Organization;
|
|
|
10500
10525
|
export type OrganizationAuthorization = io.flow.v0.models.OrganizationAuthorization;
|
|
10501
10526
|
export type OrganizationAuthorizationForm = io.flow.v0.models.OrganizationAuthorizationForm;
|
|
10502
10527
|
export type OrganizationConfigurationReference = io.flow.v0.models.OrganizationConfigurationReference;
|
|
10503
|
-
export type OrganizationCountriesData = io.flow.v0.models.OrganizationCountriesData;
|
|
10504
|
-
export type OrganizationCountriesPublished = io.flow.v0.models.OrganizationCountriesPublished;
|
|
10505
10528
|
export type OrganizationCurrencySetting = io.flow.v0.models.OrganizationCurrencySetting;
|
|
10506
10529
|
export type OrganizationCurrencySettingForm = io.flow.v0.models.OrganizationCurrencySettingForm;
|
|
10507
10530
|
export type OrganizationCurrencySettingVersion = io.flow.v0.models.OrganizationCurrencySettingVersion;
|
|
@@ -10603,6 +10626,7 @@ export type PriceDetailComponentKey = io.flow.v0.enums.PriceDetailComponentKey;
|
|
|
10603
10626
|
export type PriceDetailKey = io.flow.v0.enums.PriceDetailKey;
|
|
10604
10627
|
export type PriceDetails = io.flow.v0.models.PriceDetails;
|
|
10605
10628
|
export type PriceEquation = io.flow.v0.models.PriceEquation;
|
|
10629
|
+
export type PriceFacetBoundary = io.flow.v0.enums.PriceFacetBoundary;
|
|
10606
10630
|
export type PriceForm = io.flow.v0.models.PriceForm;
|
|
10607
10631
|
export type PriceSource = io.flow.v0.unions.PriceSource;
|
|
10608
10632
|
export type PriceSourceCatalog = io.flow.v0.models.PriceSourceCatalog;
|