@flowio/types 11.24.92 → 11.24.94
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 +6077 -6081
- package/dist/api.d.ts +49 -21
- package/package.json +2 -2
- package/src/api-internal.ts +7556 -7522
- package/src/api.ts +79 -22
package/dist/api.d.ts
CHANGED
|
@@ -1019,6 +1019,7 @@ declare namespace io.flow.shopify.external.v0.enums {
|
|
|
1019
1019
|
type ShopifyCustomerState = 'disabled' | 'invited' | 'enabled';
|
|
1020
1020
|
type ShopifyDiscountPaginationDirection = 'next' | 'prev';
|
|
1021
1021
|
type ShopifyGiftCardStatus = 'any' | 'enabled' | 'disabled';
|
|
1022
|
+
type ShopifyPlanName = 'basic' | 'business' | 'cancelled' | 'dormant' | 'enterprise' | 'fraudulent' | 'frozen' | 'npo_full' | 'npo_lite' | 'open_learning' | 'paid_trial' | 'professional' | 'retail' | 'shopify_alumni' | 'shopify_plus' | 'staff' | 'staff_business' | 'starter' | 'starter_2022' | 'unlimited';
|
|
1022
1023
|
type ShopifyProcessingMethodType = 'checkout' | 'direct' | 'manual' | 'offsite' | 'express';
|
|
1023
1024
|
type ShopifyTransactionErrorCode = 'incorrect_number' | 'invalid_number' | 'invalid_expiry_date' | 'invalid_cvc' | 'expired_card' | 'incorrect_cvc' | 'incorrect_zip' | 'incorrect_address' | 'card_declined' | 'processing_error' | 'call_issuer' | 'pick_up_card';
|
|
1024
1025
|
type ShopifyTransactionStatus = 'pending' | 'failure' | 'success' | 'error';
|
|
@@ -1151,7 +1152,7 @@ declare namespace io.flow.shopify.external.v0.models {
|
|
|
1151
1152
|
readonly id: number;
|
|
1152
1153
|
readonly product_id: number;
|
|
1153
1154
|
readonly variant_ids: number[];
|
|
1154
|
-
readonly src
|
|
1155
|
+
readonly src?: string;
|
|
1155
1156
|
readonly position: number;
|
|
1156
1157
|
readonly created_at: string;
|
|
1157
1158
|
readonly updated_at: string;
|
|
@@ -1694,6 +1695,11 @@ declare namespace io.flow.shopify.external.v0.models {
|
|
|
1694
1695
|
readonly tax_lines: io.flow.shopify.external.v0.models.ShopifyTaxLine[];
|
|
1695
1696
|
readonly carrier_identifier?: string;
|
|
1696
1697
|
}
|
|
1698
|
+
interface ShopifyShopUpdate {
|
|
1699
|
+
readonly id: number;
|
|
1700
|
+
readonly plan_display_name: string;
|
|
1701
|
+
readonly plan_name: io.flow.shopify.external.v0.enums.ShopifyPlanName;
|
|
1702
|
+
}
|
|
1697
1703
|
interface ShopifyTaxLine {
|
|
1698
1704
|
readonly price: string;
|
|
1699
1705
|
readonly rate: number;
|
|
@@ -2095,7 +2101,7 @@ declare namespace io.flow.v0.enums {
|
|
|
2095
2101
|
type TrackingStatus = 'label_created' | 'pending' | 'info_received' | 'picked_up' | 'in_transit' | 'out_for_delivery' | 'attempt_fail' | 'delivered' | 'exception' | 'returned' | 'expired';
|
|
2096
2102
|
type TradeAgreementName = 'USMCA' | 'T-MEC' | 'CUSMA' | 'TCA';
|
|
2097
2103
|
type TradeAgreementStatus = 'supported' | 'not_supported';
|
|
2098
|
-
type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | 'carrier_charge' | 'carrier_charge_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
|
|
2104
|
+
type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | 'carrier_charge' | 'carrier_charge_revenue_share' | 'carrier_fee' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
|
|
2099
2105
|
type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
|
|
2100
2106
|
type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction' | 'security' | 'eei_filing' | 'fixed_ddp' | 'fixed_currency_conversion';
|
|
2101
2107
|
type UnitOfLength = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'meter';
|
|
@@ -4155,6 +4161,7 @@ declare namespace io.flow.v0.models {
|
|
|
4155
4161
|
}
|
|
4156
4162
|
interface DeactivationPutForm {
|
|
4157
4163
|
readonly reason: string;
|
|
4164
|
+
readonly deactivate_at?: string;
|
|
4158
4165
|
}
|
|
4159
4166
|
interface DeadWeight {
|
|
4160
4167
|
readonly weight: number;
|
|
@@ -6372,6 +6379,7 @@ declare namespace io.flow.v0.models {
|
|
|
6372
6379
|
interface MerchantDeactivated {
|
|
6373
6380
|
readonly discriminator: 'merchant_deactivated';
|
|
6374
6381
|
readonly reason: string;
|
|
6382
|
+
readonly deactivate_at?: string;
|
|
6375
6383
|
}
|
|
6376
6384
|
interface MerchantDisabled {
|
|
6377
6385
|
readonly discriminator: 'merchant_disabled';
|
|
@@ -7534,6 +7542,7 @@ declare namespace io.flow.v0.models {
|
|
|
7534
7542
|
readonly currency: string;
|
|
7535
7543
|
readonly base_amount?: number;
|
|
7536
7544
|
readonly base_currency?: string;
|
|
7545
|
+
readonly reference?: string;
|
|
7537
7546
|
}
|
|
7538
7547
|
interface PaymentAuthorizationStatus {
|
|
7539
7548
|
readonly status: io.flow.v0.enums.AuthorizationStatus;
|
|
@@ -7545,6 +7554,7 @@ declare namespace io.flow.v0.models {
|
|
|
7545
7554
|
readonly currency: string;
|
|
7546
7555
|
readonly base_amount?: number;
|
|
7547
7556
|
readonly base_currency?: string;
|
|
7557
|
+
readonly reference?: string;
|
|
7548
7558
|
readonly created_at: string;
|
|
7549
7559
|
readonly updated_at: string;
|
|
7550
7560
|
readonly status: io.flow.v0.models.PaymentCaptureStatus;
|
|
@@ -7552,6 +7562,7 @@ declare namespace io.flow.v0.models {
|
|
|
7552
7562
|
interface PaymentCaptureForm {
|
|
7553
7563
|
readonly amount?: number;
|
|
7554
7564
|
readonly currency?: string;
|
|
7565
|
+
readonly reference?: string;
|
|
7555
7566
|
readonly attributes?: Record<string, string>;
|
|
7556
7567
|
}
|
|
7557
7568
|
interface PaymentCaptureOptionAutomaticImmediate {
|
|
@@ -7677,6 +7688,7 @@ declare namespace io.flow.v0.models {
|
|
|
7677
7688
|
readonly device_fingerprint_details: io.flow.v0.unions.DeviceFingerprintDetails;
|
|
7678
7689
|
readonly cvv?: string;
|
|
7679
7690
|
readonly stored_details_card?: io.flow.v0.unions.PaymentMethodStoredDetailsCard;
|
|
7691
|
+
readonly reference?: string;
|
|
7680
7692
|
}
|
|
7681
7693
|
interface PaymentMethodDataAuthorizeGooglepay {
|
|
7682
7694
|
readonly type: 'authorize_googlepay';
|
|
@@ -7705,35 +7717,36 @@ declare namespace io.flow.v0.models {
|
|
|
7705
7717
|
}
|
|
7706
7718
|
interface PaymentMethodDataInitAfterpay {
|
|
7707
7719
|
readonly type: 'init_afterpay';
|
|
7708
|
-
readonly
|
|
7720
|
+
readonly reference?: string;
|
|
7709
7721
|
}
|
|
7710
7722
|
interface PaymentMethodDataInitApplepay {
|
|
7711
7723
|
readonly type: 'init_applepay';
|
|
7712
|
-
readonly
|
|
7724
|
+
readonly reference?: string;
|
|
7713
7725
|
}
|
|
7714
7726
|
interface PaymentMethodDataInitBancontact {
|
|
7715
7727
|
readonly type: 'init_bancontact';
|
|
7716
|
-
readonly
|
|
7728
|
+
readonly reference?: string;
|
|
7717
7729
|
}
|
|
7718
7730
|
interface PaymentMethodDataInitGooglepay {
|
|
7719
7731
|
readonly type: 'init_googlepay';
|
|
7720
|
-
readonly
|
|
7732
|
+
readonly reference?: string;
|
|
7721
7733
|
}
|
|
7722
7734
|
interface PaymentMethodDataInitIdeal {
|
|
7723
7735
|
readonly type: 'init_ideal';
|
|
7724
7736
|
readonly issuer?: string;
|
|
7737
|
+
readonly reference?: string;
|
|
7725
7738
|
}
|
|
7726
7739
|
interface PaymentMethodDataInitKlarna {
|
|
7727
7740
|
readonly type: 'init_klarna';
|
|
7728
|
-
readonly
|
|
7741
|
+
readonly reference?: string;
|
|
7729
7742
|
}
|
|
7730
7743
|
interface PaymentMethodDataInitPaypal {
|
|
7731
7744
|
readonly type: 'init_paypal';
|
|
7732
|
-
readonly
|
|
7745
|
+
readonly reference?: string;
|
|
7733
7746
|
}
|
|
7734
7747
|
interface PaymentMethodDataInitSofort {
|
|
7735
7748
|
readonly type: 'init_sofort';
|
|
7736
|
-
readonly
|
|
7749
|
+
readonly reference?: string;
|
|
7737
7750
|
}
|
|
7738
7751
|
interface PaymentMethodDataOptionLogoSvg {
|
|
7739
7752
|
readonly type: 'svg';
|
|
@@ -7832,7 +7845,7 @@ declare namespace io.flow.v0.models {
|
|
|
7832
7845
|
readonly merchant_of_record: io.flow.v0.enums.MerchantOfRecord;
|
|
7833
7846
|
}
|
|
7834
7847
|
interface PaymentOrderDetailsLineItem {
|
|
7835
|
-
readonly id
|
|
7848
|
+
readonly id?: string;
|
|
7836
7849
|
readonly description: string;
|
|
7837
7850
|
readonly quantity: number;
|
|
7838
7851
|
readonly amount: number;
|
|
@@ -7909,6 +7922,7 @@ declare namespace io.flow.v0.models {
|
|
|
7909
7922
|
readonly currency: string;
|
|
7910
7923
|
readonly base_amount?: number;
|
|
7911
7924
|
readonly base_currency?: string;
|
|
7925
|
+
readonly reference?: string;
|
|
7912
7926
|
readonly created_at: string;
|
|
7913
7927
|
readonly updated_at: string;
|
|
7914
7928
|
readonly status: io.flow.v0.models.PaymentRefundStatus;
|
|
@@ -7916,6 +7930,7 @@ declare namespace io.flow.v0.models {
|
|
|
7916
7930
|
interface PaymentRefundForm {
|
|
7917
7931
|
readonly amount?: number;
|
|
7918
7932
|
readonly currency?: string;
|
|
7933
|
+
readonly reference?: string;
|
|
7919
7934
|
}
|
|
7920
7935
|
interface PaymentRefundStatus {
|
|
7921
7936
|
readonly status: io.flow.v0.enums.RefundStatus;
|
|
@@ -8009,6 +8024,7 @@ declare namespace io.flow.v0.models {
|
|
|
8009
8024
|
readonly currency: string;
|
|
8010
8025
|
readonly base_amount?: number;
|
|
8011
8026
|
readonly base_currency?: string;
|
|
8027
|
+
readonly reference?: string;
|
|
8012
8028
|
readonly created_at: string;
|
|
8013
8029
|
readonly updated_at: string;
|
|
8014
8030
|
readonly status: io.flow.v0.models.PaymentReversalStatus;
|
|
@@ -8016,6 +8032,7 @@ declare namespace io.flow.v0.models {
|
|
|
8016
8032
|
interface PaymentReversalForm {
|
|
8017
8033
|
readonly amount?: number;
|
|
8018
8034
|
readonly currency?: string;
|
|
8035
|
+
readonly reference?: string;
|
|
8019
8036
|
}
|
|
8020
8037
|
interface PaymentReversalStatus {
|
|
8021
8038
|
readonly status: io.flow.v0.enums.ReversalStatus;
|
|
@@ -8402,7 +8419,7 @@ declare namespace io.flow.v0.models {
|
|
|
8402
8419
|
readonly event_id: string;
|
|
8403
8420
|
readonly timestamp: string;
|
|
8404
8421
|
readonly organization: string;
|
|
8405
|
-
readonly
|
|
8422
|
+
readonly id: string;
|
|
8406
8423
|
}
|
|
8407
8424
|
interface ProductRestrictionResultUpserted {
|
|
8408
8425
|
readonly discriminator: 'product_restriction_result_upserted';
|
|
@@ -10605,10 +10622,16 @@ declare namespace io.flow.v0.models {
|
|
|
10605
10622
|
readonly carrier_id: string;
|
|
10606
10623
|
readonly carrier_tracking_number: string;
|
|
10607
10624
|
readonly revenue_share_percentage: number;
|
|
10608
|
-
readonly outbound?: io.flow.v0.models.
|
|
10625
|
+
readonly outbound?: io.flow.v0.models.TransactionMetadataOutboundTransaction;
|
|
10609
10626
|
}
|
|
10610
|
-
interface
|
|
10611
|
-
readonly
|
|
10627
|
+
interface TransactionMetadataCarrierFee {
|
|
10628
|
+
readonly discriminator: 'carrier_fee';
|
|
10629
|
+
readonly outbound: io.flow.v0.models.TransactionMetadataOutboundTransaction;
|
|
10630
|
+
readonly estimate: io.flow.v0.models.TransactionMetadataCarrierFeeData;
|
|
10631
|
+
readonly actual: io.flow.v0.models.TransactionMetadataCarrierFeeData;
|
|
10632
|
+
}
|
|
10633
|
+
interface TransactionMetadataCarrierFeeData {
|
|
10634
|
+
readonly surcharges: io.flow.v0.models.TrueupLabelSurcharge[];
|
|
10612
10635
|
}
|
|
10613
10636
|
interface TransactionMetadataChannel {
|
|
10614
10637
|
readonly discriminator: 'channel';
|
|
@@ -10632,6 +10655,13 @@ declare namespace io.flow.v0.models {
|
|
|
10632
10655
|
interface TransactionMetadataOriginalTransaction {
|
|
10633
10656
|
readonly id: string;
|
|
10634
10657
|
}
|
|
10658
|
+
interface TransactionMetadataOutboundTransaction {
|
|
10659
|
+
readonly transaction_id: string;
|
|
10660
|
+
}
|
|
10661
|
+
interface TransactionMetadataPaymentTransaction {
|
|
10662
|
+
readonly discriminator: 'payment_transaction';
|
|
10663
|
+
readonly key?: string;
|
|
10664
|
+
}
|
|
10635
10665
|
interface TransactionMetadataShippingLabel {
|
|
10636
10666
|
readonly discriminator: 'shipping_label';
|
|
10637
10667
|
readonly request_method?: io.flow.v0.enums.LabelRequestMethod;
|
|
@@ -10785,10 +10815,6 @@ declare namespace io.flow.v0.models {
|
|
|
10785
10815
|
readonly type: io.flow.v0.enums.ChangeType;
|
|
10786
10816
|
readonly virtual_card_capture: io.flow.v0.models.VirtualCardCapture;
|
|
10787
10817
|
}
|
|
10788
|
-
interface VirtualCardForm {
|
|
10789
|
-
readonly limit: io.flow.v0.models.Money;
|
|
10790
|
-
readonly attributes?: Record<string, string>;
|
|
10791
|
-
}
|
|
10792
10818
|
interface VirtualCardReference {
|
|
10793
10819
|
readonly id: string;
|
|
10794
10820
|
}
|
|
@@ -11005,7 +11031,7 @@ declare namespace io.flow.v0.unions {
|
|
|
11005
11031
|
type Token = io.flow.v0.models.ChannelToken | io.flow.v0.models.OrganizationToken | io.flow.v0.models.OrganizationTokenV2 | io.flow.v0.models.PartnerToken;
|
|
11006
11032
|
type TokenReference = io.flow.v0.models.ChannelTokenReference | io.flow.v0.models.OrganizationTokenReference | io.flow.v0.models.OrganizationTokenV2Reference | io.flow.v0.models.PartnerTokenReference;
|
|
11007
11033
|
type TransactionDetails = io.flow.v0.models.TransactionDetailsCard;
|
|
11008
|
-
type TransactionMetadata = io.flow.v0.models.TransactionMetadataShippingLabel | io.flow.v0.models.TransactionMetadataChannel | io.flow.v0.models.TransactionMetadataTrueup | io.flow.v0.models.TransactionMetadataCarrierCharge | io.flow.v0.models.TransactionMetadataManual;
|
|
11034
|
+
type TransactionMetadata = io.flow.v0.models.TransactionMetadataShippingLabel | io.flow.v0.models.TransactionMetadataChannel | io.flow.v0.models.TransactionMetadataTrueup | io.flow.v0.models.TransactionMetadataCarrierCharge | io.flow.v0.models.TransactionMetadataCarrierFee | io.flow.v0.models.TransactionMetadataManual | io.flow.v0.models.TransactionMetadataPaymentTransaction;
|
|
11009
11035
|
}
|
|
11010
11036
|
export declare type AbandonedOrderEmailSettings = io.flow.v0.models.AbandonedOrderEmailSettings;
|
|
11011
11037
|
export declare type AbandonedOrderPromotion = io.flow.v0.models.AbandonedOrderPromotion;
|
|
@@ -12683,12 +12709,15 @@ export declare type TransactionDetails = io.flow.v0.unions.TransactionDetails;
|
|
|
12683
12709
|
export declare type TransactionDetailsCard = io.flow.v0.models.TransactionDetailsCard;
|
|
12684
12710
|
export declare type TransactionMetadata = io.flow.v0.unions.TransactionMetadata;
|
|
12685
12711
|
export declare type TransactionMetadataCarrierCharge = io.flow.v0.models.TransactionMetadataCarrierCharge;
|
|
12686
|
-
export declare type
|
|
12712
|
+
export declare type TransactionMetadataCarrierFee = io.flow.v0.models.TransactionMetadataCarrierFee;
|
|
12713
|
+
export declare type TransactionMetadataCarrierFeeData = io.flow.v0.models.TransactionMetadataCarrierFeeData;
|
|
12687
12714
|
export declare type TransactionMetadataChannel = io.flow.v0.models.TransactionMetadataChannel;
|
|
12688
12715
|
export declare type TransactionMetadataChannelCardMetadata = io.flow.v0.models.TransactionMetadataChannelCardMetadata;
|
|
12689
12716
|
export declare type TransactionMetadataChannelCardMetadataIssuerSummary = io.flow.v0.models.TransactionMetadataChannelCardMetadataIssuerSummary;
|
|
12690
12717
|
export declare type TransactionMetadataManual = io.flow.v0.models.TransactionMetadataManual;
|
|
12691
12718
|
export declare type TransactionMetadataOriginalTransaction = io.flow.v0.models.TransactionMetadataOriginalTransaction;
|
|
12719
|
+
export declare type TransactionMetadataOutboundTransaction = io.flow.v0.models.TransactionMetadataOutboundTransaction;
|
|
12720
|
+
export declare type TransactionMetadataPaymentTransaction = io.flow.v0.models.TransactionMetadataPaymentTransaction;
|
|
12692
12721
|
export declare type TransactionMetadataShippingLabel = io.flow.v0.models.TransactionMetadataShippingLabel;
|
|
12693
12722
|
export declare type TransactionMetadataShippingLabelCarrier = io.flow.v0.models.TransactionMetadataShippingLabelCarrier;
|
|
12694
12723
|
export declare type TransactionMetadataTrueup = io.flow.v0.models.TransactionMetadataTrueup;
|
|
@@ -12727,7 +12756,6 @@ export declare type VirtualCardCapture = io.flow.v0.models.VirtualCardCapture;
|
|
|
12727
12756
|
export declare type VirtualCardCaptureDeleted = io.flow.v0.models.VirtualCardCaptureDeleted;
|
|
12728
12757
|
export declare type VirtualCardCaptureUpserted = io.flow.v0.models.VirtualCardCaptureUpserted;
|
|
12729
12758
|
export declare type VirtualCardCaptureVersion = io.flow.v0.models.VirtualCardCaptureVersion;
|
|
12730
|
-
export declare type VirtualCardForm = io.flow.v0.models.VirtualCardForm;
|
|
12731
12759
|
export declare type VirtualCardReference = io.flow.v0.models.VirtualCardReference;
|
|
12732
12760
|
export declare type VirtualCardRefund = io.flow.v0.models.VirtualCardRefund;
|
|
12733
12761
|
export declare type VirtualCardRefundDeleted = io.flow.v0.models.VirtualCardRefundDeleted;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flowio/types",
|
|
3
|
-
"version": "11.24.
|
|
3
|
+
"version": "11.24.94",
|
|
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",
|
|
@@ -25,5 +25,5 @@
|
|
|
25
25
|
"maintainers": [
|
|
26
26
|
"Christian Muñoz <christian.munoz@flow.io>"
|
|
27
27
|
],
|
|
28
|
-
"gitHead": "
|
|
28
|
+
"gitHead": "237a816e178ccd4501b30aaf454fb6a93392afd9"
|
|
29
29
|
}
|