@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/dist/api.d.ts CHANGED
@@ -352,7 +352,7 @@ declare namespace io.flow.shopify.external.v0.models {
352
352
  readonly product_title: string;
353
353
  readonly product_description?: string;
354
354
  readonly product_type: string;
355
- readonly variant_title: string;
355
+ readonly variant_title?: string;
356
356
  readonly variant_options?: string[];
357
357
  readonly line_level_discount_allocations?: io.flow.shopify.external.v0.models.ShopifyLineLevelDiscountAllocation[];
358
358
  }
@@ -851,7 +851,6 @@ declare namespace io.flow.v0.enums {
851
851
  type ExportStatus = 'created' | 'processing' | 'completed' | 'failed';
852
852
  type FlowAddonRole = 'consumer_data_viewer' | 'membership_manager';
853
853
  type FlowBehavior = 'view_consumer_data';
854
- type FlowFieldName = 'item-number' | 'sku-attribute' | 'product_id-attribute';
855
854
  type FlowUserRole = 'organization_admin' | 'organization_merchant' | 'organization_operations' | 'organization_fulfillment' | 'organization_marketing' | 'organization_finance' | 'flow_operations';
856
855
  type FraudEmailRuleDecision = 'approved' | 'declined';
857
856
  type FraudLiability = 'flow' | 'organization';
@@ -863,10 +862,8 @@ declare namespace io.flow.v0.enums {
863
862
  type GenericErrorCode = 'generic_error' | 'client_error' | 'server_error';
864
863
  type HolidayCalendar = 'us_bank_holidays' | 'jewish_holidays';
865
864
  type ImageTag = 'thumbnail' | 'checkout';
866
- type ImportType = 'harmonization_codes' | 'catalog_items' | 'price_book_items' | 'price_book_items_query' | 'customs_descriptions' | 'customs_description_tariffs' | 'item_form_overlays' | 'experiences_with_settings';
865
+ type ImportType = 'catalog_items' | 'customs_descriptions' | 'customs_description_tariffs' | 'experiences_with_settings' | 'harmonization_codes' | 'item_form_overlays' | 'price_book_items' | 'price_book_items_query' | 'ratecard_lanes';
867
866
  type IncludedLevyKey = 'duty' | 'vat' | 'vat_and_duty' | 'none';
868
- type IncomingFeedFormat = 'google-xml' | 'google-sheet';
869
- type IncomingFieldName = 'id' | 'mpn';
870
867
  type Incoterm = 'EXW' | 'FCA' | 'CPT' | 'CIP' | 'DAT' | 'DAP' | 'DDP' | 'FAS' | 'FOB' | 'CFR' | 'CIF' | 'DAF' | 'DES' | 'DEQ' | 'DDU';
871
868
  type InputSpecificationType = 'text' | 'number';
872
869
  type InstallmentPlanPaymentErrorCode = 'invalid_authorization' | 'invalid_authorization_amount' | 'invalid_installment_plan';
@@ -889,7 +886,6 @@ declare namespace io.flow.v0.enums {
889
886
  type OrderPriceDetailKey = 'adjustment' | 'subtotal' | 'vat' | 'duty' | 'shipping' | 'insurance' | 'discount' | 'surcharges';
890
887
  type OrderStatus = 'open' | 'submitted';
891
888
  type OrganizationPaymentMethodTag = 'deny';
892
- type OutgoingFeedFormat = 'facebook-xml' | 'google-tsv' | 'google-xml' | 'criteo-xml';
893
889
  type PaymentErrorCode = 'duplicate' | 'invalid_amount' | 'invalid_currency' | 'invalid_method' | 'invalid_order' | 'invalid_customer' | 'invalid_destination' | 'unknown';
894
890
  type PaymentMethodRuleContentKey = 'description';
895
891
  type PaymentMethodType = 'card' | 'online' | 'offline';
@@ -1717,24 +1713,6 @@ declare namespace io.flow.v0.models {
1717
1713
  readonly organization: string;
1718
1714
  readonly catalog: string;
1719
1715
  }
1720
- interface CatalogFeed {
1721
- readonly id: string;
1722
- readonly experience_feed_summaries: io.flow.v0.models.ExperienceFeedSummary[];
1723
- readonly incoming_feed: io.flow.v0.models.IncomingFeed;
1724
- readonly outgoing_feed: io.flow.v0.models.OutgoingFeed;
1725
- readonly feed_statistics_summary: io.flow.v0.models.FeedStatisticsSummary;
1726
- }
1727
- interface CatalogFeedFormPost {
1728
- readonly experience_keys: string[];
1729
- readonly incoming_feed: io.flow.v0.models.IncomingFeed;
1730
- readonly outgoing_feed_form: io.flow.v0.models.OutgoingFeed;
1731
- }
1732
- interface CatalogFeedFormPut {
1733
- readonly id: string;
1734
- readonly experience_keys: string[];
1735
- readonly incoming_feed: io.flow.v0.models.IncomingFeed;
1736
- readonly outgoing_feed_form: io.flow.v0.models.OutgoingFeed;
1737
- }
1738
1716
  interface CatalogItemDeleted {
1739
1717
  readonly event_id: string;
1740
1718
  readonly timestamp: string;
@@ -1936,12 +1914,12 @@ declare namespace io.flow.v0.models {
1936
1914
  }
1937
1915
  interface CheckoutTokenOrderForm {
1938
1916
  readonly order_form: io.flow.v0.models.OrderForm;
1939
- readonly urls: io.flow.v0.models.CheckoutUrlsForm;
1940
1917
  readonly customer?: io.flow.v0.models.CustomerForm;
1941
1918
  readonly address_book?: io.flow.v0.models.CustomerAddressBookForm;
1942
1919
  readonly payment_sources?: ({
1943
1920
  discriminator: 'card_payment_source_form';
1944
1921
  } & io.flow.v0.models.CardPaymentSourceForm)[];
1922
+ readonly urls?: io.flow.v0.models.CheckoutUrlsForm;
1945
1923
  }
1946
1924
  interface CheckoutTokenReferenceForm {
1947
1925
  readonly order_number: string;
@@ -2675,11 +2653,6 @@ declare namespace io.flow.v0.models {
2675
2653
  readonly ids?: string[];
2676
2654
  readonly keys?: string[];
2677
2655
  }
2678
- interface ExperienceFeedSummary {
2679
- readonly experience: io.flow.v0.models.ExperienceReference;
2680
- readonly url: string;
2681
- readonly last_construct_date?: string;
2682
- }
2683
2656
  interface ExperienceForm {
2684
2657
  readonly region_id: string;
2685
2658
  readonly name: string;
@@ -2916,9 +2889,6 @@ declare namespace io.flow.v0.models {
2916
2889
  interface ExternalApiTimeoutReservationError {
2917
2890
  readonly messages: string[];
2918
2891
  }
2919
- interface FeedStatisticsSummary {
2920
- readonly last_incoming_date?: string;
2921
- }
2922
2892
  interface FieldValidationMax {
2923
2893
  readonly length: number;
2924
2894
  }
@@ -3153,6 +3123,23 @@ declare namespace io.flow.v0.models {
3153
3123
  readonly organization: string;
3154
3124
  readonly number: string;
3155
3125
  }
3126
+ interface HarmonizedItemForm {
3127
+ readonly name: string;
3128
+ readonly number: string;
3129
+ readonly categories?: string[];
3130
+ readonly description?: string;
3131
+ readonly attributes?: {
3132
+ [key: string]: string;
3133
+ };
3134
+ }
3135
+ interface HarmonizedItemPutForm {
3136
+ readonly name: string;
3137
+ readonly categories?: string[];
3138
+ readonly description?: string;
3139
+ readonly attributes?: {
3140
+ [key: string]: string;
3141
+ };
3142
+ }
3156
3143
  interface HarmonizedItemReference {
3157
3144
  readonly id: string;
3158
3145
  readonly number: string;
@@ -3337,12 +3324,6 @@ declare namespace io.flow.v0.models {
3337
3324
  readonly key: io.flow.v0.enums.IncludedLevyKey;
3338
3325
  readonly label: string;
3339
3326
  }
3340
- interface IncomingFeed {
3341
- readonly url: string;
3342
- readonly format: io.flow.v0.enums.IncomingFeedFormat;
3343
- readonly minute: number;
3344
- readonly item_link: io.flow.v0.models.ItemLink;
3345
- }
3346
3327
  interface InlineAuthorizationDetails {
3347
3328
  readonly id: string;
3348
3329
  readonly client_token?: string;
@@ -3626,10 +3607,6 @@ declare namespace io.flow.v0.models {
3626
3607
  readonly dimensions?: io.flow.v0.models.Dimensions;
3627
3608
  readonly images?: io.flow.v0.models.ImageForm[];
3628
3609
  }
3629
- interface ItemLink {
3630
- readonly incoming_field_name: io.flow.v0.enums.IncomingFieldName;
3631
- readonly flow_field_name: io.flow.v0.enums.FlowFieldName;
3632
- }
3633
3610
  interface ItemMargin {
3634
3611
  readonly id: string;
3635
3612
  readonly key: string;
@@ -4824,14 +4801,6 @@ declare namespace io.flow.v0.models {
4824
4801
  interface OutboundCartonFee {
4825
4802
  readonly amount: io.flow.v0.models.Money;
4826
4803
  }
4827
- interface OutgoingFeed {
4828
- readonly format: io.flow.v0.enums.OutgoingFeedFormat;
4829
- readonly minute: number;
4830
- }
4831
- interface OutgoingFeedForm {
4832
- readonly format: io.flow.v0.enums.OutgoingFeedFormat;
4833
- readonly minute: number;
4834
- }
4835
4804
  interface OversizedShipmentRatecardFee {
4836
4805
  readonly weight_threshold: number;
4837
4806
  readonly weight_unit: io.flow.v0.enums.UnitOfMeasurement;
@@ -5549,6 +5518,18 @@ declare namespace io.flow.v0.models {
5549
5518
  readonly weight_unit: io.flow.v0.enums.UnitOfMeasurement;
5550
5519
  readonly distance_unit: io.flow.v0.enums.UnitOfMeasurement;
5551
5520
  }
5521
+ interface RatecardLaneImportForm {
5522
+ readonly service: string;
5523
+ readonly currency: string;
5524
+ readonly delivered_duty: io.flow.v0.enums.DeliveredDuty;
5525
+ readonly origin: io.flow.v0.models.Zone;
5526
+ readonly destination: io.flow.v0.models.Zone;
5527
+ readonly shipment_window: io.flow.v0.models.ShipmentWindow;
5528
+ readonly dim_factor: number;
5529
+ readonly weight_unit: io.flow.v0.enums.UnitOfMeasurement;
5530
+ readonly distance_unit: io.flow.v0.enums.UnitOfMeasurement;
5531
+ readonly rates: io.flow.v0.models.RatecardRateForm[];
5532
+ }
5552
5533
  interface RatecardLaneUpserted {
5553
5534
  readonly event_id: string;
5554
5535
  readonly timestamp: string;
@@ -5561,6 +5542,11 @@ declare namespace io.flow.v0.models {
5561
5542
  readonly type: io.flow.v0.enums.ChangeType;
5562
5543
  readonly ratecard_lane: io.flow.v0.models.RatecardLane;
5563
5544
  }
5545
+ interface RatecardLanesImportRequestData {
5546
+ readonly id: string;
5547
+ readonly source_url: string;
5548
+ readonly filename?: string;
5549
+ }
5564
5550
  interface RatecardRate {
5565
5551
  readonly id: string;
5566
5552
  readonly amount: number;
@@ -6366,9 +6352,16 @@ declare namespace io.flow.v0.models {
6366
6352
  [key: string]: string;
6367
6353
  };
6368
6354
  }
6369
- interface ShopifyCartFlowRepresentation {
6355
+ interface ShopifyCartConversion {
6356
+ readonly flow: io.flow.v0.models.ShopifyCartConversionFlowOrder;
6357
+ readonly shopify: io.flow.v0.models.ShopifyCartConversionShopifyCart;
6358
+ }
6359
+ interface ShopifyCartConversionFlowOrder {
6370
6360
  readonly order: io.flow.v0.models.Order;
6371
6361
  }
6362
+ interface ShopifyCartConversionShopifyCart {
6363
+ readonly cart: io.flow.shopify.external.v0.models.ShopifyCart;
6364
+ }
6372
6365
  interface ShopifyCartItem {
6373
6366
  readonly id: string;
6374
6367
  readonly handle: string;
@@ -6394,13 +6387,6 @@ declare namespace io.flow.v0.models {
6394
6387
  readonly variant_options?: string[];
6395
6388
  readonly vendor?: string;
6396
6389
  }
6397
- interface ShopifyCartRepresentation {
6398
- readonly flow: io.flow.v0.models.ShopifyCartFlowRepresentation;
6399
- readonly shopify: io.flow.v0.models.ShopifyCartShopifyRepresentation;
6400
- }
6401
- interface ShopifyCartShopifyRepresentation {
6402
- readonly cart: io.flow.shopify.external.v0.models.ShopifyCart;
6403
- }
6404
6390
  interface ShopifyCustomerMetafieldValue {
6405
6391
  readonly flow_consumer_id: string;
6406
6392
  }
@@ -7710,9 +7696,6 @@ declare namespace io.flow.v0.unions {
7710
7696
  } & io.flow.v0.models.SolidusVariantExportType | {
7711
7697
  discriminator: 'localized_item_prices_export_type';
7712
7698
  } & io.flow.v0.models.LocalizedItemPricesExportType;
7713
- type Feed = {
7714
- discriminator: 'catalog_feed';
7715
- } & io.flow.v0.models.CatalogFeed;
7716
7699
  type FieldValidationRule = {
7717
7700
  discriminator: 'required';
7718
7701
  } & io.flow.v0.models.FieldValidationRequired | {
@@ -8049,9 +8032,6 @@ export declare type CarrierService = io.flow.v0.models.CarrierService;
8049
8032
  export declare type CartReference = io.flow.v0.models.CartReference;
8050
8033
  export declare type Catalog = io.flow.v0.models.Catalog;
8051
8034
  export declare type CatalogDeleted = io.flow.v0.models.CatalogDeleted;
8052
- export declare type CatalogFeed = io.flow.v0.models.CatalogFeed;
8053
- export declare type CatalogFeedFormPost = io.flow.v0.models.CatalogFeedFormPost;
8054
- export declare type CatalogFeedFormPut = io.flow.v0.models.CatalogFeedFormPut;
8055
8035
  export declare type CatalogItemDeleted = io.flow.v0.models.CatalogItemDeleted;
8056
8036
  export declare type CatalogItemDeletedV2 = io.flow.v0.models.CatalogItemDeletedV2;
8057
8037
  export declare type CatalogItemDocument = io.flow.v0.models.CatalogItemDocument;
@@ -8237,7 +8217,6 @@ export declare type ExperienceDefaults = io.flow.v0.models.ExperienceDefaults;
8237
8217
  export declare type ExperienceDeleted = io.flow.v0.models.ExperienceDeleted;
8238
8218
  export declare type ExperienceDeletedV2 = io.flow.v0.models.ExperienceDeletedV2;
8239
8219
  export declare type ExperienceExportType = io.flow.v0.models.ExperienceExportType;
8240
- export declare type ExperienceFeedSummary = io.flow.v0.models.ExperienceFeedSummary;
8241
8220
  export declare type ExperienceForm = io.flow.v0.models.ExperienceForm;
8242
8221
  export declare type ExperienceGeo = io.flow.v0.models.ExperienceGeo;
8243
8222
  export declare type ExperienceLogisticsSettings = io.flow.v0.models.ExperienceLogisticsSettings;
@@ -8274,8 +8253,6 @@ export declare type ExportStatus = io.flow.v0.enums.ExportStatus;
8274
8253
  export declare type ExportType = io.flow.v0.unions.ExportType;
8275
8254
  export declare type ExportVersion = io.flow.v0.models.ExportVersion;
8276
8255
  export declare type ExternalApiTimeoutReservationError = io.flow.v0.models.ExternalApiTimeoutReservationError;
8277
- export declare type Feed = io.flow.v0.unions.Feed;
8278
- export declare type FeedStatisticsSummary = io.flow.v0.models.FeedStatisticsSummary;
8279
8256
  export declare type FieldValidationMax = io.flow.v0.models.FieldValidationMax;
8280
8257
  export declare type FieldValidationMin = io.flow.v0.models.FieldValidationMin;
8281
8258
  export declare type FieldValidationPattern = io.flow.v0.models.FieldValidationPattern;
@@ -8286,7 +8263,6 @@ export declare type FlatRateForm = io.flow.v0.models.FlatRateForm;
8286
8263
  export declare type FlowAddonRole = io.flow.v0.enums.FlowAddonRole;
8287
8264
  export declare type FlowBehavior = io.flow.v0.enums.FlowBehavior;
8288
8265
  export declare type FlowCenterReference = io.flow.v0.models.FlowCenterReference;
8289
- export declare type FlowFieldName = io.flow.v0.enums.FlowFieldName;
8290
8266
  export declare type FlowItemIndexMetadata = io.flow.v0.models.FlowItemIndexMetadata;
8291
8267
  export declare type FlowRole = io.flow.v0.unions.FlowRole;
8292
8268
  export declare type FlowUserRole = io.flow.v0.enums.FlowUserRole;
@@ -8339,6 +8315,8 @@ export declare type HarmonizedCategory = io.flow.v0.models.HarmonizedCategory;
8339
8315
  export declare type HarmonizedCategoryReference = io.flow.v0.models.HarmonizedCategoryReference;
8340
8316
  export declare type HarmonizedItem = io.flow.v0.models.HarmonizedItem;
8341
8317
  export declare type HarmonizedItemDeleted = io.flow.v0.models.HarmonizedItemDeleted;
8318
+ export declare type HarmonizedItemForm = io.flow.v0.models.HarmonizedItemForm;
8319
+ export declare type HarmonizedItemPutForm = io.flow.v0.models.HarmonizedItemPutForm;
8342
8320
  export declare type HarmonizedItemReference = io.flow.v0.models.HarmonizedItemReference;
8343
8321
  export declare type HarmonizedItemUpserted = io.flow.v0.models.HarmonizedItemUpserted;
8344
8322
  export declare type HarmonizedLandedCost = io.flow.v0.models.HarmonizedLandedCost;
@@ -8372,9 +8350,6 @@ export declare type ImportVersion = io.flow.v0.models.ImportVersion;
8372
8350
  export declare type InboundCartonFee = io.flow.v0.models.InboundCartonFee;
8373
8351
  export declare type IncludedLevies = io.flow.v0.models.IncludedLevies;
8374
8352
  export declare type IncludedLevyKey = io.flow.v0.enums.IncludedLevyKey;
8375
- export declare type IncomingFeed = io.flow.v0.models.IncomingFeed;
8376
- export declare type IncomingFeedFormat = io.flow.v0.enums.IncomingFeedFormat;
8377
- export declare type IncomingFieldName = io.flow.v0.enums.IncomingFieldName;
8378
8353
  export declare type Incoterm = io.flow.v0.enums.Incoterm;
8379
8354
  export declare type InlineAuthorizationDetails = io.flow.v0.models.InlineAuthorizationDetails;
8380
8355
  export declare type InlineAuthorizationForm = io.flow.v0.models.InlineAuthorizationForm;
@@ -8425,7 +8400,6 @@ export declare type ItemAvailabilityStatus = io.flow.v0.enums.ItemAvailabilitySt
8425
8400
  export declare type ItemForm = io.flow.v0.models.ItemForm;
8426
8401
  export declare type ItemFormOverlay = io.flow.v0.models.ItemFormOverlay;
8427
8402
  export declare type ItemFormOverlayForm = io.flow.v0.models.ItemFormOverlayForm;
8428
- export declare type ItemLink = io.flow.v0.models.ItemLink;
8429
8403
  export declare type ItemMargin = io.flow.v0.models.ItemMargin;
8430
8404
  export declare type ItemMarginDeleted = io.flow.v0.models.ItemMarginDeleted;
8431
8405
  export declare type ItemMarginPostForm = io.flow.v0.models.ItemMarginPostForm;
@@ -8613,9 +8587,6 @@ export declare type OrganizationUpsertedV2 = io.flow.v0.models.OrganizationUpser
8613
8587
  export declare type OrganizationVersion = io.flow.v0.models.OrganizationVersion;
8614
8588
  export declare type OriginalPrices = io.flow.v0.models.OriginalPrices;
8615
8589
  export declare type OutboundCartonFee = io.flow.v0.models.OutboundCartonFee;
8616
- export declare type OutgoingFeed = io.flow.v0.models.OutgoingFeed;
8617
- export declare type OutgoingFeedForm = io.flow.v0.models.OutgoingFeedForm;
8618
- export declare type OutgoingFeedFormat = io.flow.v0.enums.OutgoingFeedFormat;
8619
8590
  export declare type OversizedShipmentRatecardFee = io.flow.v0.models.OversizedShipmentRatecardFee;
8620
8591
  export declare type Packaging = io.flow.v0.models.Packaging;
8621
8592
  export declare type PartnerCenter = io.flow.v0.models.PartnerCenter;
@@ -8747,8 +8718,10 @@ export declare type RatecardForm = io.flow.v0.models.RatecardForm;
8747
8718
  export declare type RatecardLane = io.flow.v0.models.RatecardLane;
8748
8719
  export declare type RatecardLaneDeleted = io.flow.v0.models.RatecardLaneDeleted;
8749
8720
  export declare type RatecardLaneForm = io.flow.v0.models.RatecardLaneForm;
8721
+ export declare type RatecardLaneImportForm = io.flow.v0.models.RatecardLaneImportForm;
8750
8722
  export declare type RatecardLaneUpserted = io.flow.v0.models.RatecardLaneUpserted;
8751
8723
  export declare type RatecardLaneVersion = io.flow.v0.models.RatecardLaneVersion;
8724
+ export declare type RatecardLanesImportRequestData = io.flow.v0.models.RatecardLanesImportRequestData;
8752
8725
  export declare type RatecardRate = io.flow.v0.models.RatecardRate;
8753
8726
  export declare type RatecardRateForm = io.flow.v0.models.RatecardRateForm;
8754
8727
  export declare type RatecardRateVersion = io.flow.v0.models.RatecardRateVersion;
@@ -8890,10 +8863,10 @@ export declare type ShopifyCartAddForm = io.flow.v0.unions.ShopifyCartAddForm;
8890
8863
  export declare type ShopifyCartAddMultipleForm = io.flow.v0.models.ShopifyCartAddMultipleForm;
8891
8864
  export declare type ShopifyCartAddSingleForm = io.flow.v0.models.ShopifyCartAddSingleForm;
8892
8865
  export declare type ShopifyCartChangeForm = io.flow.v0.models.ShopifyCartChangeForm;
8893
- export declare type ShopifyCartFlowRepresentation = io.flow.v0.models.ShopifyCartFlowRepresentation;
8866
+ export declare type ShopifyCartConversion = io.flow.v0.models.ShopifyCartConversion;
8867
+ export declare type ShopifyCartConversionFlowOrder = io.flow.v0.models.ShopifyCartConversionFlowOrder;
8868
+ export declare type ShopifyCartConversionShopifyCart = io.flow.v0.models.ShopifyCartConversionShopifyCart;
8894
8869
  export declare type ShopifyCartItem = io.flow.v0.models.ShopifyCartItem;
8895
- export declare type ShopifyCartRepresentation = io.flow.v0.models.ShopifyCartRepresentation;
8896
- export declare type ShopifyCartShopifyRepresentation = io.flow.v0.models.ShopifyCartShopifyRepresentation;
8897
8870
  export declare type ShopifyCustomerMetafieldValue = io.flow.v0.models.ShopifyCustomerMetafieldValue;
8898
8871
  export declare type ShopifyEventBucket = io.flow.v0.unions.ShopifyEventBucket;
8899
8872
  export declare type ShopifyGrant = io.flow.v0.enums.ShopifyGrant;
package/package.json CHANGED
@@ -1,8 +1,9 @@
1
1
  {
2
2
  "name": "@flowio/types",
3
- "version": "0.0.1",
3
+ "version": "0.0.3",
4
4
  "description": "TypeScript type definitions for custom types found in Flow API",
5
- "main": "dist/index.ts",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
6
7
  "scripts": {
7
8
  "build": "tsc",
8
9
  "ci": "npm run build",
@@ -19,6 +20,5 @@
19
20
  "license": "MIT",
20
21
  "devDependencies": {
21
22
  "typescript": "^3.2.2"
22
- },
23
- "gitHead": "b20b000586595eccfdbc9db60e817e3a0dbf8b8d"
23
+ }
24
24
  }