@flowio/api-types 0.0.210 → 0.0.211
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.reporting.csv.v0.billing-reporting-csv.d.ts +28 -63
- package/generated/io.flow.channel.internal.v0.channel-internal.d.ts +5 -0
- package/generated/io.flow.internal.v0.api-internal.d.ts +15 -1
- package/generated/io.flow.v0.api.d.ts +5 -0
- package/package.json +2 -2
|
@@ -357,6 +357,7 @@ declare namespace io.flow.billing.csv.v0.models {
|
|
|
357
357
|
interface BillingCsvTransactionMetadata {
|
|
358
358
|
readonly 'channel'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataChannel;
|
|
359
359
|
readonly 'shipping_label'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataShippingLabel;
|
|
360
|
+
readonly 'shipping_label_revenue_share'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataShippingLabelRevenueShare;
|
|
360
361
|
readonly 'trueup'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataTrueup;
|
|
361
362
|
readonly 'manual'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataManual;
|
|
362
363
|
}
|
|
@@ -375,6 +376,12 @@ declare namespace io.flow.billing.csv.v0.models {
|
|
|
375
376
|
readonly 'request_method'?: io.flow.label.v0.enums.LabelRequestMethod;
|
|
376
377
|
}
|
|
377
378
|
|
|
379
|
+
interface BillingCsvTransactionMetadataShippingLabelRevenueShare {
|
|
380
|
+
readonly 'label_id': string;
|
|
381
|
+
readonly 'base_amount'?: number;
|
|
382
|
+
readonly 'percentage'?: number;
|
|
383
|
+
}
|
|
384
|
+
|
|
378
385
|
interface BillingCsvTransactionMetadataTrueup {
|
|
379
386
|
readonly 'original': io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
|
|
380
387
|
}
|
|
@@ -19,65 +19,25 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
|
|
|
19
19
|
readonly 'shipping': boolean;
|
|
20
20
|
}
|
|
21
21
|
|
|
22
|
+
interface RecordReference {
|
|
23
|
+
readonly 'id': string;
|
|
24
|
+
}
|
|
25
|
+
|
|
22
26
|
interface RefundRecord {
|
|
23
|
-
readonly '
|
|
24
|
-
readonly '
|
|
25
|
-
readonly '
|
|
26
|
-
readonly '
|
|
27
|
-
readonly '
|
|
28
|
-
readonly '
|
|
29
|
-
readonly '
|
|
30
|
-
readonly '
|
|
31
|
-
readonly '
|
|
32
|
-
readonly '
|
|
33
|
-
readonly '
|
|
34
|
-
readonly '
|
|
35
|
-
readonly '
|
|
36
|
-
readonly '
|
|
37
|
-
readonly 'merchant_name': string;
|
|
38
|
-
readonly 'destination_country': string;
|
|
39
|
-
readonly 'shopper_country_is_eu': boolean;
|
|
40
|
-
readonly 'order_refund_reason_name': string;
|
|
41
|
-
readonly 'order_refund_status_name': string;
|
|
42
|
-
readonly 'original_ccy': string;
|
|
43
|
-
readonly 'transaction_ccy': string;
|
|
44
|
-
readonly 'total_refund_amount_exc_vat_in_transaction_ccy'?: number;
|
|
45
|
-
readonly 'refund_vat_in_transaction_ccy'?: number;
|
|
46
|
-
readonly 'total_refund_amount_inc_vat_in_transaction_ccy'?: number;
|
|
47
|
-
readonly 'merchant_total_products_refund_amount_exc_vat_in_original_ccy': number;
|
|
48
|
-
readonly 'merchant_shipping_refund_amount_exc_vat_in_transaction_ccy'?: number;
|
|
49
|
-
readonly 'merchant_shipping_refund_amount_exc_vat_in_original_ccy': number;
|
|
50
|
-
readonly 'total_refund_amount_exc_tax_collected_in_shopper_ccy'?: number;
|
|
51
|
-
readonly 'tax_collected_amount_in_shopper_ccy': number;
|
|
52
|
-
readonly 'total_refund_amount_inc_tax_collected_in_shopper_ccy'?: number;
|
|
53
|
-
readonly 'payment_gateway': string;
|
|
54
|
-
readonly 'min_product_customer_vat_rate'?: number;
|
|
55
|
-
readonly 'is_virtual_order': boolean;
|
|
56
|
-
readonly 'is_mixed_virtual_order': boolean;
|
|
57
|
-
readonly 'total_refund_amount_exc_tax_collected_in_usd': number;
|
|
58
|
-
readonly 'tax_collected_amount_in_usd': number;
|
|
59
|
-
readonly 'total_refund_amount_inc_tax_collected_in_usd': number;
|
|
60
|
-
readonly 'total_refund_amount_exc_tax_collected_in_eur': number;
|
|
61
|
-
readonly 'tax_collected_amount_in_eur': number;
|
|
62
|
-
readonly 'total_refund_amount_inc_tax_collected_in_eur': number;
|
|
63
|
-
readonly 'is_wyol_order': boolean;
|
|
64
|
-
readonly 'is_duties_guaranteed': boolean;
|
|
65
|
-
readonly 'invoice_id'?: string;
|
|
66
|
-
readonly 'total_refund_amount_exc_vat_in_entity_ccy': number;
|
|
67
|
-
readonly 'refund_vat_in_entity_ccy': number;
|
|
68
|
-
readonly 'total_refund_amount_inc_vat_in_entity_ccy': number;
|
|
69
|
-
readonly 'merchant_total_products_refund_amount_exc_vat_in_entity_ccy': number;
|
|
70
|
-
readonly 'merchant_shipping_refund_amount_exc_vat_in_entity_ccy': number;
|
|
71
|
-
readonly 'merchant_duties_and_taxes_refund_amount_in_entity_ccy': number;
|
|
72
|
-
readonly 'merchant_service_gesture_amount_exc_vat_in_entity_ccy': number;
|
|
73
|
-
readonly 'customer_prepaid_refund_amount_exc_vat_in_entity_ccy': number;
|
|
74
|
-
readonly 'total_refund_amount_exc_tax_collected_in_entity_ccy': number;
|
|
75
|
-
readonly 'tax_collected_amount_in_entity_ccy': number;
|
|
76
|
-
readonly 'total_refund_amount_inc_tax_collected_in_entity_ccy': number;
|
|
77
|
-
readonly 'conversion_rate_transaction_to_entity_ccy': number;
|
|
78
|
-
readonly 'merchant_order_id': string;
|
|
79
|
-
readonly 'transaction_date': string;
|
|
80
|
-
readonly 'debug_console_order_link': string;
|
|
27
|
+
readonly 'id': string;
|
|
28
|
+
readonly 'parent'?: io.flow.billing.reporting.csv.v0.models.RecordReference;
|
|
29
|
+
readonly 'merchant': io.flow.billing.reporting.csv.v0.models.ReportingOrganizationSummary;
|
|
30
|
+
readonly 'order': io.flow.billing.reporting.csv.v0.models.ReportingOrderSummary;
|
|
31
|
+
readonly 'entity': io.flow.billing.reporting.csv.v0.models.ReportingEntity;
|
|
32
|
+
readonly 'vendor': io.flow.billing.reporting.csv.v0.models.ReportingVendor;
|
|
33
|
+
readonly 'currencies': io.flow.billing.reporting.csv.v0.models.ReportingCurrencies;
|
|
34
|
+
readonly 'conversion_rate': io.flow.billing.reporting.csv.v0.models.ReportingConversionRates;
|
|
35
|
+
readonly 'reconciliation': io.flow.billing.reporting.csv.v0.models.ReportingReconciliation;
|
|
36
|
+
readonly 'merchant_subsidies': io.flow.billing.reporting.csv.v0.models.ReportingMerchantSubsidies;
|
|
37
|
+
readonly 'merchant_fees': io.flow.billing.reporting.csv.v0.models.ReportingMerchantFees;
|
|
38
|
+
readonly 'merchant_transactions': io.flow.billing.reporting.csv.v0.models.ReportingMerchantTransactions;
|
|
39
|
+
readonly 'debug': io.flow.billing.reporting.csv.v0.models.ReportingDebug;
|
|
40
|
+
readonly 'return'?: io.flow.billing.reporting.csv.v0.models.ReportingReturn;
|
|
81
41
|
}
|
|
82
42
|
|
|
83
43
|
interface ReportingAuthorizationReference {
|
|
@@ -211,6 +171,7 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
|
|
|
211
171
|
readonly 'tax': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
212
172
|
readonly 'duty': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
213
173
|
readonly 'freight': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
174
|
+
readonly 'refund': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
214
175
|
}
|
|
215
176
|
|
|
216
177
|
interface ReportingMonetaryValue {
|
|
@@ -243,6 +204,10 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
|
|
|
243
204
|
readonly 'year': number;
|
|
244
205
|
}
|
|
245
206
|
|
|
207
|
+
interface ReportingReturn {
|
|
208
|
+
readonly 'placeholder': string;
|
|
209
|
+
}
|
|
210
|
+
|
|
246
211
|
interface ReportingShopperFees {
|
|
247
212
|
readonly 'fuel': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
248
213
|
readonly 'remote_area': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
@@ -271,24 +236,24 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
|
|
|
271
236
|
|
|
272
237
|
interface SalesRecord {
|
|
273
238
|
readonly 'id': string;
|
|
274
|
-
readonly 'parent'?: io.flow.billing.reporting.csv.v0.models.
|
|
239
|
+
readonly 'parent'?: io.flow.billing.reporting.csv.v0.models.RecordReference;
|
|
275
240
|
readonly 'merchant': io.flow.billing.reporting.csv.v0.models.ReportingOrganizationSummary;
|
|
276
241
|
readonly 'order': io.flow.billing.reporting.csv.v0.models.ReportingOrderSummary;
|
|
277
242
|
readonly 'entity': io.flow.billing.reporting.csv.v0.models.ReportingEntity;
|
|
278
243
|
readonly 'vendor': io.flow.billing.reporting.csv.v0.models.ReportingVendor;
|
|
279
244
|
readonly 'currencies': io.flow.billing.reporting.csv.v0.models.ReportingCurrencies;
|
|
280
245
|
readonly 'conversion_rate': io.flow.billing.reporting.csv.v0.models.ReportingConversionRates;
|
|
281
|
-
readonly 'fulfillment': io.flow.billing.reporting.csv.v0.models.ReportingFulfillment;
|
|
282
246
|
readonly 'reconciliation': io.flow.billing.reporting.csv.v0.models.ReportingReconciliation;
|
|
283
|
-
readonly 'marked_as_final': io.flow.billing.reporting.csv.v0.models.MarkedAsFinal;
|
|
284
247
|
readonly 'merchant_subsidies': io.flow.billing.reporting.csv.v0.models.ReportingMerchantSubsidies;
|
|
285
248
|
readonly 'merchant_fees': io.flow.billing.reporting.csv.v0.models.ReportingMerchantFees;
|
|
286
249
|
readonly 'merchant_transactions': io.flow.billing.reporting.csv.v0.models.ReportingMerchantTransactions;
|
|
287
|
-
readonly 'vat_remittance': io.flow.billing.reporting.csv.v0.models.ReportingVatRemittance;
|
|
288
250
|
readonly 'debug': io.flow.billing.reporting.csv.v0.models.ReportingDebug;
|
|
251
|
+
readonly 'fulfillment': io.flow.billing.reporting.csv.v0.models.ReportingFulfillment;
|
|
252
|
+
readonly 'vat_remittance': io.flow.billing.reporting.csv.v0.models.ReportingVatRemittance;
|
|
253
|
+
readonly 'marked_as_final': io.flow.billing.reporting.csv.v0.models.MarkedAsFinal;
|
|
289
254
|
}
|
|
290
255
|
|
|
291
|
-
interface
|
|
256
|
+
interface TransactionReference {
|
|
292
257
|
readonly 'id': string;
|
|
293
258
|
}
|
|
294
259
|
}
|
|
@@ -49,6 +49,11 @@ declare namespace io.flow.channel.internal.v0.models {
|
|
|
49
49
|
readonly 'order_updated_at'?: string;
|
|
50
50
|
}
|
|
51
51
|
|
|
52
|
+
interface ChannelOrderAcceptanceDetails {
|
|
53
|
+
readonly 'order_acceptance': io.flow.channel.internal.v0.models.ChannelOrderAcceptance;
|
|
54
|
+
readonly 'external_order': any/*object*/;
|
|
55
|
+
}
|
|
56
|
+
|
|
52
57
|
interface ChannelOrderAcceptanceForm {
|
|
53
58
|
readonly 'status': io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceStatus;
|
|
54
59
|
}
|
|
@@ -29,6 +29,8 @@ declare namespace io.flow.internal.v0.enums {
|
|
|
29
29
|
type ChannelOrderAcceptanceStatus = 'accepted' | 'rejected' | 'review';
|
|
30
30
|
type ChannelOrderFulfillmentStatusCode = 'unfulfilled' | 'fulfilled' | 'partial' | 'cancelled';
|
|
31
31
|
type ChannelTransactionType = 'adjustment' | 'reversal' | 'processing';
|
|
32
|
+
type ChargeEstimateSource = 'global-e' | 'shopify';
|
|
33
|
+
type ChargeInputType = 'fuelsc' | 'incoterm_ddp' | 'delivery_confirmation' | 'base_charge' | 'package_pickup' | 'insurance' | 'usps_first_mile' | 'oversize_piece' | 'incoterm_dap' | 'remote_area_delivery';
|
|
32
34
|
type ChargebackPaymentStatus = 'captured' | 'refunded';
|
|
33
35
|
type ChargebackProcessStatus = 'inquiry' | 'open' | 'closed';
|
|
34
36
|
type CheckoutAddAuthorizationErrorCode = 'checkout_not_found' | 'authorization_not_found';
|
|
@@ -224,7 +226,7 @@ declare namespace io.flow.internal.v0.enums {
|
|
|
224
226
|
type PromptCheckoutDisplayPosition = 'email' | 'submission';
|
|
225
227
|
type PromptOptions = 'notice_only' | 'require_consent' | 'consent_by_default';
|
|
226
228
|
type PromptTarget = 'browse' | 'checkout';
|
|
227
|
-
type QueuedRecordType = 'capture' | 'channel_transaction' | 'consumer_invoice' | 'fulfillment_in_transit' | 'fulfillment_shipping_notification' | 'fulfillment_external' | 'fulfillment_order_combined_shipment' | 'fulfillment_order_time' | 'label_tracking_summary' | 'label_invoice_request' | 'carrier_charge' | 'carrier_charge_file' | 'order' | 'order_identifier' | 'organization_onboarding_state' | 'posting_proof' | 'refund' | 'refund_over_capture' | 'sales_record' | 'statement_batch' | 'statement_email' | 'statement_summary_email' | 'pending_payout_transaction_event' | 'credit_and_subsidy' | 'negative_balance_guarantee';
|
|
229
|
+
type QueuedRecordType = 'capture' | 'channel_transaction' | 'consumer_invoice' | 'fulfillment_in_transit' | 'fulfillment_shipping_notification' | 'fulfillment_external' | 'fulfillment_order_combined_shipment' | 'fulfillment_order_time' | 'return_refund' | 'label_tracking_summary' | 'label_invoice_request' | 'carrier_charge' | 'carrier_charge_file' | 'order' | 'order_identifier' | 'organization_onboarding_state' | 'posting_proof' | 'refund' | 'refund_over_capture' | 'sales_record' | 'statement_batch' | 'statement_email' | 'statement_summary_email' | 'pending_payout_transaction_event' | 'credit_and_subsidy' | 'negative_balance_guarantee';
|
|
228
230
|
type QuoteRequestType = 'generate' | 'delete' | 'update_currency_rate' | 'update_country';
|
|
229
231
|
type RateLevelKey = 'shopify_small_usa' | 'shopify_medium_usa' | 'shopify_enterprise_usa' | 'shopify_small_sdc_usa';
|
|
230
232
|
type RateSource = 'calculated' | 'market';
|
|
@@ -2103,6 +2105,11 @@ declare namespace io.flow.internal.v0.models {
|
|
|
2103
2105
|
readonly 'channel_order_acceptance': io.flow.internal.v0.models.ChannelOrderAcceptance;
|
|
2104
2106
|
}
|
|
2105
2107
|
|
|
2108
|
+
interface ChannelOrderAcceptanceDetails {
|
|
2109
|
+
readonly 'order_acceptance': io.flow.internal.v0.models.ChannelOrderAcceptance;
|
|
2110
|
+
readonly 'external_order': any/*object*/;
|
|
2111
|
+
}
|
|
2112
|
+
|
|
2106
2113
|
interface ChannelOrderAcceptanceForm {
|
|
2107
2114
|
readonly 'status': io.flow.internal.v0.enums.ChannelOrderAcceptanceStatus;
|
|
2108
2115
|
}
|
|
@@ -2218,6 +2225,12 @@ declare namespace io.flow.internal.v0.models {
|
|
|
2218
2225
|
readonly 'channel_transaction': io.flow.internal.v0.models.ChannelTransaction;
|
|
2219
2226
|
}
|
|
2220
2227
|
|
|
2228
|
+
interface ChargeInput {
|
|
2229
|
+
readonly 'charge_input_code': io.flow.internal.v0.enums.ChargeInputType;
|
|
2230
|
+
readonly 'price': io.flow.common.v0.models.Money;
|
|
2231
|
+
readonly 'charge_input_source': io.flow.internal.v0.enums.ChargeEstimateSource;
|
|
2232
|
+
}
|
|
2233
|
+
|
|
2221
2234
|
interface Chargeback {
|
|
2222
2235
|
readonly 'id': string;
|
|
2223
2236
|
readonly 'key': string;
|
|
@@ -8212,6 +8225,7 @@ declare namespace io.flow.internal.v0.models {
|
|
|
8212
8225
|
readonly 'organization': string;
|
|
8213
8226
|
readonly 'shipping_label_form': io.flow.label.v0.unions.ShippingLabelForm;
|
|
8214
8227
|
readonly 'shipment_cost'?: io.flow.common.v0.models.Money;
|
|
8228
|
+
readonly 'charges'?: io.flow.internal.v0.models.ChargeInput[];
|
|
8215
8229
|
readonly 'reference_id'?: string;
|
|
8216
8230
|
}
|
|
8217
8231
|
|
|
@@ -151,6 +151,7 @@ declare namespace io.flow.v0.enums {
|
|
|
151
151
|
type PriceDetailKey = 'item_price' | 'margins' | 'vat' | 'duty' | 'rounding' | 'adjustment';
|
|
152
152
|
type PriceFacetBoundary = 'min' | 'max';
|
|
153
153
|
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' | 'unknown';
|
|
154
155
|
type PromotionTriggerType = 'automatic' | 'order_subtotal';
|
|
155
156
|
type ProvinceType = 'area' | 'city' | 'county' | 'department' | 'dependency' | 'district' | 'do_si' | 'emirate' | 'entity' | 'island' | 'municipality' | 'oblast' | 'outlying_area' | 'parish' | 'prefecture' | 'province' | 'state' | 'territory' | 'other';
|
|
156
157
|
type QuoteErrorCode = 'generic_error' | 'items_not_available' | 'shipping_unavailable';
|
|
@@ -164,6 +165,7 @@ declare namespace io.flow.v0.enums {
|
|
|
164
165
|
type ReturnTrackingStatus = 'awaiting_customs_clearance' | 'cancel_requested' | 'canceled' | 'collection_attempt_failed' | 'customs_clearance_completed' | 'delivered_to_retailer' | 'in_transit_to_local_hub' | 'in_transit_to_retailer' | 'parcel_added_to_pallet' | 'parcel_delayed' | 'parcel_extracted_from_pallet' | 'parcel_lost' | 'parcel_processed_by_retailer' | 'parcel_under_investigation' | 'processed_by_local_hub' | 'received_at_local_hub' | 'received_by_the_carrier' | 'return_registered_online';
|
|
165
166
|
type ReversalErrorCode = 'amount_exceeds_balance' | 'authorization_declined' | 'authorization_expired' | 'invalid_authorization' | 'invalid_key' | 'invalid_amount' | 'invalid_currency' | 'no_remaining_balance' | 'partial_reversal_not_supported' | 'unknown';
|
|
166
167
|
type ReversalStatus = 'pending' | 'processed' | 'failed';
|
|
168
|
+
type ReviewStatus = 'high_risk_in_review' | 'low_risk_in_review' | 'reviewed';
|
|
167
169
|
type Role = 'admin' | 'member';
|
|
168
170
|
type RoundingMethod = 'up' | 'down' | 'nearest';
|
|
169
171
|
type RoundingType = 'pattern' | 'multiple';
|
|
@@ -7561,6 +7563,9 @@ declare namespace io.flow.v0.models {
|
|
|
7561
7563
|
readonly 'product_id': string;
|
|
7562
7564
|
readonly 'item_numbers': string[];
|
|
7563
7565
|
readonly 'prohibited_regions': string[];
|
|
7566
|
+
readonly 'review_status': io.flow.v0.enums.ReviewStatus;
|
|
7567
|
+
readonly 'rules': io.flow.v0.enums.ProductRestrictionRule[];
|
|
7568
|
+
readonly 'updated_by_user_id': string;
|
|
7564
7569
|
}
|
|
7565
7570
|
|
|
7566
7571
|
interface ProductRestrictionResultDeleted {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flowio/api-types",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.211",
|
|
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": "1855db886db2701e6ba2ae9ede907ce6abbcaa38"
|
|
18
18
|
}
|