@flowio/types 9.2.2 → 9.3.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
@@ -1477,6 +1477,7 @@ declare namespace io.flow.v0.enums {
1477
1477
  | 'invalid_customer'
1478
1478
  | 'invalid_destination'
1479
1479
  | 'unknown';
1480
+ type PaymentMethodCapability = 'credit' | 'debit';
1480
1481
  type PaymentMethodRuleContentKey = 'description';
1481
1482
  type PaymentMethodType = 'card' | 'online' | 'offline';
1482
1483
  type PaymentSourceConfirmationActionType =
@@ -1576,6 +1577,13 @@ declare namespace io.flow.v0.enums {
1576
1577
  type Strategy = 'range' | 'from' | 'to';
1577
1578
  type SubcatalogItemStatus = 'excluded' | 'included' | 'restricted';
1578
1579
  type SurchargeResponsibleParty = 'organization' | 'customer';
1580
+ type SyncRecordFailureReason =
1581
+ | 'inventory'
1582
+ | 'address'
1583
+ | 'promotion'
1584
+ | 'other';
1585
+ type SyncStreamType = 'submitted_order';
1586
+ type SyncUnitOfTime = 'day' | 'hour' | 'minute' | 'second';
1579
1587
  type TaxApplicability = 'none' | 'all';
1580
1588
  type TaxVerificationResult = 'valid' | 'invalid' | 'unable_to_validate';
1581
1589
  type TaxabilityType = 'tax_rule';
@@ -2234,7 +2242,7 @@ declare namespace io.flow.v0.models {
2234
2242
  readonly requested?: io.flow.v0.models.Money;
2235
2243
  readonly created_at: string;
2236
2244
  readonly attributes?: Record<string, string>;
2237
- readonly status: io.flow.v0.enums.CaptureStatus;
2245
+ readonly status?: io.flow.v0.enums.CaptureStatus;
2238
2246
  readonly base?: io.flow.v0.models.Money;
2239
2247
  }
2240
2248
 
@@ -2322,7 +2330,7 @@ declare namespace io.flow.v0.models {
2322
2330
  readonly discriminator: 'card_authorization';
2323
2331
  readonly id: string;
2324
2332
  readonly key: string;
2325
- readonly merchant_of_record: io.flow.v0.enums.MerchantOfRecord;
2333
+ readonly merchant_of_record?: io.flow.v0.enums.MerchantOfRecord;
2326
2334
  readonly method?: io.flow.v0.models.PaymentMethod;
2327
2335
  readonly card: io.flow.v0.unions.ExpandableCard;
2328
2336
  readonly amount: number;
@@ -4088,6 +4096,7 @@ declare namespace io.flow.v0.models {
4088
4096
  }
4089
4097
 
4090
4098
  interface FraudEmailRule {
4099
+ readonly id?: string;
4091
4100
  readonly email: string;
4092
4101
  readonly decision: io.flow.v0.enums.FraudEmailRuleDecision;
4093
4102
  }
@@ -4298,11 +4307,6 @@ declare namespace io.flow.v0.models {
4298
4307
  readonly sort?: string;
4299
4308
  }
4300
4309
 
4301
- interface HarmonizationLandedCostExportType {
4302
- readonly discriminator: 'harmonization_landed_cost_export_type';
4303
- readonly items: io.flow.v0.models.LandedCostItem[];
4304
- }
4305
-
4306
4310
  interface HarmonizationOverviewExportType {
4307
4311
  readonly discriminator: 'harmonization_overview_export_type';
4308
4312
  readonly origin?: string;
@@ -4714,7 +4718,7 @@ declare namespace io.flow.v0.models {
4714
4718
  readonly organization: string;
4715
4719
  readonly email: string;
4716
4720
  readonly name?: io.flow.v0.models.Name;
4717
- readonly role: io.flow.v0.enums.Role;
4721
+ readonly role?: io.flow.v0.enums.Role;
4718
4722
  readonly roles?: io.flow.v0.unions.FlowRole[];
4719
4723
  }
4720
4724
 
@@ -5201,7 +5205,7 @@ declare namespace io.flow.v0.models {
5201
5205
  readonly base: io.flow.v0.models.Price;
5202
5206
  readonly name: string;
5203
5207
  readonly adjustment?: io.flow.v0.models.LocalizedAdjustment;
5204
- readonly accuracy: io.flow.v0.enums.PriceAccuracy;
5208
+ readonly accuracy?: io.flow.v0.enums.PriceAccuracy;
5205
5209
  readonly basis?: io.flow.v0.models.MoneyWithBase;
5206
5210
  }
5207
5211
 
@@ -5318,13 +5322,13 @@ declare namespace io.flow.v0.models {
5318
5322
  interface MembershipForm {
5319
5323
  readonly organization: string;
5320
5324
  readonly user: string;
5321
- readonly role: io.flow.v0.enums.Role;
5322
- readonly roles: io.flow.v0.unions.FlowRole[];
5325
+ readonly role?: io.flow.v0.enums.Role;
5326
+ readonly roles?: io.flow.v0.unions.FlowRole[];
5323
5327
  }
5324
5328
 
5325
5329
  interface MembershipPutForm {
5326
- readonly role: io.flow.v0.enums.Role;
5327
- readonly roles: io.flow.v0.unions.FlowRole[];
5330
+ readonly role?: io.flow.v0.enums.Role;
5331
+ readonly roles?: io.flow.v0.unions.FlowRole[];
5328
5332
  }
5329
5333
 
5330
5334
  interface MembershipUpsertedV2 {
@@ -5499,7 +5503,7 @@ declare namespace io.flow.v0.models {
5499
5503
  readonly id: string;
5500
5504
  readonly key: string;
5501
5505
  readonly method?: io.flow.v0.models.PaymentMethod;
5502
- readonly merchant_of_record: io.flow.v0.enums.MerchantOfRecord;
5506
+ readonly merchant_of_record?: io.flow.v0.enums.MerchantOfRecord;
5503
5507
  readonly details?: io.flow.v0.unions.OnlineAuthorizationDetails;
5504
5508
  readonly payment?: any /*object*/;
5505
5509
  readonly amount: number;
@@ -5876,7 +5880,7 @@ declare namespace io.flow.v0.models {
5876
5880
  readonly components: io.flow.v0.models.OrderPriceDetailComponent[];
5877
5881
  readonly name?: string;
5878
5882
  readonly rate?: number;
5879
- readonly accuracy: io.flow.v0.enums.PriceAccuracy;
5883
+ readonly accuracy?: io.flow.v0.enums.PriceAccuracy;
5880
5884
  readonly rate_label?: string;
5881
5885
  }
5882
5886
 
@@ -6394,6 +6398,7 @@ declare namespace io.flow.v0.models {
6394
6398
  readonly name: string;
6395
6399
  readonly images: io.flow.v0.models.PaymentMethodImages;
6396
6400
  readonly regions: string[];
6401
+ readonly capabilities?: io.flow.v0.enums.PaymentMethodCapability[];
6397
6402
  }
6398
6403
 
6399
6404
  interface PaymentMethodImage {
@@ -6464,6 +6469,10 @@ declare namespace io.flow.v0.models {
6464
6469
  interface PaypalAuthorizationDetails {
6465
6470
  readonly discriminator: 'paypal_authorization_details';
6466
6471
  readonly payment_id: string;
6472
+ readonly payment_method?: string;
6473
+ readonly payment_state?: string;
6474
+ readonly payer_email?: string;
6475
+ readonly payer_status?: string;
6467
6476
  }
6468
6477
 
6469
6478
  interface PaypalAuthorizationForm {
@@ -6567,7 +6576,7 @@ declare namespace io.flow.v0.models {
6567
6576
  readonly currency: string;
6568
6577
  readonly name: string;
6569
6578
  readonly includes: io.flow.v0.enums.IncludedLevyKey;
6570
- readonly status: io.flow.v0.enums.PriceBookStatus;
6579
+ readonly status?: io.flow.v0.enums.PriceBookStatus;
6571
6580
  }
6572
6581
 
6573
6582
  interface PriceBookItem {
@@ -7036,12 +7045,12 @@ declare namespace io.flow.v0.models {
7036
7045
  readonly origination_zones: io.flow.v0.models.Zone[];
7037
7046
  readonly service: string;
7038
7047
  readonly number?: string;
7039
- readonly ratecard_owner: io.flow.v0.enums.RatecardOwner;
7048
+ readonly ratecard_owner?: io.flow.v0.enums.RatecardOwner;
7040
7049
  }
7041
7050
 
7042
7051
  interface RatecardLane {
7043
7052
  readonly id: string;
7044
- readonly ratecard: io.flow.v0.models.RatecardReference;
7053
+ readonly ratecard: io.flow.v0.models.RatecardSummary;
7045
7054
  readonly currency: string;
7046
7055
  readonly delivered_duty: io.flow.v0.enums.DeliveredDuty;
7047
7056
  readonly shipment_window: io.flow.v0.models.ShipmentWindow;
@@ -7146,6 +7155,12 @@ declare namespace io.flow.v0.models {
7146
7155
  readonly carrier: io.flow.v0.models.RatecardCarrierSummary;
7147
7156
  }
7148
7157
 
7158
+ interface RatecardSummary {
7159
+ readonly id: string;
7160
+ readonly number: string;
7161
+ readonly ratecard_owner: io.flow.v0.enums.RatecardOwner;
7162
+ }
7163
+
7149
7164
  interface RatecardUpserted {
7150
7165
  readonly discriminator: 'ratecard_upserted';
7151
7166
  readonly event_id: string;
@@ -7202,7 +7217,7 @@ declare namespace io.flow.v0.models {
7202
7217
  readonly captures: io.flow.v0.models.RefundCaptureSummary[];
7203
7218
  readonly created_at: string;
7204
7219
  readonly attributes?: Record<string, string>;
7205
- readonly status: io.flow.v0.enums.RefundStatus;
7220
+ readonly status?: io.flow.v0.enums.RefundStatus;
7206
7221
  readonly base?: io.flow.v0.models.Money;
7207
7222
  }
7208
7223
 
@@ -7213,7 +7228,7 @@ declare namespace io.flow.v0.models {
7213
7228
  readonly amount: number;
7214
7229
  readonly currency: string;
7215
7230
  readonly base: io.flow.v0.models.Money;
7216
- readonly status: io.flow.v0.enums.RefundStatus;
7231
+ readonly status?: io.flow.v0.enums.RefundStatus;
7217
7232
  }
7218
7233
 
7219
7234
  interface RefundCaptureSummary {
@@ -8379,6 +8394,79 @@ declare namespace io.flow.v0.models {
8379
8394
  readonly available: io.flow.v0.models.SurchargeResponsiblePartyDisplay[];
8380
8395
  }
8381
8396
 
8397
+ interface SyncDuration {
8398
+ readonly unit: io.flow.v0.enums.SyncUnitOfTime;
8399
+ readonly value: number;
8400
+ }
8401
+
8402
+ interface SyncPendingRecord {
8403
+ readonly id: string;
8404
+ readonly stream: io.flow.v0.models.SyncStreamReference;
8405
+ readonly value: string;
8406
+ readonly system: string;
8407
+ }
8408
+
8409
+ interface SyncRecord {
8410
+ readonly id: string;
8411
+ readonly system: string;
8412
+ readonly value: string;
8413
+ readonly stream: io.flow.v0.models.SyncStreamReference;
8414
+ }
8415
+
8416
+ interface SyncRecordFailure {
8417
+ readonly id: string;
8418
+ readonly stream: io.flow.v0.models.SyncStreamReference;
8419
+ readonly value: string;
8420
+ readonly system: string;
8421
+ readonly reason: io.flow.v0.enums.SyncRecordFailureReason;
8422
+ readonly attributes?: Record<string, string>;
8423
+ }
8424
+
8425
+ interface SyncRecordFailureForm {
8426
+ readonly stream_key: string;
8427
+ readonly value: string;
8428
+ readonly system: string;
8429
+ readonly reason: io.flow.v0.enums.SyncRecordFailureReason;
8430
+ readonly attributes?: Record<string, string>;
8431
+ }
8432
+
8433
+ interface SyncRecordForm {
8434
+ readonly stream_key: string;
8435
+ readonly system: string;
8436
+ readonly value: string;
8437
+ }
8438
+
8439
+ interface SyncStream {
8440
+ readonly id: string;
8441
+ readonly key: string;
8442
+ readonly type: io.flow.v0.enums.SyncStreamType;
8443
+ readonly systems: string[];
8444
+ readonly settings: io.flow.v0.models.SyncStreamSettings;
8445
+ }
8446
+
8447
+ interface SyncStreamForm {
8448
+ readonly type: io.flow.v0.enums.SyncStreamType;
8449
+ readonly systems: string[];
8450
+ readonly settings?: io.flow.v0.models.SyncStreamSettingsForm;
8451
+ }
8452
+
8453
+ interface SyncStreamReference {
8454
+ readonly id: string;
8455
+ readonly key: string;
8456
+ }
8457
+
8458
+ interface SyncStreamSettings {
8459
+ readonly pending_record_after: io.flow.v0.models.SyncDuration;
8460
+ readonly warn_after: io.flow.v0.models.SyncDuration;
8461
+ readonly error_after: io.flow.v0.models.SyncDuration;
8462
+ }
8463
+
8464
+ interface SyncStreamSettingsForm {
8465
+ readonly pending_record_after: io.flow.v0.models.SyncDuration;
8466
+ readonly warn_after: io.flow.v0.models.SyncDuration;
8467
+ readonly error_after: io.flow.v0.models.SyncDuration;
8468
+ }
8469
+
8382
8470
  interface Tax {
8383
8471
  readonly name: string;
8384
8472
  readonly rate: number;
@@ -9139,7 +9227,6 @@ declare namespace io.flow.v0.unions {
9139
9227
  | io.flow.v0.models.HarmonizationHs6ExportType
9140
9228
  | io.flow.v0.models.HarmonizationHs10ExportType
9141
9229
  | io.flow.v0.models.UnharmonizedItemExportType
9142
- | io.flow.v0.models.HarmonizationLandedCostExportType
9143
9230
  | io.flow.v0.models.OrderExportType
9144
9231
  | io.flow.v0.models.PriceBookItemExportType
9145
9232
  | io.flow.v0.models.SolidusProductExportType
@@ -9753,7 +9840,6 @@ export type GooglePayAuthorizationPayload = io.flow.v0.models.GooglePayAuthoriza
9753
9840
  export type HarmonizationDocument = io.flow.v0.models.HarmonizationDocument;
9754
9841
  export type HarmonizationHs10ExportType = io.flow.v0.models.HarmonizationHs10ExportType;
9755
9842
  export type HarmonizationHs6ExportType = io.flow.v0.models.HarmonizationHs6ExportType;
9756
- export type HarmonizationLandedCostExportType = io.flow.v0.models.HarmonizationLandedCostExportType;
9757
9843
  export type HarmonizationOverviewExportType = io.flow.v0.models.HarmonizationOverviewExportType;
9758
9844
  export type HarmonizedCategory = io.flow.v0.models.HarmonizedCategory;
9759
9845
  export type HarmonizedCategoryReference = io.flow.v0.models.HarmonizedCategoryReference;
@@ -10074,6 +10160,7 @@ export type PaymentError = io.flow.v0.models.PaymentError;
10074
10160
  export type PaymentErrorCode = io.flow.v0.enums.PaymentErrorCode;
10075
10161
  export type PaymentForm = io.flow.v0.unions.PaymentForm;
10076
10162
  export type PaymentMethod = io.flow.v0.models.PaymentMethod;
10163
+ export type PaymentMethodCapability = io.flow.v0.enums.PaymentMethodCapability;
10077
10164
  export type PaymentMethodImage = io.flow.v0.models.PaymentMethodImage;
10078
10165
  export type PaymentMethodImages = io.flow.v0.models.PaymentMethodImages;
10079
10166
  export type PaymentMethodIssuer = io.flow.v0.models.PaymentMethodIssuer;
@@ -10201,6 +10288,7 @@ export type RatecardRateVersion = io.flow.v0.models.RatecardRateVersion;
10201
10288
  export type RatecardReference = io.flow.v0.models.RatecardReference;
10202
10289
  export type RatecardRegionReference = io.flow.v0.models.RatecardRegionReference;
10203
10290
  export type RatecardServiceSummary = io.flow.v0.models.RatecardServiceSummary;
10291
+ export type RatecardSummary = io.flow.v0.models.RatecardSummary;
10204
10292
  export type RatecardUpserted = io.flow.v0.models.RatecardUpserted;
10205
10293
  export type RatecardVersion = io.flow.v0.models.RatecardVersion;
10206
10294
  export type ReadyToFulfill = io.flow.v0.models.ReadyToFulfill;
@@ -10403,6 +10491,20 @@ export type SurchargeResponsibleParty = io.flow.v0.enums.SurchargeResponsiblePar
10403
10491
  export type SurchargeResponsiblePartyDisplay = io.flow.v0.models.SurchargeResponsiblePartyDisplay;
10404
10492
  export type SurchargeSetting = io.flow.v0.models.SurchargeSetting;
10405
10493
  export type SurchargeSettingDisplay = io.flow.v0.models.SurchargeSettingDisplay;
10494
+ export type SyncDuration = io.flow.v0.models.SyncDuration;
10495
+ export type SyncPendingRecord = io.flow.v0.models.SyncPendingRecord;
10496
+ export type SyncRecord = io.flow.v0.models.SyncRecord;
10497
+ export type SyncRecordFailure = io.flow.v0.models.SyncRecordFailure;
10498
+ export type SyncRecordFailureForm = io.flow.v0.models.SyncRecordFailureForm;
10499
+ export type SyncRecordFailureReason = io.flow.v0.enums.SyncRecordFailureReason;
10500
+ export type SyncRecordForm = io.flow.v0.models.SyncRecordForm;
10501
+ export type SyncStream = io.flow.v0.models.SyncStream;
10502
+ export type SyncStreamForm = io.flow.v0.models.SyncStreamForm;
10503
+ export type SyncStreamReference = io.flow.v0.models.SyncStreamReference;
10504
+ export type SyncStreamSettings = io.flow.v0.models.SyncStreamSettings;
10505
+ export type SyncStreamSettingsForm = io.flow.v0.models.SyncStreamSettingsForm;
10506
+ export type SyncStreamType = io.flow.v0.enums.SyncStreamType;
10507
+ export type SyncUnitOfTime = io.flow.v0.enums.SyncUnitOfTime;
10406
10508
  export type Tax = io.flow.v0.models.Tax;
10407
10509
  export type TaxApplicability = io.flow.v0.enums.TaxApplicability;
10408
10510
  export type TaxRegistration = io.flow.v0.models.TaxRegistration;