@flowio/types 5.0.0 → 7.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/src/api.ts CHANGED
@@ -1110,6 +1110,7 @@ declare namespace io.flow.v0.enums {
1110
1110
  | 'individual';
1111
1111
  type ConsumerInvoiceDocumentType = 'pdf';
1112
1112
  type ConsumerInvoiceStatus = 'pending' | 'available' | 'invalid';
1113
+ type CountryPickerSource = 'experience' | 'destination';
1113
1114
  type CreditPaymentErrorCode =
1114
1115
  | 'generic_error'
1115
1116
  | 'invalid_order_number'
@@ -1313,7 +1314,6 @@ declare namespace io.flow.v0.enums {
1313
1314
  | 'price_book_item_upserted'
1314
1315
  | 'price_book_item_deleted'
1315
1316
  | 'organization_rates_published'
1316
- | 'organization_countries_published'
1317
1317
  | 'ratecard_lane_upserted'
1318
1318
  | 'ratecard_lane_deleted'
1319
1319
  | 'ratecard_upserted'
@@ -1383,10 +1383,6 @@ declare namespace io.flow.v0.enums {
1383
1383
  | 'DEQ'
1384
1384
  | 'DDU';
1385
1385
  type InputSpecificationType = 'text' | 'number';
1386
- type InstallmentPlanPaymentErrorCode =
1387
- | 'invalid_authorization'
1388
- | 'invalid_authorization_amount'
1389
- | 'invalid_installment_plan';
1390
1386
  type InventoryStatus = 'has_inventory' | 'no_inventory';
1391
1387
  type InvitationErrorCode = 'expired' | 'invalid_email';
1392
1388
  type ItemAvailabilityStatus = 'available' | 'low' | 'out_of_stock';
@@ -1475,6 +1471,7 @@ declare namespace io.flow.v0.enums {
1475
1471
  | 'discount'
1476
1472
  | 'surcharges';
1477
1473
  type OrderStatus = 'open' | 'submitted';
1474
+ type OrderStorage = 'do_not_persist' | 'persist';
1478
1475
  type OrganizationPaymentMethodTag = 'deny';
1479
1476
  type PaymentErrorCode =
1480
1477
  | 'duplicate'
@@ -1528,6 +1525,7 @@ declare namespace io.flow.v0.enums {
1528
1525
  | 'duty'
1529
1526
  | 'rounding'
1530
1527
  | 'adjustment';
1528
+ type PriceFacetBoundary = 'min' | 'max';
1531
1529
  type PricingLevySetting = 'included' | 'displayed' | 'ignored';
1532
1530
  type PromotionTriggerType = 'automatic' | 'order_subtotal';
1533
1531
  type ProvinceType =
@@ -2233,6 +2231,7 @@ declare namespace io.flow.v0.models {
2233
2231
  interface CaptureIdentifier {
2234
2232
  readonly id: string;
2235
2233
  readonly capture: io.flow.v0.models.CaptureReference;
2234
+ readonly name: string;
2236
2235
  readonly identifier: string;
2237
2236
  readonly primary: boolean;
2238
2237
  }
@@ -2821,6 +2820,7 @@ declare namespace io.flow.v0.models {
2821
2820
  readonly item_number: string;
2822
2821
  readonly quantity: number;
2823
2822
  readonly unit_price: number;
2823
+ readonly unit_discount?: number;
2824
2824
  readonly unit_tax?: io.flow.v0.models.ConsumerInvoiceLevyForm;
2825
2825
  readonly unit_duty?: io.flow.v0.models.ConsumerInvoiceLevyForm;
2826
2826
  }
@@ -2834,6 +2834,7 @@ declare namespace io.flow.v0.models {
2834
2834
 
2835
2835
  interface ConsumerInvoiceLineShippingForm {
2836
2836
  readonly price: number;
2837
+ readonly discount?: number;
2837
2838
  readonly tax?: io.flow.v0.models.ConsumerInvoiceLevyForm;
2838
2839
  readonly duty?: io.flow.v0.models.ConsumerInvoiceLevyForm;
2839
2840
  }
@@ -2894,6 +2895,15 @@ declare namespace io.flow.v0.models {
2894
2895
  readonly language: string;
2895
2896
  }
2896
2897
 
2898
+ interface CountryPicker {
2899
+ readonly id: string;
2900
+ readonly source: io.flow.v0.enums.CountryPickerSource;
2901
+ }
2902
+
2903
+ interface CountryPickerForm {
2904
+ readonly source: io.flow.v0.enums.CountryPickerSource;
2905
+ }
2906
+
2897
2907
  interface CountryShippingPricing {
2898
2908
  readonly pricing: io.flow.v0.models.ItemShippingPricing;
2899
2909
  readonly countries: string[];
@@ -3436,6 +3446,11 @@ declare namespace io.flow.v0.models {
3436
3446
  readonly ecommerce_platform: io.flow.v0.models.EcommercePlatform;
3437
3447
  }
3438
3448
 
3449
+ interface EcommercePlatformForm {
3450
+ readonly type: io.flow.v0.enums.EcommercePlatformType;
3451
+ readonly version?: string;
3452
+ }
3453
+
3439
3454
  interface EcommercePlatformUpserted {
3440
3455
  readonly event_id: string;
3441
3456
  readonly timestamp: string;
@@ -3452,7 +3467,7 @@ declare namespace io.flow.v0.models {
3452
3467
 
3453
3468
  interface EmailNotificationDataRefund {
3454
3469
  readonly order: io.flow.v0.models.OrderSummary;
3455
- readonly refund: io.flow.v0.models.OrderSummary;
3470
+ readonly return: io.flow.v0.models.OrderSummary;
3456
3471
  readonly payment: io.flow.v0.models.EmailPaymentSummary;
3457
3472
  }
3458
3473
 
@@ -3717,6 +3732,37 @@ declare namespace io.flow.v0.models {
3717
3732
  readonly experience_price_book_mapping: io.flow.v0.models.ExperiencePriceBookMapping;
3718
3733
  }
3719
3734
 
3735
+ interface ExperiencePriceConversion {
3736
+ readonly request: io.flow.v0.models.ExperiencePriceConversionRequest;
3737
+ readonly price: io.flow.v0.models.PriceWithBase;
3738
+ }
3739
+
3740
+ interface ExperiencePriceConversionRequest {
3741
+ readonly value: number;
3742
+ readonly base: string;
3743
+ readonly local: string;
3744
+ }
3745
+
3746
+ interface ExperiencePriceConversionResponse {
3747
+ readonly prices: io.flow.v0.models.ExperiencePriceConversion[];
3748
+ }
3749
+
3750
+ interface ExperiencePriceFacetConversion {
3751
+ readonly request: io.flow.v0.models.ExperiencePriceFacetConversionRequest;
3752
+ readonly price: io.flow.v0.models.PriceWithBase;
3753
+ }
3754
+
3755
+ interface ExperiencePriceFacetConversionRequest {
3756
+ readonly boundary: io.flow.v0.enums.PriceFacetBoundary;
3757
+ readonly value: number;
3758
+ readonly base: string;
3759
+ readonly local: string;
3760
+ }
3761
+
3762
+ interface ExperiencePriceFacetConversionResponse {
3763
+ readonly facets: io.flow.v0.models.ExperiencePriceFacetConversion[];
3764
+ }
3765
+
3720
3766
  interface ExperienceReference {
3721
3767
  readonly key: string;
3722
3768
  }
@@ -4239,6 +4285,7 @@ declare namespace io.flow.v0.models {
4239
4285
 
4240
4286
  interface IdentifierForm {
4241
4287
  readonly primary?: boolean;
4288
+ readonly name: string;
4242
4289
  }
4243
4290
 
4244
4291
  interface Image {
@@ -4354,23 +4401,6 @@ declare namespace io.flow.v0.models {
4354
4401
  readonly limitations?: io.flow.v0.unions.InputSpecificationLimitation[];
4355
4402
  }
4356
4403
 
4357
- interface InstallmentPlanPaymentError {
4358
- readonly code: io.flow.v0.enums.InstallmentPlanPaymentErrorCode;
4359
- readonly messages: string[];
4360
- readonly codes: io.flow.v0.enums.InstallmentPlanPaymentErrorCode[];
4361
- }
4362
-
4363
- interface InstallmentPlanPaymentForm {
4364
- readonly installment_program_id: string;
4365
- readonly authorization_key: string;
4366
- }
4367
-
4368
- interface InstallmentProgramSummary {
4369
- readonly id: string;
4370
- readonly name: string;
4371
- readonly initial: io.flow.v0.models.Price;
4372
- }
4373
-
4374
4404
  interface InventoryBackorder {
4375
4405
  readonly quantity: number;
4376
4406
  }
@@ -5155,7 +5185,6 @@ declare namespace io.flow.v0.models {
5155
5185
  readonly ip?: string;
5156
5186
  readonly options?: io.flow.v0.enums.AuthorizationOption[];
5157
5187
  readonly redirect_urls?: io.flow.v0.models.PostPaymentRedirectUrls;
5158
- readonly installment_program_id?: string;
5159
5188
  readonly browser_info?: io.flow.v0.models.BrowserInfo;
5160
5189
  }
5161
5190
 
@@ -5467,6 +5496,7 @@ declare namespace io.flow.v0.models {
5467
5496
  [key: string]: string;
5468
5497
  };
5469
5498
  readonly authorization_keys?: string[];
5499
+ readonly options?: io.flow.v0.models.OrderOptions;
5470
5500
  }
5471
5501
 
5472
5502
  interface OrderFraudStatus {
@@ -5484,6 +5514,7 @@ declare namespace io.flow.v0.models {
5484
5514
  interface OrderIdentifier {
5485
5515
  readonly id: string;
5486
5516
  readonly order: io.flow.v0.models.OrderReference;
5517
+ readonly name: string;
5487
5518
  readonly identifier: string;
5488
5519
  readonly primary: boolean;
5489
5520
  readonly number?: string;
@@ -5504,6 +5535,7 @@ declare namespace io.flow.v0.models {
5504
5535
 
5505
5536
  interface OrderIdentifierForm {
5506
5537
  readonly order: string;
5538
+ readonly name?: string;
5507
5539
  readonly identifier?: string;
5508
5540
  readonly number?: string;
5509
5541
  readonly primary?: boolean;
@@ -5511,6 +5543,7 @@ declare namespace io.flow.v0.models {
5511
5543
 
5512
5544
  interface OrderIdentifierPutForm {
5513
5545
  readonly order: string;
5546
+ readonly name?: string;
5514
5547
  readonly primary?: boolean;
5515
5548
  }
5516
5549
 
@@ -5577,6 +5610,10 @@ declare namespace io.flow.v0.models {
5577
5610
  readonly number: string;
5578
5611
  }
5579
5612
 
5613
+ interface OrderOptions {
5614
+ readonly storage: io.flow.v0.enums.OrderStorage;
5615
+ }
5616
+
5580
5617
  interface OrderPayment {
5581
5618
  readonly id: string;
5582
5619
  readonly type: io.flow.v0.enums.OrderPaymentType;
@@ -5623,6 +5660,7 @@ declare namespace io.flow.v0.models {
5623
5660
  readonly name?: string;
5624
5661
  readonly rate?: number;
5625
5662
  readonly accuracy?: io.flow.v0.enums.PriceAccuracy;
5663
+ readonly rate_label?: string;
5626
5664
  }
5627
5665
 
5628
5666
  interface OrderPriceDetailComponent {
@@ -5651,6 +5689,7 @@ declare namespace io.flow.v0.models {
5651
5689
  [key: string]: string;
5652
5690
  };
5653
5691
  readonly authorization_keys?: string[];
5692
+ readonly options?: io.flow.v0.models.OrderOptions;
5654
5693
  }
5655
5694
 
5656
5695
  interface OrderReference {
@@ -5697,6 +5736,7 @@ declare namespace io.flow.v0.models {
5697
5736
 
5698
5737
  interface OrderSubmissionIdentifierForm {
5699
5738
  readonly identifier: string;
5739
+ readonly name?: string;
5700
5740
  readonly primary?: boolean;
5701
5741
  }
5702
5742
 
@@ -5712,6 +5752,9 @@ declare namespace io.flow.v0.models {
5712
5752
  readonly adjustment?: io.flow.v0.models.OrderSummaryPriceDetail;
5713
5753
  readonly total: io.flow.v0.models.OrderSummaryPriceDetail;
5714
5754
  readonly lines: io.flow.v0.models.OrderSummaryLineItem[];
5755
+ readonly identifiers?: {
5756
+ [key: string]: string;
5757
+ };
5715
5758
  }
5716
5759
 
5717
5760
  interface OrderSummaryImage {
@@ -5735,6 +5778,7 @@ declare namespace io.flow.v0.models {
5735
5778
 
5736
5779
  interface OrderSummaryLevy {
5737
5780
  readonly rate: number;
5781
+ readonly rate_label?: string;
5738
5782
  readonly value: io.flow.v0.models.Price;
5739
5783
  }
5740
5784
 
@@ -5754,6 +5798,7 @@ declare namespace io.flow.v0.models {
5754
5798
  readonly price: io.flow.v0.models.Price;
5755
5799
  readonly name?: string;
5756
5800
  readonly rate?: number;
5801
+ readonly rate_label?: string;
5757
5802
  }
5758
5803
 
5759
5804
  interface OrderUpserted {
@@ -5824,17 +5869,6 @@ declare namespace io.flow.v0.models {
5824
5869
  readonly id: string;
5825
5870
  }
5826
5871
 
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
5872
  interface OrganizationCurrencySetting {
5839
5873
  readonly id: string;
5840
5874
  readonly base: string;
@@ -6141,7 +6175,9 @@ declare namespace io.flow.v0.models {
6141
6175
  readonly display_position: number;
6142
6176
  readonly content?: io.flow.v0.models.PaymentMethodRuleContent[];
6143
6177
  readonly issuers?: io.flow.v0.models.PaymentMethodIssuer[];
6144
- readonly programs: io.flow.v0.models.InstallmentProgramSummary[];
6178
+ readonly programs?: {
6179
+ [key: string]: string;
6180
+ }[];
6145
6181
  readonly q?: io.flow.v0.models.Query;
6146
6182
  }
6147
6183
 
@@ -6655,13 +6691,13 @@ declare namespace io.flow.v0.models {
6655
6691
 
6656
6692
  interface Ratecard {
6657
6693
  readonly id: string;
6694
+ readonly number: string;
6658
6695
  readonly direction: io.flow.v0.enums.Direction;
6659
6696
  readonly effective_at: string;
6660
6697
  readonly origination_zones: io.flow.v0.models.Zone[];
6661
6698
  readonly service: io.flow.v0.models.RatecardServiceSummary;
6662
- readonly number?: string;
6663
6699
  readonly published_at?: string;
6664
- readonly ratecard_owner?: io.flow.v0.enums.RatecardOwner;
6700
+ readonly ratecard_owner: io.flow.v0.enums.RatecardOwner;
6665
6701
  }
6666
6702
 
6667
6703
  interface RatecardCarrierSummary {
@@ -6956,6 +6992,7 @@ declare namespace io.flow.v0.models {
6956
6992
  interface RefundIdentifier {
6957
6993
  readonly id: string;
6958
6994
  readonly refund: io.flow.v0.models.RefundReference;
6995
+ readonly name: string;
6959
6996
  readonly identifier: string;
6960
6997
  readonly primary: boolean;
6961
6998
  }
@@ -9312,9 +9349,6 @@ declare namespace io.flow.v0.unions {
9312
9349
  | {
9313
9350
  discriminator: 'organization_rates_published';
9314
9351
  } & io.flow.v0.models.OrganizationRatesPublished
9315
- | {
9316
- discriminator: 'organization_countries_published';
9317
- } & io.flow.v0.models.OrganizationCountriesPublished
9318
9352
  | {
9319
9353
  discriminator: 'ratecard_lane_upserted';
9320
9354
  } & io.flow.v0.models.RatecardLaneUpserted
@@ -10001,6 +10035,9 @@ export type Contact = io.flow.v0.models.Contact;
10001
10035
  export type Country = io.flow.v0.models.Country;
10002
10036
  export type CountryAvailability = io.flow.v0.models.CountryAvailability;
10003
10037
  export type CountryDefaults = io.flow.v0.models.CountryDefaults;
10038
+ export type CountryPicker = io.flow.v0.models.CountryPicker;
10039
+ export type CountryPickerForm = io.flow.v0.models.CountryPickerForm;
10040
+ export type CountryPickerSource = io.flow.v0.enums.CountryPickerSource;
10004
10041
  export type CountryShippingPricing = io.flow.v0.models.CountryShippingPricing;
10005
10042
  export type CreditMemo = io.flow.v0.models.CreditMemo;
10006
10043
  export type CreditMemoDeleted = io.flow.v0.models.CreditMemoDeleted;
@@ -10095,6 +10132,7 @@ export type Duration = io.flow.v0.models.Duration;
10095
10132
  export type Duty = io.flow.v0.models.Duty;
10096
10133
  export type EcommercePlatform = io.flow.v0.models.EcommercePlatform;
10097
10134
  export type EcommercePlatformDeleted = io.flow.v0.models.EcommercePlatformDeleted;
10135
+ export type EcommercePlatformForm = io.flow.v0.models.EcommercePlatformForm;
10098
10136
  export type EcommercePlatformType = io.flow.v0.enums.EcommercePlatformType;
10099
10137
  export type EcommercePlatformUpserted = io.flow.v0.models.EcommercePlatformUpserted;
10100
10138
  export type EconomicTitleLocation = io.flow.v0.enums.EconomicTitleLocation;
@@ -10156,6 +10194,12 @@ export type ExperiencePriceBookMappingDeleted = io.flow.v0.models.ExperiencePric
10156
10194
  export type ExperiencePriceBookMappingForm = io.flow.v0.models.ExperiencePriceBookMappingForm;
10157
10195
  export type ExperiencePriceBookMappingPutForm = io.flow.v0.models.ExperiencePriceBookMappingPutForm;
10158
10196
  export type ExperiencePriceBookMappingUpserted = io.flow.v0.models.ExperiencePriceBookMappingUpserted;
10197
+ export type ExperiencePriceConversion = io.flow.v0.models.ExperiencePriceConversion;
10198
+ export type ExperiencePriceConversionRequest = io.flow.v0.models.ExperiencePriceConversionRequest;
10199
+ export type ExperiencePriceConversionResponse = io.flow.v0.models.ExperiencePriceConversionResponse;
10200
+ export type ExperiencePriceFacetConversion = io.flow.v0.models.ExperiencePriceFacetConversion;
10201
+ export type ExperiencePriceFacetConversionRequest = io.flow.v0.models.ExperiencePriceFacetConversionRequest;
10202
+ export type ExperiencePriceFacetConversionResponse = io.flow.v0.models.ExperiencePriceFacetConversionResponse;
10159
10203
  export type ExperienceReference = io.flow.v0.models.ExperienceReference;
10160
10204
  export type ExperienceSettings = io.flow.v0.models.ExperienceSettings;
10161
10205
  export type ExperienceStatus = io.flow.v0.enums.ExperienceStatus;
@@ -10281,10 +10325,6 @@ export type InputSpecificationLimitation = io.flow.v0.unions.InputSpecificationL
10281
10325
  export type InputSpecificationLimitationMax = io.flow.v0.models.InputSpecificationLimitationMax;
10282
10326
  export type InputSpecificationLimitations = io.flow.v0.models.InputSpecificationLimitations;
10283
10327
  export type InputSpecificationType = io.flow.v0.enums.InputSpecificationType;
10284
- export type InstallmentPlanPaymentError = io.flow.v0.models.InstallmentPlanPaymentError;
10285
- export type InstallmentPlanPaymentErrorCode = io.flow.v0.enums.InstallmentPlanPaymentErrorCode;
10286
- export type InstallmentPlanPaymentForm = io.flow.v0.models.InstallmentPlanPaymentForm;
10287
- export type InstallmentProgramSummary = io.flow.v0.models.InstallmentProgramSummary;
10288
10328
  export type InventoryBackorder = io.flow.v0.models.InventoryBackorder;
10289
10329
  export type InventoryCenterReference = io.flow.v0.models.InventoryCenterReference;
10290
10330
  export type InventoryCheckResponse = io.flow.v0.models.InventoryCheckResponse;
@@ -10464,6 +10504,7 @@ export type OrderNumberGeneratorHexadecimal = io.flow.v0.models.OrderNumberGener
10464
10504
  export type OrderNumberGeneratorPrefixSuffix = io.flow.v0.models.OrderNumberGeneratorPrefixSuffix;
10465
10505
  export type OrderNumberGeneratorUuid = io.flow.v0.models.OrderNumberGeneratorUuid;
10466
10506
  export type OrderNumberReference = io.flow.v0.models.OrderNumberReference;
10507
+ export type OrderOptions = io.flow.v0.models.OrderOptions;
10467
10508
  export type OrderPayment = io.flow.v0.models.OrderPayment;
10468
10509
  export type OrderPaymentType = io.flow.v0.enums.OrderPaymentType;
10469
10510
  export type OrderPlaced = io.flow.v0.models.OrderPlaced;
@@ -10485,6 +10526,7 @@ export type OrderServiceChangeForm = io.flow.v0.models.OrderServiceChangeForm;
10485
10526
  export type OrderServiceChangeRequest = io.flow.v0.models.OrderServiceChangeRequest;
10486
10527
  export type OrderServiceChangeRequestData = io.flow.v0.models.OrderServiceChangeRequestData;
10487
10528
  export type OrderStatus = io.flow.v0.enums.OrderStatus;
10529
+ export type OrderStorage = io.flow.v0.enums.OrderStorage;
10488
10530
  export type OrderSubmissionForm = io.flow.v0.models.OrderSubmissionForm;
10489
10531
  export type OrderSubmissionIdentifierForm = io.flow.v0.models.OrderSubmissionIdentifierForm;
10490
10532
  export type OrderSummary = io.flow.v0.models.OrderSummary;
@@ -10500,8 +10542,6 @@ export type Organization = io.flow.v0.models.Organization;
10500
10542
  export type OrganizationAuthorization = io.flow.v0.models.OrganizationAuthorization;
10501
10543
  export type OrganizationAuthorizationForm = io.flow.v0.models.OrganizationAuthorizationForm;
10502
10544
  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
10545
  export type OrganizationCurrencySetting = io.flow.v0.models.OrganizationCurrencySetting;
10506
10546
  export type OrganizationCurrencySettingForm = io.flow.v0.models.OrganizationCurrencySettingForm;
10507
10547
  export type OrganizationCurrencySettingVersion = io.flow.v0.models.OrganizationCurrencySettingVersion;
@@ -10603,6 +10643,7 @@ export type PriceDetailComponentKey = io.flow.v0.enums.PriceDetailComponentKey;
10603
10643
  export type PriceDetailKey = io.flow.v0.enums.PriceDetailKey;
10604
10644
  export type PriceDetails = io.flow.v0.models.PriceDetails;
10605
10645
  export type PriceEquation = io.flow.v0.models.PriceEquation;
10646
+ export type PriceFacetBoundary = io.flow.v0.enums.PriceFacetBoundary;
10606
10647
  export type PriceForm = io.flow.v0.models.PriceForm;
10607
10648
  export type PriceSource = io.flow.v0.unions.PriceSource;
10608
10649
  export type PriceSourceCatalog = io.flow.v0.models.PriceSourceCatalog;