@flowio/types 11.24.135 → 11.24.136

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
@@ -2177,7 +2177,7 @@ declare namespace io.flow.shopify.external.v0.models {
2177
2177
  readonly id: string;
2178
2178
  readonly legacyResourceId: string;
2179
2179
  readonly handle: string;
2180
- readonly variants: io.flow.shopify.external.v0.models.GraphqlProductVariant[];
2180
+ readonly variants?: io.flow.shopify.external.v0.models.GraphqlProductVariant[];
2181
2181
  readonly images: io.flow.shopify.external.v0.models.GraphqlProductImage[];
2182
2182
  readonly title: string;
2183
2183
  readonly vendor?: string;
@@ -2323,7 +2323,7 @@ declare namespace io.flow.shopify.external.v0.models {
2323
2323
  interface Product {
2324
2324
  readonly id: number;
2325
2325
  readonly handle: string;
2326
- readonly variants: io.flow.shopify.external.v0.models.ProductVariant[];
2326
+ readonly variants?: io.flow.shopify.external.v0.models.ProductVariant[];
2327
2327
  readonly images: io.flow.shopify.external.v0.models.ProductImage[];
2328
2328
  readonly title: string;
2329
2329
  readonly vendor?: string;
@@ -2523,7 +2523,7 @@ declare namespace io.flow.shopify.external.v0.models {
2523
2523
  }
2524
2524
 
2525
2525
  interface ShopifyClientDetail {
2526
- readonly accept_language: boolean;
2526
+ readonly accept_language?: boolean;
2527
2527
  readonly browser_height?: number;
2528
2528
  readonly browser_ip?: string;
2529
2529
  readonly browser_width?: number;
@@ -2544,7 +2544,7 @@ declare namespace io.flow.shopify.external.v0.models {
2544
2544
  readonly tax_exempt: boolean;
2545
2545
  readonly verified_email: boolean;
2546
2546
  readonly state: io.flow.shopify.external.v0.enums.ShopifyCustomerState;
2547
- readonly accepts_marketing: boolean;
2547
+ readonly accepts_marketing?: boolean;
2548
2548
  readonly default_address?: any /*object*/;
2549
2549
  readonly email?: string;
2550
2550
  readonly first_name?: string;
@@ -2623,7 +2623,7 @@ declare namespace io.flow.shopify.external.v0.models {
2623
2623
  readonly requires_shipping: boolean;
2624
2624
  readonly currency?: string;
2625
2625
  readonly items: io.flow.shopify.external.v0.models.ShopifyExternalCartItem[];
2626
- readonly cart_level_discount_applications: io.flow.shopify.external.v0.models.ShopifyDiscountApplication[];
2626
+ readonly cart_level_discount_applications?: io.flow.shopify.external.v0.models.ShopifyDiscountApplication[];
2627
2627
  }
2628
2628
 
2629
2629
  interface ShopifyExternalCartItem {
@@ -2638,7 +2638,7 @@ declare namespace io.flow.shopify.external.v0.models {
2638
2638
  readonly original_line_price: number;
2639
2639
  readonly total_discount: number;
2640
2640
  readonly discounted_price: number;
2641
- readonly discounts: io.flow.shopify.external.v0.models.ShopifyCartItemDiscount[];
2641
+ readonly discounts?: io.flow.shopify.external.v0.models.ShopifyCartItemDiscount[];
2642
2642
  readonly taxable: boolean;
2643
2643
  readonly quantity: number;
2644
2644
  readonly sku?: string;
@@ -2656,8 +2656,8 @@ declare namespace io.flow.shopify.external.v0.models {
2656
2656
  readonly product_description?: string;
2657
2657
  readonly product_type: string;
2658
2658
  readonly variant_title?: string;
2659
- readonly variant_options: string[];
2660
- readonly line_level_discount_allocations: io.flow.shopify.external.v0.models.ShopifyLineLevelDiscountAllocation[];
2659
+ readonly variant_options?: string[];
2660
+ readonly line_level_discount_allocations?: io.flow.shopify.external.v0.models.ShopifyLineLevelDiscountAllocation[];
2661
2661
  }
2662
2662
 
2663
2663
  interface ShopifyFulfillment {
@@ -2908,7 +2908,7 @@ declare namespace io.flow.shopify.external.v0.models {
2908
2908
  readonly gateway?: string;
2909
2909
  readonly transactions?: io.flow.shopify.external.v0.models.ShopifyTransactionForm[];
2910
2910
  readonly send_receipt?: boolean;
2911
- readonly metafields: io.flow.shopify.external.v0.models.MetafieldForm[];
2911
+ readonly metafields?: io.flow.shopify.external.v0.models.MetafieldForm[];
2912
2912
  }
2913
2913
 
2914
2914
  interface ShopifyOrderCount {
@@ -3051,7 +3051,7 @@ declare namespace io.flow.shopify.external.v0.models {
3051
3051
 
3052
3052
  interface ShopifyWebhookOrder {
3053
3053
  readonly id?: number;
3054
- readonly line_items: io.flow.shopify.external.v0.models.ShopifyWebhookOrderLineItem[];
3054
+ readonly line_items?: io.flow.shopify.external.v0.models.ShopifyWebhookOrderLineItem[];
3055
3055
  }
3056
3056
 
3057
3057
  interface ShopifyWebhookOrderCancelled {
@@ -3142,7 +3142,8 @@ declare namespace io.flow.channel.internal.v0.enums {
3142
3142
  | 'non_matching_currencies'
3143
3143
  | 'unsupported_order_edit'
3144
3144
  | 'order_allocation_duties_mismatch'
3145
- | 'order_missing';
3145
+ | 'order_missing'
3146
+ | 'organization_deactivated';
3146
3147
  type ChannelOrderAcceptanceStatus =
3147
3148
  | 'accepted'
3148
3149
  | 'rejected'
@@ -3430,7 +3431,7 @@ declare namespace io.flow.common.v0.models {
3430
3431
 
3431
3432
  interface DiscountForm {
3432
3433
  readonly offer: io.flow.common.v0.unions.DiscountOffer;
3433
- readonly target: io.flow.common.v0.enums.DiscountTarget;
3434
+ readonly target?: io.flow.common.v0.enums.DiscountTarget;
3434
3435
  readonly label?: string;
3435
3436
  }
3436
3437
 
@@ -3632,7 +3633,7 @@ declare namespace io.flow.common.v0.models {
3632
3633
  readonly parent?: io.flow.common.v0.models.OrganizationReference;
3633
3634
  readonly defaults?: io.flow.common.v0.models.OrganizationDefaults;
3634
3635
  readonly created_at?: string;
3635
- readonly status: io.flow.common.v0.enums.OrganizationStatus;
3636
+ readonly status?: io.flow.common.v0.enums.OrganizationStatus;
3636
3637
  readonly type?: io.flow.common.v0.enums.OrganizationType;
3637
3638
  }
3638
3639
 
@@ -3981,8 +3982,10 @@ declare namespace io.flow.apple.pay.v0.models {
3981
3982
 
3982
3983
  declare namespace io.flow.tech.onboarding.playground.v0.enums {
3983
3984
  type AmruthaItemType = 'physical' | 'digital';
3985
+ type BojanaItemType = 'physical' | 'digital';
3984
3986
  type ChenglinItemType = 'physical' | 'digital';
3985
3987
  type GabrielItemType = 'physical' | 'digital';
3988
+ type RaveenaItemType = 'physical' | 'digital';
3986
3989
  }
3987
3990
 
3988
3991
  declare namespace io.flow.tech.onboarding.playground.v0.models {
@@ -4003,6 +4006,23 @@ declare namespace io.flow.tech.onboarding.playground.v0.models {
4003
4006
  readonly added_on: string;
4004
4007
  }
4005
4008
 
4009
+ interface BojanaItem {
4010
+ readonly id: string;
4011
+ readonly number: string;
4012
+ readonly amount: io.flow.common.v0.models.Price;
4013
+ readonly description?: string;
4014
+ readonly type: io.flow.tech.onboarding.playground.v0.enums.BojanaItemType;
4015
+ readonly added_on: string;
4016
+ }
4017
+
4018
+ interface BojanaItemForm {
4019
+ readonly number: string;
4020
+ readonly amount: io.flow.common.v0.models.Price;
4021
+ readonly description?: string;
4022
+ readonly type: io.flow.tech.onboarding.playground.v0.enums.BojanaItemType;
4023
+ readonly added_on: string;
4024
+ }
4025
+
4006
4026
  interface ChenglinItem {
4007
4027
  readonly id: string;
4008
4028
  readonly number: string;
@@ -4037,6 +4057,23 @@ declare namespace io.flow.tech.onboarding.playground.v0.models {
4037
4057
  readonly added_on: string;
4038
4058
  }
4039
4059
 
4060
+ interface RaveenaItem {
4061
+ readonly id: string;
4062
+ readonly number: string;
4063
+ readonly amount: io.flow.common.v0.models.Price;
4064
+ readonly description?: string;
4065
+ readonly type: io.flow.tech.onboarding.playground.v0.enums.RaveenaItemType;
4066
+ readonly added_on: string;
4067
+ }
4068
+
4069
+ interface RaveenaItemForm {
4070
+ readonly number: string;
4071
+ readonly amount: io.flow.common.v0.models.Price;
4072
+ readonly description?: string;
4073
+ readonly type: io.flow.tech.onboarding.playground.v0.enums.RaveenaItemType;
4074
+ readonly added_on: string;
4075
+ }
4076
+
4040
4077
  interface TechOnboardingDescription {
4041
4078
  readonly description: string;
4042
4079
  }
@@ -4374,6 +4411,8 @@ declare namespace io.flow.v0.enums {
4374
4411
  | 'consumer_invoice_deleted'
4375
4412
  | 'credit_memo_upserted'
4376
4413
  | 'credit_memo_deleted'
4414
+ | 'fee_invoice_upserted'
4415
+ | 'fee_invoice_deleted'
4377
4416
  | 'crossdock_shipment_upserted'
4378
4417
  | 'rate_deleted'
4379
4418
  | 'rate_upserted'
@@ -4514,6 +4553,11 @@ declare namespace io.flow.v0.enums {
4514
4553
  | 'negative_balance_guarantee'
4515
4554
  | 'sp'
4516
4555
  | 'rev_share';
4556
+ type FeeInvoiceType =
4557
+ | 'mor_invoice'
4558
+ | 'label_invoice'
4559
+ | 'mor_credit_memo'
4560
+ | 'label_credit_memo';
4517
4561
  type FlowBehavior = 'view_consumer_data';
4518
4562
  type FlowEntity =
4519
4563
  | 'flow-usa'
@@ -4521,6 +4565,7 @@ declare namespace io.flow.v0.enums {
4521
4565
  | 'flow-can'
4522
4566
  | 'ge-usa'
4523
4567
  | 'ge-can'
4568
+ | 'ge-can-ship'
4524
4569
  | 'ge-gbr'
4525
4570
  | 'ge-irl';
4526
4571
  type FlowRole =
@@ -4754,7 +4799,8 @@ declare namespace io.flow.v0.enums {
4754
4799
  | 'tax'
4755
4800
  | 'duties'
4756
4801
  | 'tax_and_duties'
4757
- | 'product';
4802
+ | 'product'
4803
+ | 'mor_tax';
4758
4804
  type OrderRefundSummaryIncludes = 'duties' | 'vat' | 'shipping';
4759
4805
  type OrderRefundSummaryPartialCharged =
4760
4806
  | 'per_item'
@@ -5097,6 +5143,11 @@ declare namespace io.flow.v0.enums {
5097
5143
  | 'Pending_006'
5098
5144
  | 'Expired_001';
5099
5145
  type SurchargeResponsibleParty = 'organization' | 'customer';
5146
+ type TaxAndDutyInclusivitySetting =
5147
+ | 'duty_exclusive_tax_exclusive'
5148
+ | 'duty_inclusive_tax_exclusive'
5149
+ | 'duty_exclusive_tax_inclusive'
5150
+ | 'duty_inclusive_tax_inclusive';
5100
5151
  type TaxApplicability = 'none' | 'all';
5101
5152
  type TaxDutyCalculatorValidationErrorCode =
5102
5153
  | 'generic_error'
@@ -5202,7 +5253,9 @@ declare namespace io.flow.v0.enums {
5202
5253
  | 'merchant_fee'
5203
5254
  | 'b2b_tax'
5204
5255
  | 'b2b_tax_refund'
5205
- | 'b2b_fee_mor_tax';
5256
+ | 'b2b_fee_mor_tax'
5257
+ | 'b2b_fee_shipping_tax'
5258
+ | 'flat_rate_label';
5206
5259
  type TransferStatus = 'succeeded' | 'canceled';
5207
5260
  type TransferType =
5208
5261
  | 'payout_to_merchant'
@@ -6125,14 +6178,10 @@ declare namespace io.flow.v0.models {
6125
6178
 
6126
6179
  interface BankAccountInfoKor {
6127
6180
  readonly discriminator: 'kor';
6128
- readonly name?: string;
6129
- readonly address?: io.flow.v0.models.Address;
6130
- readonly phone?: string;
6131
- readonly email?: string;
6181
+ readonly name: string;
6132
6182
  readonly bank_account_number: string;
6133
- readonly bank_routing_number?: string;
6134
- readonly bank_name?: string;
6135
- readonly bank_address?: io.flow.v0.models.Address;
6183
+ readonly bank_routing_number: string;
6184
+ readonly bank_name: string;
6136
6185
  }
6137
6186
 
6138
6187
  interface BankAccountInfoUsa {
@@ -7119,7 +7168,6 @@ declare namespace io.flow.v0.models {
7119
7168
  readonly default_country_of_origin?: string;
7120
7169
  readonly rate_card: string;
7121
7170
  readonly shop?: io.flow.v0.models.Shop;
7122
- readonly settlement_currency?: string;
7123
7171
  readonly created_at: string;
7124
7172
  readonly last_year_xborder_gmv?: io.flow.v0.models.Money;
7125
7173
  readonly last_month_xborder_gmv?: io.flow.v0.models.Money;
@@ -7148,7 +7196,6 @@ declare namespace io.flow.v0.models {
7148
7196
  readonly monthly_average_number_transactions?: number;
7149
7197
  readonly default_country_of_origin?: string;
7150
7198
  readonly shop?: io.flow.v0.models.Shop;
7151
- readonly settlement_currency?: string;
7152
7199
  readonly rate_card?: string;
7153
7200
  readonly last_year_xborder_gmv?: io.flow.v0.models.Money;
7154
7201
  readonly last_month_xborder_gmv?: io.flow.v0.models.Money;
@@ -8537,6 +8584,37 @@ declare namespace io.flow.v0.models {
8537
8584
  readonly description?: string;
8538
8585
  }
8539
8586
 
8587
+ interface FeeInvoice {
8588
+ readonly id: string;
8589
+ readonly number: string;
8590
+ readonly invoice_type: io.flow.v0.enums.FeeInvoiceType;
8591
+ readonly buyer: io.flow.v0.models.MerchantOfRecordEntity;
8592
+ readonly seller: io.flow.v0.models.MerchantOfRecordEntity;
8593
+ readonly date: string;
8594
+ readonly b2b_tax_transaction_id: string;
8595
+ readonly order_number: string;
8596
+ readonly tax: io.flow.v0.models.Money;
8597
+ readonly tax_lines?: io.flow.v0.models.InvoiceTaxLine[];
8598
+ readonly lines: io.flow.v0.unions.ConsumerInvoiceLine[];
8599
+ readonly documents: io.flow.v0.models.ConsumerInvoiceDocument[];
8600
+ }
8601
+
8602
+ interface FeeInvoiceDeleted {
8603
+ readonly discriminator: 'fee_invoice_deleted';
8604
+ readonly event_id: string;
8605
+ readonly timestamp: string;
8606
+ readonly organization: string;
8607
+ readonly id: string;
8608
+ }
8609
+
8610
+ interface FeeInvoiceUpserted {
8611
+ readonly discriminator: 'fee_invoice_upserted';
8612
+ readonly event_id: string;
8613
+ readonly timestamp: string;
8614
+ readonly organization: string;
8615
+ readonly fee_invoice: io.flow.v0.models.FeeInvoice;
8616
+ }
8617
+
8540
8618
  interface FeeWeight {
8541
8619
  readonly weight: number;
8542
8620
  readonly unit: io.flow.v0.enums.UnitOfMeasurement;
@@ -9798,6 +9876,7 @@ declare namespace io.flow.v0.models {
9798
9876
  interface LineItemForm {
9799
9877
  readonly number: string;
9800
9878
  readonly quantity: number;
9879
+ readonly line_item_identifier?: string;
9801
9880
  readonly shipment_estimate?: io.flow.v0.models.DatetimeRange;
9802
9881
  readonly price?: io.flow.v0.models.Money;
9803
9882
  readonly attributes?: Record<string, string>;
@@ -12858,13 +12937,6 @@ declare namespace io.flow.v0.models {
12858
12937
  readonly commercial_invoice_mode?: io.flow.v0.enums.CommercialInvoiceMode;
12859
12938
  }
12860
12939
 
12861
- interface RatecardEstimateSummaryForm {
12862
- readonly origin?: string;
12863
- readonly destination?: string;
12864
- readonly service?: string;
12865
- readonly center_key?: string;
12866
- }
12867
-
12868
12940
  interface RatecardEstimateV1 {
12869
12941
  readonly discriminator: 'ratecard_estimate_v1';
12870
12942
  readonly service: io.flow.v0.models.RatecardServiceSummary;
@@ -14053,6 +14125,7 @@ declare namespace io.flow.v0.models {
14053
14125
  }
14054
14126
 
14055
14127
  interface ShippingRateEstimateRequest {
14128
+ readonly carrier_id: string;
14056
14129
  readonly origin_address: io.flow.v0.models.Address;
14057
14130
  readonly destination_address: io.flow.v0.models.Address;
14058
14131
  readonly package_dimensions: io.flow.v0.models.Dimension;
@@ -14290,7 +14363,6 @@ declare namespace io.flow.v0.models {
14290
14363
  readonly activated_at?: string;
14291
14364
  readonly status_updated_at?: string;
14292
14365
  readonly shop?: io.flow.v0.models.Shop;
14293
- readonly settlement_currency?: string;
14294
14366
  readonly last_year_xborder_gmv?: io.flow.v0.models.Money;
14295
14367
  readonly last_month_xborder_gmv?: io.flow.v0.models.Money;
14296
14368
  readonly average_order_value?: io.flow.v0.models.Money;
@@ -14324,7 +14396,6 @@ declare namespace io.flow.v0.models {
14324
14396
  readonly ratecard_id?: string;
14325
14397
  readonly rate_card: string;
14326
14398
  readonly shop?: io.flow.v0.models.Shop;
14327
- readonly settlement_currency?: string;
14328
14399
  readonly last_year_xborder_gmv?: io.flow.v0.models.Money;
14329
14400
  readonly last_month_xborder_gmv?: io.flow.v0.models.Money;
14330
14401
  readonly average_order_value?: io.flow.v0.models.Money;
@@ -15229,6 +15300,12 @@ declare namespace io.flow.v0.models {
15229
15300
  readonly id: string;
15230
15301
  }
15231
15302
 
15303
+ interface TransactionMetadataFlatRateLabel {
15304
+ readonly discriminator: 'flat_rate_label';
15305
+ readonly flat_rate?: number;
15306
+ readonly coefficient?: number;
15307
+ }
15308
+
15232
15309
  interface TransactionMetadataManual {
15233
15310
  readonly discriminator: 'manual';
15234
15311
  readonly description: string;
@@ -15824,6 +15901,8 @@ declare namespace io.flow.v0.unions {
15824
15901
  | io.flow.v0.models.ConsumerInvoiceDeleted
15825
15902
  | io.flow.v0.models.CreditMemoUpserted
15826
15903
  | io.flow.v0.models.CreditMemoDeleted
15904
+ | io.flow.v0.models.FeeInvoiceUpserted
15905
+ | io.flow.v0.models.FeeInvoiceDeleted
15827
15906
  | io.flow.v0.models.CrossdockShipmentUpserted
15828
15907
  | io.flow.v0.models.RateDeleted
15829
15908
  | io.flow.v0.models.RateUpserted
@@ -16280,7 +16359,8 @@ declare namespace io.flow.v0.unions {
16280
16359
  | io.flow.v0.models.TransactionMetadataFailedPayout
16281
16360
  | io.flow.v0.models.TransactionMetadataPaymentTransaction
16282
16361
  | io.flow.v0.models.TransactionMetadataTaxDuty
16283
- | io.flow.v0.models.TransactionMetadataMerchantFee;
16362
+ | io.flow.v0.models.TransactionMetadataMerchantFee
16363
+ | io.flow.v0.models.TransactionMetadataFlatRateLabel;
16284
16364
  type TransferReference =
16285
16365
  | io.flow.v0.models.CaptureReference
16286
16366
  | io.flow.v0.models.RefundReference
@@ -17008,6 +17088,10 @@ export type ExternalCard = io.flow.v0.models.ExternalCard;
17008
17088
  export type ExternalOrderSummary = io.flow.v0.models.ExternalOrderSummary;
17009
17089
  export type FeeDeduction = io.flow.v0.models.FeeDeduction;
17010
17090
  export type FeeDeductionType = io.flow.v0.enums.FeeDeductionType;
17091
+ export type FeeInvoice = io.flow.v0.models.FeeInvoice;
17092
+ export type FeeInvoiceDeleted = io.flow.v0.models.FeeInvoiceDeleted;
17093
+ export type FeeInvoiceType = io.flow.v0.enums.FeeInvoiceType;
17094
+ export type FeeInvoiceUpserted = io.flow.v0.models.FeeInvoiceUpserted;
17011
17095
  export type FeeWeight = io.flow.v0.models.FeeWeight;
17012
17096
  export type FieldValidationMax = io.flow.v0.models.FieldValidationMax;
17013
17097
  export type FieldValidationMin = io.flow.v0.models.FieldValidationMin;
@@ -17987,8 +18071,6 @@ export type RatecardData = io.flow.v0.models.RatecardData;
17987
18071
  export type RatecardDeleted = io.flow.v0.models.RatecardDeleted;
17988
18072
  export type RatecardEstimate = io.flow.v0.unions.RatecardEstimate;
17989
18073
  export type RatecardEstimateForm = io.flow.v0.models.RatecardEstimateForm;
17990
- export type RatecardEstimateSummaryForm =
17991
- io.flow.v0.models.RatecardEstimateSummaryForm;
17992
18074
  export type RatecardEstimateV1 = io.flow.v0.models.RatecardEstimateV1;
17993
18075
  export type RatecardEstimateV2 = io.flow.v0.models.RatecardEstimateV2;
17994
18076
  export type RatecardEstimateV3 = io.flow.v0.models.RatecardEstimateV3;
@@ -18363,6 +18445,8 @@ export type TariffCodes = io.flow.v0.models.TariffCodes;
18363
18445
  export type TariffCodesDeleted = io.flow.v0.models.TariffCodesDeleted;
18364
18446
  export type TariffCodesUpserted = io.flow.v0.models.TariffCodesUpserted;
18365
18447
  export type Tax = io.flow.v0.models.Tax;
18448
+ export type TaxAndDutyInclusivitySetting =
18449
+ io.flow.v0.enums.TaxAndDutyInclusivitySetting;
18366
18450
  export type TaxApplicability = io.flow.v0.enums.TaxApplicability;
18367
18451
  export type TaxBreakdown = io.flow.v0.models.TaxBreakdown;
18368
18452
  export type TaxDutyCalculatorValidationError =
@@ -18485,6 +18569,8 @@ export type TransactionMetadataFailedPayout =
18485
18569
  io.flow.v0.models.TransactionMetadataFailedPayout;
18486
18570
  export type TransactionMetadataFailedPayoutReference =
18487
18571
  io.flow.v0.models.TransactionMetadataFailedPayoutReference;
18572
+ export type TransactionMetadataFlatRateLabel =
18573
+ io.flow.v0.models.TransactionMetadataFlatRateLabel;
18488
18574
  export type TransactionMetadataManual =
18489
18575
  io.flow.v0.models.TransactionMetadataManual;
18490
18576
  export type TransactionMetadataMerchantFee =