@flowio/types 0.0.1 → 0.0.3

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
@@ -505,7 +505,7 @@ namespace io.flow.shopify.external.v0.models {
505
505
  readonly product_title: string;
506
506
  readonly product_description?: string;
507
507
  readonly product_type: string;
508
- readonly variant_title: string;
508
+ readonly variant_title?: string;
509
509
  readonly variant_options?: string[];
510
510
  readonly line_level_discount_allocations?: io.flow.shopify.external.v0.models.ShopifyLineLevelDiscountAllocation[];
511
511
  }
@@ -1329,10 +1329,6 @@ namespace io.flow.v0.enums {
1329
1329
  export type ExportStatus = 'created' | 'processing' | 'completed' | 'failed';
1330
1330
  export type FlowAddonRole = 'consumer_data_viewer' | 'membership_manager';
1331
1331
  export type FlowBehavior = 'view_consumer_data';
1332
- export type FlowFieldName =
1333
- | 'item-number'
1334
- | 'sku-attribute'
1335
- | 'product_id-attribute';
1336
1332
  export type FlowUserRole =
1337
1333
  | 'organization_admin'
1338
1334
  | 'organization_merchant'
@@ -1355,17 +1351,16 @@ namespace io.flow.v0.enums {
1355
1351
  export type HolidayCalendar = 'us_bank_holidays' | 'jewish_holidays';
1356
1352
  export type ImageTag = 'thumbnail' | 'checkout';
1357
1353
  export type ImportType =
1358
- | 'harmonization_codes'
1359
1354
  | 'catalog_items'
1360
- | 'price_book_items'
1361
- | 'price_book_items_query'
1362
1355
  | 'customs_descriptions'
1363
1356
  | 'customs_description_tariffs'
1357
+ | 'experiences_with_settings'
1358
+ | 'harmonization_codes'
1364
1359
  | 'item_form_overlays'
1365
- | 'experiences_with_settings';
1360
+ | 'price_book_items'
1361
+ | 'price_book_items_query'
1362
+ | 'ratecard_lanes';
1366
1363
  export type IncludedLevyKey = 'duty' | 'vat' | 'vat_and_duty' | 'none';
1367
- export type IncomingFeedFormat = 'google-xml' | 'google-sheet';
1368
- export type IncomingFieldName = 'id' | 'mpn';
1369
1364
  export type Incoterm =
1370
1365
  | 'EXW'
1371
1366
  | 'FCA'
@@ -1468,11 +1463,6 @@ namespace io.flow.v0.enums {
1468
1463
  | 'surcharges';
1469
1464
  export type OrderStatus = 'open' | 'submitted';
1470
1465
  export type OrganizationPaymentMethodTag = 'deny';
1471
- export type OutgoingFeedFormat =
1472
- | 'facebook-xml'
1473
- | 'google-tsv'
1474
- | 'google-xml'
1475
- | 'criteo-xml';
1476
1466
  export type PaymentErrorCode =
1477
1467
  | 'duplicate'
1478
1468
  | 'invalid_amount'
@@ -2564,27 +2554,6 @@ namespace io.flow.v0.models {
2564
2554
  readonly catalog: string;
2565
2555
  }
2566
2556
 
2567
- export interface CatalogFeed {
2568
- readonly id: string;
2569
- readonly experience_feed_summaries: io.flow.v0.models.ExperienceFeedSummary[];
2570
- readonly incoming_feed: io.flow.v0.models.IncomingFeed;
2571
- readonly outgoing_feed: io.flow.v0.models.OutgoingFeed;
2572
- readonly feed_statistics_summary: io.flow.v0.models.FeedStatisticsSummary;
2573
- }
2574
-
2575
- export interface CatalogFeedFormPost {
2576
- readonly experience_keys: string[];
2577
- readonly incoming_feed: io.flow.v0.models.IncomingFeed;
2578
- readonly outgoing_feed_form: io.flow.v0.models.OutgoingFeed;
2579
- }
2580
-
2581
- export interface CatalogFeedFormPut {
2582
- readonly id: string;
2583
- readonly experience_keys: string[];
2584
- readonly incoming_feed: io.flow.v0.models.IncomingFeed;
2585
- readonly outgoing_feed_form: io.flow.v0.models.OutgoingFeed;
2586
- }
2587
-
2588
2557
  export interface CatalogItemDeleted {
2589
2558
  readonly event_id: string;
2590
2559
  readonly timestamp: string;
@@ -2817,12 +2786,12 @@ namespace io.flow.v0.models {
2817
2786
 
2818
2787
  export interface CheckoutTokenOrderForm {
2819
2788
  readonly order_form: io.flow.v0.models.OrderForm;
2820
- readonly urls: io.flow.v0.models.CheckoutUrlsForm;
2821
2789
  readonly customer?: io.flow.v0.models.CustomerForm;
2822
2790
  readonly address_book?: io.flow.v0.models.CustomerAddressBookForm;
2823
2791
  readonly payment_sources?: ({
2824
2792
  discriminator: 'card_payment_source_form';
2825
2793
  } & io.flow.v0.models.CardPaymentSourceForm)[];
2794
+ readonly urls?: io.flow.v0.models.CheckoutUrlsForm;
2826
2795
  }
2827
2796
 
2828
2797
  export interface CheckoutTokenReferenceForm {
@@ -3689,12 +3658,6 @@ namespace io.flow.v0.models {
3689
3658
  readonly keys?: string[];
3690
3659
  }
3691
3660
 
3692
- export interface ExperienceFeedSummary {
3693
- readonly experience: io.flow.v0.models.ExperienceReference;
3694
- readonly url: string;
3695
- readonly last_construct_date?: string;
3696
- }
3697
-
3698
3661
  export interface ExperienceForm {
3699
3662
  readonly region_id: string;
3700
3663
  readonly name: string;
@@ -3990,10 +3953,6 @@ namespace io.flow.v0.models {
3990
3953
  readonly messages: string[];
3991
3954
  }
3992
3955
 
3993
- export interface FeedStatisticsSummary {
3994
- readonly last_incoming_date?: string;
3995
- }
3996
-
3997
3956
  export interface FieldValidationMax {
3998
3957
  readonly length: number;
3999
3958
  }
@@ -4277,6 +4236,25 @@ namespace io.flow.v0.models {
4277
4236
  readonly number: string;
4278
4237
  }
4279
4238
 
4239
+ export interface HarmonizedItemForm {
4240
+ readonly name: string;
4241
+ readonly number: string;
4242
+ readonly categories?: string[];
4243
+ readonly description?: string;
4244
+ readonly attributes?: {
4245
+ [key: string]: string;
4246
+ };
4247
+ }
4248
+
4249
+ export interface HarmonizedItemPutForm {
4250
+ readonly name: string;
4251
+ readonly categories?: string[];
4252
+ readonly description?: string;
4253
+ readonly attributes?: {
4254
+ [key: string]: string;
4255
+ };
4256
+ }
4257
+
4280
4258
  export interface HarmonizedItemReference {
4281
4259
  readonly id: string;
4282
4260
  readonly number: string;
@@ -4496,13 +4474,6 @@ namespace io.flow.v0.models {
4496
4474
  readonly label: string;
4497
4475
  }
4498
4476
 
4499
- export interface IncomingFeed {
4500
- readonly url: string;
4501
- readonly format: io.flow.v0.enums.IncomingFeedFormat;
4502
- readonly minute: number;
4503
- readonly item_link: io.flow.v0.models.ItemLink;
4504
- }
4505
-
4506
4477
  export interface InlineAuthorizationDetails {
4507
4478
  readonly id: string;
4508
4479
  readonly client_token?: string;
@@ -4840,11 +4811,6 @@ namespace io.flow.v0.models {
4840
4811
  readonly images?: io.flow.v0.models.ImageForm[];
4841
4812
  }
4842
4813
 
4843
- export interface ItemLink {
4844
- readonly incoming_field_name: io.flow.v0.enums.IncomingFieldName;
4845
- readonly flow_field_name: io.flow.v0.enums.FlowFieldName;
4846
- }
4847
-
4848
4814
  export interface ItemMargin {
4849
4815
  readonly id: string;
4850
4816
  readonly key: string;
@@ -6233,16 +6199,6 @@ namespace io.flow.v0.models {
6233
6199
  readonly amount: io.flow.v0.models.Money;
6234
6200
  }
6235
6201
 
6236
- export interface OutgoingFeed {
6237
- readonly format: io.flow.v0.enums.OutgoingFeedFormat;
6238
- readonly minute: number;
6239
- }
6240
-
6241
- export interface OutgoingFeedForm {
6242
- readonly format: io.flow.v0.enums.OutgoingFeedFormat;
6243
- readonly minute: number;
6244
- }
6245
-
6246
6202
  export interface OversizedShipmentRatecardFee {
6247
6203
  readonly weight_threshold: number;
6248
6204
  readonly weight_unit: io.flow.v0.enums.UnitOfMeasurement;
@@ -7107,6 +7063,19 @@ namespace io.flow.v0.models {
7107
7063
  readonly distance_unit: io.flow.v0.enums.UnitOfMeasurement;
7108
7064
  }
7109
7065
 
7066
+ export interface RatecardLaneImportForm {
7067
+ readonly service: string;
7068
+ readonly currency: string;
7069
+ readonly delivered_duty: io.flow.v0.enums.DeliveredDuty;
7070
+ readonly origin: io.flow.v0.models.Zone;
7071
+ readonly destination: io.flow.v0.models.Zone;
7072
+ readonly shipment_window: io.flow.v0.models.ShipmentWindow;
7073
+ readonly dim_factor: number;
7074
+ readonly weight_unit: io.flow.v0.enums.UnitOfMeasurement;
7075
+ readonly distance_unit: io.flow.v0.enums.UnitOfMeasurement;
7076
+ readonly rates: io.flow.v0.models.RatecardRateForm[];
7077
+ }
7078
+
7110
7079
  export interface RatecardLaneUpserted {
7111
7080
  readonly event_id: string;
7112
7081
  readonly timestamp: string;
@@ -7121,6 +7090,12 @@ namespace io.flow.v0.models {
7121
7090
  readonly ratecard_lane: io.flow.v0.models.RatecardLane;
7122
7091
  }
7123
7092
 
7093
+ export interface RatecardLanesImportRequestData {
7094
+ readonly id: string;
7095
+ readonly source_url: string;
7096
+ readonly filename?: string;
7097
+ }
7098
+
7124
7099
  export interface RatecardRate {
7125
7100
  readonly id: string;
7126
7101
  readonly amount: number;
@@ -8078,10 +8053,19 @@ namespace io.flow.v0.models {
8078
8053
  };
8079
8054
  }
8080
8055
 
8081
- export interface ShopifyCartFlowRepresentation {
8056
+ export interface ShopifyCartConversion {
8057
+ readonly flow: io.flow.v0.models.ShopifyCartConversionFlowOrder;
8058
+ readonly shopify: io.flow.v0.models.ShopifyCartConversionShopifyCart;
8059
+ }
8060
+
8061
+ export interface ShopifyCartConversionFlowOrder {
8082
8062
  readonly order: io.flow.v0.models.Order;
8083
8063
  }
8084
8064
 
8065
+ export interface ShopifyCartConversionShopifyCart {
8066
+ readonly cart: io.flow.shopify.external.v0.models.ShopifyCart;
8067
+ }
8068
+
8085
8069
  export interface ShopifyCartItem {
8086
8070
  readonly id: string;
8087
8071
  readonly handle: string;
@@ -8108,15 +8092,6 @@ namespace io.flow.v0.models {
8108
8092
  readonly vendor?: string;
8109
8093
  }
8110
8094
 
8111
- export interface ShopifyCartRepresentation {
8112
- readonly flow: io.flow.v0.models.ShopifyCartFlowRepresentation;
8113
- readonly shopify: io.flow.v0.models.ShopifyCartShopifyRepresentation;
8114
- }
8115
-
8116
- export interface ShopifyCartShopifyRepresentation {
8117
- readonly cart: io.flow.shopify.external.v0.models.ShopifyCart;
8118
- }
8119
-
8120
8095
  export interface ShopifyCustomerMetafieldValue {
8121
8096
  readonly flow_consumer_id: string;
8122
8097
  }
@@ -9822,10 +9797,6 @@ namespace io.flow.v0.unions {
9822
9797
  discriminator: 'localized_item_prices_export_type';
9823
9798
  } & io.flow.v0.models.LocalizedItemPricesExportType;
9824
9799
 
9825
- export type Feed = {
9826
- discriminator: 'catalog_feed';
9827
- } & io.flow.v0.models.CatalogFeed;
9828
-
9829
9800
  export type FieldValidationRule =
9830
9801
  | {
9831
9802
  discriminator: 'required';
@@ -10274,9 +10245,6 @@ export type CarrierService = io.flow.v0.models.CarrierService;
10274
10245
  export type CartReference = io.flow.v0.models.CartReference;
10275
10246
  export type Catalog = io.flow.v0.models.Catalog;
10276
10247
  export type CatalogDeleted = io.flow.v0.models.CatalogDeleted;
10277
- export type CatalogFeed = io.flow.v0.models.CatalogFeed;
10278
- export type CatalogFeedFormPost = io.flow.v0.models.CatalogFeedFormPost;
10279
- export type CatalogFeedFormPut = io.flow.v0.models.CatalogFeedFormPut;
10280
10248
  export type CatalogItemDeleted = io.flow.v0.models.CatalogItemDeleted;
10281
10249
  export type CatalogItemDeletedV2 = io.flow.v0.models.CatalogItemDeletedV2;
10282
10250
  export type CatalogItemDocument = io.flow.v0.models.CatalogItemDocument;
@@ -10462,7 +10430,6 @@ export type ExperienceDefaults = io.flow.v0.models.ExperienceDefaults;
10462
10430
  export type ExperienceDeleted = io.flow.v0.models.ExperienceDeleted;
10463
10431
  export type ExperienceDeletedV2 = io.flow.v0.models.ExperienceDeletedV2;
10464
10432
  export type ExperienceExportType = io.flow.v0.models.ExperienceExportType;
10465
- export type ExperienceFeedSummary = io.flow.v0.models.ExperienceFeedSummary;
10466
10433
  export type ExperienceForm = io.flow.v0.models.ExperienceForm;
10467
10434
  export type ExperienceGeo = io.flow.v0.models.ExperienceGeo;
10468
10435
  export type ExperienceLogisticsSettings = io.flow.v0.models.ExperienceLogisticsSettings;
@@ -10499,8 +10466,6 @@ export type ExportStatus = io.flow.v0.enums.ExportStatus;
10499
10466
  export type ExportType = io.flow.v0.unions.ExportType;
10500
10467
  export type ExportVersion = io.flow.v0.models.ExportVersion;
10501
10468
  export type ExternalApiTimeoutReservationError = io.flow.v0.models.ExternalApiTimeoutReservationError;
10502
- export type Feed = io.flow.v0.unions.Feed;
10503
- export type FeedStatisticsSummary = io.flow.v0.models.FeedStatisticsSummary;
10504
10469
  export type FieldValidationMax = io.flow.v0.models.FieldValidationMax;
10505
10470
  export type FieldValidationMin = io.flow.v0.models.FieldValidationMin;
10506
10471
  export type FieldValidationPattern = io.flow.v0.models.FieldValidationPattern;
@@ -10511,7 +10476,6 @@ export type FlatRateForm = io.flow.v0.models.FlatRateForm;
10511
10476
  export type FlowAddonRole = io.flow.v0.enums.FlowAddonRole;
10512
10477
  export type FlowBehavior = io.flow.v0.enums.FlowBehavior;
10513
10478
  export type FlowCenterReference = io.flow.v0.models.FlowCenterReference;
10514
- export type FlowFieldName = io.flow.v0.enums.FlowFieldName;
10515
10479
  export type FlowItemIndexMetadata = io.flow.v0.models.FlowItemIndexMetadata;
10516
10480
  export type FlowRole = io.flow.v0.unions.FlowRole;
10517
10481
  export type FlowUserRole = io.flow.v0.enums.FlowUserRole;
@@ -10564,6 +10528,8 @@ export type HarmonizedCategory = io.flow.v0.models.HarmonizedCategory;
10564
10528
  export type HarmonizedCategoryReference = io.flow.v0.models.HarmonizedCategoryReference;
10565
10529
  export type HarmonizedItem = io.flow.v0.models.HarmonizedItem;
10566
10530
  export type HarmonizedItemDeleted = io.flow.v0.models.HarmonizedItemDeleted;
10531
+ export type HarmonizedItemForm = io.flow.v0.models.HarmonizedItemForm;
10532
+ export type HarmonizedItemPutForm = io.flow.v0.models.HarmonizedItemPutForm;
10567
10533
  export type HarmonizedItemReference = io.flow.v0.models.HarmonizedItemReference;
10568
10534
  export type HarmonizedItemUpserted = io.flow.v0.models.HarmonizedItemUpserted;
10569
10535
  export type HarmonizedLandedCost = io.flow.v0.models.HarmonizedLandedCost;
@@ -10597,9 +10563,6 @@ export type ImportVersion = io.flow.v0.models.ImportVersion;
10597
10563
  export type InboundCartonFee = io.flow.v0.models.InboundCartonFee;
10598
10564
  export type IncludedLevies = io.flow.v0.models.IncludedLevies;
10599
10565
  export type IncludedLevyKey = io.flow.v0.enums.IncludedLevyKey;
10600
- export type IncomingFeed = io.flow.v0.models.IncomingFeed;
10601
- export type IncomingFeedFormat = io.flow.v0.enums.IncomingFeedFormat;
10602
- export type IncomingFieldName = io.flow.v0.enums.IncomingFieldName;
10603
10566
  export type Incoterm = io.flow.v0.enums.Incoterm;
10604
10567
  export type InlineAuthorizationDetails = io.flow.v0.models.InlineAuthorizationDetails;
10605
10568
  export type InlineAuthorizationForm = io.flow.v0.models.InlineAuthorizationForm;
@@ -10650,7 +10613,6 @@ export type ItemAvailabilityStatus = io.flow.v0.enums.ItemAvailabilityStatus;
10650
10613
  export type ItemForm = io.flow.v0.models.ItemForm;
10651
10614
  export type ItemFormOverlay = io.flow.v0.models.ItemFormOverlay;
10652
10615
  export type ItemFormOverlayForm = io.flow.v0.models.ItemFormOverlayForm;
10653
- export type ItemLink = io.flow.v0.models.ItemLink;
10654
10616
  export type ItemMargin = io.flow.v0.models.ItemMargin;
10655
10617
  export type ItemMarginDeleted = io.flow.v0.models.ItemMarginDeleted;
10656
10618
  export type ItemMarginPostForm = io.flow.v0.models.ItemMarginPostForm;
@@ -10838,9 +10800,6 @@ export type OrganizationUpsertedV2 = io.flow.v0.models.OrganizationUpsertedV2;
10838
10800
  export type OrganizationVersion = io.flow.v0.models.OrganizationVersion;
10839
10801
  export type OriginalPrices = io.flow.v0.models.OriginalPrices;
10840
10802
  export type OutboundCartonFee = io.flow.v0.models.OutboundCartonFee;
10841
- export type OutgoingFeed = io.flow.v0.models.OutgoingFeed;
10842
- export type OutgoingFeedForm = io.flow.v0.models.OutgoingFeedForm;
10843
- export type OutgoingFeedFormat = io.flow.v0.enums.OutgoingFeedFormat;
10844
10803
  export type OversizedShipmentRatecardFee = io.flow.v0.models.OversizedShipmentRatecardFee;
10845
10804
  export type Packaging = io.flow.v0.models.Packaging;
10846
10805
  export type PartnerCenter = io.flow.v0.models.PartnerCenter;
@@ -10972,8 +10931,10 @@ export type RatecardForm = io.flow.v0.models.RatecardForm;
10972
10931
  export type RatecardLane = io.flow.v0.models.RatecardLane;
10973
10932
  export type RatecardLaneDeleted = io.flow.v0.models.RatecardLaneDeleted;
10974
10933
  export type RatecardLaneForm = io.flow.v0.models.RatecardLaneForm;
10934
+ export type RatecardLaneImportForm = io.flow.v0.models.RatecardLaneImportForm;
10975
10935
  export type RatecardLaneUpserted = io.flow.v0.models.RatecardLaneUpserted;
10976
10936
  export type RatecardLaneVersion = io.flow.v0.models.RatecardLaneVersion;
10937
+ export type RatecardLanesImportRequestData = io.flow.v0.models.RatecardLanesImportRequestData;
10977
10938
  export type RatecardRate = io.flow.v0.models.RatecardRate;
10978
10939
  export type RatecardRateForm = io.flow.v0.models.RatecardRateForm;
10979
10940
  export type RatecardRateVersion = io.flow.v0.models.RatecardRateVersion;
@@ -11115,10 +11076,10 @@ export type ShopifyCartAddForm = io.flow.v0.unions.ShopifyCartAddForm;
11115
11076
  export type ShopifyCartAddMultipleForm = io.flow.v0.models.ShopifyCartAddMultipleForm;
11116
11077
  export type ShopifyCartAddSingleForm = io.flow.v0.models.ShopifyCartAddSingleForm;
11117
11078
  export type ShopifyCartChangeForm = io.flow.v0.models.ShopifyCartChangeForm;
11118
- export type ShopifyCartFlowRepresentation = io.flow.v0.models.ShopifyCartFlowRepresentation;
11079
+ export type ShopifyCartConversion = io.flow.v0.models.ShopifyCartConversion;
11080
+ export type ShopifyCartConversionFlowOrder = io.flow.v0.models.ShopifyCartConversionFlowOrder;
11081
+ export type ShopifyCartConversionShopifyCart = io.flow.v0.models.ShopifyCartConversionShopifyCart;
11119
11082
  export type ShopifyCartItem = io.flow.v0.models.ShopifyCartItem;
11120
- export type ShopifyCartRepresentation = io.flow.v0.models.ShopifyCartRepresentation;
11121
- export type ShopifyCartShopifyRepresentation = io.flow.v0.models.ShopifyCartShopifyRepresentation;
11122
11083
  export type ShopifyCustomerMetafieldValue = io.flow.v0.models.ShopifyCustomerMetafieldValue;
11123
11084
  export type ShopifyEventBucket = io.flow.v0.unions.ShopifyEventBucket;
11124
11085
  export type ShopifyGrant = io.flow.v0.enums.ShopifyGrant;
package/LICENSE DELETED
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2017 Flow Commerce
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.