@flowio/types 9.1.7 → 9.1.9

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/src/api.ts CHANGED
@@ -705,7 +705,7 @@ declare namespace io.flow.shopify.external.v0.models {
705
705
  readonly vendor?: string;
706
706
  readonly name?: string;
707
707
  readonly gift_card: boolean;
708
- readonly properties: Record<string, string>[];
708
+ readonly properties: io.flow.shopify.external.v0.models.ShopifyProperty[];
709
709
  readonly taxable: boolean;
710
710
  readonly tax_lines: io.flow.shopify.external.v0.models.ShopifyTaxLine[];
711
711
  readonly total_discount?: string;
@@ -727,7 +727,7 @@ declare namespace io.flow.shopify.external.v0.models {
727
727
  readonly vendor?: string;
728
728
  readonly name?: string;
729
729
  readonly gift_card: boolean;
730
- readonly properties?: io.flow.shopify.external.v0.models.ShopifyAttribute[];
730
+ readonly properties?: io.flow.shopify.external.v0.models.ShopifyProperty[];
731
731
  readonly taxable: boolean;
732
732
  readonly tax_lines: io.flow.shopify.external.v0.models.ShopifyTaxLine[];
733
733
  readonly total_discount?: string;
@@ -842,6 +842,11 @@ declare namespace io.flow.shopify.external.v0.models {
842
842
  readonly cvv_result_code?: string;
843
843
  }
844
844
 
845
+ interface ShopifyProperty {
846
+ readonly name: string;
847
+ readonly value: any /*json*/;
848
+ }
849
+
845
850
  interface ShopifyRefund {
846
851
  readonly id: number;
847
852
  readonly order_id: number;
@@ -1002,6 +1007,7 @@ declare namespace io.flow.shopify.external.v0.models {
1002
1007
  }
1003
1008
 
1004
1009
  declare namespace io.flow.v0.enums {
1010
+ type AbandonedOrderSettingStatus = 'active' | 'inactive';
1005
1011
  type AdjustmentReasonKey = 'duty_deminimis' | 'vat_deminimis';
1006
1012
  type Aggregate = 'maximum' | 'minimum';
1007
1013
  type AttributeDataType = 'boolean' | 'decimal' | 'string' | 'json_array';
@@ -1141,6 +1147,8 @@ declare namespace io.flow.v0.enums {
1141
1147
  | 'mixed';
1142
1148
  type DeliveryWindowLocation = 'center' | 'crossdock' | 'customer';
1143
1149
  type Direction = 'outbound' | 'return';
1150
+ type DiscountRuleStatus = 'active' | 'inactive';
1151
+ type DiscountRuleSubsidyTarget = 'vat' | 'duty';
1144
1152
  type DiscountTarget = 'item' | 'shipping';
1145
1153
  type EcommercePlatformType =
1146
1154
  | 'commercetools'
@@ -1613,6 +1621,16 @@ declare namespace io.flow.v0.enums {
1613
1621
  }
1614
1622
 
1615
1623
  declare namespace io.flow.v0.models {
1624
+ interface AbandonedOrderEmailSettings {
1625
+ readonly delay: io.flow.v0.models.Duration;
1626
+ readonly frequency: io.flow.v0.models.Duration;
1627
+ }
1628
+
1629
+ interface AbandonedOrderSettings {
1630
+ readonly email_settings: io.flow.v0.models.AbandonedOrderEmailSettings;
1631
+ readonly status: io.flow.v0.enums.AbandonedOrderSettingStatus;
1632
+ }
1633
+
1616
1634
  interface AccountOrdersExportType {
1617
1635
  readonly discriminator: 'account_orders_export_type';
1618
1636
  readonly statement_id?: string;
@@ -1772,7 +1790,7 @@ declare namespace io.flow.v0.models {
1772
1790
  readonly rate: number;
1773
1791
  readonly name: string;
1774
1792
  readonly price?: io.flow.v0.models.PriceWithBase;
1775
- readonly accuracy?: io.flow.v0.enums.PriceAccuracy;
1793
+ readonly accuracy: io.flow.v0.enums.PriceAccuracy;
1776
1794
  readonly basis?: io.flow.v0.models.MoneyWithBase;
1777
1795
  }
1778
1796
 
@@ -2216,7 +2234,7 @@ declare namespace io.flow.v0.models {
2216
2234
  readonly requested?: io.flow.v0.models.Money;
2217
2235
  readonly created_at: string;
2218
2236
  readonly attributes?: Record<string, string>;
2219
- readonly status?: io.flow.v0.enums.CaptureStatus;
2237
+ readonly status: io.flow.v0.enums.CaptureStatus;
2220
2238
  readonly base?: io.flow.v0.models.Money;
2221
2239
  }
2222
2240
 
@@ -2304,7 +2322,7 @@ declare namespace io.flow.v0.models {
2304
2322
  readonly discriminator: 'card_authorization';
2305
2323
  readonly id: string;
2306
2324
  readonly key: string;
2307
- readonly merchant_of_record?: io.flow.v0.enums.MerchantOfRecord;
2325
+ readonly merchant_of_record: io.flow.v0.enums.MerchantOfRecord;
2308
2326
  readonly method?: io.flow.v0.models.PaymentMethod;
2309
2327
  readonly card: io.flow.v0.unions.ExpandableCard;
2310
2328
  readonly amount: number;
@@ -3352,6 +3370,11 @@ declare namespace io.flow.v0.models {
3352
3370
  readonly transit_estimates: io.flow.v0.models.TransitEstimate[];
3353
3371
  }
3354
3372
 
3373
+ interface DeliveryWindowSummary {
3374
+ readonly country: string;
3375
+ readonly delivery_window: io.flow.v0.models.DeliveryWindow;
3376
+ }
3377
+
3355
3378
  interface DeminimisPerItem {
3356
3379
  readonly discriminator: 'deminimis_per_item';
3357
3380
  readonly currency: string;
@@ -3483,6 +3506,37 @@ declare namespace io.flow.v0.models {
3483
3506
  readonly percent: number;
3484
3507
  }
3485
3508
 
3509
+ interface DiscountRule {
3510
+ readonly offers: io.flow.v0.models.DiscountRuleOffer[];
3511
+ }
3512
+
3513
+ interface DiscountRuleOffer {
3514
+ readonly discount: io.flow.v0.unions.DiscountOffer;
3515
+ readonly entitlement: io.flow.v0.unions.DiscountRuleEntitlement;
3516
+ }
3517
+
3518
+ interface DiscountRuleSettings {
3519
+ readonly id: string;
3520
+ readonly name: string;
3521
+ readonly from: string;
3522
+ readonly to?: string;
3523
+ readonly status: io.flow.v0.enums.DiscountRuleStatus;
3524
+ readonly rule: io.flow.v0.models.DiscountRule;
3525
+ }
3526
+
3527
+ interface DiscountRuleSettingsForm {
3528
+ readonly name: string;
3529
+ readonly from: string;
3530
+ readonly to?: string;
3531
+ readonly status: io.flow.v0.enums.DiscountRuleStatus;
3532
+ readonly rule: io.flow.v0.models.DiscountRule;
3533
+ }
3534
+
3535
+ interface DiscountRuleSubsidyEntitlement {
3536
+ readonly discriminator: 'subsidy';
3537
+ readonly targets: io.flow.v0.enums.DiscountRuleSubsidyTarget[];
3538
+ }
3539
+
3486
3540
  interface DiscountsForm {
3487
3541
  readonly discounts: io.flow.v0.models.DiscountForm[];
3488
3542
  }
@@ -3526,12 +3580,6 @@ declare namespace io.flow.v0.models {
3526
3580
  readonly ecommerce_platform: io.flow.v0.models.EcommercePlatform;
3527
3581
  }
3528
3582
 
3529
- interface EmailAbandonedOrder {
3530
- readonly discriminator: 'abandoned_order';
3531
- readonly order: io.flow.v0.models.OrderSummary;
3532
- readonly urls: io.flow.v0.models.EmailAbandonedOrderUrls;
3533
- }
3534
-
3535
3583
  interface EmailAbandonedOrderUrls {
3536
3584
  readonly checkout: string;
3537
3585
  }
@@ -3543,6 +3591,12 @@ declare namespace io.flow.v0.models {
3543
3591
  readonly data: io.flow.v0.unions.EmailNotificationData;
3544
3592
  }
3545
3593
 
3594
+ interface EmailNotificationAbandonedOrder {
3595
+ readonly discriminator: 'abandoned_order';
3596
+ readonly order: io.flow.v0.models.OrderSummary;
3597
+ readonly urls: io.flow.v0.models.EmailAbandonedOrderUrls;
3598
+ }
3599
+
3546
3600
  interface EmailNotificationDataRefund {
3547
3601
  readonly discriminator: 'refund';
3548
3602
  readonly order: io.flow.v0.models.OrderSummary;
@@ -3796,6 +3850,11 @@ declare namespace io.flow.v0.models {
3796
3850
  readonly key: string;
3797
3851
  }
3798
3852
 
3853
+ interface ExperiencePaymentMethodRule {
3854
+ readonly experience_key: string;
3855
+ readonly payment_method_rules: io.flow.v0.models.PaymentMethodRule[];
3856
+ }
3857
+
3799
3858
  interface ExperiencePaymentMethodRuleForm {
3800
3859
  readonly payment_method_id: string;
3801
3860
  readonly tags: io.flow.v0.enums.ExperiencePaymentMethodTag[];
@@ -4654,7 +4713,7 @@ declare namespace io.flow.v0.models {
4654
4713
  readonly organization: string;
4655
4714
  readonly email: string;
4656
4715
  readonly name?: io.flow.v0.models.Name;
4657
- readonly role?: io.flow.v0.enums.Role;
4716
+ readonly role: io.flow.v0.enums.Role;
4658
4717
  readonly roles?: io.flow.v0.unions.FlowRole[];
4659
4718
  }
4660
4719
 
@@ -5141,7 +5200,7 @@ declare namespace io.flow.v0.models {
5141
5200
  readonly base: io.flow.v0.models.Price;
5142
5201
  readonly name: string;
5143
5202
  readonly adjustment?: io.flow.v0.models.LocalizedAdjustment;
5144
- readonly accuracy?: io.flow.v0.enums.PriceAccuracy;
5203
+ readonly accuracy: io.flow.v0.enums.PriceAccuracy;
5145
5204
  readonly basis?: io.flow.v0.models.MoneyWithBase;
5146
5205
  }
5147
5206
 
@@ -5258,13 +5317,13 @@ declare namespace io.flow.v0.models {
5258
5317
  interface MembershipForm {
5259
5318
  readonly organization: string;
5260
5319
  readonly user: string;
5261
- readonly role?: io.flow.v0.enums.Role;
5262
- readonly roles?: io.flow.v0.unions.FlowRole[];
5320
+ readonly role: io.flow.v0.enums.Role;
5321
+ readonly roles: io.flow.v0.unions.FlowRole[];
5263
5322
  }
5264
5323
 
5265
5324
  interface MembershipPutForm {
5266
- readonly role?: io.flow.v0.enums.Role;
5267
- readonly roles?: io.flow.v0.unions.FlowRole[];
5325
+ readonly role: io.flow.v0.enums.Role;
5326
+ readonly roles: io.flow.v0.unions.FlowRole[];
5268
5327
  }
5269
5328
 
5270
5329
  interface MembershipUpsertedV2 {
@@ -5439,7 +5498,7 @@ declare namespace io.flow.v0.models {
5439
5498
  readonly id: string;
5440
5499
  readonly key: string;
5441
5500
  readonly method?: io.flow.v0.models.PaymentMethod;
5442
- readonly merchant_of_record?: io.flow.v0.enums.MerchantOfRecord;
5501
+ readonly merchant_of_record: io.flow.v0.enums.MerchantOfRecord;
5443
5502
  readonly details?: io.flow.v0.unions.OnlineAuthorizationDetails;
5444
5503
  readonly payment?: any /*object*/;
5445
5504
  readonly amount: number;
@@ -5760,7 +5819,7 @@ declare namespace io.flow.v0.models {
5760
5819
 
5761
5820
  interface OrderNumberGeneratorUuid {
5762
5821
  readonly discriminator: 'uuid';
5763
- readonly prefix?: string;
5822
+ readonly prefix: string;
5764
5823
  }
5765
5824
 
5766
5825
  interface OrderNumberReference {
@@ -5774,13 +5833,13 @@ declare namespace io.flow.v0.models {
5774
5833
  interface OrderPayment {
5775
5834
  readonly id: string;
5776
5835
  readonly type: io.flow.v0.enums.OrderPaymentType;
5777
- readonly merchant_of_record?: io.flow.v0.enums.MerchantOfRecord;
5836
+ readonly merchant_of_record: io.flow.v0.enums.MerchantOfRecord;
5778
5837
  readonly reference: string;
5779
5838
  readonly description: string;
5780
5839
  readonly total: io.flow.v0.models.PriceWithBase;
5781
5840
  readonly address?: io.flow.v0.models.BillingAddress;
5782
5841
  readonly date?: string;
5783
- readonly attributes?: Record<string, string>;
5842
+ readonly attributes: Record<string, string>;
5784
5843
  }
5785
5844
 
5786
5845
  interface OrderPlaced {
@@ -5816,7 +5875,7 @@ declare namespace io.flow.v0.models {
5816
5875
  readonly components: io.flow.v0.models.OrderPriceDetailComponent[];
5817
5876
  readonly name?: string;
5818
5877
  readonly rate?: number;
5819
- readonly accuracy?: io.flow.v0.enums.PriceAccuracy;
5878
+ readonly accuracy: io.flow.v0.enums.PriceAccuracy;
5820
5879
  readonly rate_label?: string;
5821
5880
  }
5822
5881
 
@@ -5888,7 +5947,7 @@ declare namespace io.flow.v0.models {
5888
5947
  }
5889
5948
 
5890
5949
  interface OrderSubmissionForm {
5891
- readonly identifiers?: io.flow.v0.models.OrderSubmissionIdentifierForm[];
5950
+ readonly identifiers: io.flow.v0.models.OrderSubmissionIdentifierForm[];
5892
5951
  }
5893
5952
 
5894
5953
  interface OrderSubmissionIdentifierForm {
@@ -6507,7 +6566,7 @@ declare namespace io.flow.v0.models {
6507
6566
  readonly currency: string;
6508
6567
  readonly name: string;
6509
6568
  readonly includes: io.flow.v0.enums.IncludedLevyKey;
6510
- readonly status?: io.flow.v0.enums.PriceBookStatus;
6569
+ readonly status: io.flow.v0.enums.PriceBookStatus;
6511
6570
  }
6512
6571
 
6513
6572
  interface PriceBookItem {
@@ -6976,7 +7035,7 @@ declare namespace io.flow.v0.models {
6976
7035
  readonly origination_zones: io.flow.v0.models.Zone[];
6977
7036
  readonly service: string;
6978
7037
  readonly number?: string;
6979
- readonly ratecard_owner?: io.flow.v0.enums.RatecardOwner;
7038
+ readonly ratecard_owner: io.flow.v0.enums.RatecardOwner;
6980
7039
  }
6981
7040
 
6982
7041
  interface RatecardLane {
@@ -7142,7 +7201,7 @@ declare namespace io.flow.v0.models {
7142
7201
  readonly captures: io.flow.v0.models.RefundCaptureSummary[];
7143
7202
  readonly created_at: string;
7144
7203
  readonly attributes?: Record<string, string>;
7145
- readonly status?: io.flow.v0.enums.RefundStatus;
7204
+ readonly status: io.flow.v0.enums.RefundStatus;
7146
7205
  readonly base?: io.flow.v0.models.Money;
7147
7206
  }
7148
7207
 
@@ -7153,7 +7212,7 @@ declare namespace io.flow.v0.models {
7153
7212
  readonly amount: number;
7154
7213
  readonly currency: string;
7155
7214
  readonly base: io.flow.v0.models.Money;
7156
- readonly status?: io.flow.v0.enums.RefundStatus;
7215
+ readonly status: io.flow.v0.enums.RefundStatus;
7157
7216
  }
7158
7217
 
7159
7218
  interface RefundCaptureSummary {
@@ -8879,12 +8938,13 @@ declare namespace io.flow.v0.unions {
8879
8938
  type DiscountOffer =
8880
8939
  | io.flow.v0.models.DiscountOfferFixed
8881
8940
  | io.flow.v0.models.DiscountOfferPercent;
8941
+ type DiscountRuleEntitlement = io.flow.v0.models.DiscountRuleSubsidyEntitlement;
8882
8942
  type Document =
8883
8943
  | io.flow.v0.models.CatalogItemDocument
8884
8944
  | io.flow.v0.models.HarmonizationDocument;
8885
8945
  type EmailNotificationData =
8886
8946
  | io.flow.v0.models.EmailNotificationDataRefund
8887
- | io.flow.v0.models.EmailAbandonedOrder;
8947
+ | io.flow.v0.models.EmailNotificationAbandonedOrder;
8888
8948
  type Event =
8889
8949
  | io.flow.v0.models.AttributeUpserted
8890
8950
  | io.flow.v0.models.AttributeDeleted
@@ -9219,6 +9279,9 @@ declare namespace io.flow.v0.unions {
9219
9279
  | io.flow.v0.models.PartnerTokenReference;
9220
9280
  }
9221
9281
 
9282
+ export type AbandonedOrderEmailSettings = io.flow.v0.models.AbandonedOrderEmailSettings;
9283
+ export type AbandonedOrderSettingStatus = io.flow.v0.enums.AbandonedOrderSettingStatus;
9284
+ export type AbandonedOrderSettings = io.flow.v0.models.AbandonedOrderSettings;
9222
9285
  export type AccountOrdersExportType = io.flow.v0.models.AccountOrdersExportType;
9223
9286
  export type AccountTransactionsExportType = io.flow.v0.models.AccountTransactionsExportType;
9224
9287
  export type AchAuthorizationForm = io.flow.v0.models.AchAuthorizationForm;
@@ -9503,6 +9566,7 @@ export type DeliveryWindowComponentSource = io.flow.v0.enums.DeliveryWindowCompo
9503
9566
  export type DeliveryWindowComponents = io.flow.v0.models.DeliveryWindowComponents;
9504
9567
  export type DeliveryWindowComponentsV2 = io.flow.v0.models.DeliveryWindowComponentsV2;
9505
9568
  export type DeliveryWindowLocation = io.flow.v0.enums.DeliveryWindowLocation;
9569
+ export type DeliveryWindowSummary = io.flow.v0.models.DeliveryWindowSummary;
9506
9570
  export type Deminimis = io.flow.v0.unions.Deminimis;
9507
9571
  export type DeminimisPerItem = io.flow.v0.models.DeminimisPerItem;
9508
9572
  export type DeminimisSimple = io.flow.v0.models.DeminimisSimple;
@@ -9522,6 +9586,14 @@ export type DiscountForm = io.flow.v0.models.DiscountForm;
9522
9586
  export type DiscountOffer = io.flow.v0.unions.DiscountOffer;
9523
9587
  export type DiscountOfferFixed = io.flow.v0.models.DiscountOfferFixed;
9524
9588
  export type DiscountOfferPercent = io.flow.v0.models.DiscountOfferPercent;
9589
+ export type DiscountRule = io.flow.v0.models.DiscountRule;
9590
+ export type DiscountRuleEntitlement = io.flow.v0.unions.DiscountRuleEntitlement;
9591
+ export type DiscountRuleOffer = io.flow.v0.models.DiscountRuleOffer;
9592
+ export type DiscountRuleSettings = io.flow.v0.models.DiscountRuleSettings;
9593
+ export type DiscountRuleSettingsForm = io.flow.v0.models.DiscountRuleSettingsForm;
9594
+ export type DiscountRuleStatus = io.flow.v0.enums.DiscountRuleStatus;
9595
+ export type DiscountRuleSubsidyEntitlement = io.flow.v0.models.DiscountRuleSubsidyEntitlement;
9596
+ export type DiscountRuleSubsidyTarget = io.flow.v0.enums.DiscountRuleSubsidyTarget;
9525
9597
  export type DiscountTarget = io.flow.v0.enums.DiscountTarget;
9526
9598
  export type DiscountsForm = io.flow.v0.models.DiscountsForm;
9527
9599
  export type Document = io.flow.v0.unions.Document;
@@ -9533,9 +9605,9 @@ export type EcommercePlatformForm = io.flow.v0.models.EcommercePlatformForm;
9533
9605
  export type EcommercePlatformType = io.flow.v0.enums.EcommercePlatformType;
9534
9606
  export type EcommercePlatformUpserted = io.flow.v0.models.EcommercePlatformUpserted;
9535
9607
  export type EconomicTitleLocation = io.flow.v0.enums.EconomicTitleLocation;
9536
- export type EmailAbandonedOrder = io.flow.v0.models.EmailAbandonedOrder;
9537
9608
  export type EmailAbandonedOrderUrls = io.flow.v0.models.EmailAbandonedOrderUrls;
9538
9609
  export type EmailNotification = io.flow.v0.models.EmailNotification;
9610
+ export type EmailNotificationAbandonedOrder = io.flow.v0.models.EmailNotificationAbandonedOrder;
9539
9611
  export type EmailNotificationData = io.flow.v0.unions.EmailNotificationData;
9540
9612
  export type EmailNotificationDataRefund = io.flow.v0.models.EmailNotificationDataRefund;
9541
9613
  export type EmailNotificationDeleted = io.flow.v0.models.EmailNotificationDeleted;
@@ -9588,6 +9660,7 @@ export type ExperienceLogisticsSummary = io.flow.v0.models.ExperienceLogisticsSu
9588
9660
  export type ExperienceLogisticsTierSummary = io.flow.v0.models.ExperienceLogisticsTierSummary;
9589
9661
  export type ExperienceLogisticsTierSummaryPrices = io.flow.v0.models.ExperienceLogisticsTierSummaryPrices;
9590
9662
  export type ExperienceOverview = io.flow.v0.models.ExperienceOverview;
9663
+ export type ExperiencePaymentMethodRule = io.flow.v0.models.ExperiencePaymentMethodRule;
9591
9664
  export type ExperiencePaymentMethodRuleForm = io.flow.v0.models.ExperiencePaymentMethodRuleForm;
9592
9665
  export type ExperiencePaymentMethodTag = io.flow.v0.enums.ExperiencePaymentMethodTag;
9593
9666
  export type ExperiencePriceBookMapping = io.flow.v0.models.ExperiencePriceBookMapping;