@flowio/api-types 0.0.241 → 0.0.243

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.
@@ -1,6 +1,8 @@
1
1
  declare namespace io.flow.label.v0.enums {
2
2
  type CostEstimateSource = 'flow' | 'channel';
3
3
  type Direction = 'outbound' | 'return';
4
+ type EstimateOrigin = 'Shopify' | 'GlobalE' | 'Aftership' | 'Carrier';
5
+ type EstimateType = 'Estimated' | 'Final';
4
6
  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';
5
7
  type LabelTriggerMethod = 'autogenerated' | 'on_demand';
6
8
  type OriginLocationSource = 'public_hub_code' | 'merchant_hub_code_override' | 'shopify' | 'fallback_location';
@@ -76,6 +78,15 @@ declare namespace io.flow.label.v0.models {
76
78
  readonly 'shipment_recipient'?: io.flow.label.v0.enums.ShipmentRecipient;
77
79
  }
78
80
 
81
+ interface Estimate {
82
+ readonly 'id': string;
83
+ readonly 'organization_id': string;
84
+ readonly 'label_id': string;
85
+ readonly 'estimate': io.flow.label.v0.models.ShippingLabelHopSummary;
86
+ readonly 'type': io.flow.label.v0.enums.EstimateType;
87
+ readonly 'origin'?: io.flow.label.v0.enums.EstimateOrigin;
88
+ }
89
+
79
90
  interface LabelOrderSummary {
80
91
  readonly 'id': string;
81
92
  readonly 'number': string;
@@ -155,6 +155,17 @@ declare namespace io.flow.payment.v0.models {
155
155
  readonly 'display': string;
156
156
  }
157
157
 
158
+ interface AuthorizationRetry {
159
+ readonly 'id': string;
160
+ readonly 'authorization_request_id': string;
161
+ readonly 'authorization_id': string;
162
+ readonly 'organization_id': string;
163
+ readonly 'attempt': number;
164
+ readonly 'last_failure_code': string;
165
+ readonly 'created_at': string;
166
+ readonly 'updated_at': string;
167
+ }
168
+
158
169
  interface AuthorizationVersion {
159
170
  readonly 'id': string;
160
171
  readonly 'timestamp': string;
@@ -272,6 +283,7 @@ declare namespace io.flow.payment.v0.models {
272
283
  readonly 'processor'?: io.flow.payment.v0.unions.ExpandablePaymentProcessor;
273
284
  readonly 'stored_method_usage_step'?: io.flow.payment.v0.enums.StoredMethodUsageStep;
274
285
  readonly 'authorized_at'?: string;
286
+ readonly 'authorization_request_id'?: string;
275
287
  }
276
288
 
277
289
  interface CardBrowserActionConfiguration {
@@ -553,6 +565,7 @@ declare namespace io.flow.payment.v0.models {
553
565
  readonly 'processor'?: io.flow.payment.v0.unions.ExpandablePaymentProcessor;
554
566
  readonly 'confirmation_details'?: io.flow.payment.v0.unions.ConfirmationDetails;
555
567
  readonly 'authorized_at'?: string;
568
+ readonly 'authorization_request_id'?: string;
556
569
  }
557
570
 
558
571
  interface OnlinePaymentAuthorizationForm {
@@ -1,20 +1,21 @@
1
1
  declare namespace io.flow.sellability.v0.enums {
2
2
  type RuleEffectType = 'market' | 'dhl' | 'dhl_ecommerce' | 'ups';
3
+ type SellabilityErrorCode = 'insufficient_details' | 'ineligible_category';
3
4
  }
4
5
 
5
6
  declare namespace io.flow.sellability.v0.models {
6
7
  interface ProductSellability {
7
- readonly 'organization_id': string;
8
+ readonly 'shop_id': string;
8
9
  readonly 'product_id'?: string;
9
- readonly 'product_correlation_id': string;
10
+ readonly 'request_id': string;
11
+ readonly 'hs6_code': string;
10
12
  readonly 'restricted_regions': io.flow.sellability.v0.models.SellablilityRegionResult[];
11
- readonly 'in_review_regions': io.flow.sellability.v0.models.SellablilityRegionResult[];
12
13
  }
13
14
 
14
15
  interface ProductSellabilityForm {
15
- readonly 'organization_id': string;
16
+ readonly 'shop_id': string;
16
17
  readonly 'product_id'?: string;
17
- readonly 'product_correlation_id': string;
18
+ readonly 'request_id': string;
18
19
  readonly 'name': string;
19
20
  readonly 'price': io.flow.sellability.v0.models.ProductSellabilityPrice;
20
21
  readonly 'description': string;
@@ -26,6 +27,11 @@ declare namespace io.flow.sellability.v0.models {
26
27
  readonly 'amount': number;
27
28
  }
28
29
 
30
+ interface SellabilityError {
31
+ readonly 'code': io.flow.sellability.v0.enums.SellabilityErrorCode;
32
+ readonly 'messages': string[];
33
+ }
34
+
29
35
  interface SellablilityRegionResult {
30
36
  readonly 'type': io.flow.sellability.v0.enums.RuleEffectType;
31
37
  readonly 'regions': string[];
@@ -69,8 +69,21 @@ declare namespace io.flow.shopify.external.v0.models {
69
69
  }
70
70
 
71
71
  interface GraphqlMetafield {
72
+ readonly 'id': string;
72
73
  readonly 'key': string;
73
74
  readonly 'value': string;
75
+ readonly 'type'?: string;
76
+ }
77
+
78
+ interface GraphqlMetaobject {
79
+ readonly 'id': string;
80
+ readonly 'displayName': string;
81
+ readonly 'fields': io.flow.shopify.external.v0.models.GraphqlMetaobjectField[];
82
+ }
83
+
84
+ interface GraphqlMetaobjectField {
85
+ readonly 'key': string;
86
+ readonly 'value'?: string;
74
87
  }
75
88
 
76
89
  interface GraphqlOption {
@@ -246,6 +259,7 @@ declare namespace io.flow.shopify.external.v0.models {
246
259
  readonly 'updated_at': string;
247
260
  readonly 'has_variants_that_requires_components'?: boolean;
248
261
  readonly 'category'?: io.flow.product.v0.models.ProductTaxonomyCategory;
262
+ readonly 'metafields'?: io.flow.shopify.external.v0.models.ProductMetafield[];
249
263
  }
250
264
 
251
265
  interface ProductDelete {
@@ -263,6 +277,17 @@ declare namespace io.flow.shopify.external.v0.models {
263
277
  readonly 'alt'?: string;
264
278
  }
265
279
 
280
+ interface ProductMetafield {
281
+ readonly 'id': number;
282
+ readonly 'namespace': string;
283
+ readonly 'key': string;
284
+ readonly 'value': string;
285
+ readonly 'created_at': string;
286
+ readonly 'updated_at': string;
287
+ readonly 'type': string;
288
+ readonly 'admin_graphql_api_id': string;
289
+ }
290
+
266
291
  interface ProductVariant {
267
292
  readonly 'id': number;
268
293
  readonly 'sku'?: string;
@@ -5,6 +5,7 @@ declare namespace io.flow.stripe.v0.enums {
5
5
  type BankIdeal = 'abn_amro' | 'asn_bank' | 'bunq' | 'handelsbanken' | 'ing' | 'knab' | 'moneyou' | 'n26' | 'nn' | 'rabobank' | 'regiobank' | 'revolut' | 'sns_bank' | 'triodos_bank' | 'van_lanschot' | 'yoursafe';
6
6
  type BicIdeal = 'ABNANL2A' | 'ASNBNL21' | 'BITSNL2A' | 'BUNQNL2A' | 'FVLBNL22' | 'HANDNL2A' | 'INGBNL2A' | 'KNABNL2H' | 'MOYONL21' | 'NNBANL2G' | 'NTSBDEB1' | 'RABONL2U' | 'RBRBNL21' | 'REVOIE23' | 'REVOLT21' | 'SNSBNL2A' | 'TRIONL2U';
7
7
  type CancellationReason = 'abandoned' | 'automatic' | 'duplicate' | 'failed_invoice' | 'fraudulent' | 'requested_by_customer' | 'void_invoice';
8
+ type CapabilityStatus = 'active' | 'disabled' | 'inactive' | 'pending' | 'unrequested';
8
9
  type CaptureMethod = 'automatic' | 'manual';
9
10
  type CardBrand = 'American Express' | 'MasterCard' | 'Discover' | 'JCB' | 'Diners Club' | 'Unknown';
10
11
  type CardFundingType = 'credit' | 'debit' | 'prepaid' | 'unknown';
@@ -22,7 +23,7 @@ declare namespace io.flow.stripe.v0.enums {
22
23
  type EarlyFraudWarningType = 'card_never_received' | 'fraudulent_card_application' | 'made_with_counterfeit_card' | 'made_with_lost_card' | 'made_with_stolen_card' | 'unauthorized_use_of_card' | 'misc';
23
24
  type ErrorCode = 'invalid_number' | 'invalid_expiry_month' | 'invalid_expiry_year' | 'invalid_cvc' | 'invalid_swipe_data' | 'country_code_invalid' | 'email_invalid' | 'postal_code_invalid' | 'invalid_characters' | 'url_invalid' | 'invalid_charge_amount' | 'incorrect_number' | 'incorrect_address' | 'incorrect_cvc' | 'incorrect_zip' | 'card_declined' | 'expired_card' | 'missing' | 'processing_error' | 'account_closed' | 'amount_too_small' | 'amount_too_large' | 'api_key_expired' | 'authentication_required' | 'capture_charge_authorization_expired' | 'capture_unauthorized_payment' | 'card_decline_rate_limit_exceeded' | 'charge_already_captured' | 'charge_already_refunded' | 'charge_disputed' | 'charge_exceeds_source_limit' | 'charge_expired_for_capture' | 'charge_invalid_parameter' | 'charge_not_refundable' | 'insufficient_funds' | 'intent_invalid_state' | 'livemode_mismatch' | 'parameter_invalid_empty' | 'parameter_invalid_integer' | 'parameter_invalid_string_blank' | 'parameter_invalid_string_empty' | 'parameter_missing' | 'parameter_unknown' | 'parameters_exclusive' | 'payment_intent_action_required' | 'payment_intent_authentication_failure' | 'payment_intent_incompatible_payment_method' | 'payment_intent_payment_attempt_expired' | 'payment_intent_payment_attempt_failed' | 'payment_intent_unexpected_state' | 'payment_intent_invalid_parameter' | 'payment_method_billing_details_address_missing' | 'payment_method_customer_decline' | 'payment_method_currency_mismatch' | 'payment_method_invalid_parameter' | 'payment_method_invalid_parameter_testmode' | 'payment_method_not_available' | 'payment_method_provider_decline' | 'payment_method_provider_timeout' | 'payment_method_unactivated' | 'payment_method_unexpected_state' | 'payment_method_unsupported_type' | 'platform_api_key_expired' | 'refund_disputed_payment' | 'testmode_charges_only' | 'tls_version_unsupported' | 'setup_attempt_failed' | 'setup_intent_authentication_failure' | 'setup_intent_invalid_parameter' | 'setup_intent_setup_attempt_expired' | 'setup_intent_unexpected_state';
24
25
  type ErrorType = 'api_connection_error' | 'api_error' | 'authentication_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error' | 'rate_limit_error' | 'validation_error';
25
- type EventType = 'charge.captured' | 'charge.failed' | 'charge.pending' | 'charge.refunded' | 'charge.expired' | 'charge.succeeded' | 'charge.updated' | 'charge.refund.updated' | 'charge.dispute.closed' | 'charge.dispute.created' | 'charge.dispute.funds_reinstated' | 'charge.dispute.funds_withdrawn' | 'charge.dispute.updated' | 'payment_intent.created' | 'payment_intent.amount_capturable_updated' | 'payment_intent.payment_failed' | 'payment_intent.succeeded' | 'payment_intent.requires_action' | 'payment_intent.canceled' | 'payment_intent.processing' | 'source.canceled' | 'source.chargeable' | 'source.failed';
26
+ type EventType = 'capability.updated' | 'charge.captured' | 'charge.failed' | 'charge.pending' | 'charge.refunded' | 'charge.expired' | 'charge.succeeded' | 'charge.updated' | 'charge.refund.updated' | 'charge.dispute.closed' | 'charge.dispute.created' | 'charge.dispute.funds_reinstated' | 'charge.dispute.funds_withdrawn' | 'charge.dispute.updated' | 'payment_intent.created' | 'payment_intent.amount_capturable_updated' | 'payment_intent.payment_failed' | 'payment_intent.succeeded' | 'payment_intent.requires_action' | 'payment_intent.canceled' | 'payment_intent.processing' | 'source.canceled' | 'source.chargeable' | 'source.failed';
26
27
  type ExtendedAuthorizationStatus = 'enabled' | 'disabled';
27
28
  type FeatureAvailability = 'available' | 'unavailable';
28
29
  type KlarnaPaymentMethodCategoryType = 'direct_bank_transfer' | 'direct_debit' | 'pay_later' | 'pay_now' | 'pay_over_time';
@@ -40,9 +41,12 @@ declare namespace io.flow.stripe.v0.enums {
40
41
  type RefundFailureReason = 'charge_for_pending_refund_disputed' | 'declined' | 'expired_or_canceled_card' | 'insufficient_funds' | 'lost_or_stolen_card' | 'merchant_request' | 'unknown';
41
42
  type RefundReason = 'duplicate' | 'fraudulent' | 'requested_by_customer';
42
43
  type RefundStatus = 'succeeded' | 'failed' | 'pending' | 'canceled';
44
+ type ReportingReportRunStatus = 'pending' | 'succeeded' | 'failed';
45
+ type ReportingReportType = 'ending_balance_reconciliation.itemized.1' | 'ending_balance_reconciliation.itemized.2' | 'ending_balance_reconciliation.itemized.3' | 'ending_balance_reconciliation.itemized.4' | 'payout_reconciliation.itemized.5' | 'payout_reconciliation.by_id.itemized.1' | 'payout_reconciliation.by_id.itemized.2' | 'payout_reconciliation.by_id.itemized.3' | 'payout_reconciliation.by_id.itemized.4' | 'payout_reconciliation.by_id.summary.1' | 'ending_balance_reconciliation.summary.1' | 'payout_reconciliation.itemized.1' | 'payout_reconciliation.itemized.2' | 'payout_reconciliation.itemized.3' | 'payout_reconciliation.itemized.4' | 'payout_reconciliation.summary.1';
43
46
  type RequestThreeDSecureType = 'automatic' | 'any';
44
47
  type RequestedCapabilities = 'card_payments' | 'legacy_payments' | 'transfers';
45
48
  type SetupFutureUsage = 'on_session' | 'off_session';
49
+ type ShopifyPaymentStripeEventType = 'charge.captured' | 'charge.dispute.created' | 'charge.dispute.closed' | 'charge.dispute.funds_reinstated' | 'charge.dispute.funds_withdrawn' | 'charge.dispute.updated' | 'charge.expired' | 'charge.failed' | 'charge.pending' | 'charge.refund.updated' | 'charge.refunded' | 'charge.succeeded' | 'charge.updated' | 'payment_intent.amount_capturable_updated' | 'payment_intent.canceled' | 'payment_intent.created' | 'payment_intent.partially_funded' | 'payment_intent.payment_failed' | 'payment_intent.processing' | 'payment_intent.requires_action' | 'payment_intent.succeeded' | 'transfer.created' | 'transfer.reversed' | 'transfer.updated' | 'reporting.report_run.succeeded' | 'reporting.report_type.updated' | 'reporting.report_type.failed';
46
50
  type SourceFlow = 'redirect' | 'receiver' | 'code_verification' | 'none';
47
51
  type SourceStatus = 'canceled' | 'chargeable' | 'consumed' | 'failed' | 'pending';
48
52
  type SourceType = 'ach_credit_transfer' | 'ach_debit' | 'alipay' | 'bancontact' | 'bitcoin' | 'card' | 'eps' | 'giropay' | 'ideal' | 'klarna' | 'multibanco' | 'p24' | 'sepa_debit' | 'sofort' | 'three_d_secure';
@@ -111,6 +115,17 @@ declare namespace io.flow.stripe.v0.models {
111
115
  readonly 'type': io.flow.stripe.v0.enums.ApplePayType;
112
116
  }
113
117
 
118
+ interface Capability {
119
+ readonly 'id': string;
120
+ readonly 'account': string;
121
+ readonly 'requested': boolean;
122
+ readonly 'requirements': any/*object*/;
123
+ readonly 'status': io.flow.stripe.v0.enums.CapabilityStatus;
124
+ readonly 'object': string;
125
+ readonly 'future_requirements': any/*object*/;
126
+ readonly 'requested_at'?: number;
127
+ }
128
+
114
129
  interface Card {
115
130
  readonly 'id': string;
116
131
  readonly 'object': string;
@@ -936,12 +951,76 @@ declare namespace io.flow.stripe.v0.models {
936
951
  readonly 'url': string;
937
952
  }
938
953
 
954
+ interface ReportRunParameters {
955
+ readonly 'interval_start': number;
956
+ readonly 'interval_end': number;
957
+ readonly 'columns'?: string[];
958
+ readonly 'payout'?: string;
959
+ readonly 'connected_account'?: string;
960
+ readonly 'reporting_category'?: string;
961
+ }
962
+
963
+ interface ReportingReportRun {
964
+ readonly 'id': string;
965
+ readonly 'object': string;
966
+ readonly 'created': number;
967
+ readonly 'error'?: string;
968
+ readonly 'livemode': boolean;
969
+ readonly 'status': io.flow.stripe.v0.enums.ReportingReportRunStatus;
970
+ readonly 'result'?: io.flow.stripe.v0.models.ReportingReportRunResult;
971
+ readonly 'succeeded_at'?: number;
972
+ }
973
+
974
+ interface ReportingReportRunForm {
975
+ readonly 'report_type': io.flow.stripe.v0.enums.ReportingReportType;
976
+ readonly 'parameters': io.flow.stripe.v0.models.ReportRunParameters;
977
+ }
978
+
979
+ interface ReportingReportRunResult {
980
+ readonly 'id': string;
981
+ readonly 'object': string;
982
+ readonly 'created': number;
983
+ readonly 'expires_at': number;
984
+ readonly 'filename': string;
985
+ readonly 'links': any/*object*/;
986
+ readonly 'purpose': string;
987
+ readonly 'size': number;
988
+ readonly 'title': string;
989
+ readonly 'type': string;
990
+ readonly 'url': string;
991
+ }
992
+
993
+ interface ReportingReportRuns {
994
+ readonly 'object': string;
995
+ readonly 'data': io.flow.stripe.v0.models.ReportingReportRun[];
996
+ readonly 'has_more': boolean;
997
+ readonly 'url'?: string;
998
+ }
999
+
939
1000
  interface Shipping {
940
1001
  readonly 'address': io.flow.stripe.v0.models.Address;
941
1002
  readonly 'name'?: string;
942
1003
  readonly 'phone'?: string;
943
1004
  }
944
1005
 
1006
+ interface ShopifyPaymentStripeEvent {
1007
+ readonly 'id': string;
1008
+ readonly 'api_version'?: string;
1009
+ readonly 'data': io.flow.stripe.v0.models.ShopifyPaymentStripeEventData;
1010
+ readonly 'request'?: any/*object*/;
1011
+ readonly 'type': io.flow.stripe.v0.enums.ShopifyPaymentStripeEventType;
1012
+ readonly 'object': string;
1013
+ readonly 'account'?: string;
1014
+ readonly 'created': number;
1015
+ readonly 'livemode': boolean;
1016
+ readonly 'pending_webhooks': number;
1017
+ }
1018
+
1019
+ interface ShopifyPaymentStripeEventData {
1020
+ readonly 'object'?: any/*object*/;
1021
+ readonly 'previous_attributes'?: any/*object*/;
1022
+ }
1023
+
945
1024
  interface Source {
946
1025
  readonly 'id': string;
947
1026
  readonly 'object': string;
@@ -43,13 +43,6 @@ declare namespace io.flow.tech.onboarding.playground.v0.models {
43
43
  readonly 'name': string;
44
44
  }
45
45
 
46
- interface ShawnRoundtableWorkshopRate {
47
- readonly 'origin_country': string;
48
- readonly 'destination_country': string;
49
- readonly 'weight': number;
50
- readonly 'amount': number;
51
- }
52
-
53
46
  interface TechOnboardingDescription {
54
47
  readonly 'description': string;
55
48
  }
@@ -1,6 +1,6 @@
1
1
  declare namespace io.flow.tracking.v0.enums {
2
2
  type SubstatusCode = 'Delivered_001' | 'Delivered_002' | 'Delivered_003' | 'Delivered_004' | 'AvailableForPickup_001' | 'Exception_001' | 'Exception_002' | 'Exception_003' | 'Exception_004' | 'Exception_005' | 'Exception_006' | 'Exception_007' | 'Exception_008' | 'Exception_009' | 'Exception_010' | 'Exception_011' | 'Exception_012' | 'Exception_013' | 'AttemptFail_001' | 'AttemptFail_002' | 'AttemptFail_003' | 'InTransit_001' | 'InTransit_002' | 'InTransit_003' | 'InTransit_004' | 'InTransit_005' | 'InTransit_006' | 'InTransit_007' | 'InTransit_008' | 'InTransit_009' | 'InfoReceived_001' | 'OutForDelivery_001' | 'OutForDelivery_003' | 'OutForDelivery_004' | 'Pending_001' | 'Pending_002' | 'Pending_003' | 'Pending_004' | 'Pending_005' | 'Pending_006' | 'Expired_001';
3
- type TrackingStatus = 'label_created' | 'pending' | 'info_received' | 'picked_up' | 'in_transit' | 'out_for_delivery' | 'attempt_fail' | 'delivered' | 'exception' | 'returned' | 'expired';
3
+ type TrackingStatus = 'label_created' | 'pending' | 'info_received' | 'picked_up' | 'in_transit' | 'out_for_delivery' | 'attempt_fail' | 'delivered' | 'exception' | 'returned' | 'expired' | 'unknown' | 'unmapped';
4
4
  }
5
5
 
6
6
  declare namespace io.flow.tracking.v0.models {