@flowio/api-types 0.0.261 → 0.0.263
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.bank.account.v0.billing-bank-account.d.ts +13 -1
- package/generated/io.flow.billing.v0.billing.d.ts +10 -4
- package/generated/io.flow.channel.internal.v0.channel-internal.d.ts +2 -1
- package/generated/io.flow.channel.shopify.v0.channel-shopify.d.ts +28 -0
- package/generated/io.flow.common.v0.common.d.ts +2 -0
- package/generated/io.flow.consumer.invoice.v0.consumer-invoice.d.ts +242 -0
- package/generated/io.flow.experience.v0.experience.d.ts +2 -0
- package/generated/io.flow.internal.v0.api-internal.d.ts +404 -59
- package/generated/io.flow.label.v0.label.d.ts +1 -0
- package/generated/io.flow.merchant.onboarding.v0.merchant-onboarding.d.ts +89 -4
- package/generated/io.flow.organization.v0.organization.d.ts +28 -0
- package/generated/io.flow.payment.gateway.v0.payment-gateway.d.ts +1 -0
- package/generated/io.flow.payment.v0.payment.d.ts +1 -1
- package/generated/io.flow.ratecard.v0.ratecard.d.ts +39 -0
- package/generated/io.flow.restrictions.v0.restrictions.d.ts +40 -0
- package/generated/io.flow.sellability.v0.sellability.d.ts +71 -2
- package/generated/io.flow.shopify.markets.internal.event.v0.shopify-markets-internal-event.d.ts +17 -1
- package/generated/io.flow.shopify.markets.internal.v0.shopify-markets-internal.d.ts +12 -0
- package/generated/io.flow.shopify.markets.v0.shopify-markets.d.ts +2 -0
- package/generated/io.flow.v0.api.d.ts +330 -116
- package/index.d.ts +3 -1
- package/package.json +2 -2
- package/generated/io.flow.tech.onboarding.playground.v0.tech-onboarding-playground.d.ts +0 -157
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
declare namespace io.flow.label.v0.enums {
|
|
2
|
+
type CommercialInvoiceMode = 'direct' | 'indirect';
|
|
2
3
|
type CostEstimateSource = 'flow' | 'channel';
|
|
3
4
|
type Direction = 'outbound' | 'return';
|
|
4
5
|
type LabelRequestMethod = 'flow_web_sync' | 'channel_web_async' | 'direct_api_sync' | 'direct_api_async' | 'bridge_api_sync' | 'partner_api_sync' | 'notification_requiring_crossdock' | 'flow_simulation_sync' | 'autogenerated';
|
|
@@ -6,6 +6,77 @@ declare namespace io.flow.merchant.onboarding.v0.enums {
|
|
|
6
6
|
}
|
|
7
7
|
|
|
8
8
|
declare namespace io.flow.merchant.onboarding.v0.models {
|
|
9
|
+
interface CommonMerchantApplication {
|
|
10
|
+
readonly 'discriminator': 'common_merchant_application';
|
|
11
|
+
readonly 'id': string;
|
|
12
|
+
readonly 'organization_id': string;
|
|
13
|
+
readonly 'organization_reference': io.flow.merchant.onboarding.v0.models.OnboardingOrganizationReference;
|
|
14
|
+
readonly 'status': io.flow.merchant.onboarding.v0.enums.OnboardingApplicationStatus;
|
|
15
|
+
readonly 'company'?: io.flow.merchant.onboarding.v0.models.MerchantInfo;
|
|
16
|
+
readonly 'indirect_tax'?: io.flow.merchant.onboarding.v0.models.IndirectTax;
|
|
17
|
+
readonly 'ultimate_beneficiary_owner'?: io.flow.merchant.onboarding.v0.models.UltimateBeneficiaryOwner;
|
|
18
|
+
readonly 'business_url'?: string;
|
|
19
|
+
readonly 'business_description'?: string;
|
|
20
|
+
readonly 'business_address'?: io.flow.common.v0.models.Address;
|
|
21
|
+
readonly 'refund_percentage'?: number;
|
|
22
|
+
readonly 'chargeback_percentage'?: number;
|
|
23
|
+
readonly 'beneficiary_details'?: io.flow.merchant.onboarding.v0.models.MerchantOnboardingBeneficiaryDetails;
|
|
24
|
+
readonly 'other_trade_sector'?: string;
|
|
25
|
+
readonly 'center_contact'?: io.flow.merchant.onboarding.v0.models.OperationsContact;
|
|
26
|
+
readonly 'center_address'?: io.flow.common.v0.models.Address;
|
|
27
|
+
readonly 'average_order_weight'?: number;
|
|
28
|
+
readonly 'average_order_weight_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
|
|
29
|
+
readonly 'package_dimensions'?: io.flow.common.v0.models.Dimension[];
|
|
30
|
+
readonly 'monthly_average'?: io.flow.merchant.onboarding.v0.models.MonthlyAverage;
|
|
31
|
+
readonly 'default_country_of_origin'?: string;
|
|
32
|
+
readonly 'rate_card': string;
|
|
33
|
+
readonly 'shop'?: io.flow.merchant.onboarding.v0.models.Shop;
|
|
34
|
+
readonly 'created_at': string;
|
|
35
|
+
readonly 'last_year_xborder_gmv'?: io.flow.common.v0.models.Money;
|
|
36
|
+
readonly 'last_month_xborder_gmv'?: io.flow.common.v0.models.Money;
|
|
37
|
+
readonly 'average_order_value'?: io.flow.common.v0.models.Money;
|
|
38
|
+
readonly 'mcc_codes'?: number[];
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
interface CommonMerchantApplicationForm {
|
|
42
|
+
readonly 'discriminator': 'common_merchant_application_form';
|
|
43
|
+
readonly 'company'?: io.flow.merchant.onboarding.v0.models.MerchantInfo;
|
|
44
|
+
readonly 'indirect_tax'?: io.flow.merchant.onboarding.v0.models.IndirectTax;
|
|
45
|
+
readonly 'ultimate_beneficiary_owner'?: io.flow.merchant.onboarding.v0.models.UltimateBeneficiaryOwner;
|
|
46
|
+
readonly 'business_url'?: string;
|
|
47
|
+
readonly 'business_description'?: string;
|
|
48
|
+
readonly 'business_address'?: io.flow.common.v0.models.Address;
|
|
49
|
+
readonly 'refund_percentage'?: number;
|
|
50
|
+
readonly 'chargeback_percentage'?: number;
|
|
51
|
+
readonly 'beneficiary_details'?: io.flow.merchant.onboarding.v0.models.MerchantOnboardingBeneficiaryDetails;
|
|
52
|
+
readonly 'other_trade_sector'?: string;
|
|
53
|
+
readonly 'center_contact'?: io.flow.merchant.onboarding.v0.models.OperationsContact;
|
|
54
|
+
readonly 'center_address'?: io.flow.common.v0.models.Address;
|
|
55
|
+
readonly 'average_order_weight'?: number;
|
|
56
|
+
readonly 'average_order_weight_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
|
|
57
|
+
readonly 'package_dimensions'?: io.flow.common.v0.models.Dimension[];
|
|
58
|
+
readonly 'monthly_average_volume_amount'?: number;
|
|
59
|
+
readonly 'monthly_average_volume_currency'?: string;
|
|
60
|
+
readonly 'monthly_average_number_transactions'?: number;
|
|
61
|
+
readonly 'default_country_of_origin'?: string;
|
|
62
|
+
readonly 'shop'?: io.flow.merchant.onboarding.v0.models.Shop;
|
|
63
|
+
readonly 'rate_card'?: string;
|
|
64
|
+
readonly 'last_year_xborder_gmv'?: io.flow.common.v0.models.Money;
|
|
65
|
+
readonly 'last_month_xborder_gmv'?: io.flow.common.v0.models.Money;
|
|
66
|
+
readonly 'average_order_value'?: io.flow.common.v0.models.Money;
|
|
67
|
+
readonly 'mcc_codes'?: number[];
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
interface CommonMerchantApplicationPutForm {
|
|
71
|
+
readonly 'discriminator': 'common_merchant_application_put_form';
|
|
72
|
+
readonly 'status'?: io.flow.merchant.onboarding.v0.enums.OnboardingApplicationStatus;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
interface CommonMerchantApplicationsSummary {
|
|
76
|
+
readonly 'discriminator': 'common_merchant_applications_summary';
|
|
77
|
+
readonly 'total': number;
|
|
78
|
+
}
|
|
79
|
+
|
|
9
80
|
interface IndirectTax {
|
|
10
81
|
readonly 'number'?: string;
|
|
11
82
|
readonly 'id'?: string;
|
|
@@ -22,6 +93,7 @@ declare namespace io.flow.merchant.onboarding.v0.models {
|
|
|
22
93
|
readonly 'region'?: io.flow.merchant.onboarding.v0.enums.RegionType;
|
|
23
94
|
readonly 'region_value'?: string;
|
|
24
95
|
readonly 'category_code'?: string;
|
|
96
|
+
readonly 'description'?: string;
|
|
25
97
|
}
|
|
26
98
|
|
|
27
99
|
interface MerchantOnboardingAddress {
|
|
@@ -33,6 +105,17 @@ declare namespace io.flow.merchant.onboarding.v0.models {
|
|
|
33
105
|
readonly 'country'?: string;
|
|
34
106
|
}
|
|
35
107
|
|
|
108
|
+
interface MerchantOnboardingBeneficiaryDetails {
|
|
109
|
+
readonly 'name'?: string;
|
|
110
|
+
readonly 'address'?: io.flow.common.v0.models.Address;
|
|
111
|
+
readonly 'phone'?: string;
|
|
112
|
+
readonly 'email'?: string;
|
|
113
|
+
readonly 'bank_account_number'?: string;
|
|
114
|
+
readonly 'bank_routing_number'?: string;
|
|
115
|
+
readonly 'bank_name'?: string;
|
|
116
|
+
readonly 'bank_address'?: io.flow.common.v0.models.Address;
|
|
117
|
+
}
|
|
118
|
+
|
|
36
119
|
interface MonthlyAverage {
|
|
37
120
|
readonly 'volume'?: io.flow.merchant.onboarding.v0.models.MonthlyAverageVolume;
|
|
38
121
|
readonly 'number_transactions'?: number;
|
|
@@ -97,6 +180,7 @@ declare namespace io.flow.merchant.onboarding.v0.models {
|
|
|
97
180
|
readonly 'third_party_logistics_partners'?: io.flow.merchant.onboarding.v0.models.ThirdPartyLogisticsPartner[];
|
|
98
181
|
readonly 'center_contact'?: io.flow.merchant.onboarding.v0.models.OperationsContact;
|
|
99
182
|
readonly 'average_order_weight'?: number;
|
|
183
|
+
readonly 'average_order_weight_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
|
|
100
184
|
readonly 'package_dimensions'?: io.flow.common.v0.models.Dimension[];
|
|
101
185
|
readonly 'monthly_average'?: io.flow.merchant.onboarding.v0.models.MonthlyAverage;
|
|
102
186
|
readonly 'default_country_of_origin'?: string;
|
|
@@ -130,6 +214,7 @@ declare namespace io.flow.merchant.onboarding.v0.models {
|
|
|
130
214
|
readonly 'third_party_logistics_partners'?: io.flow.merchant.onboarding.v0.models.ThirdPartyLogisticsPartner[];
|
|
131
215
|
readonly 'center_contact'?: io.flow.merchant.onboarding.v0.models.OperationsContact;
|
|
132
216
|
readonly 'average_order_weight'?: number;
|
|
217
|
+
readonly 'average_order_weight_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
|
|
133
218
|
readonly 'package_dimensions'?: io.flow.common.v0.models.Dimension[];
|
|
134
219
|
readonly 'monthly_average_volume_amount'?: number;
|
|
135
220
|
readonly 'monthly_average_volume_currency'?: string;
|
|
@@ -170,8 +255,8 @@ declare namespace io.flow.merchant.onboarding.v0.models {
|
|
|
170
255
|
}
|
|
171
256
|
|
|
172
257
|
declare namespace io.flow.merchant.onboarding.v0.unions {
|
|
173
|
-
type MerchantApplication = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplication);
|
|
174
|
-
type MerchantApplicationForm = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationForm);
|
|
175
|
-
type MerchantApplicationPutForm = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationPutForm);
|
|
176
|
-
type MerchantApplicationsSummary = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationsSummary);
|
|
258
|
+
type MerchantApplication = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplication | io.flow.merchant.onboarding.v0.models.CommonMerchantApplication);
|
|
259
|
+
type MerchantApplicationForm = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationForm | io.flow.merchant.onboarding.v0.models.CommonMerchantApplicationForm);
|
|
260
|
+
type MerchantApplicationPutForm = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationPutForm | io.flow.merchant.onboarding.v0.models.CommonMerchantApplicationPutForm);
|
|
261
|
+
type MerchantApplicationsSummary = (io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationsSummary | io.flow.merchant.onboarding.v0.models.CommonMerchantApplicationsSummary);
|
|
177
262
|
}
|
|
@@ -110,6 +110,22 @@ declare namespace io.flow.organization.v0.models {
|
|
|
110
110
|
readonly 'status'?: io.flow.common.v0.enums.OrganizationStatus;
|
|
111
111
|
}
|
|
112
112
|
|
|
113
|
+
interface OrganizationTaxRegistration {
|
|
114
|
+
readonly 'id': string;
|
|
115
|
+
readonly 'organization': io.flow.common.v0.models.OrganizationSummary;
|
|
116
|
+
readonly 'address': io.flow.common.v0.models.BillingAddress;
|
|
117
|
+
readonly 'registration': io.flow.organization.v0.models.TaxRegistrationDetail;
|
|
118
|
+
readonly 'self_billing_agreement': io.flow.organization.v0.models.SelfBillingAgreement;
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
interface OrganizationTaxRegistrationForm {
|
|
122
|
+
readonly 'tax_number': string;
|
|
123
|
+
readonly 'country': string;
|
|
124
|
+
readonly 'province'?: string;
|
|
125
|
+
readonly 'self_billing_agreement_effective_at': string;
|
|
126
|
+
readonly 'self_billing_agreement_expires_at'?: string;
|
|
127
|
+
}
|
|
128
|
+
|
|
113
129
|
interface OrganizationVersion {
|
|
114
130
|
readonly 'id': string;
|
|
115
131
|
readonly 'timestamp': string;
|
|
@@ -126,4 +142,16 @@ declare namespace io.flow.organization.v0.models {
|
|
|
126
142
|
interface RegionSettingForm {
|
|
127
143
|
readonly 'status': io.flow.common.v0.enums.AvailabilityStatus;
|
|
128
144
|
}
|
|
145
|
+
|
|
146
|
+
interface SelfBillingAgreement {
|
|
147
|
+
readonly 'effective_at': string;
|
|
148
|
+
readonly 'expires_at': string;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
interface TaxRegistrationDetail {
|
|
152
|
+
readonly 'tax_number': string;
|
|
153
|
+
readonly 'country': string;
|
|
154
|
+
readonly 'tax_code': string;
|
|
155
|
+
readonly 'province'?: string;
|
|
156
|
+
}
|
|
129
157
|
}
|
|
@@ -614,6 +614,7 @@ declare namespace io.flow.payment.gateway.v0.models {
|
|
|
614
614
|
readonly 'supported_actions': io.flow.payment.gateway.v0.enums.PaymentActionType[];
|
|
615
615
|
readonly 'payment_capture_option'?: io.flow.payment.gateway.v0.unions.PaymentCaptureOption;
|
|
616
616
|
readonly 'review'?: io.flow.payment.gateway.v0.models.PaymentRequestReview;
|
|
617
|
+
readonly 'client_secret'?: string;
|
|
617
618
|
}
|
|
618
619
|
|
|
619
620
|
interface PaymentRequestCancellationReasonOrderMissing {
|
|
@@ -12,7 +12,7 @@ declare namespace io.flow.payment.v0.enums {
|
|
|
12
12
|
type CvvCode = 'match' | 'suspicious' | 'unsupported' | 'no_match';
|
|
13
13
|
type CvvResultCode = 'matched' | 'not_available' | 'not_checked' | 'not_matched';
|
|
14
14
|
type PaymentErrorCode = 'duplicate' | 'invalid_amount' | 'invalid_currency' | 'invalid_method' | 'invalid_order' | 'invalid_customer' | 'invalid_destination' | 'unknown';
|
|
15
|
-
type PaymentFeeType = 'fx' | 'mor' | 'sp';
|
|
15
|
+
type PaymentFeeType = 'fx' | 'mor' | 'sp' | 'mor_tax';
|
|
16
16
|
type PaymentSourceConfirmationActionType = 'cvv' | 'billing_address' | 'number';
|
|
17
17
|
type RefundDeclineCode = 'expired' | 'insufficient_funds' | 'unknown';
|
|
18
18
|
type RefundFailureCategory = 'amount_too_high' | 'amount_too_low' | 'not_enough_balance' | 'insufficient_funds' | 'refund_period_expired' | 'dispute' | 'not_captured' | 'unsupported_payment_method' | 'unsupported_partial_refund' | 'invalid_currency' | 'card_no_longer_valid' | 'general';
|
|
@@ -78,6 +78,7 @@ declare namespace io.flow.ratecard.v0.models {
|
|
|
78
78
|
readonly 'amount': io.flow.common.v0.models.Money;
|
|
79
79
|
readonly 'origin_region'?: io.flow.ratecard.v0.models.RatecardRegionReference;
|
|
80
80
|
readonly 'destination_region'?: io.flow.ratecard.v0.models.RatecardRegionReference;
|
|
81
|
+
readonly 'destination_regions'?: io.flow.ratecard.v0.models.RatecardRegionReference[];
|
|
81
82
|
readonly 'interval_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
|
|
82
83
|
}
|
|
83
84
|
|
|
@@ -282,6 +283,7 @@ declare namespace io.flow.ratecard.v0.models {
|
|
|
282
283
|
readonly 'center_id'?: string;
|
|
283
284
|
readonly 'taxes_owed'?: io.flow.common.v0.models.Money;
|
|
284
285
|
readonly 'duties_owed'?: io.flow.common.v0.models.Money;
|
|
286
|
+
readonly 'commercial_invoice_mode'?: io.flow.label.v0.enums.CommercialInvoiceMode;
|
|
285
287
|
}
|
|
286
288
|
|
|
287
289
|
interface RatecardEstimateSummaryForm {
|
|
@@ -501,6 +503,43 @@ declare namespace io.flow.ratecard.v0.models {
|
|
|
501
503
|
readonly 'from': number;
|
|
502
504
|
readonly 'to': number;
|
|
503
505
|
}
|
|
506
|
+
|
|
507
|
+
interface ShippingRateEstimate {
|
|
508
|
+
readonly 'origin_address': io.flow.common.v0.models.Address;
|
|
509
|
+
readonly 'destination_address': io.flow.common.v0.models.Address;
|
|
510
|
+
readonly 'shipping_date_time': string;
|
|
511
|
+
readonly 'services': string[];
|
|
512
|
+
readonly 'available': io.flow.ratecard.v0.models.ShippingRateEstimateAvailable[];
|
|
513
|
+
readonly 'unavailable'?: io.flow.ratecard.v0.models.ShippingRateEstimateUnavailable[];
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
interface ShippingRateEstimateAvailable {
|
|
517
|
+
readonly 'service': io.flow.ratecard.v0.models.RatecardServiceSummary;
|
|
518
|
+
readonly 'delivered_duty': io.flow.common.v0.enums.DeliveredDuty;
|
|
519
|
+
readonly 'shipment_window': io.flow.ratecard.v0.models.ShipmentWindow;
|
|
520
|
+
readonly 'total_amount': io.flow.common.v0.models.Money;
|
|
521
|
+
readonly 'base_amount': io.flow.common.v0.models.Money;
|
|
522
|
+
readonly 'fees': io.flow.ratecard.v0.unions.RatecardFee[];
|
|
523
|
+
readonly 'dimensional_weight'?: io.flow.common.v0.models.Measurement;
|
|
524
|
+
readonly 'gravitational_weight'?: io.flow.common.v0.models.Measurement;
|
|
525
|
+
readonly 'weight_break'?: number;
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
interface ShippingRateEstimateRequest {
|
|
529
|
+
readonly 'origin_address': io.flow.common.v0.models.Address;
|
|
530
|
+
readonly 'destination_address': io.flow.common.v0.models.Address;
|
|
531
|
+
readonly 'package_dimensions': io.flow.common.v0.models.Dimension;
|
|
532
|
+
readonly 'shipping_date_time': string;
|
|
533
|
+
readonly 'delivered_duty'?: io.flow.common.v0.enums.DeliveredDuty;
|
|
534
|
+
readonly 'duties_owed'?: io.flow.common.v0.models.Money;
|
|
535
|
+
readonly 'taxes_owed'?: io.flow.common.v0.models.Money;
|
|
536
|
+
readonly 'line_items'?: io.flow.common.v0.models.LineItemForm[];
|
|
537
|
+
}
|
|
538
|
+
|
|
539
|
+
interface ShippingRateEstimateUnavailable {
|
|
540
|
+
readonly 'service': string;
|
|
541
|
+
readonly 'reason': string;
|
|
542
|
+
}
|
|
504
543
|
}
|
|
505
544
|
|
|
506
545
|
declare namespace io.flow.ratecard.v0.unions {
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
declare namespace io.flow.restrictions.v0.enums {
|
|
2
|
+
type RestrictedReviewStatus = 'in_review' | 'reviewed';
|
|
3
|
+
type RestrictionEnvironment = 'sandbox' | 'production' | 'qa';
|
|
4
|
+
type ReviewStatus = 'high_risk_in_review' | 'low_risk_in_review' | 'reviewed';
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
declare namespace io.flow.restrictions.v0.models {
|
|
8
|
+
interface CarrierRestrictions {
|
|
9
|
+
readonly 'carrier': string;
|
|
10
|
+
readonly 'regions': string[];
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
interface NeedsActionAttributes {
|
|
14
|
+
readonly 'reason_code': string;
|
|
15
|
+
readonly 'category_metafield_handles': string[];
|
|
16
|
+
readonly 'require_msds'?: boolean;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
interface ProductRestrictionResult {
|
|
20
|
+
readonly 'id': string;
|
|
21
|
+
readonly 'product_id': string;
|
|
22
|
+
readonly 'item_numbers': string[];
|
|
23
|
+
readonly 'prohibited_regions': string[];
|
|
24
|
+
readonly 'sellability_restricted_regions'?: string[];
|
|
25
|
+
readonly 'reasons_per_region'?: io.flow.restrictions.v0.models.ReasonsPerRegion[];
|
|
26
|
+
readonly 'review_status'?: io.flow.restrictions.v0.enums.ReviewStatus;
|
|
27
|
+
readonly 'rules'?: string[];
|
|
28
|
+
readonly 'updated_by'?: string;
|
|
29
|
+
readonly 'product_restriction_id'?: string;
|
|
30
|
+
readonly 'hs_code'?: string;
|
|
31
|
+
readonly 'restricted_regions_by_type'?: io.flow.sellability.v0.models.SellabilityRegionResult[];
|
|
32
|
+
readonly 'needs_action_attributes'?: io.flow.restrictions.v0.models.NeedsActionAttributes[];
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
interface ReasonsPerRegion {
|
|
36
|
+
readonly 'region': string;
|
|
37
|
+
readonly 'reasons': string[];
|
|
38
|
+
readonly 'review_status': io.flow.restrictions.v0.enums.RestrictedReviewStatus;
|
|
39
|
+
}
|
|
40
|
+
}
|
|
@@ -2,6 +2,9 @@ declare namespace io.flow.sellability.v0.enums {
|
|
|
2
2
|
type RuleEffectType = 'market' | 'dhl' | 'dhl_ecommerce' | 'ups';
|
|
3
3
|
type SellabilityErrorCode = 'insufficient_details' | 'ineligible_category' | 'wait_for_high_fidelity' | 'external_service_unavailable';
|
|
4
4
|
type SellabilityRequestStatus = 'commit';
|
|
5
|
+
type SellabilityResultErrorCode = 'insufficient_details' | 'generic_error';
|
|
6
|
+
type SellabilityResultStatus = 'in_review' | 'succeeded' | 'failed';
|
|
7
|
+
type SellabilityScreeningMode = 'pre_onboarding' | 'default_on' | 'active';
|
|
5
8
|
}
|
|
6
9
|
|
|
7
10
|
declare namespace io.flow.sellability.v0.models {
|
|
@@ -11,10 +14,11 @@ declare namespace io.flow.sellability.v0.models {
|
|
|
11
14
|
readonly 'product_id'?: string;
|
|
12
15
|
readonly 'request_id': string;
|
|
13
16
|
readonly 'hs6_code': string;
|
|
14
|
-
readonly 'restricted_regions': io.flow.sellability.v0.models.
|
|
17
|
+
readonly 'restricted_regions': io.flow.sellability.v0.models.SellabilityRegionResult[];
|
|
15
18
|
}
|
|
16
19
|
|
|
17
20
|
interface ProductSellabilityForm {
|
|
21
|
+
readonly 'discriminator': 'product_sellability_form';
|
|
18
22
|
readonly 'shop_id': string;
|
|
19
23
|
readonly 'product_id'?: string;
|
|
20
24
|
readonly 'name': string;
|
|
@@ -25,12 +29,76 @@ declare namespace io.flow.sellability.v0.models {
|
|
|
25
29
|
readonly 'dry_run'?: boolean;
|
|
26
30
|
}
|
|
27
31
|
|
|
32
|
+
interface ProductSellabilityResult {
|
|
33
|
+
readonly 'merchant_id'?: string;
|
|
34
|
+
readonly 'product_id': string;
|
|
35
|
+
readonly 'restricted_regions': io.flow.sellability.v0.models.SellabilityRestrictedRegion[];
|
|
36
|
+
readonly 'restricted_reasons': io.flow.sellability.v0.models.SellabilityRestrictedReason[];
|
|
37
|
+
readonly 'needs_action_attributes'?: io.flow.sellability.v0.models.SellabilityNeedsActionAttributes[];
|
|
38
|
+
readonly 'request_id'?: string;
|
|
39
|
+
readonly 'hs6_code'?: string;
|
|
40
|
+
}
|
|
41
|
+
|
|
28
42
|
interface SellabilityError {
|
|
29
43
|
readonly 'discriminator': 'sellability_error';
|
|
30
44
|
readonly 'code': io.flow.sellability.v0.enums.SellabilityErrorCode;
|
|
31
45
|
readonly 'messages': string[];
|
|
32
46
|
}
|
|
33
47
|
|
|
48
|
+
interface SellabilityNeedsActionAttributes {
|
|
49
|
+
readonly 'reason_code': string;
|
|
50
|
+
readonly 'category_metafield_handles': string[];
|
|
51
|
+
readonly 'require_msds'?: boolean;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
interface SellabilityReasonWithRegions {
|
|
55
|
+
readonly 'reason': string;
|
|
56
|
+
readonly 'regions': string[];
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
interface SellabilityRegionResult {
|
|
60
|
+
readonly 'type': io.flow.sellability.v0.enums.RuleEffectType;
|
|
61
|
+
readonly 'regions': string[];
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
interface SellabilityRegionWithReasons {
|
|
65
|
+
readonly 'region': string;
|
|
66
|
+
readonly 'reasons': string[];
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
interface SellabilityRestrictedReason {
|
|
70
|
+
readonly 'type': io.flow.sellability.v0.enums.RuleEffectType;
|
|
71
|
+
readonly 'reasons_with_regions': io.flow.sellability.v0.models.SellabilityReasonWithRegions[];
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
interface SellabilityRestrictedRegion {
|
|
75
|
+
readonly 'type': io.flow.sellability.v0.enums.RuleEffectType;
|
|
76
|
+
readonly 'regions': string[];
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
interface SellabilityScreening {
|
|
80
|
+
readonly 'discriminator': 'sellability_screening';
|
|
81
|
+
readonly 'product_sellability_result'?: io.flow.sellability.v0.models.ProductSellabilityResult;
|
|
82
|
+
readonly 'request_id': string;
|
|
83
|
+
readonly 'status': io.flow.sellability.v0.enums.SellabilityResultStatus;
|
|
84
|
+
readonly 'error_code'?: io.flow.sellability.v0.enums.SellabilityResultErrorCode;
|
|
85
|
+
readonly 'error_message'?: string;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
interface SellabilityScreeningForm {
|
|
89
|
+
readonly 'discriminator': 'sellability_screening_form';
|
|
90
|
+
readonly 'merchant_id': string;
|
|
91
|
+
readonly 'product_id': string;
|
|
92
|
+
readonly 'name': string;
|
|
93
|
+
readonly 'price': io.flow.common.v0.models.Money;
|
|
94
|
+
readonly 'description': string;
|
|
95
|
+
readonly 'taxonomy_category': io.flow.product.v0.models.ProductTaxonomyCategory;
|
|
96
|
+
readonly 'mode': io.flow.sellability.v0.enums.SellabilityScreeningMode;
|
|
97
|
+
readonly 'catalog_size'?: number;
|
|
98
|
+
readonly 'relative_ranking'?: number;
|
|
99
|
+
readonly 'dry_run'?: boolean;
|
|
100
|
+
}
|
|
101
|
+
|
|
34
102
|
interface SellablilityRegionResult {
|
|
35
103
|
readonly 'type': io.flow.sellability.v0.enums.RuleEffectType;
|
|
36
104
|
readonly 'regions': string[];
|
|
@@ -38,5 +106,6 @@ declare namespace io.flow.sellability.v0.models {
|
|
|
38
106
|
}
|
|
39
107
|
|
|
40
108
|
declare namespace io.flow.sellability.v0.unions {
|
|
41
|
-
type
|
|
109
|
+
type SellabilityRequest = (io.flow.sellability.v0.models.ProductSellabilityForm | io.flow.sellability.v0.models.SellabilityScreeningForm);
|
|
110
|
+
type SellabilityResponse = (io.flow.sellability.v0.models.ProductSellability | io.flow.sellability.v0.models.SellabilityError | io.flow.sellability.v0.models.SellabilityScreening);
|
|
42
111
|
}
|
package/generated/io.flow.shopify.markets.internal.event.v0.shopify-markets-internal-event.d.ts
CHANGED
|
@@ -252,8 +252,24 @@ declare namespace io.flow.shopify.markets.internal.event.v0.models {
|
|
|
252
252
|
readonly 'timestamp': string;
|
|
253
253
|
readonly 'shopify_product_taxonomy_attribute_value': io.flow.shopify.markets.internal.v0.models.ShopifyProductTaxonomyAttributeValue;
|
|
254
254
|
}
|
|
255
|
+
|
|
256
|
+
interface ShopifyTestOrderDeleted {
|
|
257
|
+
readonly 'discriminator': 'shopify_test_order_deleted';
|
|
258
|
+
readonly 'event_id': string;
|
|
259
|
+
readonly 'timestamp': string;
|
|
260
|
+
readonly 'organization': string;
|
|
261
|
+
readonly 'id': string;
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
interface ShopifyTestOrderUpserted {
|
|
265
|
+
readonly 'discriminator': 'shopify_test_order_upserted';
|
|
266
|
+
readonly 'event_id': string;
|
|
267
|
+
readonly 'timestamp': string;
|
|
268
|
+
readonly 'organization': string;
|
|
269
|
+
readonly 'shopify_test_order': io.flow.shopify.markets.internal.v0.models.ShopifyTestOrder;
|
|
270
|
+
}
|
|
255
271
|
}
|
|
256
272
|
|
|
257
273
|
declare namespace io.flow.shopify.markets.internal.event.v0.unions {
|
|
258
|
-
type ShopifyMarketsInternalEvent = (io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsOrderUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsOrderDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsShopUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsShopDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsWebhookRegistrationUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsWebhookRegistrationDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsShopStatisticsUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsShopStatisticsDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyProductTaxonomyAttributeUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyProductTaxonomyAttributeDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyProductTaxonomyAttributeValueUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyProductTaxonomyAttributeValueDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsMetricsUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsMetricsDeleted | io.flow.shopify.markets.internal.event.v0.models.ChannelOrderSummaryUpserted | io.flow.shopify.markets.internal.event.v0.models.ChannelOrderSummaryDeleted | io.flow.shopify.markets.internal.event.v0.models.ChannelOrganizationIdentifierUpserted | io.flow.shopify.markets.internal.event.v0.models.ChannelOrganizationIdentifierDeleted | io.flow.shopify.markets.internal.event.v0.models.OrderTaxAndDutyInclusivitySettingUpserted | io.flow.shopify.markets.internal.event.v0.models.OrderTaxAndDutyInclusivitySettingDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyProductBundleUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyProductBundleDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyIncotermSummaryErrorPublished | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsBestSellingProductUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsBestSellingProductDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyOrderRiskAssessmentUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyOrderRiskAssessmentDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyOrderTransactionUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyOrderTransactionDeleted);
|
|
274
|
+
type ShopifyMarketsInternalEvent = (io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsOrderUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsOrderDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsShopUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsShopDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsWebhookRegistrationUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsWebhookRegistrationDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsShopStatisticsUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsShopStatisticsDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyProductTaxonomyAttributeUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyProductTaxonomyAttributeDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyProductTaxonomyAttributeValueUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyProductTaxonomyAttributeValueDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsMetricsUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsMetricsDeleted | io.flow.shopify.markets.internal.event.v0.models.ChannelOrderSummaryUpserted | io.flow.shopify.markets.internal.event.v0.models.ChannelOrderSummaryDeleted | io.flow.shopify.markets.internal.event.v0.models.ChannelOrganizationIdentifierUpserted | io.flow.shopify.markets.internal.event.v0.models.ChannelOrganizationIdentifierDeleted | io.flow.shopify.markets.internal.event.v0.models.OrderTaxAndDutyInclusivitySettingUpserted | io.flow.shopify.markets.internal.event.v0.models.OrderTaxAndDutyInclusivitySettingDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyProductBundleUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyProductBundleDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyIncotermSummaryErrorPublished | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsBestSellingProductUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyMarketsBestSellingProductDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyOrderRiskAssessmentUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyOrderRiskAssessmentDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyOrderTransactionUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyOrderTransactionDeleted | io.flow.shopify.markets.internal.event.v0.models.ShopifyTestOrderUpserted | io.flow.shopify.markets.internal.event.v0.models.ShopifyTestOrderDeleted);
|
|
259
275
|
}
|
|
@@ -160,6 +160,14 @@ declare namespace io.flow.shopify.markets.internal.v0.models {
|
|
|
160
160
|
readonly 'shopify': io.flow.shopify.markets.internal.v0.models.ShopifyMarketsShopifyOrderMetrics;
|
|
161
161
|
readonly 'internal': io.flow.shopify.markets.internal.v0.models.ShopifyMarketsInternalOrderMetrics;
|
|
162
162
|
readonly 'discrepancy_data': io.flow.shopify.markets.internal.v0.models.ShopifyMarketsDiscrepancyData;
|
|
163
|
+
readonly 'organization_metrics'?: io.flow.shopify.markets.internal.v0.models.ShopifyMarketsOrganizationOrderMetrics[];
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
interface ShopifyMarketsOrganizationOrderMetrics {
|
|
167
|
+
readonly 'organization_id': string;
|
|
168
|
+
readonly 'shopify_order_count': number;
|
|
169
|
+
readonly 'internal_order_count': number;
|
|
170
|
+
readonly 'discrepancy_count'?: number;
|
|
163
171
|
}
|
|
164
172
|
|
|
165
173
|
interface ShopifyMarketsQueuedRecord {
|
|
@@ -287,6 +295,10 @@ declare namespace io.flow.shopify.markets.internal.v0.models {
|
|
|
287
295
|
readonly 'initial_product_restrictions_synced_at'?: string;
|
|
288
296
|
}
|
|
289
297
|
|
|
298
|
+
interface ShopifyTestOrder {
|
|
299
|
+
readonly 'id': string;
|
|
300
|
+
}
|
|
301
|
+
|
|
290
302
|
interface ThirdPartyLogisticsPartner {
|
|
291
303
|
readonly 'warehouse_address': io.flow.common.v0.models.BillingAddress;
|
|
292
304
|
readonly 'warehouse_url'?: string;
|
|
@@ -296,6 +296,7 @@ declare namespace io.flow.shopify.markets.v0.models {
|
|
|
296
296
|
readonly 'tags'?: string;
|
|
297
297
|
readonly 'tax_lines': io.flow.shopify.markets.v0.models.ShopifyOrderTaxLine[];
|
|
298
298
|
readonly 'taxes_included': boolean;
|
|
299
|
+
readonly 'test'?: boolean;
|
|
299
300
|
readonly 'token'?: string;
|
|
300
301
|
readonly 'total_weight'?: number;
|
|
301
302
|
readonly 'updated_at'?: string;
|
|
@@ -308,6 +309,7 @@ declare namespace io.flow.shopify.markets.v0.models {
|
|
|
308
309
|
readonly 'metafields'?: io.flow.shopify.markets.v0.models.ShopifyOrderMetafield[];
|
|
309
310
|
readonly 'merchant_of_record_app_id'?: number;
|
|
310
311
|
readonly 'total_shipping_price_set'?: io.flow.shopify.markets.v0.models.ShopifyOrderMoneySet;
|
|
312
|
+
readonly 'current_shipping_price_set'?: io.flow.shopify.markets.v0.models.ShopifyOrderMoneySet;
|
|
311
313
|
readonly 'total_tip_received'?: string;
|
|
312
314
|
}
|
|
313
315
|
|