@flowio/types 0.0.10 → 0.0.11
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-internal.d.ts +216 -108
- package/dist/api.d.ts +73 -58
- package/package.json +2 -3
- package/src/api-internal.ts +265 -128
- package/src/api.ts +95 -63
- package/LICENSE +0 -21
package/src/api.ts
CHANGED
|
@@ -1253,8 +1253,6 @@ namespace io.flow.v0.enums {
|
|
|
1253
1253
|
| 'fraud_status_changed'
|
|
1254
1254
|
| 'center_upserted'
|
|
1255
1255
|
| 'center_deleted'
|
|
1256
|
-
| 'delivery_option_upserted'
|
|
1257
|
-
| 'delivery_option_deleted'
|
|
1258
1256
|
| 'shipping_configuration_upserted'
|
|
1259
1257
|
| 'shipping_configuration_deleted'
|
|
1260
1258
|
| 'tier_upserted_v2'
|
|
@@ -1416,7 +1414,11 @@ namespace io.flow.v0.enums {
|
|
|
1416
1414
|
export type InventoryStatus = 'has_inventory' | 'no_inventory';
|
|
1417
1415
|
export type InvitationErrorCode = 'expired' | 'invalid_email';
|
|
1418
1416
|
export type ItemAvailabilityStatus = 'available' | 'low' | 'out_of_stock';
|
|
1419
|
-
export type LaneStrategy =
|
|
1417
|
+
export type LaneStrategy =
|
|
1418
|
+
| 'oldest'
|
|
1419
|
+
| 'fastest'
|
|
1420
|
+
| 'lowest_cost'
|
|
1421
|
+
| 'highest_priority';
|
|
1420
1422
|
export type LevyComponent =
|
|
1421
1423
|
| 'goods'
|
|
1422
1424
|
| 'duty'
|
|
@@ -1426,6 +1428,12 @@ namespace io.flow.v0.enums {
|
|
|
1426
1428
|
export type LevyStrategy = 'minimum' | 'average' | 'maximum';
|
|
1427
1429
|
export type MarginType = 'fixed' | 'percent';
|
|
1428
1430
|
export type MeasurementSystem = 'imperial' | 'metric';
|
|
1431
|
+
export type MerchantGiftCardErrorCode =
|
|
1432
|
+
| 'invalid'
|
|
1433
|
+
| 'expired'
|
|
1434
|
+
| 'empty'
|
|
1435
|
+
| 'insufficient_funds'
|
|
1436
|
+
| 'unsupported_currency';
|
|
1429
1437
|
export type MerchantOfRecord = 'flow' | 'organization';
|
|
1430
1438
|
export type Method = 'post';
|
|
1431
1439
|
export type OptinResponseType = 'not_shown' | 'opted_in' | 'opted_out';
|
|
@@ -1564,7 +1572,10 @@ namespace io.flow.v0.enums {
|
|
|
1564
1572
|
| 'territory'
|
|
1565
1573
|
| 'other';
|
|
1566
1574
|
export type QueryType = 'exclusion' | 'inclusion';
|
|
1567
|
-
export type QuoteErrorCode =
|
|
1575
|
+
export type QuoteErrorCode =
|
|
1576
|
+
| 'generic_error'
|
|
1577
|
+
| 'items_not_available'
|
|
1578
|
+
| 'shipping_unavailable';
|
|
1568
1579
|
export type RateType = 'flow' | 'organization';
|
|
1569
1580
|
export type RefundDeclineCode = 'expired' | 'insufficient_funds' | 'unknown';
|
|
1570
1581
|
export type RefundStatus = 'pending' | 'succeeded' | 'failed' | 'canceled';
|
|
@@ -2309,24 +2320,22 @@ namespace io.flow.v0.models {
|
|
|
2309
2320
|
readonly summary: io.flow.v0.models.CardPaymentSourceSummary;
|
|
2310
2321
|
}
|
|
2311
2322
|
|
|
2323
|
+
export interface CardPaymentSourceAuthorizationForm {
|
|
2324
|
+
readonly key?: string;
|
|
2325
|
+
readonly card_payment_source_id: string;
|
|
2326
|
+
readonly order_number: string;
|
|
2327
|
+
readonly amount: number;
|
|
2328
|
+
readonly currency: string;
|
|
2329
|
+
}
|
|
2330
|
+
|
|
2312
2331
|
export interface CardPaymentSourceForm {
|
|
2313
2332
|
readonly customer_number: string;
|
|
2314
|
-
readonly
|
|
2315
|
-
readonly last4?: string;
|
|
2316
|
-
readonly expiration_month?: number;
|
|
2317
|
-
readonly expiration_year?: number;
|
|
2318
|
-
readonly type?: io.flow.v0.enums.CardType;
|
|
2319
|
-
readonly billing_address?: io.flow.v0.models.BillingAddress;
|
|
2333
|
+
readonly card_id: string;
|
|
2320
2334
|
}
|
|
2321
2335
|
|
|
2322
2336
|
export interface CardPaymentSourceSummary {
|
|
2323
2337
|
readonly customer_number: string;
|
|
2324
|
-
readonly
|
|
2325
|
-
readonly last4?: string;
|
|
2326
|
-
readonly expiration_month?: number;
|
|
2327
|
-
readonly expiration_year?: number;
|
|
2328
|
-
readonly type?: io.flow.v0.enums.CardType;
|
|
2329
|
-
readonly billing_address?: io.flow.v0.models.BillingAddress;
|
|
2338
|
+
readonly card: io.flow.v0.models.CardSummary;
|
|
2330
2339
|
}
|
|
2331
2340
|
|
|
2332
2341
|
export interface CardReference {
|
|
@@ -2640,6 +2649,7 @@ namespace io.flow.v0.models {
|
|
|
2640
2649
|
readonly payment_sources?: io.flow.v0.unions.PaymentSourceForm[];
|
|
2641
2650
|
readonly session_id: string;
|
|
2642
2651
|
readonly urls?: io.flow.v0.models.CheckoutUrlsForm;
|
|
2652
|
+
readonly identifiers?: io.flow.v0.models.OrderSubmissionIdentifierForm[];
|
|
2643
2653
|
}
|
|
2644
2654
|
|
|
2645
2655
|
export interface CheckoutTokenReferenceForm {
|
|
@@ -2650,10 +2660,12 @@ namespace io.flow.v0.models {
|
|
|
2650
2660
|
|
|
2651
2661
|
export interface CheckoutUrls {
|
|
2652
2662
|
readonly continue_shopping?: string;
|
|
2663
|
+
readonly confirmation?: string;
|
|
2653
2664
|
}
|
|
2654
2665
|
|
|
2655
2666
|
export interface CheckoutUrlsForm {
|
|
2656
2667
|
readonly continue_shopping?: string;
|
|
2668
|
+
readonly confirmation?: string;
|
|
2657
2669
|
}
|
|
2658
2670
|
|
|
2659
2671
|
export interface Cleartext {
|
|
@@ -3111,13 +3123,6 @@ namespace io.flow.v0.models {
|
|
|
3111
3123
|
readonly components: io.flow.v0.models.DeliveryOptionCostComponent[];
|
|
3112
3124
|
}
|
|
3113
3125
|
|
|
3114
|
-
export interface DeliveryOptionDeleted {
|
|
3115
|
-
readonly event_id: string;
|
|
3116
|
-
readonly timestamp: string;
|
|
3117
|
-
readonly organization: string;
|
|
3118
|
-
readonly id: string;
|
|
3119
|
-
}
|
|
3120
|
-
|
|
3121
3126
|
export interface DeliveryOptionForm {
|
|
3122
3127
|
readonly delivery: string;
|
|
3123
3128
|
readonly items: io.flow.v0.models.QuoteLineItemForm[];
|
|
@@ -3138,37 +3143,6 @@ namespace io.flow.v0.models {
|
|
|
3138
3143
|
readonly window: io.flow.v0.models.DatetimeRange;
|
|
3139
3144
|
}
|
|
3140
3145
|
|
|
3141
|
-
export interface DeliveryOptionUpserted {
|
|
3142
|
-
readonly event_id: string;
|
|
3143
|
-
readonly timestamp: string;
|
|
3144
|
-
readonly organization: string;
|
|
3145
|
-
readonly id: string;
|
|
3146
|
-
readonly cost: {
|
|
3147
|
-
[key: string]: string;
|
|
3148
|
-
};
|
|
3149
|
-
readonly price: {
|
|
3150
|
-
[key: string]: string;
|
|
3151
|
-
};
|
|
3152
|
-
readonly delivered_duty: string;
|
|
3153
|
-
readonly service_id: string;
|
|
3154
|
-
readonly tier: {
|
|
3155
|
-
[key: string]: string;
|
|
3156
|
-
};
|
|
3157
|
-
readonly window: {
|
|
3158
|
-
[key: string]: string;
|
|
3159
|
-
};
|
|
3160
|
-
readonly rule_outcome: {
|
|
3161
|
-
[key: string]: string;
|
|
3162
|
-
};
|
|
3163
|
-
readonly weight?: {
|
|
3164
|
-
[key: string]: string;
|
|
3165
|
-
};
|
|
3166
|
-
readonly delivery_window_components: {
|
|
3167
|
-
[key: string]: string;
|
|
3168
|
-
};
|
|
3169
|
-
readonly surcharge?: io.flow.v0.models.PriceWithBaseAndDetails;
|
|
3170
|
-
}
|
|
3171
|
-
|
|
3172
3146
|
export interface DeliveryOptionVersion {
|
|
3173
3147
|
readonly id: string;
|
|
3174
3148
|
readonly timestamp: string;
|
|
@@ -3254,6 +3228,7 @@ namespace io.flow.v0.models {
|
|
|
3254
3228
|
|
|
3255
3229
|
export interface DigitalDelivery {
|
|
3256
3230
|
readonly id: string;
|
|
3231
|
+
readonly key?: string;
|
|
3257
3232
|
readonly items: io.flow.v0.models.DeliveryItem[];
|
|
3258
3233
|
readonly prices?: io.flow.v0.models.OrderPriceDetail[];
|
|
3259
3234
|
readonly total?: io.flow.v0.models.LocalizedTotal;
|
|
@@ -4759,6 +4734,7 @@ namespace io.flow.v0.models {
|
|
|
4759
4734
|
export interface LocalItem {
|
|
4760
4735
|
readonly id: string;
|
|
4761
4736
|
readonly experience: io.flow.v0.models.ExperienceSummary;
|
|
4737
|
+
readonly center?: io.flow.v0.models.CenterSummary;
|
|
4762
4738
|
readonly item: io.flow.v0.models.CatalogItemReference;
|
|
4763
4739
|
readonly pricing: io.flow.v0.models.LocalItemPricing;
|
|
4764
4740
|
readonly status: io.flow.v0.enums.SubcatalogItemStatus;
|
|
@@ -4773,6 +4749,8 @@ namespace io.flow.v0.models {
|
|
|
4773
4749
|
|
|
4774
4750
|
export interface LocalItemPricing {
|
|
4775
4751
|
readonly price: io.flow.v0.models.LocalizedItemPrice;
|
|
4752
|
+
readonly vat?: io.flow.v0.models.LocalizedItemVat;
|
|
4753
|
+
readonly duty?: io.flow.v0.models.LocalizedItemDuty;
|
|
4776
4754
|
readonly attributes: {
|
|
4777
4755
|
[key: string]: io.flow.v0.models.PriceWithBase;
|
|
4778
4756
|
};
|
|
@@ -4976,6 +4954,40 @@ namespace io.flow.v0.models {
|
|
|
4976
4954
|
readonly membership: io.flow.v0.models.Membership;
|
|
4977
4955
|
}
|
|
4978
4956
|
|
|
4957
|
+
export interface MerchantGiftCardBalance {
|
|
4958
|
+
readonly amount: number;
|
|
4959
|
+
readonly currency: string;
|
|
4960
|
+
}
|
|
4961
|
+
|
|
4962
|
+
export interface MerchantGiftCardBalanceForm {
|
|
4963
|
+
readonly number: string;
|
|
4964
|
+
}
|
|
4965
|
+
|
|
4966
|
+
export interface MerchantGiftCardError {
|
|
4967
|
+
readonly code: io.flow.v0.enums.MerchantGiftCardErrorCode;
|
|
4968
|
+
readonly messages?: string[];
|
|
4969
|
+
}
|
|
4970
|
+
|
|
4971
|
+
export interface MerchantGiftCardRedemption {
|
|
4972
|
+
readonly id: string;
|
|
4973
|
+
}
|
|
4974
|
+
|
|
4975
|
+
export interface MerchantGiftCardRedemptionForm {
|
|
4976
|
+
readonly number: string;
|
|
4977
|
+
readonly amount: number;
|
|
4978
|
+
readonly currency: string;
|
|
4979
|
+
}
|
|
4980
|
+
|
|
4981
|
+
export interface MerchantGiftCardReversal {
|
|
4982
|
+
readonly id: string;
|
|
4983
|
+
}
|
|
4984
|
+
|
|
4985
|
+
export interface MerchantGiftCardReversalForm {
|
|
4986
|
+
readonly number: string;
|
|
4987
|
+
readonly amount: number;
|
|
4988
|
+
readonly currency: string;
|
|
4989
|
+
}
|
|
4990
|
+
|
|
4979
4991
|
export interface MerchantOfRecordAuthorizationForm {
|
|
4980
4992
|
readonly token: string;
|
|
4981
4993
|
readonly order_number: string;
|
|
@@ -5500,6 +5512,15 @@ namespace io.flow.v0.models {
|
|
|
5500
5512
|
readonly applied: io.flow.v0.models.OrderRuleReference[];
|
|
5501
5513
|
}
|
|
5502
5514
|
|
|
5515
|
+
export interface OrderSubmissionForm {
|
|
5516
|
+
readonly identifiers?: io.flow.v0.models.OrderSubmissionIdentifierForm[];
|
|
5517
|
+
}
|
|
5518
|
+
|
|
5519
|
+
export interface OrderSubmissionIdentifierForm {
|
|
5520
|
+
readonly identifier: string;
|
|
5521
|
+
readonly primary?: boolean;
|
|
5522
|
+
}
|
|
5523
|
+
|
|
5503
5524
|
export interface OrderUpserted {
|
|
5504
5525
|
readonly event_id: string;
|
|
5505
5526
|
readonly timestamp: string;
|
|
@@ -5989,6 +6010,7 @@ namespace io.flow.v0.models {
|
|
|
5989
6010
|
|
|
5990
6011
|
export interface PhysicalDelivery {
|
|
5991
6012
|
readonly id: string;
|
|
6013
|
+
readonly key?: string;
|
|
5992
6014
|
readonly center?: io.flow.v0.models.CenterSummary;
|
|
5993
6015
|
readonly items: io.flow.v0.models.DeliveryItem[];
|
|
5994
6016
|
readonly options: io.flow.v0.models.DeliveryOption[];
|
|
@@ -7557,10 +7579,14 @@ namespace io.flow.v0.models {
|
|
|
7557
7579
|
}
|
|
7558
7580
|
|
|
7559
7581
|
export interface ShopifyOrderDeliveryMetafield {
|
|
7582
|
+
readonly key?: string;
|
|
7560
7583
|
readonly items: io.flow.v0.models.ShopifyOrderDeliveryMetafieldItem[];
|
|
7561
7584
|
readonly service: io.flow.v0.models.ServiceSummary;
|
|
7562
7585
|
readonly window: io.flow.v0.models.DeliveryWindow;
|
|
7563
7586
|
readonly cost?: io.flow.v0.models.MoneyWithOptionalBase;
|
|
7587
|
+
readonly prices?: io.flow.v0.models.ShopifyPrice[];
|
|
7588
|
+
readonly total?: io.flow.v0.models.ShopifyPrice;
|
|
7589
|
+
readonly merchant_of_record_entity?: io.flow.v0.models.MerchantOfRecordEntity;
|
|
7564
7590
|
}
|
|
7565
7591
|
|
|
7566
7592
|
export interface ShopifyOrderDeliveryMetafieldItem {
|
|
@@ -8421,7 +8447,10 @@ namespace io.flow.v0.unions {
|
|
|
8421
8447
|
} & io.flow.v0.models.InlineAuthorizationForm
|
|
8422
8448
|
| {
|
|
8423
8449
|
discriminator: 'ach_authorization_form';
|
|
8424
|
-
} & io.flow.v0.models.AchAuthorizationForm
|
|
8450
|
+
} & io.flow.v0.models.AchAuthorizationForm
|
|
8451
|
+
| {
|
|
8452
|
+
discriminator: 'card_payment_source_authorization_form';
|
|
8453
|
+
} & io.flow.v0.models.CardPaymentSourceAuthorizationForm;
|
|
8425
8454
|
|
|
8426
8455
|
export type AuthorizationPayloadParameters =
|
|
8427
8456
|
| {
|
|
@@ -8712,12 +8741,6 @@ namespace io.flow.v0.unions {
|
|
|
8712
8741
|
| {
|
|
8713
8742
|
discriminator: 'center_deleted';
|
|
8714
8743
|
} & io.flow.v0.models.CenterDeleted
|
|
8715
|
-
| {
|
|
8716
|
-
discriminator: 'delivery_option_upserted';
|
|
8717
|
-
} & io.flow.v0.models.DeliveryOptionUpserted
|
|
8718
|
-
| {
|
|
8719
|
-
discriminator: 'delivery_option_deleted';
|
|
8720
|
-
} & io.flow.v0.models.DeliveryOptionDeleted
|
|
8721
8744
|
| {
|
|
8722
8745
|
discriminator: 'shipping_configuration_upserted';
|
|
8723
8746
|
} & io.flow.v0.models.ShippingConfigurationUpserted
|
|
@@ -9542,6 +9565,7 @@ export type CardErrorCode = io.flow.v0.enums.CardErrorCode;
|
|
|
9542
9565
|
export type CardForm = io.flow.v0.models.CardForm;
|
|
9543
9566
|
export type CardNonceForm = io.flow.v0.models.CardNonceForm;
|
|
9544
9567
|
export type CardPaymentSource = io.flow.v0.models.CardPaymentSource;
|
|
9568
|
+
export type CardPaymentSourceAuthorizationForm = io.flow.v0.models.CardPaymentSourceAuthorizationForm;
|
|
9545
9569
|
export type CardPaymentSourceForm = io.flow.v0.models.CardPaymentSourceForm;
|
|
9546
9570
|
export type CardPaymentSourceSummary = io.flow.v0.models.CardPaymentSourceSummary;
|
|
9547
9571
|
export type CardReference = io.flow.v0.models.CardReference;
|
|
@@ -9676,11 +9700,9 @@ export type DeliveryOptionCostComponent = io.flow.v0.models.DeliveryOptionCostCo
|
|
|
9676
9700
|
export type DeliveryOptionCostDetail = io.flow.v0.models.DeliveryOptionCostDetail;
|
|
9677
9701
|
export type DeliveryOptionCostDetailComponentKey = io.flow.v0.enums.DeliveryOptionCostDetailComponentKey;
|
|
9678
9702
|
export type DeliveryOptionCostDetailSource = io.flow.v0.enums.DeliveryOptionCostDetailSource;
|
|
9679
|
-
export type DeliveryOptionDeleted = io.flow.v0.models.DeliveryOptionDeleted;
|
|
9680
9703
|
export type DeliveryOptionForm = io.flow.v0.models.DeliveryOptionForm;
|
|
9681
9704
|
export type DeliveryOptionReference = io.flow.v0.models.DeliveryOptionReference;
|
|
9682
9705
|
export type DeliveryOptionSummary = io.flow.v0.models.DeliveryOptionSummary;
|
|
9683
|
-
export type DeliveryOptionUpserted = io.flow.v0.models.DeliveryOptionUpserted;
|
|
9684
9706
|
export type DeliveryOptionVersion = io.flow.v0.models.DeliveryOptionVersion;
|
|
9685
9707
|
export type DeliverySummary = io.flow.v0.models.DeliverySummary;
|
|
9686
9708
|
export type DeliveryVersion = io.flow.v0.models.DeliveryVersion;
|
|
@@ -9998,6 +10020,14 @@ export type MembershipForm = io.flow.v0.models.MembershipForm;
|
|
|
9998
10020
|
export type MembershipPutForm = io.flow.v0.models.MembershipPutForm;
|
|
9999
10021
|
export type MembershipUpsertedV2 = io.flow.v0.models.MembershipUpsertedV2;
|
|
10000
10022
|
export type MembershipVersion = io.flow.v0.models.MembershipVersion;
|
|
10023
|
+
export type MerchantGiftCardBalance = io.flow.v0.models.MerchantGiftCardBalance;
|
|
10024
|
+
export type MerchantGiftCardBalanceForm = io.flow.v0.models.MerchantGiftCardBalanceForm;
|
|
10025
|
+
export type MerchantGiftCardError = io.flow.v0.models.MerchantGiftCardError;
|
|
10026
|
+
export type MerchantGiftCardErrorCode = io.flow.v0.enums.MerchantGiftCardErrorCode;
|
|
10027
|
+
export type MerchantGiftCardRedemption = io.flow.v0.models.MerchantGiftCardRedemption;
|
|
10028
|
+
export type MerchantGiftCardRedemptionForm = io.flow.v0.models.MerchantGiftCardRedemptionForm;
|
|
10029
|
+
export type MerchantGiftCardReversal = io.flow.v0.models.MerchantGiftCardReversal;
|
|
10030
|
+
export type MerchantGiftCardReversalForm = io.flow.v0.models.MerchantGiftCardReversalForm;
|
|
10001
10031
|
export type MerchantOfRecord = io.flow.v0.enums.MerchantOfRecord;
|
|
10002
10032
|
export type MerchantOfRecordAuthorizationForm = io.flow.v0.models.MerchantOfRecordAuthorizationForm;
|
|
10003
10033
|
export type MerchantOfRecordEntity = io.flow.v0.models.MerchantOfRecordEntity;
|
|
@@ -10078,6 +10108,8 @@ export type OrderReference = io.flow.v0.models.OrderReference;
|
|
|
10078
10108
|
export type OrderRuleReference = io.flow.v0.models.OrderRuleReference;
|
|
10079
10109
|
export type OrderRulesSummary = io.flow.v0.models.OrderRulesSummary;
|
|
10080
10110
|
export type OrderStatus = io.flow.v0.enums.OrderStatus;
|
|
10111
|
+
export type OrderSubmissionForm = io.flow.v0.models.OrderSubmissionForm;
|
|
10112
|
+
export type OrderSubmissionIdentifierForm = io.flow.v0.models.OrderSubmissionIdentifierForm;
|
|
10081
10113
|
export type OrderUpserted = io.flow.v0.models.OrderUpserted;
|
|
10082
10114
|
export type OrderUpsertedV2 = io.flow.v0.models.OrderUpsertedV2;
|
|
10083
10115
|
export type OrderVersion = io.flow.v0.models.OrderVersion;
|
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.
|