@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/dist/api.d.ts CHANGED
@@ -908,6 +908,7 @@ declare namespace io.flow.v0.enums {
908
908
  type OrderStorage = 'do_not_persist' | 'persist';
909
909
  type OrganizationPaymentMethodTag = 'deny';
910
910
  type PaymentErrorCode = 'duplicate' | 'invalid_amount' | 'invalid_currency' | 'invalid_method' | 'invalid_order' | 'invalid_customer' | 'invalid_destination' | 'unknown';
911
+ type PaymentMethodCapability = 'credit' | 'debit';
911
912
  type PaymentMethodRuleContentKey = 'description';
912
913
  type PaymentMethodType = 'card' | 'online' | 'offline';
913
914
  type PaymentSourceConfirmationActionType = 'cvv' | 'billing_address' | 'number';
@@ -943,6 +944,9 @@ declare namespace io.flow.v0.enums {
943
944
  type Strategy = 'range' | 'from' | 'to';
944
945
  type SubcatalogItemStatus = 'excluded' | 'included' | 'restricted';
945
946
  type SurchargeResponsibleParty = 'organization' | 'customer';
947
+ type SyncRecordFailureReason = 'inventory' | 'address' | 'promotion' | 'other';
948
+ type SyncStreamType = 'submitted_order';
949
+ type SyncUnitOfTime = 'day' | 'hour' | 'minute' | 'second';
946
950
  type TaxApplicability = 'none' | 'all';
947
951
  type TaxVerificationResult = 'valid' | 'invalid' | 'unable_to_validate';
948
952
  type TaxabilityType = 'tax_rule';
@@ -1501,7 +1505,7 @@ declare namespace io.flow.v0.models {
1501
1505
  readonly requested?: io.flow.v0.models.Money;
1502
1506
  readonly created_at: string;
1503
1507
  readonly attributes?: Record<string, string>;
1504
- readonly status: io.flow.v0.enums.CaptureStatus;
1508
+ readonly status?: io.flow.v0.enums.CaptureStatus;
1505
1509
  readonly base?: io.flow.v0.models.Money;
1506
1510
  }
1507
1511
  interface CaptureDeleted {
@@ -1578,7 +1582,7 @@ declare namespace io.flow.v0.models {
1578
1582
  readonly discriminator: 'card_authorization';
1579
1583
  readonly id: string;
1580
1584
  readonly key: string;
1581
- readonly merchant_of_record: io.flow.v0.enums.MerchantOfRecord;
1585
+ readonly merchant_of_record?: io.flow.v0.enums.MerchantOfRecord;
1582
1586
  readonly method?: io.flow.v0.models.PaymentMethod;
1583
1587
  readonly card: io.flow.v0.unions.ExpandableCard;
1584
1588
  readonly amount: number;
@@ -3089,6 +3093,7 @@ declare namespace io.flow.v0.models {
3089
3093
  readonly status: io.flow.v0.enums.SubcatalogItemStatus;
3090
3094
  }
3091
3095
  interface FraudEmailRule {
3096
+ readonly id?: string;
3092
3097
  readonly email: string;
3093
3098
  readonly decision: io.flow.v0.enums.FraudEmailRuleDecision;
3094
3099
  }
@@ -3266,10 +3271,6 @@ declare namespace io.flow.v0.models {
3266
3271
  readonly has_codes?: boolean;
3267
3272
  readonly sort?: string;
3268
3273
  }
3269
- interface HarmonizationLandedCostExportType {
3270
- readonly discriminator: 'harmonization_landed_cost_export_type';
3271
- readonly items: io.flow.v0.models.LandedCostItem[];
3272
- }
3273
3274
  interface HarmonizationOverviewExportType {
3274
3275
  readonly discriminator: 'harmonization_overview_export_type';
3275
3276
  readonly origin?: string;
@@ -3620,7 +3621,7 @@ declare namespace io.flow.v0.models {
3620
3621
  readonly organization: string;
3621
3622
  readonly email: string;
3622
3623
  readonly name?: io.flow.v0.models.Name;
3623
- readonly role: io.flow.v0.enums.Role;
3624
+ readonly role?: io.flow.v0.enums.Role;
3624
3625
  readonly roles?: io.flow.v0.unions.FlowRole[];
3625
3626
  }
3626
3627
  interface InvitationVersion {
@@ -4048,7 +4049,7 @@ declare namespace io.flow.v0.models {
4048
4049
  readonly base: io.flow.v0.models.Price;
4049
4050
  readonly name: string;
4050
4051
  readonly adjustment?: io.flow.v0.models.LocalizedAdjustment;
4051
- readonly accuracy: io.flow.v0.enums.PriceAccuracy;
4052
+ readonly accuracy?: io.flow.v0.enums.PriceAccuracy;
4052
4053
  readonly basis?: io.flow.v0.models.MoneyWithBase;
4053
4054
  }
4054
4055
  interface LocalizedLineItem {
@@ -4149,12 +4150,12 @@ declare namespace io.flow.v0.models {
4149
4150
  interface MembershipForm {
4150
4151
  readonly organization: string;
4151
4152
  readonly user: string;
4152
- readonly role: io.flow.v0.enums.Role;
4153
- readonly roles: io.flow.v0.unions.FlowRole[];
4153
+ readonly role?: io.flow.v0.enums.Role;
4154
+ readonly roles?: io.flow.v0.unions.FlowRole[];
4154
4155
  }
4155
4156
  interface MembershipPutForm {
4156
- readonly role: io.flow.v0.enums.Role;
4157
- readonly roles: io.flow.v0.unions.FlowRole[];
4157
+ readonly role?: io.flow.v0.enums.Role;
4158
+ readonly roles?: io.flow.v0.unions.FlowRole[];
4158
4159
  }
4159
4160
  interface MembershipUpsertedV2 {
4160
4161
  readonly discriminator: 'membership_upserted_v2';
@@ -4305,7 +4306,7 @@ declare namespace io.flow.v0.models {
4305
4306
  readonly id: string;
4306
4307
  readonly key: string;
4307
4308
  readonly method?: io.flow.v0.models.PaymentMethod;
4308
- readonly merchant_of_record: io.flow.v0.enums.MerchantOfRecord;
4309
+ readonly merchant_of_record?: io.flow.v0.enums.MerchantOfRecord;
4309
4310
  readonly details?: io.flow.v0.unions.OnlineAuthorizationDetails;
4310
4311
  readonly payment?: any;
4311
4312
  readonly amount: number;
@@ -4635,7 +4636,7 @@ declare namespace io.flow.v0.models {
4635
4636
  readonly components: io.flow.v0.models.OrderPriceDetailComponent[];
4636
4637
  readonly name?: string;
4637
4638
  readonly rate?: number;
4638
- readonly accuracy: io.flow.v0.enums.PriceAccuracy;
4639
+ readonly accuracy?: io.flow.v0.enums.PriceAccuracy;
4639
4640
  readonly rate_label?: string;
4640
4641
  }
4641
4642
  interface OrderPriceDetailComponent {
@@ -5083,6 +5084,7 @@ declare namespace io.flow.v0.models {
5083
5084
  readonly name: string;
5084
5085
  readonly images: io.flow.v0.models.PaymentMethodImages;
5085
5086
  readonly regions: string[];
5087
+ readonly capabilities?: io.flow.v0.enums.PaymentMethodCapability[];
5086
5088
  }
5087
5089
  interface PaymentMethodImage {
5088
5090
  readonly url: string;
@@ -5142,6 +5144,10 @@ declare namespace io.flow.v0.models {
5142
5144
  interface PaypalAuthorizationDetails {
5143
5145
  readonly discriminator: 'paypal_authorization_details';
5144
5146
  readonly payment_id: string;
5147
+ readonly payment_method?: string;
5148
+ readonly payment_state?: string;
5149
+ readonly payer_email?: string;
5150
+ readonly payer_status?: string;
5145
5151
  }
5146
5152
  interface PaypalAuthorizationForm {
5147
5153
  readonly discriminator: 'paypal_authorization_form';
@@ -5227,7 +5233,7 @@ declare namespace io.flow.v0.models {
5227
5233
  readonly currency: string;
5228
5234
  readonly name: string;
5229
5235
  readonly includes: io.flow.v0.enums.IncludedLevyKey;
5230
- readonly status: io.flow.v0.enums.PriceBookStatus;
5236
+ readonly status?: io.flow.v0.enums.PriceBookStatus;
5231
5237
  }
5232
5238
  interface PriceBookItem {
5233
5239
  readonly id: string;
@@ -5635,11 +5641,11 @@ declare namespace io.flow.v0.models {
5635
5641
  readonly origination_zones: io.flow.v0.models.Zone[];
5636
5642
  readonly service: string;
5637
5643
  readonly number?: string;
5638
- readonly ratecard_owner: io.flow.v0.enums.RatecardOwner;
5644
+ readonly ratecard_owner?: io.flow.v0.enums.RatecardOwner;
5639
5645
  }
5640
5646
  interface RatecardLane {
5641
5647
  readonly id: string;
5642
- readonly ratecard: io.flow.v0.models.RatecardReference;
5648
+ readonly ratecard: io.flow.v0.models.RatecardSummary;
5643
5649
  readonly currency: string;
5644
5650
  readonly delivered_duty: io.flow.v0.enums.DeliveredDuty;
5645
5651
  readonly shipment_window: io.flow.v0.models.ShipmentWindow;
@@ -5731,6 +5737,11 @@ declare namespace io.flow.v0.models {
5731
5737
  readonly name: string;
5732
5738
  readonly carrier: io.flow.v0.models.RatecardCarrierSummary;
5733
5739
  }
5740
+ interface RatecardSummary {
5741
+ readonly id: string;
5742
+ readonly number: string;
5743
+ readonly ratecard_owner: io.flow.v0.enums.RatecardOwner;
5744
+ }
5734
5745
  interface RatecardUpserted {
5735
5746
  readonly discriminator: 'ratecard_upserted';
5736
5747
  readonly event_id: string;
@@ -5782,7 +5793,7 @@ declare namespace io.flow.v0.models {
5782
5793
  readonly captures: io.flow.v0.models.RefundCaptureSummary[];
5783
5794
  readonly created_at: string;
5784
5795
  readonly attributes?: Record<string, string>;
5785
- readonly status: io.flow.v0.enums.RefundStatus;
5796
+ readonly status?: io.flow.v0.enums.RefundStatus;
5786
5797
  readonly base?: io.flow.v0.models.Money;
5787
5798
  }
5788
5799
  interface RefundCapture {
@@ -5792,7 +5803,7 @@ declare namespace io.flow.v0.models {
5792
5803
  readonly amount: number;
5793
5804
  readonly currency: string;
5794
5805
  readonly base: io.flow.v0.models.Money;
5795
- readonly status: io.flow.v0.enums.RefundStatus;
5806
+ readonly status?: io.flow.v0.enums.RefundStatus;
5796
5807
  }
5797
5808
  interface RefundCaptureSummary {
5798
5809
  readonly capture: io.flow.v0.models.Capture;
@@ -6790,6 +6801,68 @@ declare namespace io.flow.v0.models {
6790
6801
  readonly key: io.flow.v0.enums.DeliveryOptionCostDetailComponentKey;
6791
6802
  readonly available: io.flow.v0.models.SurchargeResponsiblePartyDisplay[];
6792
6803
  }
6804
+ interface SyncDuration {
6805
+ readonly unit: io.flow.v0.enums.SyncUnitOfTime;
6806
+ readonly value: number;
6807
+ }
6808
+ interface SyncPendingRecord {
6809
+ readonly id: string;
6810
+ readonly stream: io.flow.v0.models.SyncStreamReference;
6811
+ readonly value: string;
6812
+ readonly system: string;
6813
+ }
6814
+ interface SyncRecord {
6815
+ readonly id: string;
6816
+ readonly system: string;
6817
+ readonly value: string;
6818
+ readonly stream: io.flow.v0.models.SyncStreamReference;
6819
+ }
6820
+ interface SyncRecordFailure {
6821
+ readonly id: string;
6822
+ readonly stream: io.flow.v0.models.SyncStreamReference;
6823
+ readonly value: string;
6824
+ readonly system: string;
6825
+ readonly reason: io.flow.v0.enums.SyncRecordFailureReason;
6826
+ readonly attributes?: Record<string, string>;
6827
+ }
6828
+ interface SyncRecordFailureForm {
6829
+ readonly stream_key: string;
6830
+ readonly value: string;
6831
+ readonly system: string;
6832
+ readonly reason: io.flow.v0.enums.SyncRecordFailureReason;
6833
+ readonly attributes?: Record<string, string>;
6834
+ }
6835
+ interface SyncRecordForm {
6836
+ readonly stream_key: string;
6837
+ readonly system: string;
6838
+ readonly value: string;
6839
+ }
6840
+ interface SyncStream {
6841
+ readonly id: string;
6842
+ readonly key: string;
6843
+ readonly type: io.flow.v0.enums.SyncStreamType;
6844
+ readonly systems: string[];
6845
+ readonly settings: io.flow.v0.models.SyncStreamSettings;
6846
+ }
6847
+ interface SyncStreamForm {
6848
+ readonly type: io.flow.v0.enums.SyncStreamType;
6849
+ readonly systems: string[];
6850
+ readonly settings?: io.flow.v0.models.SyncStreamSettingsForm;
6851
+ }
6852
+ interface SyncStreamReference {
6853
+ readonly id: string;
6854
+ readonly key: string;
6855
+ }
6856
+ interface SyncStreamSettings {
6857
+ readonly pending_record_after: io.flow.v0.models.SyncDuration;
6858
+ readonly warn_after: io.flow.v0.models.SyncDuration;
6859
+ readonly error_after: io.flow.v0.models.SyncDuration;
6860
+ }
6861
+ interface SyncStreamSettingsForm {
6862
+ readonly pending_record_after: io.flow.v0.models.SyncDuration;
6863
+ readonly warn_after: io.flow.v0.models.SyncDuration;
6864
+ readonly error_after: io.flow.v0.models.SyncDuration;
6865
+ }
6793
6866
  interface Tax {
6794
6867
  readonly name: string;
6795
6868
  readonly rate: number;
@@ -7254,7 +7327,7 @@ declare namespace io.flow.v0.unions {
7254
7327
  type ExpandableSubcatalog = io.flow.v0.models.Subcatalog | io.flow.v0.models.SubcatalogReference;
7255
7328
  type ExpandableUser = io.flow.v0.models.User | io.flow.v0.models.UserReference;
7256
7329
  type ExportDelivery = io.flow.v0.models.ExportDeliveryEmail;
7257
- type ExportType = io.flow.v0.models.AccountTransactionsExportType | io.flow.v0.models.AccountOrdersExportType | io.flow.v0.models.AnalyticsExportType | io.flow.v0.models.CatalogItemExportType | io.flow.v0.models.ExperienceExportType | io.flow.v0.models.HarmonizationOverviewExportType | io.flow.v0.models.HarmonizationHs6ExportType | io.flow.v0.models.HarmonizationHs10ExportType | io.flow.v0.models.UnharmonizedItemExportType | io.flow.v0.models.HarmonizationLandedCostExportType | io.flow.v0.models.OrderExportType | io.flow.v0.models.PriceBookItemExportType | io.flow.v0.models.SolidusProductExportType | io.flow.v0.models.SolidusVariantExportType | io.flow.v0.models.LocalizedItemPricesExportType | io.flow.v0.models.MarketingFeedsExportType;
7330
+ type ExportType = io.flow.v0.models.AccountTransactionsExportType | io.flow.v0.models.AccountOrdersExportType | io.flow.v0.models.AnalyticsExportType | io.flow.v0.models.CatalogItemExportType | io.flow.v0.models.ExperienceExportType | io.flow.v0.models.HarmonizationOverviewExportType | io.flow.v0.models.HarmonizationHs6ExportType | io.flow.v0.models.HarmonizationHs10ExportType | io.flow.v0.models.UnharmonizedItemExportType | io.flow.v0.models.OrderExportType | io.flow.v0.models.PriceBookItemExportType | io.flow.v0.models.SolidusProductExportType | io.flow.v0.models.SolidusVariantExportType | io.flow.v0.models.LocalizedItemPricesExportType | io.flow.v0.models.MarketingFeedsExportType;
7258
7331
  type FieldValidationRule = io.flow.v0.models.FieldValidationRequired | io.flow.v0.models.FieldValidationMin | io.flow.v0.models.FieldValidationMax | io.flow.v0.models.FieldValidationPattern;
7259
7332
  type FlowRole = {
7260
7333
  discriminator: 'flow_user_role';
@@ -7780,7 +7853,6 @@ export declare type GooglePayAuthorizationPayload = io.flow.v0.models.GooglePayA
7780
7853
  export declare type HarmonizationDocument = io.flow.v0.models.HarmonizationDocument;
7781
7854
  export declare type HarmonizationHs10ExportType = io.flow.v0.models.HarmonizationHs10ExportType;
7782
7855
  export declare type HarmonizationHs6ExportType = io.flow.v0.models.HarmonizationHs6ExportType;
7783
- export declare type HarmonizationLandedCostExportType = io.flow.v0.models.HarmonizationLandedCostExportType;
7784
7856
  export declare type HarmonizationOverviewExportType = io.flow.v0.models.HarmonizationOverviewExportType;
7785
7857
  export declare type HarmonizedCategory = io.flow.v0.models.HarmonizedCategory;
7786
7858
  export declare type HarmonizedCategoryReference = io.flow.v0.models.HarmonizedCategoryReference;
@@ -8101,6 +8173,7 @@ export declare type PaymentError = io.flow.v0.models.PaymentError;
8101
8173
  export declare type PaymentErrorCode = io.flow.v0.enums.PaymentErrorCode;
8102
8174
  export declare type PaymentForm = io.flow.v0.unions.PaymentForm;
8103
8175
  export declare type PaymentMethod = io.flow.v0.models.PaymentMethod;
8176
+ export declare type PaymentMethodCapability = io.flow.v0.enums.PaymentMethodCapability;
8104
8177
  export declare type PaymentMethodImage = io.flow.v0.models.PaymentMethodImage;
8105
8178
  export declare type PaymentMethodImages = io.flow.v0.models.PaymentMethodImages;
8106
8179
  export declare type PaymentMethodIssuer = io.flow.v0.models.PaymentMethodIssuer;
@@ -8228,6 +8301,7 @@ export declare type RatecardRateVersion = io.flow.v0.models.RatecardRateVersion;
8228
8301
  export declare type RatecardReference = io.flow.v0.models.RatecardReference;
8229
8302
  export declare type RatecardRegionReference = io.flow.v0.models.RatecardRegionReference;
8230
8303
  export declare type RatecardServiceSummary = io.flow.v0.models.RatecardServiceSummary;
8304
+ export declare type RatecardSummary = io.flow.v0.models.RatecardSummary;
8231
8305
  export declare type RatecardUpserted = io.flow.v0.models.RatecardUpserted;
8232
8306
  export declare type RatecardVersion = io.flow.v0.models.RatecardVersion;
8233
8307
  export declare type ReadyToFulfill = io.flow.v0.models.ReadyToFulfill;
@@ -8430,6 +8504,20 @@ export declare type SurchargeResponsibleParty = io.flow.v0.enums.SurchargeRespon
8430
8504
  export declare type SurchargeResponsiblePartyDisplay = io.flow.v0.models.SurchargeResponsiblePartyDisplay;
8431
8505
  export declare type SurchargeSetting = io.flow.v0.models.SurchargeSetting;
8432
8506
  export declare type SurchargeSettingDisplay = io.flow.v0.models.SurchargeSettingDisplay;
8507
+ export declare type SyncDuration = io.flow.v0.models.SyncDuration;
8508
+ export declare type SyncPendingRecord = io.flow.v0.models.SyncPendingRecord;
8509
+ export declare type SyncRecord = io.flow.v0.models.SyncRecord;
8510
+ export declare type SyncRecordFailure = io.flow.v0.models.SyncRecordFailure;
8511
+ export declare type SyncRecordFailureForm = io.flow.v0.models.SyncRecordFailureForm;
8512
+ export declare type SyncRecordFailureReason = io.flow.v0.enums.SyncRecordFailureReason;
8513
+ export declare type SyncRecordForm = io.flow.v0.models.SyncRecordForm;
8514
+ export declare type SyncStream = io.flow.v0.models.SyncStream;
8515
+ export declare type SyncStreamForm = io.flow.v0.models.SyncStreamForm;
8516
+ export declare type SyncStreamReference = io.flow.v0.models.SyncStreamReference;
8517
+ export declare type SyncStreamSettings = io.flow.v0.models.SyncStreamSettings;
8518
+ export declare type SyncStreamSettingsForm = io.flow.v0.models.SyncStreamSettingsForm;
8519
+ export declare type SyncStreamType = io.flow.v0.enums.SyncStreamType;
8520
+ export declare type SyncUnitOfTime = io.flow.v0.enums.SyncUnitOfTime;
8433
8521
  export declare type Tax = io.flow.v0.models.Tax;
8434
8522
  export declare type TaxApplicability = io.flow.v0.enums.TaxApplicability;
8435
8523
  export declare type TaxRegistration = io.flow.v0.models.TaxRegistration;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flowio/types",
3
- "version": "9.2.2",
3
+ "version": "9.3.0",
4
4
  "description": "TypeScript type definitions for custom types found in Flow API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -27,5 +27,5 @@
27
27
  "prettier": "^1.18.2",
28
28
  "typescript": "3.8.3"
29
29
  },
30
- "gitHead": "925a464981fba3fe811eb1cb2213e684e463d017"
30
+ "gitHead": "a0a2d66a561a1ebb27d0bc3a80ee1928112efc6b"
31
31
  }