@flowio/api-types 0.0.212 → 0.0.213
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.
|
@@ -16,12 +16,11 @@ declare namespace io.flow.billing.internal.v0.enums {
|
|
|
16
16
|
type FeesSource = 'settings' | 'authorization_bundle';
|
|
17
17
|
type LabelTransactionType = 'adjustment' | 'reversal' | 'billable_label' | 'fee' | 'revenue_share';
|
|
18
18
|
type MainTransactionStatus = 'scheduled' | 'pending_proof';
|
|
19
|
-
type ManualTransactionCategory = 'cancelled_order_refund' | 'channel_partner_initiated' | 'client_accepted_chargeback' | 'fee_reimbursement' | 'partial_refund' | 'platform_fee' | 'shipping_true_up' | 'tax_credit' | 'carrier_credit' | 'negative_balance_guarantee';
|
|
19
|
+
type ManualTransactionCategory = 'cancelled_order_refund' | 'channel_partner_initiated' | 'client_accepted_chargeback' | 'fee_reimbursement' | 'partial_refund' | 'platform_fee' | 'shipping_true_up' | 'tax_credit' | 'carrier_credit' | 'negative_balance_guarantee' | 'bank_payment_failure';
|
|
20
20
|
type OrderCancellationInitiatedBy = 'flow' | 'organization';
|
|
21
21
|
type OrderTransactionType = 'adjustment' | 'reversal' | 'order_service';
|
|
22
22
|
type PreferredBillingSchedule = 'monthly' | 'bi-monthly';
|
|
23
23
|
type ProcessingTransactionType = 'adjustment' | 'reversal' | 'capture' | 'refund' | 'fully_subsidized_order' | 'credit_payment';
|
|
24
|
-
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' | 'refund_record' | 'statement_batch' | 'statement_email' | 'statement_summary_email' | 'pending_payout_transaction_event' | 'credit_and_subsidy' | 'negative_balance_guarantee';
|
|
25
24
|
type ResponsibleParty = 'flow' | 'organization';
|
|
26
25
|
type StatementTransferTransactionLocation = 'transactions_file' | 'summary';
|
|
27
26
|
type SubscriptionFrequency = 'yearly' | 'monthly';
|
|
@@ -107,6 +107,7 @@ declare namespace io.flow.internal.v0.enums {
|
|
|
107
107
|
type CheckoutSubmitErrorCode = 'balance_not_zero' | 'address_book_contact_invalid' | 'address_book_contact_not_found' | 'address_city_invalid' | 'address_city_required' | 'address_country_invalid' | 'address_country_required' | 'address_line_number_invalid' | 'address_postal_invalid' | 'address_postal_required' | 'address_province_invalid' | 'address_province_required' | 'address_street1_invalid' | 'address_street1_required' | 'address_street2_invalid' | 'address_street2_required' | 'address_streets_must_be_unique' | 'authorization_amount_exceeds_balance' | 'authorization_form_not_supported' | 'authorization_invalid_amount' | 'authorization_invalid_currency' | 'authorization_not_found' | 'checkout_not_found' | 'checkout_requires_at_least_one_line' | 'contact_email_invalid' | 'contact_email_required' | 'contact_phone_invalid' | 'contact_phone_required' | 'country_not_supported' | 'currency_invalid' | 'delivery_not_found' | 'delivery_option_not_found' | 'delivery_option_not_supported' | 'delivery_option_required' | 'first_name_invalid' | 'first_name_required' | 'gift_card_insufficient_funds' | 'gift_card_invalid_number' | 'gift_card_not_supported' | 'invalid_prediction' | 'language_invalid' | 'last_name_invalid' | 'last_name_required' | 'line_item_number_invalid' | 'line_item_number_not_available' | 'line_not_found' | 'line_quantity_invalid' | 'line_value_threshold_exceeded' | 'locale_invalid' | 'name_missing_first_or_last' | 'name_required' | 'national_id_number_invalid' | 'no_customer' | 'no_valid_address_book_contacts' | 'optin_prompt_consent_required' | 'optin_prompt_invalid_value' | 'optin_prompt_not_found' | 'order_balance_not_available' | 'order_identifier_invalid' | 'payment_failed' | 'payment_not_found' | 'payment_source_confirmation_required' | 'payment_source_failed' | 'payment_source_not_found' | 'payment_type_does_not_support_delete' | 'promotion_code_does_not_meet_requirements' | 'promotion_code_expired' | 'promotion_code_invalid' | 'promotion_code_not_supported' | 'promotion_code_order_item_not_available';
|
|
108
108
|
type CheckoutUrlType = 'continue_shopping' | 'confirmation' | 'invalid_checkout';
|
|
109
109
|
type ClassificationErrorCode = 'generic_error';
|
|
110
|
+
type ColmItemType = 'physical' | 'digital';
|
|
110
111
|
type ComplianceType = 'weee';
|
|
111
112
|
type ContentElementType = 'markdown' | 'html' | 'plain_text' | 'href';
|
|
112
113
|
type ContentStatus = 'draft' | 'live' | 'archived';
|
|
@@ -175,7 +176,7 @@ declare namespace io.flow.internal.v0.enums {
|
|
|
175
176
|
type LogisticsResponsibility = 'organization' | 'flow';
|
|
176
177
|
type MainTransactionStatus = 'scheduled' | 'pending_proof';
|
|
177
178
|
type ManualReviewRuleStatus = 'active' | 'archived';
|
|
178
|
-
type ManualTransactionCategory = 'cancelled_order_refund' | 'channel_partner_initiated' | 'client_accepted_chargeback' | 'fee_reimbursement' | 'partial_refund' | 'platform_fee' | 'shipping_true_up' | 'tax_credit' | 'carrier_credit' | 'negative_balance_guarantee';
|
|
179
|
+
type ManualTransactionCategory = 'cancelled_order_refund' | 'channel_partner_initiated' | 'client_accepted_chargeback' | 'fee_reimbursement' | 'partial_refund' | 'platform_fee' | 'shipping_true_up' | 'tax_credit' | 'carrier_credit' | 'negative_balance_guarantee' | 'bank_payment_failure';
|
|
179
180
|
type MarketingGatewayAccountConnectionStatus = 'not_connected' | 'connecting' | 'connected' | 'disconnecting' | 'disconnected';
|
|
180
181
|
type MarketingGatewayChannelIntegrationType = 'automated' | 'manual';
|
|
181
182
|
type MarketingGatewayChannelStatus = 'not_connected' | 'connecting' | 'connected' | 'disconnecting' | 'disconnected' | 'unavailable';
|
|
@@ -226,7 +227,6 @@ declare namespace io.flow.internal.v0.enums {
|
|
|
226
227
|
type PromptCheckoutDisplayPosition = 'email' | 'submission';
|
|
227
228
|
type PromptOptions = 'notice_only' | 'require_consent' | 'consent_by_default';
|
|
228
229
|
type PromptTarget = 'browse' | 'checkout';
|
|
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' | 'refund_record' | 'statement_batch' | 'statement_email' | 'statement_summary_email' | 'pending_payout_transaction_event' | 'credit_and_subsidy' | 'negative_balance_guarantee';
|
|
230
230
|
type QuoteRequestType = 'generate' | 'delete' | 'update_currency_rate' | 'update_country';
|
|
231
231
|
type RateLevelKey = 'shopify_small_usa' | 'shopify_medium_usa' | 'shopify_enterprise_usa' | 'shopify_small_sdc_usa';
|
|
232
232
|
type RateSource = 'calculated' | 'market';
|
|
@@ -262,6 +262,7 @@ declare namespace io.flow.internal.v0.enums {
|
|
|
262
262
|
type ShopifyPromotionOrderEntitlementComponent = 'subtotal' | 'shipping' | 'vat' | 'duty';
|
|
263
263
|
type ShopifyPromotionStatus = 'active' | 'inactive';
|
|
264
264
|
type ShopifyService = 'payment' | 'duty_tax_calculator';
|
|
265
|
+
type ShrutiDemoType = 'digital' | 'physical';
|
|
265
266
|
type SignificanceAction = 'end_and_implement_winner' | 'end_and_revert' | 'do_nothing';
|
|
266
267
|
type SimpleRoundingStrategy = 'no_rounding' | 'currency_precision';
|
|
267
268
|
type SnoozeNextActionWith = 'customer_service' | 'engineering';
|
|
@@ -272,6 +273,7 @@ declare namespace io.flow.internal.v0.enums {
|
|
|
272
273
|
type Status = 'draft' | 'scheduled' | 'live' | 'ended' | 'archived';
|
|
273
274
|
type SubscriptionFrequency = 'yearly' | 'monthly';
|
|
274
275
|
type SuggestionAction = 'accept' | 'validate' | 'review';
|
|
276
|
+
type SvitlanaType = 'physical' | 'digital';
|
|
275
277
|
type TariffEligibilityType = 'rex';
|
|
276
278
|
type TaskProcessorKey = 'order_messenger' | 'harmonization' | 'fraud_review' | 'carrier_account' | 'payment' | 'rate_levels' | 'center_defaults';
|
|
277
279
|
type TaxCalculationErrorCode = 'generic_error' | 'outside_of_jurisdiction';
|
|
@@ -4563,6 +4565,23 @@ declare namespace io.flow.internal.v0.models {
|
|
|
4563
4565
|
readonly 'classified_by': string;
|
|
4564
4566
|
}
|
|
4565
4567
|
|
|
4568
|
+
interface ColmItem {
|
|
4569
|
+
readonly 'id': string;
|
|
4570
|
+
readonly 'number': string;
|
|
4571
|
+
readonly 'amount': io.flow.common.v0.models.Price;
|
|
4572
|
+
readonly 'description'?: string;
|
|
4573
|
+
readonly 'type': io.flow.internal.v0.enums.ColmItemType;
|
|
4574
|
+
readonly 'added_on': string;
|
|
4575
|
+
}
|
|
4576
|
+
|
|
4577
|
+
interface ColmItemForm {
|
|
4578
|
+
readonly 'number': string;
|
|
4579
|
+
readonly 'amount': io.flow.common.v0.models.Price;
|
|
4580
|
+
readonly 'description'?: string;
|
|
4581
|
+
readonly 'type': io.flow.internal.v0.enums.ColmItemType;
|
|
4582
|
+
readonly 'added_on': string;
|
|
4583
|
+
}
|
|
4584
|
+
|
|
4566
4585
|
interface CommercialInvoiceComparison {
|
|
4567
4586
|
readonly 'urls': string[];
|
|
4568
4587
|
}
|
|
@@ -10735,8 +10754,6 @@ declare namespace io.flow.internal.v0.models {
|
|
|
10735
10754
|
readonly 'status': io.flow.internal.v0.enums.RestrictionStatus;
|
|
10736
10755
|
readonly 'matching_positive_keywords': string[];
|
|
10737
10756
|
readonly 'matching_negative_keywords': string[];
|
|
10738
|
-
readonly 'positive_search_matches'?: string[];
|
|
10739
|
-
readonly 'negative_search_matches'?: string[];
|
|
10740
10757
|
readonly 'updated_by_user_id': string;
|
|
10741
10758
|
}
|
|
10742
10759
|
|
|
@@ -11597,8 +11614,6 @@ declare namespace io.flow.internal.v0.models {
|
|
|
11597
11614
|
interface RestrictionKeywords {
|
|
11598
11615
|
readonly 'positive_keywords': string[];
|
|
11599
11616
|
readonly 'negative_keywords': string[];
|
|
11600
|
-
readonly 'positive_search_matches': string[];
|
|
11601
|
-
readonly 'negative_search_matches': string[];
|
|
11602
11617
|
}
|
|
11603
11618
|
|
|
11604
11619
|
interface RestrictionOrganization {
|
|
@@ -11687,8 +11702,6 @@ declare namespace io.flow.internal.v0.models {
|
|
|
11687
11702
|
readonly 'accepted_rules'?: string[];
|
|
11688
11703
|
readonly 'positive_keywords'?: string[];
|
|
11689
11704
|
readonly 'negative_keywords'?: string[];
|
|
11690
|
-
readonly 'positive_search_matches'?: string[];
|
|
11691
|
-
readonly 'negative_search_matches'?: string[];
|
|
11692
11705
|
readonly 'user_ids'?: string[];
|
|
11693
11706
|
readonly 'categories'?: string[];
|
|
11694
11707
|
readonly 'product_name_query'?: string;
|
|
@@ -12196,11 +12209,12 @@ declare namespace io.flow.internal.v0.models {
|
|
|
12196
12209
|
readonly 'shopify_markets_order': io.flow.internal.v0.models.ShopifyMarketsOrder;
|
|
12197
12210
|
}
|
|
12198
12211
|
|
|
12199
|
-
interface
|
|
12212
|
+
interface ShopifyMarketsOrderVersionWithShopId {
|
|
12200
12213
|
readonly 'id': string;
|
|
12201
12214
|
readonly 'timestamp': string;
|
|
12202
12215
|
readonly 'type': io.flow.common.v0.enums.ChangeType;
|
|
12203
12216
|
readonly 'shopify_markets_order': io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsOrder;
|
|
12217
|
+
readonly 'shop_id'?: string;
|
|
12204
12218
|
}
|
|
12205
12219
|
|
|
12206
12220
|
interface ShopifyMarketsOrdersMetrics {
|
|
@@ -12662,6 +12676,23 @@ declare namespace io.flow.internal.v0.models {
|
|
|
12662
12676
|
readonly 'total': number;
|
|
12663
12677
|
}
|
|
12664
12678
|
|
|
12679
|
+
interface ShrutiDemoItem {
|
|
12680
|
+
readonly 'id': string;
|
|
12681
|
+
readonly 'number': string;
|
|
12682
|
+
readonly 'amount': io.flow.common.v0.models.Price;
|
|
12683
|
+
readonly 'description'?: string;
|
|
12684
|
+
readonly 'type': io.flow.internal.v0.enums.ShrutiDemoType;
|
|
12685
|
+
readonly 'added_on': string;
|
|
12686
|
+
}
|
|
12687
|
+
|
|
12688
|
+
interface ShrutiDemoItemForm {
|
|
12689
|
+
readonly 'number': string;
|
|
12690
|
+
readonly 'amount': io.flow.common.v0.models.Price;
|
|
12691
|
+
readonly 'description'?: string;
|
|
12692
|
+
readonly 'type': io.flow.internal.v0.enums.ShrutiDemoType;
|
|
12693
|
+
readonly 'added_on': string;
|
|
12694
|
+
}
|
|
12695
|
+
|
|
12665
12696
|
interface SimpleAccountReference {
|
|
12666
12697
|
readonly 'id': string;
|
|
12667
12698
|
}
|
|
@@ -13110,6 +13141,22 @@ declare namespace io.flow.internal.v0.models {
|
|
|
13110
13141
|
readonly 'svb_virtual_card_clearing': io.flow.internal.v0.models.SvbVirtualCardClearing;
|
|
13111
13142
|
}
|
|
13112
13143
|
|
|
13144
|
+
interface SvitlanaItem {
|
|
13145
|
+
readonly 'id': string;
|
|
13146
|
+
readonly 'number': string;
|
|
13147
|
+
readonly 'amount': number;
|
|
13148
|
+
readonly 'description'?: string;
|
|
13149
|
+
readonly 'type': io.flow.internal.v0.enums.SvitlanaType;
|
|
13150
|
+
readonly 'added_on': string;
|
|
13151
|
+
}
|
|
13152
|
+
|
|
13153
|
+
interface SvitlanaItemForm {
|
|
13154
|
+
readonly 'number': string;
|
|
13155
|
+
readonly 'amount': number;
|
|
13156
|
+
readonly 'description'?: string;
|
|
13157
|
+
readonly 'type': io.flow.internal.v0.enums.SvitlanaType;
|
|
13158
|
+
}
|
|
13159
|
+
|
|
13113
13160
|
interface TariffCodeDuty {
|
|
13114
13161
|
readonly 'tariff_code': string;
|
|
13115
13162
|
readonly 'duties': Record<string, io.flow.internal.v0.models.Duties>;
|
|
@@ -152,7 +152,7 @@ declare namespace io.flow.v0.enums {
|
|
|
152
152
|
type PriceDetailKey = 'item_price' | 'margins' | 'vat' | 'duty' | 'rounding' | 'adjustment';
|
|
153
153
|
type PriceFacetBoundary = 'min' | 'max';
|
|
154
154
|
type PricingLevySetting = 'included' | 'displayed' | 'ignored';
|
|
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
|
+
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' | 'Restrict by Default' | 'Supplements' | 'Weapon' | 'Wood';
|
|
156
156
|
type PromotionTriggerType = 'automatic' | 'order_subtotal';
|
|
157
157
|
type ProvinceType = 'area' | 'city' | 'county' | 'department' | 'dependency' | 'district' | 'do_si' | 'emirate' | 'entity' | 'island' | 'municipality' | 'oblast' | 'outlying_area' | 'parish' | 'prefecture' | 'province' | 'state' | 'territory' | 'other';
|
|
158
158
|
type QuoteErrorCode = 'generic_error' | 'items_not_available' | 'shipping_unavailable';
|
|
@@ -7582,7 +7582,7 @@ declare namespace io.flow.v0.models {
|
|
|
7582
7582
|
readonly 'prohibited_regions': string[];
|
|
7583
7583
|
readonly 'review_status'?: io.flow.v0.enums.ReviewStatus;
|
|
7584
7584
|
readonly 'rules'?: io.flow.v0.enums.ProductRestrictionRule[];
|
|
7585
|
-
readonly '
|
|
7585
|
+
readonly 'updated_by'?: string;
|
|
7586
7586
|
}
|
|
7587
7587
|
|
|
7588
7588
|
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.213",
|
|
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": "2430172d05199bd940ad6b8a39eaf47a9efcea8c"
|
|
18
18
|
}
|