@flowio/api-types 0.0.211 → 0.0.212
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/generated/io.flow.billing.csv.v0.billing-csv.d.ts +7 -0
- package/generated/io.flow.billing.internal.v0.billing-internal.d.ts +19 -4
- package/generated/io.flow.billing.reporting.csv.v0.billing-reporting-csv.d.ts +22 -245
- package/generated/io.flow.billing.reporting.v0.billing-reporting.d.ts +289 -0
- package/generated/io.flow.billing.v0.billing.d.ts +9 -2
- package/generated/io.flow.internal.v0.api-internal.d.ts +296 -13
- package/generated/io.flow.payment.gateway.v0.payment-gateway.d.ts +10 -0
- package/generated/io.flow.payment.request.bundle.v0.payment-request-bundle.d.ts +6 -0
- package/generated/io.flow.shopify.markets.v0.shopify-markets.d.ts +13 -1
- package/generated/io.flow.trueup.v0.trueup.d.ts +1 -0
- package/generated/io.flow.v0.api.d.ts +30 -6
- package/index.d.ts +1 -0
- package/package.json +2 -2
|
@@ -187,6 +187,8 @@ declare namespace io.flow.payment.gateway.v0.models {
|
|
|
187
187
|
readonly 'status': io.flow.payment.gateway.v0.models.PaymentAuthorizationStatus;
|
|
188
188
|
readonly 'amount': number;
|
|
189
189
|
readonly 'currency': string;
|
|
190
|
+
readonly 'base_amount'?: number;
|
|
191
|
+
readonly 'base_currency'?: string;
|
|
190
192
|
}
|
|
191
193
|
|
|
192
194
|
interface PaymentAuthorizationStatus {
|
|
@@ -198,6 +200,8 @@ declare namespace io.flow.payment.gateway.v0.models {
|
|
|
198
200
|
readonly 'id': string;
|
|
199
201
|
readonly 'amount': number;
|
|
200
202
|
readonly 'currency': string;
|
|
203
|
+
readonly 'base_amount'?: number;
|
|
204
|
+
readonly 'base_currency'?: string;
|
|
201
205
|
readonly 'created_at': string;
|
|
202
206
|
readonly 'updated_at': string;
|
|
203
207
|
readonly 'status': io.flow.payment.gateway.v0.models.PaymentCaptureStatus;
|
|
@@ -504,6 +508,8 @@ declare namespace io.flow.payment.gateway.v0.models {
|
|
|
504
508
|
readonly 'id': string;
|
|
505
509
|
readonly 'amount': number;
|
|
506
510
|
readonly 'currency': string;
|
|
511
|
+
readonly 'base_amount'?: number;
|
|
512
|
+
readonly 'base_currency'?: string;
|
|
507
513
|
readonly 'created_at': string;
|
|
508
514
|
readonly 'updated_at': string;
|
|
509
515
|
readonly 'status': io.flow.payment.gateway.v0.models.PaymentRefundStatus;
|
|
@@ -529,6 +535,8 @@ declare namespace io.flow.payment.gateway.v0.models {
|
|
|
529
535
|
readonly 'next_action'?: io.flow.payment.gateway.v0.unions.Action;
|
|
530
536
|
readonly 'amount': number;
|
|
531
537
|
readonly 'currency': string;
|
|
538
|
+
readonly 'base_amount'?: number;
|
|
539
|
+
readonly 'base_currency'?: string;
|
|
532
540
|
readonly 'order_information': io.flow.payment.gateway.v0.unions.OrderInformation;
|
|
533
541
|
readonly 'device_details': io.flow.payment.v0.unions.DeviceDetails;
|
|
534
542
|
readonly 'locale'?: string;
|
|
@@ -574,6 +582,8 @@ declare namespace io.flow.payment.gateway.v0.models {
|
|
|
574
582
|
readonly 'id': string;
|
|
575
583
|
readonly 'amount': number;
|
|
576
584
|
readonly 'currency': string;
|
|
585
|
+
readonly 'base_amount'?: number;
|
|
586
|
+
readonly 'base_currency'?: string;
|
|
577
587
|
readonly 'created_at': string;
|
|
578
588
|
readonly 'updated_at': string;
|
|
579
589
|
readonly 'status': io.flow.payment.gateway.v0.models.PaymentReversalStatus;
|
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
declare namespace io.flow.payment.request.bundle.v0.models {
|
|
2
2
|
interface PaymentRequestBilling {
|
|
3
3
|
readonly 'fees': io.flow.payment.request.bundle.v0.models.PaymentRequestBillingFees;
|
|
4
|
+
readonly 'currency_rate'?: io.flow.payment.request.bundle.v0.models.PaymentRequestBillingCurrencyRate;
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
interface PaymentRequestBillingCurrencyRate {
|
|
8
|
+
readonly 'base_amount': number;
|
|
9
|
+
readonly 'base_currency': string;
|
|
4
10
|
}
|
|
5
11
|
|
|
6
12
|
interface PaymentRequestBillingFees {
|
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
declare namespace io.flow.shopify.markets.v0.enums {
|
|
2
|
+
type BulkOperationErrorCode = 'access_denied' | 'internal_server_error' | 'timeout';
|
|
3
|
+
type BulkOperationStatus = 'canceled' | 'canceling' | 'completed' | 'created' | 'expired' | 'failed' | 'running';
|
|
4
|
+
type BulkOperationType = 'mutation' | 'query';
|
|
2
5
|
type CancelReason = 'customer' | 'fraud' | 'inventory' | 'declined' | 'other';
|
|
3
6
|
type FulfillmentOrderDeliveryMethodType = 'local' | 'none' | 'pick_up' | 'retail' | 'shipping';
|
|
4
7
|
type IncotermDuties = 'DAP' | 'DDP';
|
|
@@ -29,7 +32,7 @@ declare namespace io.flow.shopify.markets.v0.enums {
|
|
|
29
32
|
type ShopifyOrderValueType = 'string' | 'integer';
|
|
30
33
|
type ShopifyTaxExemptions = 'EXEMPT_ALL' | 'CA_STATUS_CARD_EXEMPTION' | 'CA_DIPLOMAT_EXEMPTION' | 'CA_BC_RESELLER_EXEMPTION' | 'CA_MB_RESELLER_EXEMPTION' | 'CA_SK_RESELLER_EXEMPTION' | 'CA_BC_COMMERCIAL_FISHERY_EXEMPTION' | 'CA_MB_COMMERCIAL_FISHERY_EXEMPTION' | 'CA_NS_COMMERCIAL_FISHERY_EXEMPTION' | 'CA_PE_COMMERCIAL_FISHERY_EXEMPTION' | 'CA_SK_COMMERCIAL_FISHERY_EXEMPTION' | 'CA_BC_PRODUCTION_AND_MACHINERY_EXEMPTION' | 'CA_SK_PRODUCTION_AND_MACHINERY_EXEMPTION' | 'CA_BC_SUB_CONTRACTOR_EXEMPTION' | 'CA_SK_SUB_CONTRACTOR_EXEMPTION' | 'CA_BC_CONTRACTOR_EXEMPTION' | 'CA_SK_CONTRACTOR_EXEMPTION' | 'CA_ON_PURCHASE_EXEMPTION' | 'CA_MB_FARMER_EXEMPTION' | 'CA_NS_FARMER_EXEMPTION' | 'CA_SK_FARMER_EXEMPTION';
|
|
31
34
|
type ShopifyWebhookFormat = 'json' | 'xml';
|
|
32
|
-
type ShopifyWebhookTopic = 'customers/redact' | 'customers/data_request' | 'locations/create' | 'locations/update' | 'locations/delete' | 'order_transactions/create' | 'orders/cancelled' | 'orders/create' | 'orders/fulfilled' | 'orders/paid' | 'orders/partially_fulfilled' | 'orders/updated' | 'orders/delete' | 'orders/edited' | 'products/create' | 'products/delete' | 'products/update' | 'inventory_items/create' | 'inventory_items/update' | 'inventory_items/delete' | 'refunds/create' | 'fulfillment_events/create' | 'fulfillment_events/delete' | 'shop/redact' | 'themes/create' | 'themes/publish' | 'themes/update';
|
|
35
|
+
type ShopifyWebhookTopic = 'customers/redact' | 'customers/data_request' | 'locations/create' | 'locations/update' | 'locations/delete' | 'order_transactions/create' | 'orders/cancelled' | 'orders/create' | 'orders/fulfilled' | 'orders/paid' | 'orders/partially_fulfilled' | 'orders/updated' | 'orders/delete' | 'orders/edited' | 'products/create' | 'products/delete' | 'products/update' | 'inventory_items/create' | 'inventory_items/update' | 'inventory_items/delete' | 'refunds/create' | 'fulfillment_events/create' | 'fulfillment_events/delete' | 'shop/redact' | 'themes/create' | 'themes/publish' | 'themes/update' | 'bulk_operations/finish';
|
|
33
36
|
}
|
|
34
37
|
|
|
35
38
|
declare namespace io.flow.shopify.markets.v0.models {
|
|
@@ -103,6 +106,15 @@ declare namespace io.flow.shopify.markets.v0.models {
|
|
|
103
106
|
readonly 'amount'?: number;
|
|
104
107
|
}
|
|
105
108
|
|
|
109
|
+
interface ShopifyBulkOperationsFinish {
|
|
110
|
+
readonly 'admin_graphql_api_id': string;
|
|
111
|
+
readonly 'completed_at'?: string;
|
|
112
|
+
readonly 'created_at': string;
|
|
113
|
+
readonly 'error_code'?: io.flow.shopify.markets.v0.enums.BulkOperationErrorCode;
|
|
114
|
+
readonly 'status': io.flow.shopify.markets.v0.enums.BulkOperationStatus;
|
|
115
|
+
readonly 'type': io.flow.shopify.markets.v0.enums.BulkOperationType;
|
|
116
|
+
}
|
|
117
|
+
|
|
106
118
|
interface ShopifyCountryHarmonizedSystemCode {
|
|
107
119
|
readonly 'country_code': string;
|
|
108
120
|
readonly 'harmonized_system_code': string;
|
|
@@ -23,6 +23,7 @@ declare namespace io.flow.v0.enums {
|
|
|
23
23
|
type CaptureStatus = 'initiated' | 'pending' | 'succeeded' | 'failed' | 'canceled';
|
|
24
24
|
type CardErrorCode = 'invalid_address' | 'invalid_currency' | 'invalid_name' | 'invalid_number' | 'invalid_expiration' | 'invalid_token_type' | 'avs' | 'cvv' | 'fraud' | 'unknown';
|
|
25
25
|
type CardType = 'american_express' | 'cartes_bancaires' | 'china_union_pay' | 'dankort' | 'diners_club' | 'discover' | 'jcb' | 'maestro' | 'mastercard' | 'visa';
|
|
26
|
+
type CarrierChargeReason = 'return_to_origin' | 'rejection' | 'other';
|
|
26
27
|
type CenterCapability = 'international' | 'domestic' | 'crossdock' | 'commercial_invoice';
|
|
27
28
|
type ChangeType = 'insert' | 'update' | 'delete';
|
|
28
29
|
type ChannelCurrencyCapability = 'payment_authorizations' | 'settlement_currency';
|
|
@@ -151,7 +152,7 @@ declare namespace io.flow.v0.enums {
|
|
|
151
152
|
type PriceDetailKey = 'item_price' | 'margins' | 'vat' | 'duty' | 'rounding' | 'adjustment';
|
|
152
153
|
type PriceFacetBoundary = 'min' | 'max';
|
|
153
154
|
type PricingLevySetting = 'included' | 'displayed' | 'ignored';
|
|
154
|
-
type ProductRestrictionRule = 'Adult Products' | 'Alcohol' | 'Anti Money Laundering' | 'Collagen' | 'Consumer Safety' | 'Cosmetics' | 'DG - Batteries' | 'DG - Hazmat' | 'Drugs' | 'Dual Use' | 'Fine Art' | 'Fish & Wildlife - CITES' | 'Fish & Wildlife - Plant' | 'Fish & Wildlife - USFWS' | 'Food' | 'Gambling' | 'Health' | 'Human hair' | 'Insufficient Details' | 'Intangible' | 'Jewelry' | 'Jewelry & Watches Over 5000' | 'Knives' | 'Liquids' | 'Oversized' | 'Supplements' | 'Weapon' | 'Wood'
|
|
155
|
+
type ProductRestrictionRule = 'Adult Products' | 'Alcohol' | 'Anti Money Laundering' | 'Collagen' | 'Consumer Safety' | 'Cosmetics' | 'DG - Batteries' | 'DG - Hazmat' | 'Drugs' | 'Dual Use' | 'Fine Art' | 'Fish & Wildlife - CITES' | 'Fish & Wildlife - Plant' | 'Fish & Wildlife - USFWS' | 'Food' | 'Gambling' | 'Health' | 'Human hair' | 'Insufficient Details' | 'Intangible' | 'Jewelry' | 'Jewelry & Watches Over 5000' | 'Knives' | 'Liquids' | 'Oversized' | 'Supplements' | 'Weapon' | 'Wood';
|
|
155
156
|
type PromotionTriggerType = 'automatic' | 'order_subtotal';
|
|
156
157
|
type ProvinceType = 'area' | 'city' | 'county' | 'department' | 'dependency' | 'district' | 'do_si' | 'emirate' | 'entity' | 'island' | 'municipality' | 'oblast' | 'outlying_area' | 'parish' | 'prefecture' | 'province' | 'state' | 'territory' | 'other';
|
|
157
158
|
type QuoteErrorCode = 'generic_error' | 'items_not_available' | 'shipping_unavailable';
|
|
@@ -201,7 +202,7 @@ declare namespace io.flow.v0.enums {
|
|
|
201
202
|
type TrackingStatus = 'label_created' | 'pending' | 'info_received' | 'picked_up' | 'in_transit' | 'out_for_delivery' | 'attempt_fail' | 'delivered' | 'exception' | 'returned' | 'expired';
|
|
202
203
|
type TradeAgreementName = 'USMCA' | 'T-MEC' | 'CUSMA' | 'TCA';
|
|
203
204
|
type TradeAgreementStatus = 'supported' | 'not_supported';
|
|
204
|
-
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';
|
|
205
|
+
type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'trueup' | 'carrier_charge' | 'shipping_label_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
|
|
205
206
|
type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
|
|
206
207
|
type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction';
|
|
207
208
|
type UnitOfLength = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'meter';
|
|
@@ -6571,6 +6572,8 @@ declare namespace io.flow.v0.models {
|
|
|
6571
6572
|
readonly 'status': io.flow.v0.models.PaymentAuthorizationStatus;
|
|
6572
6573
|
readonly 'amount': number;
|
|
6573
6574
|
readonly 'currency': string;
|
|
6575
|
+
readonly 'base_amount'?: number;
|
|
6576
|
+
readonly 'base_currency'?: string;
|
|
6574
6577
|
}
|
|
6575
6578
|
|
|
6576
6579
|
interface PaymentAuthorizationStatus {
|
|
@@ -6582,6 +6585,8 @@ declare namespace io.flow.v0.models {
|
|
|
6582
6585
|
readonly 'id': string;
|
|
6583
6586
|
readonly 'amount': number;
|
|
6584
6587
|
readonly 'currency': string;
|
|
6588
|
+
readonly 'base_amount'?: number;
|
|
6589
|
+
readonly 'base_currency'?: string;
|
|
6585
6590
|
readonly 'created_at': string;
|
|
6586
6591
|
readonly 'updated_at': string;
|
|
6587
6592
|
readonly 'status': io.flow.v0.models.PaymentCaptureStatus;
|
|
@@ -7014,6 +7019,8 @@ declare namespace io.flow.v0.models {
|
|
|
7014
7019
|
readonly 'id': string;
|
|
7015
7020
|
readonly 'amount': number;
|
|
7016
7021
|
readonly 'currency': string;
|
|
7022
|
+
readonly 'base_amount'?: number;
|
|
7023
|
+
readonly 'base_currency'?: string;
|
|
7017
7024
|
readonly 'created_at': string;
|
|
7018
7025
|
readonly 'updated_at': string;
|
|
7019
7026
|
readonly 'status': io.flow.v0.models.PaymentRefundStatus;
|
|
@@ -7039,6 +7046,8 @@ declare namespace io.flow.v0.models {
|
|
|
7039
7046
|
readonly 'next_action'?: io.flow.v0.unions.Action;
|
|
7040
7047
|
readonly 'amount': number;
|
|
7041
7048
|
readonly 'currency': string;
|
|
7049
|
+
readonly 'base_amount'?: number;
|
|
7050
|
+
readonly 'base_currency'?: string;
|
|
7042
7051
|
readonly 'order_information': io.flow.v0.unions.OrderInformation;
|
|
7043
7052
|
readonly 'device_details': io.flow.v0.unions.DeviceDetails;
|
|
7044
7053
|
readonly 'locale'?: string;
|
|
@@ -7053,6 +7062,12 @@ declare namespace io.flow.v0.models {
|
|
|
7053
7062
|
|
|
7054
7063
|
interface PaymentRequestBilling {
|
|
7055
7064
|
readonly 'fees': io.flow.v0.models.PaymentRequestBillingFees;
|
|
7065
|
+
readonly 'currency_rate'?: io.flow.v0.models.PaymentRequestBillingCurrencyRate;
|
|
7066
|
+
}
|
|
7067
|
+
|
|
7068
|
+
interface PaymentRequestBillingCurrencyRate {
|
|
7069
|
+
readonly 'base_amount': number;
|
|
7070
|
+
readonly 'base_currency': string;
|
|
7056
7071
|
}
|
|
7057
7072
|
|
|
7058
7073
|
interface PaymentRequestBillingFees {
|
|
@@ -7119,6 +7134,8 @@ declare namespace io.flow.v0.models {
|
|
|
7119
7134
|
readonly 'id': string;
|
|
7120
7135
|
readonly 'amount': number;
|
|
7121
7136
|
readonly 'currency': string;
|
|
7137
|
+
readonly 'base_amount'?: number;
|
|
7138
|
+
readonly 'base_currency'?: string;
|
|
7122
7139
|
readonly 'created_at': string;
|
|
7123
7140
|
readonly 'updated_at': string;
|
|
7124
7141
|
readonly 'status': io.flow.v0.models.PaymentReversalStatus;
|
|
@@ -7563,9 +7580,9 @@ declare namespace io.flow.v0.models {
|
|
|
7563
7580
|
readonly 'product_id': string;
|
|
7564
7581
|
readonly 'item_numbers': string[];
|
|
7565
7582
|
readonly 'prohibited_regions': string[];
|
|
7566
|
-
readonly 'review_status'
|
|
7567
|
-
readonly 'rules'
|
|
7568
|
-
readonly 'updated_by_user_id'
|
|
7583
|
+
readonly 'review_status'?: io.flow.v0.enums.ReviewStatus;
|
|
7584
|
+
readonly 'rules'?: io.flow.v0.enums.ProductRestrictionRule[];
|
|
7585
|
+
readonly 'updated_by_user_id'?: string;
|
|
7569
7586
|
}
|
|
7570
7587
|
|
|
7571
7588
|
interface ProductRestrictionResultDeleted {
|
|
@@ -10078,6 +10095,13 @@ declare namespace io.flow.v0.models {
|
|
|
10078
10095
|
readonly 'network_details'?: io.flow.v0.models.TransactionNetworkDetailsCard;
|
|
10079
10096
|
}
|
|
10080
10097
|
|
|
10098
|
+
interface TransactionMetadataCarrierCharge {
|
|
10099
|
+
readonly 'discriminator': 'carrier_charge';
|
|
10100
|
+
readonly 'reason': io.flow.v0.enums.CarrierChargeReason;
|
|
10101
|
+
readonly 'carrier_id': string;
|
|
10102
|
+
readonly 'carrier_tracking_number': string;
|
|
10103
|
+
}
|
|
10104
|
+
|
|
10081
10105
|
interface TransactionMetadataChannel {
|
|
10082
10106
|
readonly 'discriminator': 'channel';
|
|
10083
10107
|
readonly 'method': string;
|
|
@@ -10523,5 +10547,5 @@ declare namespace io.flow.v0.unions {
|
|
|
10523
10547
|
type Token = (io.flow.v0.models.ChannelToken | io.flow.v0.models.OrganizationToken | io.flow.v0.models.OrganizationTokenV2 | io.flow.v0.models.PartnerToken);
|
|
10524
10548
|
type TokenReference = (io.flow.v0.models.ChannelTokenReference | io.flow.v0.models.OrganizationTokenReference | io.flow.v0.models.OrganizationTokenV2Reference | io.flow.v0.models.PartnerTokenReference);
|
|
10525
10549
|
type TransactionDetails = (io.flow.v0.models.TransactionDetailsCard);
|
|
10526
|
-
type TransactionMetadata = (io.flow.v0.models.TransactionMetadataShippingLabel | io.flow.v0.models.TransactionMetadataChannel | io.flow.v0.models.TransactionMetadataTrueup | io.flow.v0.models.TransactionMetadataManual);
|
|
10550
|
+
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);
|
|
10527
10551
|
}
|
package/index.d.ts
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
/// <reference path="generated/io.flow.billing.csv.v0.billing-csv.d.ts" />
|
|
7
7
|
/// <reference path="generated/io.flow.billing.internal.v0.billing-internal.d.ts" />
|
|
8
8
|
/// <reference path="generated/io.flow.billing.reporting.csv.v0.billing-reporting-csv.d.ts" />
|
|
9
|
+
/// <reference path="generated/io.flow.billing.reporting.v0.billing-reporting.d.ts" />
|
|
9
10
|
/// <reference path="generated/io.flow.billing.v0.billing.d.ts" />
|
|
10
11
|
/// <reference path="generated/io.flow.bitpay.v0.bitpay.d.ts" />
|
|
11
12
|
/// <reference path="generated/io.flow.brickftp.v0.brickftp.d.ts" />
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flowio/api-types",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.212",
|
|
4
4
|
"description": "Global TypeScript typings for Flow Commerce API",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,5 +14,5 @@
|
|
|
14
14
|
"scripts": {
|
|
15
15
|
"generate": "apibuilder update && node scripts/generate-index.js"
|
|
16
16
|
},
|
|
17
|
-
"gitHead": "
|
|
17
|
+
"gitHead": "69a80797baeb34690859818e5db7ef87aa6082a5"
|
|
18
18
|
}
|