@flowio/types 9.1.5 → 9.1.6

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
@@ -455,7 +455,7 @@ declare namespace io.flow.shopify.external.v0.models {
455
455
  readonly requires_shipping: boolean;
456
456
  readonly currency?: string;
457
457
  readonly items: io.flow.shopify.external.v0.models.ShopifyCartItem[];
458
- readonly cart_level_discount_applications?: io.flow.shopify.external.v0.models.ShopifyDiscountApplication[];
458
+ readonly cart_level_discount_applications: io.flow.shopify.external.v0.models.ShopifyDiscountApplication[];
459
459
  }
460
460
 
461
461
  interface ShopifyCartItem {
@@ -470,7 +470,7 @@ declare namespace io.flow.shopify.external.v0.models {
470
470
  readonly original_line_price: number;
471
471
  readonly total_discount: number;
472
472
  readonly discounted_price: number;
473
- readonly discounts?: io.flow.shopify.external.v0.models.ShopifyCartItemDiscount[];
473
+ readonly discounts: io.flow.shopify.external.v0.models.ShopifyCartItemDiscount[];
474
474
  readonly taxable: boolean;
475
475
  readonly quantity: number;
476
476
  readonly sku?: string;
@@ -488,8 +488,8 @@ declare namespace io.flow.shopify.external.v0.models {
488
488
  readonly product_description?: string;
489
489
  readonly product_type: string;
490
490
  readonly variant_title?: string;
491
- readonly variant_options?: string[];
492
- readonly line_level_discount_allocations?: io.flow.shopify.external.v0.models.ShopifyLineLevelDiscountAllocation[];
491
+ readonly variant_options: string[];
492
+ readonly line_level_discount_allocations: io.flow.shopify.external.v0.models.ShopifyLineLevelDiscountAllocation[];
493
493
  }
494
494
 
495
495
  interface ShopifyCartItemDiscount {
@@ -514,7 +514,7 @@ declare namespace io.flow.shopify.external.v0.models {
514
514
  readonly tax_exempt: boolean;
515
515
  readonly verified_email: boolean;
516
516
  readonly state: io.flow.shopify.external.v0.enums.ShopifyCustomerState;
517
- readonly accepts_marketing?: boolean;
517
+ readonly accepts_marketing: boolean;
518
518
  readonly default_address?: any /*object*/;
519
519
  readonly email?: string;
520
520
  readonly first_name?: string;
@@ -812,11 +812,11 @@ declare namespace io.flow.shopify.external.v0.models {
812
812
  readonly updated_at?: string;
813
813
  readonly user_id?: number;
814
814
  readonly order_status_url?: string;
815
- readonly inventory_behaviour?: io.flow.shopify.external.v0.enums.InventoryBehaviour;
815
+ readonly inventory_behaviour: io.flow.shopify.external.v0.enums.InventoryBehaviour;
816
816
  readonly gateway?: string;
817
817
  readonly transactions?: io.flow.shopify.external.v0.models.ShopifyTransactionForm[];
818
818
  readonly send_receipt?: boolean;
819
- readonly metafields?: io.flow.shopify.external.v0.models.MetafieldForm[];
819
+ readonly metafields: io.flow.shopify.external.v0.models.MetafieldForm[];
820
820
  }
821
821
 
822
822
  interface ShopifyOrderCount {
@@ -949,7 +949,7 @@ declare namespace io.flow.shopify.external.v0.models {
949
949
 
950
950
  interface ShopifyWebhookOrder {
951
951
  readonly id?: number;
952
- readonly line_items?: io.flow.shopify.external.v0.models.ShopifyWebhookOrderLineItem[];
952
+ readonly line_items: io.flow.shopify.external.v0.models.ShopifyWebhookOrderLineItem[];
953
953
  }
954
954
 
955
955
  interface ShopifyWebhookOrderCancelled {
@@ -1019,7 +1019,6 @@ declare namespace io.flow.v0.enums {
1019
1019
  | 'consumer_url'
1020
1020
  | 'gtin'
1021
1021
  | 'mpn'
1022
- | 'excluded_regions'
1023
1022
  | 'facet';
1024
1023
  type AuthenticationTechnique =
1025
1024
  | 'anonymous'
@@ -1129,6 +1128,7 @@ declare namespace io.flow.v0.enums {
1129
1128
  | 'ratecard_fuel_surcharge'
1130
1129
  | 'ratecard_oversized_shipment_fee'
1131
1130
  | 'ratecard_rural_shipment_fee'
1131
+ | 'ratecard_emergency_situation_surcharge_fee'
1132
1132
  | 'center_commercial_invoice_fee'
1133
1133
  | 'center_inbound_carton_fee'
1134
1134
  | 'center_outbound_carton_fee';
@@ -1446,7 +1446,8 @@ declare namespace io.flow.v0.enums {
1446
1446
  | 'vat_subsidy'
1447
1447
  | 'duty_subsidy'
1448
1448
  | 'remote_area_surcharge'
1449
- | 'fuel_surcharge';
1449
+ | 'fuel_surcharge'
1450
+ | 'emergency_situation_surcharge';
1450
1451
  type OrderPriceDetailKey =
1451
1452
  | 'adjustment'
1452
1453
  | 'subtotal'
@@ -1527,7 +1528,6 @@ declare namespace io.flow.v0.enums {
1527
1528
  | 'state'
1528
1529
  | 'territory'
1529
1530
  | 'other';
1530
- type QueryType = 'exclusion' | 'inclusion';
1531
1531
  type QuoteErrorCode =
1532
1532
  | 'generic_error'
1533
1533
  | 'items_not_available'
@@ -1772,7 +1772,7 @@ declare namespace io.flow.v0.models {
1772
1772
  readonly rate: number;
1773
1773
  readonly name: string;
1774
1774
  readonly price?: io.flow.v0.models.PriceWithBase;
1775
- readonly accuracy?: io.flow.v0.enums.PriceAccuracy;
1775
+ readonly accuracy: io.flow.v0.enums.PriceAccuracy;
1776
1776
  readonly basis?: io.flow.v0.models.MoneyWithBase;
1777
1777
  }
1778
1778
 
@@ -2216,7 +2216,7 @@ declare namespace io.flow.v0.models {
2216
2216
  readonly requested?: io.flow.v0.models.Money;
2217
2217
  readonly created_at: string;
2218
2218
  readonly attributes?: Record<string, string>;
2219
- readonly status?: io.flow.v0.enums.CaptureStatus;
2219
+ readonly status: io.flow.v0.enums.CaptureStatus;
2220
2220
  readonly base?: io.flow.v0.models.Money;
2221
2221
  }
2222
2222
 
@@ -2304,7 +2304,7 @@ declare namespace io.flow.v0.models {
2304
2304
  readonly discriminator: 'card_authorization';
2305
2305
  readonly id: string;
2306
2306
  readonly key: string;
2307
- readonly merchant_of_record?: io.flow.v0.enums.MerchantOfRecord;
2307
+ readonly merchant_of_record: io.flow.v0.enums.MerchantOfRecord;
2308
2308
  readonly method?: io.flow.v0.models.PaymentMethod;
2309
2309
  readonly card: io.flow.v0.unions.ExpandableCard;
2310
2310
  readonly amount: number;
@@ -3192,6 +3192,17 @@ declare namespace io.flow.v0.models {
3192
3192
  readonly payment_methods: io.flow.v0.models.PaymentMethod[];
3193
3193
  }
3194
3194
 
3195
+ interface CustomerPurgeSettings {
3196
+ readonly id: string;
3197
+ readonly days_until_purge_unused: number;
3198
+ readonly days_until_purge_used: number;
3199
+ }
3200
+
3201
+ interface CustomerPurgeSettingsForm {
3202
+ readonly days_until_purge_unused: number;
3203
+ readonly days_until_purge_used: number;
3204
+ }
3205
+
3195
3206
  interface CustomerPutForm {
3196
3207
  readonly email?: string;
3197
3208
  readonly name?: io.flow.v0.models.Name;
@@ -3458,7 +3469,7 @@ declare namespace io.flow.v0.models {
3458
3469
 
3459
3470
  interface DiscountForm {
3460
3471
  readonly offer: io.flow.v0.unions.DiscountOffer;
3461
- readonly target?: io.flow.v0.enums.DiscountTarget;
3472
+ readonly target: io.flow.v0.enums.DiscountTarget;
3462
3473
  readonly label?: string;
3463
3474
  }
3464
3475
 
@@ -3574,6 +3585,19 @@ declare namespace io.flow.v0.models {
3574
3585
  readonly email: string;
3575
3586
  }
3576
3587
 
3588
+ interface EmergencySituationSurchargeRatecardFee {
3589
+ readonly discriminator: 'emergency_situation_surcharge_ratecard_fee';
3590
+ readonly amount: io.flow.v0.models.Money;
3591
+ }
3592
+
3593
+ interface EmergencySituationSurchargeServiceFee {
3594
+ readonly discriminator: 'emergency_situation_surcharge_service_fee';
3595
+ readonly amount: io.flow.v0.models.Money;
3596
+ readonly origin_region?: io.flow.v0.models.RatecardRegionReference;
3597
+ readonly destination_region?: io.flow.v0.models.RatecardRegionReference;
3598
+ readonly interval_unit?: io.flow.v0.enums.UnitOfMeasurement;
3599
+ }
3600
+
3577
3601
  interface EstimatedDimensions {
3578
3602
  readonly depth: io.flow.v0.models.Measurement;
3579
3603
  readonly length: io.flow.v0.models.Measurement;
@@ -4630,7 +4654,7 @@ declare namespace io.flow.v0.models {
4630
4654
  readonly organization: string;
4631
4655
  readonly email: string;
4632
4656
  readonly name?: io.flow.v0.models.Name;
4633
- readonly role?: io.flow.v0.enums.Role;
4657
+ readonly role: io.flow.v0.enums.Role;
4634
4658
  readonly roles?: io.flow.v0.unions.FlowRole[];
4635
4659
  }
4636
4660
 
@@ -5117,7 +5141,7 @@ declare namespace io.flow.v0.models {
5117
5141
  readonly base: io.flow.v0.models.Price;
5118
5142
  readonly name: string;
5119
5143
  readonly adjustment?: io.flow.v0.models.LocalizedAdjustment;
5120
- readonly accuracy?: io.flow.v0.enums.PriceAccuracy;
5144
+ readonly accuracy: io.flow.v0.enums.PriceAccuracy;
5121
5145
  readonly basis?: io.flow.v0.models.MoneyWithBase;
5122
5146
  }
5123
5147
 
@@ -5205,6 +5229,12 @@ declare namespace io.flow.v0.models {
5205
5229
  readonly value: number;
5206
5230
  }
5207
5231
 
5232
+ interface MarketingFeedsExportType {
5233
+ readonly discriminator: 'marketing_feeds_export_type';
5234
+ readonly organization: io.flow.v0.models.OrganizationReference;
5235
+ readonly feed_ids: string[];
5236
+ }
5237
+
5208
5238
  interface Measurement {
5209
5239
  readonly value: string;
5210
5240
  readonly units: io.flow.v0.enums.UnitOfMeasurement;
@@ -5228,13 +5258,13 @@ declare namespace io.flow.v0.models {
5228
5258
  interface MembershipForm {
5229
5259
  readonly organization: string;
5230
5260
  readonly user: string;
5231
- readonly role?: io.flow.v0.enums.Role;
5232
- readonly roles?: io.flow.v0.unions.FlowRole[];
5261
+ readonly role: io.flow.v0.enums.Role;
5262
+ readonly roles: io.flow.v0.unions.FlowRole[];
5233
5263
  }
5234
5264
 
5235
5265
  interface MembershipPutForm {
5236
- readonly role?: io.flow.v0.enums.Role;
5237
- readonly roles?: io.flow.v0.unions.FlowRole[];
5266
+ readonly role: io.flow.v0.enums.Role;
5267
+ readonly roles: io.flow.v0.unions.FlowRole[];
5238
5268
  }
5239
5269
 
5240
5270
  interface MembershipUpsertedV2 {
@@ -5409,7 +5439,7 @@ declare namespace io.flow.v0.models {
5409
5439
  readonly id: string;
5410
5440
  readonly key: string;
5411
5441
  readonly method?: io.flow.v0.models.PaymentMethod;
5412
- readonly merchant_of_record?: io.flow.v0.enums.MerchantOfRecord;
5442
+ readonly merchant_of_record: io.flow.v0.enums.MerchantOfRecord;
5413
5443
  readonly details?: io.flow.v0.unions.OnlineAuthorizationDetails;
5414
5444
  readonly payment?: any /*object*/;
5415
5445
  readonly amount: number;
@@ -5730,7 +5760,7 @@ declare namespace io.flow.v0.models {
5730
5760
 
5731
5761
  interface OrderNumberGeneratorUuid {
5732
5762
  readonly discriminator: 'uuid';
5733
- readonly prefix?: string;
5763
+ readonly prefix: string;
5734
5764
  }
5735
5765
 
5736
5766
  interface OrderNumberReference {
@@ -5744,13 +5774,13 @@ declare namespace io.flow.v0.models {
5744
5774
  interface OrderPayment {
5745
5775
  readonly id: string;
5746
5776
  readonly type: io.flow.v0.enums.OrderPaymentType;
5747
- readonly merchant_of_record?: io.flow.v0.enums.MerchantOfRecord;
5777
+ readonly merchant_of_record: io.flow.v0.enums.MerchantOfRecord;
5748
5778
  readonly reference: string;
5749
5779
  readonly description: string;
5750
5780
  readonly total: io.flow.v0.models.PriceWithBase;
5751
5781
  readonly address?: io.flow.v0.models.BillingAddress;
5752
5782
  readonly date?: string;
5753
- readonly attributes?: Record<string, string>;
5783
+ readonly attributes: Record<string, string>;
5754
5784
  }
5755
5785
 
5756
5786
  interface OrderPlaced {
@@ -5858,7 +5888,7 @@ declare namespace io.flow.v0.models {
5858
5888
  }
5859
5889
 
5860
5890
  interface OrderSubmissionForm {
5861
- readonly identifiers?: io.flow.v0.models.OrderSubmissionIdentifierForm[];
5891
+ readonly identifiers: io.flow.v0.models.OrderSubmissionIdentifierForm[];
5862
5892
  }
5863
5893
 
5864
5894
  interface OrderSubmissionIdentifierForm {
@@ -6477,7 +6507,7 @@ declare namespace io.flow.v0.models {
6477
6507
  readonly currency: string;
6478
6508
  readonly name: string;
6479
6509
  readonly includes: io.flow.v0.enums.IncludedLevyKey;
6480
- readonly status?: io.flow.v0.enums.PriceBookStatus;
6510
+ readonly status: io.flow.v0.enums.PriceBookStatus;
6481
6511
  }
6482
6512
 
6483
6513
  interface PriceBookItem {
@@ -6946,7 +6976,7 @@ declare namespace io.flow.v0.models {
6946
6976
  readonly origination_zones: io.flow.v0.models.Zone[];
6947
6977
  readonly service: string;
6948
6978
  readonly number?: string;
6949
- readonly ratecard_owner?: io.flow.v0.enums.RatecardOwner;
6979
+ readonly ratecard_owner: io.flow.v0.enums.RatecardOwner;
6950
6980
  }
6951
6981
 
6952
6982
  interface RatecardLane {
@@ -7046,6 +7076,10 @@ declare namespace io.flow.v0.models {
7046
7076
  readonly id: string;
7047
7077
  }
7048
7078
 
7079
+ interface RatecardRegionReference {
7080
+ readonly id: string;
7081
+ }
7082
+
7049
7083
  interface RatecardServiceSummary {
7050
7084
  readonly id: string;
7051
7085
  readonly name: string;
@@ -7108,7 +7142,7 @@ declare namespace io.flow.v0.models {
7108
7142
  readonly captures: io.flow.v0.models.RefundCaptureSummary[];
7109
7143
  readonly created_at: string;
7110
7144
  readonly attributes?: Record<string, string>;
7111
- readonly status?: io.flow.v0.enums.RefundStatus;
7145
+ readonly status: io.flow.v0.enums.RefundStatus;
7112
7146
  readonly base?: io.flow.v0.models.Money;
7113
7147
  }
7114
7148
 
@@ -7119,7 +7153,7 @@ declare namespace io.flow.v0.models {
7119
7153
  readonly amount: number;
7120
7154
  readonly currency: string;
7121
7155
  readonly base: io.flow.v0.models.Money;
7122
- readonly status?: io.flow.v0.enums.RefundStatus;
7156
+ readonly status: io.flow.v0.enums.RefundStatus;
7123
7157
  }
7124
7158
 
7125
7159
  interface RefundCaptureSummary {
@@ -8220,22 +8254,6 @@ declare namespace io.flow.v0.models {
8220
8254
  readonly subcatalog_item: io.flow.v0.models.SubcatalogItem;
8221
8255
  }
8222
8256
 
8223
- interface SubcatalogQuery {
8224
- readonly id: string;
8225
- readonly q: string;
8226
- readonly type: io.flow.v0.enums.QueryType;
8227
- }
8228
-
8229
- interface SubcatalogQueryForm {
8230
- readonly q: string;
8231
- readonly type: io.flow.v0.enums.QueryType;
8232
- }
8233
-
8234
- interface SubcatalogQueryValidation {
8235
- readonly valid: string[];
8236
- readonly invalid: string[];
8237
- }
8238
-
8239
8257
  interface SubcatalogReference {
8240
8258
  readonly discriminator: 'subcatalog_reference';
8241
8259
  readonly id: string;
@@ -9065,7 +9083,8 @@ declare namespace io.flow.v0.unions {
9065
9083
  | io.flow.v0.models.PriceBookItemExportType
9066
9084
  | io.flow.v0.models.SolidusProductExportType
9067
9085
  | io.flow.v0.models.SolidusVariantExportType
9068
- | io.flow.v0.models.LocalizedItemPricesExportType;
9086
+ | io.flow.v0.models.LocalizedItemPricesExportType
9087
+ | io.flow.v0.models.MarketingFeedsExportType;
9069
9088
  type FieldValidationRule =
9070
9089
  | io.flow.v0.models.FieldValidationRequired
9071
9090
  | io.flow.v0.models.FieldValidationMin
@@ -9152,7 +9171,8 @@ declare namespace io.flow.v0.unions {
9152
9171
  | io.flow.v0.models.OversizedShipmentRatecardFee
9153
9172
  | io.flow.v0.models.ReturnPackageRatecardFee
9154
9173
  | io.flow.v0.models.CrossdockRatecardFee
9155
- | io.flow.v0.models.RemoteAreaRatecardFee;
9174
+ | io.flow.v0.models.RemoteAreaRatecardFee
9175
+ | io.flow.v0.models.EmergencySituationSurchargeRatecardFee;
9156
9176
  type RepeatSchedule =
9157
9177
  | io.flow.v0.models.RepeatHourly
9158
9178
  | io.flow.v0.models.RepeatDaily
@@ -9164,7 +9184,8 @@ declare namespace io.flow.v0.unions {
9164
9184
  | io.flow.v0.models.GenericReservationError;
9165
9185
  type ServiceFee =
9166
9186
  | io.flow.v0.models.FuelSurchargeServiceFee
9167
- | io.flow.v0.models.RemoteAreaServiceFee;
9187
+ | io.flow.v0.models.RemoteAreaServiceFee
9188
+ | io.flow.v0.models.EmergencySituationSurchargeServiceFee;
9168
9189
  type Session = io.flow.v0.models.OrganizationSession;
9169
9190
  type SessionAuthorization = io.flow.v0.models.OrganizationSessionAuthorization;
9170
9191
  type ShippingLabelForm =
@@ -9449,6 +9470,8 @@ export type CustomerInvoice = io.flow.v0.models.CustomerInvoice;
9449
9470
  export type CustomerLastUsed = io.flow.v0.models.CustomerLastUsed;
9450
9471
  export type CustomerOrder = io.flow.v0.models.CustomerOrder;
9451
9472
  export type CustomerPayment = io.flow.v0.models.CustomerPayment;
9473
+ export type CustomerPurgeSettings = io.flow.v0.models.CustomerPurgeSettings;
9474
+ export type CustomerPurgeSettingsForm = io.flow.v0.models.CustomerPurgeSettingsForm;
9452
9475
  export type CustomerPutForm = io.flow.v0.models.CustomerPutForm;
9453
9476
  export type CustomerReference = io.flow.v0.models.CustomerReference;
9454
9477
  export type CustomerToken = io.flow.v0.models.CustomerToken;
@@ -9521,6 +9544,8 @@ export type EmailNotificationUpserted = io.flow.v0.models.EmailNotificationUpser
9521
9544
  export type EmailPaymentSummary = io.flow.v0.models.EmailPaymentSummary;
9522
9545
  export type EmailRecipient = io.flow.v0.models.EmailRecipient;
9523
9546
  export type EmailVerification = io.flow.v0.models.EmailVerification;
9547
+ export type EmergencySituationSurchargeRatecardFee = io.flow.v0.models.EmergencySituationSurchargeRatecardFee;
9548
+ export type EmergencySituationSurchargeServiceFee = io.flow.v0.models.EmergencySituationSurchargeServiceFee;
9524
9549
  export type Environment = io.flow.v0.enums.Environment;
9525
9550
  export type EstimatedDimensions = io.flow.v0.models.EstimatedDimensions;
9526
9551
  export type EstimatedWindow = io.flow.v0.models.EstimatedWindow;
@@ -9806,6 +9831,7 @@ export type ManifestedLabelDeleted = io.flow.v0.models.ManifestedLabelDeleted;
9806
9831
  export type ManifestedLabelUpserted = io.flow.v0.models.ManifestedLabelUpserted;
9807
9832
  export type Margin = io.flow.v0.models.Margin;
9808
9833
  export type MarginType = io.flow.v0.enums.MarginType;
9834
+ export type MarketingFeedsExportType = io.flow.v0.models.MarketingFeedsExportType;
9809
9835
  export type Measurement = io.flow.v0.models.Measurement;
9810
9836
  export type MeasurementSystem = io.flow.v0.enums.MeasurementSystem;
9811
9837
  export type Membership = io.flow.v0.models.Membership;
@@ -10060,7 +10086,6 @@ export type QueryFilterStructured = io.flow.v0.models.QueryFilterStructured;
10060
10086
  export type QueryFilterStructuredForm = io.flow.v0.models.QueryFilterStructuredForm;
10061
10087
  export type QueryFilterUnstructured = io.flow.v0.models.QueryFilterUnstructured;
10062
10088
  export type QueryFilterUnstructuredForm = io.flow.v0.models.QueryFilterUnstructuredForm;
10063
- export type QueryType = io.flow.v0.enums.QueryType;
10064
10089
  export type Quote = io.flow.v0.models.Quote;
10065
10090
  export type QuoteError = io.flow.v0.models.QuoteError;
10066
10091
  export type QuoteErrorCode = io.flow.v0.enums.QuoteErrorCode;
@@ -10100,6 +10125,7 @@ export type RatecardRate = io.flow.v0.models.RatecardRate;
10100
10125
  export type RatecardRateForm = io.flow.v0.models.RatecardRateForm;
10101
10126
  export type RatecardRateVersion = io.flow.v0.models.RatecardRateVersion;
10102
10127
  export type RatecardReference = io.flow.v0.models.RatecardReference;
10128
+ export type RatecardRegionReference = io.flow.v0.models.RatecardRegionReference;
10103
10129
  export type RatecardServiceSummary = io.flow.v0.models.RatecardServiceSummary;
10104
10130
  export type RatecardUpserted = io.flow.v0.models.RatecardUpserted;
10105
10131
  export type RatecardVersion = io.flow.v0.models.RatecardVersion;
@@ -10291,9 +10317,6 @@ export type SubcatalogItemDeleted = io.flow.v0.models.SubcatalogItemDeleted;
10291
10317
  export type SubcatalogItemStatus = io.flow.v0.enums.SubcatalogItemStatus;
10292
10318
  export type SubcatalogItemUpserted = io.flow.v0.models.SubcatalogItemUpserted;
10293
10319
  export type SubcatalogItemVersion = io.flow.v0.models.SubcatalogItemVersion;
10294
- export type SubcatalogQuery = io.flow.v0.models.SubcatalogQuery;
10295
- export type SubcatalogQueryForm = io.flow.v0.models.SubcatalogQueryForm;
10296
- export type SubcatalogQueryValidation = io.flow.v0.models.SubcatalogQueryValidation;
10297
10320
  export type SubcatalogReference = io.flow.v0.models.SubcatalogReference;
10298
10321
  export type SubcatalogSettings = io.flow.v0.models.SubcatalogSettings;
10299
10322
  export type SubcatalogSettingsForm = io.flow.v0.models.SubcatalogSettingsForm;