@flowio/types 11.24.68 → 11.24.70
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 +209 -189
- package/dist/api.d.ts +88 -7
- package/package.json +2 -2
- package/src/api-internal.ts +271 -246
- package/src/api.ts +113 -5
package/dist/api.d.ts
CHANGED
|
@@ -267,6 +267,7 @@ declare namespace io.flow.stripe.v0.models {
|
|
|
267
267
|
readonly id: string;
|
|
268
268
|
readonly amount: number;
|
|
269
269
|
readonly amount_refunded: number;
|
|
270
|
+
readonly authorization_code?: string;
|
|
270
271
|
readonly captured: boolean;
|
|
271
272
|
readonly created: number;
|
|
272
273
|
readonly currency: string;
|
|
@@ -314,6 +315,7 @@ declare namespace io.flow.stripe.v0.models {
|
|
|
314
315
|
readonly id: string;
|
|
315
316
|
readonly amount: number;
|
|
316
317
|
readonly amount_refunded: number;
|
|
318
|
+
readonly authorization_code?: string;
|
|
317
319
|
readonly captured: boolean;
|
|
318
320
|
readonly created: number;
|
|
319
321
|
readonly currency: string;
|
|
@@ -826,9 +828,11 @@ declare namespace io.flow.stripe.v0.models {
|
|
|
826
828
|
readonly customer?: string;
|
|
827
829
|
}
|
|
828
830
|
interface ThreeDSecureCharge {
|
|
831
|
+
readonly authenticated?: boolean;
|
|
829
832
|
readonly authentication_flow?: io.flow.stripe.v0.enums.ThreeDsAuthenticationFlow;
|
|
830
833
|
readonly result?: io.flow.stripe.v0.enums.ThreeDsResult;
|
|
831
834
|
readonly result_reason?: io.flow.stripe.v0.enums.ThreeDsResultReason;
|
|
835
|
+
readonly succeeded?: boolean;
|
|
832
836
|
readonly version?: string;
|
|
833
837
|
}
|
|
834
838
|
interface ThreeDSecureRedirect {
|
|
@@ -1772,8 +1776,7 @@ declare namespace io.flow.error.v0.models {
|
|
|
1772
1776
|
}
|
|
1773
1777
|
}
|
|
1774
1778
|
declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.enums {
|
|
1775
|
-
type TrueUpSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak';
|
|
1776
|
-
type WeightSelection = 'dead' | 'dimensional';
|
|
1779
|
+
type TrueUpSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction';
|
|
1777
1780
|
}
|
|
1778
1781
|
declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.models {
|
|
1779
1782
|
interface LabelBase {
|
|
@@ -1793,10 +1796,38 @@ declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.models {
|
|
|
1793
1796
|
readonly destination: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelDestination;
|
|
1794
1797
|
readonly metadata: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelMetadata;
|
|
1795
1798
|
}
|
|
1799
|
+
interface LabelInvoiceResponseFile {
|
|
1800
|
+
readonly id: string;
|
|
1801
|
+
readonly url: string;
|
|
1802
|
+
readonly created_at: string;
|
|
1803
|
+
readonly result?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelInvoiceResponseFileResult;
|
|
1804
|
+
}
|
|
1805
|
+
interface LabelInvoiceResponseFileForm {
|
|
1806
|
+
readonly url: string;
|
|
1807
|
+
}
|
|
1808
|
+
interface LabelInvoiceResponseFileResult {
|
|
1809
|
+
readonly processed_at: string;
|
|
1810
|
+
readonly number_lines_successful: number;
|
|
1811
|
+
readonly number_lines_with_errors: number;
|
|
1812
|
+
readonly errors_url?: string;
|
|
1813
|
+
}
|
|
1814
|
+
interface LabelInvoiceResponseForm {
|
|
1815
|
+
readonly id: string;
|
|
1816
|
+
readonly label_invoice_request_id: string;
|
|
1817
|
+
readonly units: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelResponseUnits;
|
|
1818
|
+
readonly base: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelBase;
|
|
1819
|
+
readonly surcharges: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeForm;
|
|
1820
|
+
readonly total: number;
|
|
1821
|
+
}
|
|
1796
1822
|
interface LabelMetadata {
|
|
1797
1823
|
readonly ratecard: io.flow.billing.RESERVED_WORD_true.up.v0.models.MetadataRatecard;
|
|
1798
1824
|
readonly weights: io.flow.billing.RESERVED_WORD_true.up.v0.models.MetadataWeights;
|
|
1799
1825
|
}
|
|
1826
|
+
interface LabelResponseUnits {
|
|
1827
|
+
readonly currency: string;
|
|
1828
|
+
readonly weight: io.flow.units.v0.enums.UnitOfWeight;
|
|
1829
|
+
readonly length?: io.flow.units.v0.enums.UnitOfLength;
|
|
1830
|
+
}
|
|
1800
1831
|
interface LabelSurcharge {
|
|
1801
1832
|
readonly amount: number;
|
|
1802
1833
|
readonly type: io.flow.billing.RESERVED_WORD_true.up.v0.enums.TrueUpSurchargeType;
|
|
@@ -1814,6 +1845,20 @@ declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.models {
|
|
|
1814
1845
|
readonly discriminator: 'percentage';
|
|
1815
1846
|
readonly percentage: number;
|
|
1816
1847
|
}
|
|
1848
|
+
interface LabelSurchargeForm {
|
|
1849
|
+
readonly fuel?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
|
|
1850
|
+
readonly remote_area?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
|
|
1851
|
+
readonly oversize?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
|
|
1852
|
+
readonly duties_paid?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
|
|
1853
|
+
readonly emergency?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
|
|
1854
|
+
readonly peak?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
|
|
1855
|
+
readonly address_correction?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
|
|
1856
|
+
}
|
|
1857
|
+
interface LabelSurchargeSingleForm {
|
|
1858
|
+
readonly amount: number;
|
|
1859
|
+
readonly percentage?: number;
|
|
1860
|
+
readonly fee_per_weight_unit?: number;
|
|
1861
|
+
}
|
|
1817
1862
|
interface LabelUnits {
|
|
1818
1863
|
readonly currency: string;
|
|
1819
1864
|
readonly weight: io.flow.units.v0.enums.UnitOfWeight;
|
|
@@ -1828,7 +1873,6 @@ declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.models {
|
|
|
1828
1873
|
readonly proposition: io.flow.billing.RESERVED_WORD_true.up.v0.models.MetadataProposition;
|
|
1829
1874
|
}
|
|
1830
1875
|
interface MetadataWeights {
|
|
1831
|
-
readonly selected: io.flow.billing.RESERVED_WORD_true.up.v0.enums.WeightSelection;
|
|
1832
1876
|
readonly dead?: io.flow.billing.RESERVED_WORD_true.up.v0.models.WeightsDead;
|
|
1833
1877
|
readonly dimensional?: io.flow.billing.RESERVED_WORD_true.up.v0.models.WeightsDimensional;
|
|
1834
1878
|
}
|
|
@@ -1967,7 +2011,7 @@ declare namespace io.flow.v0.enums {
|
|
|
1967
2011
|
type OrderChangeSource = 'consumer' | 'retailer' | 'fulfillment' | 'flow' | 'carrier';
|
|
1968
2012
|
type OrderErrorCode = 'generic_error' | 'order_item_not_available' | 'order_identifier_error' | 'authorization_invalid' | 'domestic_shipping_unavailable' | 'shipping_unavailable' | 'value_threshold_exceeded' | 'invalid_currency' | 'invalid_country' | 'invalid_region' | 'invalid_language' | 'item_out_of_stock' | 'gift_card_not_accepted' | 'total_changed';
|
|
1969
2013
|
type OrderMerchantOfRecord = 'flow' | 'organization' | 'mixed';
|
|
1970
|
-
type OrderPaymentType = 'card' | 'online' | 'credit' | 'subsidized' | 'installment_plan' | 'cash_on_delivery';
|
|
2014
|
+
type OrderPaymentType = 'card' | 'online' | 'credit' | 'external' | 'subsidized' | 'installment_plan' | 'cash_on_delivery';
|
|
1971
2015
|
type OrderPriceDetailComponentKey = 'adjustment' | 'vat_deminimis' | 'duty_deminimis' | 'duties_item_price' | 'duties_freight' | 'duties_insurance' | 'vat_item_price' | 'vat_freight' | 'vat_insurance' | 'vat_duties_item_price' | 'vat_duties_freight' | 'vat_duties_insurance' | 'item_price' | 'item_discount' | 'rounding' | 'insurance' | 'shipping' | 'shipping_discount' | 'order_discount' | 'subtotal_percent_sales_margin' | 'subtotal_vat_percent_sales_margin' | 'subtotal_duty_percent_sales_margin' | 'vat_subsidy' | 'duty_subsidy' | 'remote_area_surcharge' | 'fuel_surcharge' | 'emergency_situation_surcharge' | 'peak_surcharge' | 'duties_taxes_paid_surcharge';
|
|
1972
2016
|
type OrderPriceDetailKey = 'adjustment' | 'subtotal' | 'vat' | 'duty' | 'shipping' | 'insurance' | 'discount' | 'surcharges';
|
|
1973
2017
|
type OrderQuoteAddressType = 'shipping';
|
|
@@ -1990,7 +2034,7 @@ declare namespace io.flow.v0.enums {
|
|
|
1990
2034
|
type PaymentMethodRuleContentKey = 'description';
|
|
1991
2035
|
type PaymentMethodType = 'card' | 'online' | 'offline';
|
|
1992
2036
|
type PaymentRequestReviewCheckStatus = 'passed' | 'failed';
|
|
1993
|
-
type PaymentRequestReviewCheckType = 'restricted_party_screening' | 'fraud_suspicious_behavior' | 'fraud_suspicious_past_activity' | 'fraud_risky_velocity' | 'fraud_previous_chargebacks' | 'order_restricted_goods' | 'order_unsupported_destination' | 'order_missing_information' | 'order_domestic';
|
|
2037
|
+
type PaymentRequestReviewCheckType = 'restricted_party_screening' | 'fraud_suspicious_behavior' | 'fraud_suspicious_past_activity' | 'fraud_risky_velocity' | 'fraud_previous_chargebacks' | 'order_restricted_goods' | 'order_unsupported_destination' | 'order_missing_information' | 'order_domestic' | 'order_mismatched_currencies';
|
|
1994
2038
|
type PaymentRequestReviewStatus = 'pending' | 'approved' | 'rejected';
|
|
1995
2039
|
type PaymentSourceConfirmationActionType = 'cvv' | 'billing_address' | 'number';
|
|
1996
2040
|
type PaymentStatus = 'requires_payment_method' | 'requires_action' | 'processing' | 'cancelled' | 'expired' | 'authorized' | 'reversed' | 'captured' | 'refunded' | 'in_dispute' | 'charged_back';
|
|
@@ -2056,7 +2100,9 @@ declare namespace io.flow.v0.enums {
|
|
|
2056
2100
|
type TradeAgreementName = 'USMCA' | 'T-MEC' | 'CUSMA' | 'TCA';
|
|
2057
2101
|
type TradeAgreementStatus = 'supported' | 'not_supported';
|
|
2058
2102
|
type TransactionPayoutPendingReason = 'waiting_for_full_refund' | 'waiting_for_fulfillment' | 'waiting_for_in_transit' | 'waiting_for_next_payout_date' | 'external_fulfillment_missing_tracking_info' | 'waiting_for_positive_account_balance';
|
|
2059
|
-
type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
|
|
2103
|
+
type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'trueup' | 'shipping_label_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
|
|
2104
|
+
type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
|
|
2105
|
+
type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction';
|
|
2060
2106
|
type UnitOfLength = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'meter';
|
|
2061
2107
|
type UnitOfMeasurement = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'cubic_inch' | 'cubic_meter' | 'gram' | 'kilogram' | 'meter' | 'ounce' | 'pound';
|
|
2062
2108
|
type UnitOfTime = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute';
|
|
@@ -5763,6 +5809,7 @@ declare namespace io.flow.v0.models {
|
|
|
5763
5809
|
readonly discriminator: 'know_your_business_usa';
|
|
5764
5810
|
readonly id: string;
|
|
5765
5811
|
readonly organization_id: string;
|
|
5812
|
+
readonly shop?: io.flow.v0.models.Shop;
|
|
5766
5813
|
readonly primary_entity: io.flow.v0.unions.Entity;
|
|
5767
5814
|
readonly parent_company?: io.flow.v0.models.Company;
|
|
5768
5815
|
readonly ultimate_parent_company?: io.flow.v0.models.Company;
|
|
@@ -7153,6 +7200,7 @@ declare namespace io.flow.v0.models {
|
|
|
7153
7200
|
readonly current_state: io.flow.v0.unions.OnboardingState;
|
|
7154
7201
|
readonly started_at?: string;
|
|
7155
7202
|
readonly time_blocked?: number;
|
|
7203
|
+
readonly time_in_setup?: number;
|
|
7156
7204
|
readonly blocked_since?: string;
|
|
7157
7205
|
readonly completed_at?: string;
|
|
7158
7206
|
readonly onboarding_started_at?: string;
|
|
@@ -10446,6 +10494,18 @@ declare namespace io.flow.v0.models {
|
|
|
10446
10494
|
readonly discriminator: 'shipping_label';
|
|
10447
10495
|
readonly request_method?: io.flow.v0.enums.LabelRequestMethod;
|
|
10448
10496
|
}
|
|
10497
|
+
interface TransactionMetadataTrueup {
|
|
10498
|
+
readonly discriminator: 'trueup';
|
|
10499
|
+
readonly estimate: io.flow.v0.models.TransactionMetadataTrueupData;
|
|
10500
|
+
readonly actual: io.flow.v0.models.TransactionMetadataTrueupData;
|
|
10501
|
+
}
|
|
10502
|
+
interface TransactionMetadataTrueupData {
|
|
10503
|
+
readonly source: io.flow.v0.enums.TrueupSource;
|
|
10504
|
+
readonly units: io.flow.v0.models.TrueupLabelUnits;
|
|
10505
|
+
readonly base: io.flow.v0.models.TrueupLabelBase;
|
|
10506
|
+
readonly surcharges: io.flow.v0.models.TrueupLabelSurcharge[];
|
|
10507
|
+
readonly total: number;
|
|
10508
|
+
}
|
|
10449
10509
|
interface TransactionNetworkDetailsCard {
|
|
10450
10510
|
readonly network_transaction_id?: string;
|
|
10451
10511
|
readonly network?: io.flow.v0.enums.CardType;
|
|
@@ -10473,6 +10533,20 @@ declare namespace io.flow.v0.models {
|
|
|
10473
10533
|
readonly from: number;
|
|
10474
10534
|
readonly to: number;
|
|
10475
10535
|
}
|
|
10536
|
+
interface TrueupLabelBase {
|
|
10537
|
+
readonly amount: number;
|
|
10538
|
+
readonly weight: number;
|
|
10539
|
+
}
|
|
10540
|
+
interface TrueupLabelSurcharge {
|
|
10541
|
+
readonly amount: number;
|
|
10542
|
+
readonly type: io.flow.v0.enums.TrueupSurchargeType;
|
|
10543
|
+
readonly percentage?: number;
|
|
10544
|
+
readonly per_weight_unit?: number;
|
|
10545
|
+
}
|
|
10546
|
+
interface TrueupLabelUnits {
|
|
10547
|
+
readonly weight: io.flow.v0.enums.UnitOfWeight;
|
|
10548
|
+
readonly length?: io.flow.v0.enums.UnitOfLength;
|
|
10549
|
+
}
|
|
10476
10550
|
interface UltimateBeneficiaryOwner {
|
|
10477
10551
|
readonly name: string;
|
|
10478
10552
|
readonly dob: string;
|
|
@@ -10778,7 +10852,7 @@ declare namespace io.flow.v0.unions {
|
|
|
10778
10852
|
type Token = io.flow.v0.models.ChannelToken | io.flow.v0.models.OrganizationToken | io.flow.v0.models.OrganizationTokenV2 | io.flow.v0.models.PartnerToken;
|
|
10779
10853
|
type TokenReference = io.flow.v0.models.ChannelTokenReference | io.flow.v0.models.OrganizationTokenReference | io.flow.v0.models.OrganizationTokenV2Reference | io.flow.v0.models.PartnerTokenReference;
|
|
10780
10854
|
type TransactionDetails = io.flow.v0.models.TransactionDetailsCard;
|
|
10781
|
-
type TransactionMetadata = io.flow.v0.models.TransactionMetadataShippingLabel;
|
|
10855
|
+
type TransactionMetadata = io.flow.v0.models.TransactionMetadataShippingLabel | io.flow.v0.models.TransactionMetadataTrueup;
|
|
10782
10856
|
}
|
|
10783
10857
|
export declare type AbandonedOrderEmailSettings = io.flow.v0.models.AbandonedOrderEmailSettings;
|
|
10784
10858
|
export declare type AbandonedOrderPromotion = io.flow.v0.models.AbandonedOrderPromotion;
|
|
@@ -12438,6 +12512,8 @@ export declare type TransactionDetails = io.flow.v0.unions.TransactionDetails;
|
|
|
12438
12512
|
export declare type TransactionDetailsCard = io.flow.v0.models.TransactionDetailsCard;
|
|
12439
12513
|
export declare type TransactionMetadata = io.flow.v0.unions.TransactionMetadata;
|
|
12440
12514
|
export declare type TransactionMetadataShippingLabel = io.flow.v0.models.TransactionMetadataShippingLabel;
|
|
12515
|
+
export declare type TransactionMetadataTrueup = io.flow.v0.models.TransactionMetadataTrueup;
|
|
12516
|
+
export declare type TransactionMetadataTrueupData = io.flow.v0.models.TransactionMetadataTrueupData;
|
|
12441
12517
|
export declare type TransactionNetworkDetailsCard = io.flow.v0.models.TransactionNetworkDetailsCard;
|
|
12442
12518
|
export declare type TransactionPayoutPendingReason = io.flow.v0.enums.TransactionPayoutPendingReason;
|
|
12443
12519
|
export declare type TransactionReference = io.flow.v0.models.TransactionReference;
|
|
@@ -12445,6 +12521,11 @@ export declare type TransactionSource = io.flow.v0.enums.TransactionSource;
|
|
|
12445
12521
|
export declare type TransactionUpserted = io.flow.v0.models.TransactionUpserted;
|
|
12446
12522
|
export declare type TransitEstimate = io.flow.v0.models.TransitEstimate;
|
|
12447
12523
|
export declare type TransitWindow = io.flow.v0.models.TransitWindow;
|
|
12524
|
+
export declare type TrueupLabelBase = io.flow.v0.models.TrueupLabelBase;
|
|
12525
|
+
export declare type TrueupLabelSurcharge = io.flow.v0.models.TrueupLabelSurcharge;
|
|
12526
|
+
export declare type TrueupLabelUnits = io.flow.v0.models.TrueupLabelUnits;
|
|
12527
|
+
export declare type TrueupSource = io.flow.v0.enums.TrueupSource;
|
|
12528
|
+
export declare type TrueupSurchargeType = io.flow.v0.enums.TrueupSurchargeType;
|
|
12448
12529
|
export declare type UltimateBeneficiaryOwner = io.flow.v0.models.UltimateBeneficiaryOwner;
|
|
12449
12530
|
export declare type UnharmonizedItemExportType = io.flow.v0.models.UnharmonizedItemExportType;
|
|
12450
12531
|
export declare type UnitOfLength = io.flow.v0.enums.UnitOfLength;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flowio/types",
|
|
3
|
-
"version": "11.24.
|
|
3
|
+
"version": "11.24.70",
|
|
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": "1c87d63f654d1b7f4aa3ef5237a2cf0558fda3d5"
|
|
29
29
|
}
|