@flowio/api-types 0.0.224 → 0.0.226

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.
@@ -73,6 +73,13 @@ declare namespace io.flow.label.v0.models {
73
73
  readonly 'number': string;
74
74
  }
75
75
 
76
+ interface LabelProcessingModification {
77
+ readonly 'id': string;
78
+ readonly 'modifications': string[];
79
+ readonly 'destination': io.flow.fulfillment.v0.models.ShippingAddress;
80
+ readonly 'destination_provided_to_carrier'?: io.flow.fulfillment.v0.models.ShippingAddress;
81
+ }
82
+
76
83
  interface LabelReference {
77
84
  readonly 'id': string;
78
85
  }
@@ -11,6 +11,7 @@ declare namespace io.flow.organization.onboarding.state.v0.models {
11
11
 
12
12
  interface DeactivationPutForm {
13
13
  readonly 'reason': string;
14
+ readonly 'deactivate_at'?: string;
14
15
  }
15
16
 
16
17
  interface InComplianceReview {
@@ -26,6 +27,7 @@ declare namespace io.flow.organization.onboarding.state.v0.models {
26
27
  interface MerchantDeactivated {
27
28
  readonly 'discriminator': 'merchant_deactivated';
28
29
  readonly 'reason': string;
30
+ readonly 'deactivate_at'?: string;
29
31
  }
30
32
 
31
33
  interface MerchantDisabled {
@@ -189,6 +189,7 @@ declare namespace io.flow.payment.gateway.v0.models {
189
189
  readonly 'currency': string;
190
190
  readonly 'base_amount'?: number;
191
191
  readonly 'base_currency'?: string;
192
+ readonly 'reference'?: string;
192
193
  }
193
194
 
194
195
  interface PaymentAuthorizationStatus {
@@ -202,6 +203,7 @@ declare namespace io.flow.payment.gateway.v0.models {
202
203
  readonly 'currency': string;
203
204
  readonly 'base_amount'?: number;
204
205
  readonly 'base_currency'?: string;
206
+ readonly 'reference'?: string;
205
207
  readonly 'created_at': string;
206
208
  readonly 'updated_at': string;
207
209
  readonly 'status': io.flow.payment.gateway.v0.models.PaymentCaptureStatus;
@@ -210,6 +212,7 @@ declare namespace io.flow.payment.gateway.v0.models {
210
212
  interface PaymentCaptureForm {
211
213
  readonly 'amount'?: number;
212
214
  readonly 'currency'?: string;
215
+ readonly 'reference'?: string;
213
216
  readonly 'attributes'?: Record<string, string>;
214
217
  }
215
218
 
@@ -325,6 +328,7 @@ declare namespace io.flow.payment.gateway.v0.models {
325
328
  readonly 'device_fingerprint_details': io.flow.payment.gateway.v0.unions.DeviceFingerprintDetails;
326
329
  readonly 'cvv'?: string;
327
330
  readonly 'stored_details_card'?: io.flow.payment.gateway.v0.unions.PaymentMethodStoredDetailsCard;
331
+ readonly 'reference'?: string;
328
332
  }
329
333
 
330
334
  interface PaymentMethodDataAuthorizeGooglepay {
@@ -360,42 +364,43 @@ declare namespace io.flow.payment.gateway.v0.models {
360
364
 
361
365
  interface PaymentMethodDataInitAfterpay {
362
366
  readonly 'type': 'init_afterpay';
363
- readonly 'placeholder'?: string;
367
+ readonly 'reference'?: string;
364
368
  }
365
369
 
366
370
  interface PaymentMethodDataInitApplepay {
367
371
  readonly 'type': 'init_applepay';
368
- readonly 'placeholder'?: string;
372
+ readonly 'reference'?: string;
369
373
  }
370
374
 
371
375
  interface PaymentMethodDataInitBancontact {
372
376
  readonly 'type': 'init_bancontact';
373
- readonly 'placeholder'?: string;
377
+ readonly 'reference'?: string;
374
378
  }
375
379
 
376
380
  interface PaymentMethodDataInitGooglepay {
377
381
  readonly 'type': 'init_googlepay';
378
- readonly 'placeholder'?: string;
382
+ readonly 'reference'?: string;
379
383
  }
380
384
 
381
385
  interface PaymentMethodDataInitIdeal {
382
386
  readonly 'type': 'init_ideal';
383
387
  readonly 'issuer'?: string;
388
+ readonly 'reference'?: string;
384
389
  }
385
390
 
386
391
  interface PaymentMethodDataInitKlarna {
387
392
  readonly 'type': 'init_klarna';
388
- readonly 'placeholder'?: string;
393
+ readonly 'reference'?: string;
389
394
  }
390
395
 
391
396
  interface PaymentMethodDataInitPaypal {
392
397
  readonly 'type': 'init_paypal';
393
- readonly 'placeholder'?: string;
398
+ readonly 'reference'?: string;
394
399
  }
395
400
 
396
401
  interface PaymentMethodDataInitSofort {
397
402
  readonly 'type': 'init_sofort';
398
- readonly 'placeholder'?: string;
403
+ readonly 'reference'?: string;
399
404
  }
400
405
 
401
406
  interface PaymentMethodDataOptionLogoSvg {
@@ -482,7 +487,7 @@ declare namespace io.flow.payment.gateway.v0.models {
482
487
  }
483
488
 
484
489
  interface PaymentOrderDetailsLineItem {
485
- readonly 'id': string;
490
+ readonly 'id'?: string;
486
491
  readonly 'description': string;
487
492
  readonly 'quantity': number;
488
493
  readonly 'amount': number;
@@ -510,6 +515,7 @@ declare namespace io.flow.payment.gateway.v0.models {
510
515
  readonly 'currency': string;
511
516
  readonly 'base_amount'?: number;
512
517
  readonly 'base_currency'?: string;
518
+ readonly 'reference'?: string;
513
519
  readonly 'created_at': string;
514
520
  readonly 'updated_at': string;
515
521
  readonly 'status': io.flow.payment.gateway.v0.models.PaymentRefundStatus;
@@ -518,6 +524,7 @@ declare namespace io.flow.payment.gateway.v0.models {
518
524
  interface PaymentRefundForm {
519
525
  readonly 'amount'?: number;
520
526
  readonly 'currency'?: string;
527
+ readonly 'reference'?: string;
521
528
  }
522
529
 
523
530
  interface PaymentRefundStatus {
@@ -584,6 +591,7 @@ declare namespace io.flow.payment.gateway.v0.models {
584
591
  readonly 'currency': string;
585
592
  readonly 'base_amount'?: number;
586
593
  readonly 'base_currency'?: string;
594
+ readonly 'reference'?: string;
587
595
  readonly 'created_at': string;
588
596
  readonly 'updated_at': string;
589
597
  readonly 'status': io.flow.payment.gateway.v0.models.PaymentReversalStatus;
@@ -592,6 +600,7 @@ declare namespace io.flow.payment.gateway.v0.models {
592
600
  interface PaymentReversalForm {
593
601
  readonly 'amount'?: number;
594
602
  readonly 'currency'?: string;
603
+ readonly 'reference'?: string;
595
604
  }
596
605
 
597
606
  interface PaymentReversalStatus {
@@ -833,15 +833,6 @@ declare namespace io.flow.payment.internal.v0.models {
833
833
  readonly 'id': string;
834
834
  readonly 'description': string;
835
835
  }
836
-
837
- interface VirtualCardProvider {
838
- readonly 'id': string;
839
- readonly 'organization_id': string;
840
- readonly 'provider': string;
841
- readonly 'attributes'?: Record<string, string>;
842
- readonly 'created_at': string;
843
- readonly 'updated_at': string;
844
- }
845
836
  }
846
837
 
847
838
  declare namespace io.flow.payment.internal.v0.unions {
@@ -915,11 +915,6 @@ declare namespace io.flow.payment.v0.models {
915
915
  readonly 'virtual_card_capture': io.flow.payment.v0.models.VirtualCardCapture;
916
916
  }
917
917
 
918
- interface VirtualCardForm {
919
- readonly 'limit': io.flow.common.v0.models.Money;
920
- readonly 'attributes'?: Record<string, string>;
921
- }
922
-
923
918
  interface VirtualCardReference {
924
919
  readonly 'id': string;
925
920
  }
@@ -24,6 +24,7 @@ declare namespace io.flow.shopify.external.v0.enums {
24
24
  type ShopifyCustomerState = 'disabled' | 'invited' | 'enabled';
25
25
  type ShopifyDiscountPaginationDirection = 'next' | 'prev';
26
26
  type ShopifyGiftCardStatus = 'any' | 'enabled' | 'disabled';
27
+ type ShopifyPlanName = 'basic' | 'business' | 'cancelled' | 'dormant' | 'enterprise' | 'fraudulent' | 'frozen' | 'npo_full' | 'npo_lite' | 'open_learning' | 'paid_trial' | 'professional' | 'retail' | 'shopify_alumni' | 'shopify_plus' | 'staff' | 'staff_business' | 'starter' | 'starter_2022' | 'unlimited';
27
28
  type ShopifyProcessingMethodType = 'checkout' | 'direct' | 'manual' | 'offsite' | 'express';
28
29
  type ShopifyTransactionErrorCode = 'incorrect_number' | 'invalid_number' | 'invalid_expiry_date' | 'invalid_cvc' | 'expired_card' | 'incorrect_cvc' | 'incorrect_zip' | 'incorrect_address' | 'card_declined' | 'processing_error' | 'call_issuer' | 'pick_up_card';
29
30
  type ShopifyTransactionStatus = 'pending' | 'failure' | 'success' | 'error';
@@ -172,7 +173,7 @@ declare namespace io.flow.shopify.external.v0.models {
172
173
  readonly 'id': number;
173
174
  readonly 'product_id': number;
174
175
  readonly 'variant_ids': number[];
175
- readonly 'src': string;
176
+ readonly 'src'?: string;
176
177
  readonly 'position': number;
177
178
  readonly 'created_at': string;
178
179
  readonly 'updated_at': string;
@@ -784,6 +785,12 @@ declare namespace io.flow.shopify.external.v0.models {
784
785
  readonly 'carrier_identifier'?: string;
785
786
  }
786
787
 
788
+ interface ShopifyShopUpdate {
789
+ readonly 'id': number;
790
+ readonly 'plan_display_name': string;
791
+ readonly 'plan_name': io.flow.shopify.external.v0.enums.ShopifyPlanName;
792
+ }
793
+
787
794
  interface ShopifyTaxLine {
788
795
  readonly 'price': string;
789
796
  readonly 'rate': number;
@@ -15,6 +15,22 @@ declare namespace io.flow.shopify.markets.internal.event.v0.models {
15
15
  readonly 'channel_order_summary': io.flow.shopify.markets.internal.v0.models.ChannelOrderSummary;
16
16
  }
17
17
 
18
+ interface ChannelOrganizationIdentifierDeleted {
19
+ readonly 'discriminator': 'channel_organization_identifier_deleted';
20
+ readonly 'event_id': string;
21
+ readonly 'timestamp': string;
22
+ readonly 'channel_id': string;
23
+ readonly 'id': string;
24
+ }
25
+
26
+ interface ChannelOrganizationIdentifierUpserted {
27
+ readonly 'discriminator': 'channel_organization_identifier_upserted';
28
+ readonly 'event_id': string;
29
+ readonly 'timestamp': string;
30
+ readonly 'channel_id': string;
31
+ readonly 'channel_organization_identifier': io.flow.shopify.markets.internal.v0.models.ChannelOrganizationIdentifier;
32
+ }
33
+
18
34
  interface ShopifyMarketsMetricsDeleted {
19
35
  readonly 'discriminator': 'shopify_markets_metrics_deleted';
20
36
  readonly 'event_id': string;
@@ -100,5 +116,5 @@ declare namespace io.flow.shopify.markets.internal.event.v0.models {
100
116
  }
101
117
 
102
118
  declare namespace io.flow.shopify.markets.internal.event.v0.unions {
103
- 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.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);
119
+ 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.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);
104
120
  }
@@ -28,6 +28,12 @@ declare namespace io.flow.shopify.markets.internal.v0.models {
28
28
  readonly 'timestamp': string;
29
29
  }
30
30
 
31
+ interface ChannelOrganizationIdentifier {
32
+ readonly 'id': string;
33
+ readonly 'organization': io.flow.common.v0.models.OrganizationReference;
34
+ readonly 'identifier': string;
35
+ }
36
+
31
37
  interface FlowShopValidationError {
32
38
  readonly 'message': string;
33
39
  readonly 'reason': string;
@@ -45,6 +51,10 @@ declare namespace io.flow.shopify.markets.internal.v0.models {
45
51
  readonly 'flow_authorization'?: io.flow.payment.v0.unions.Authorization;
46
52
  }
47
53
 
54
+ interface MarketsOrderSummary {
55
+ readonly 'id': string;
56
+ }
57
+
48
58
  interface OrderValidationError {
49
59
  readonly 'message': string;
50
60
  readonly 'reason': io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceRejectionReason;
@@ -117,6 +127,7 @@ declare namespace io.flow.shopify.markets.internal.v0.models {
117
127
  readonly 'api_key_masked'?: string;
118
128
  readonly 'api_password_masked'?: string;
119
129
  readonly 'access_token_masked'?: string;
130
+ readonly 'shopify_plan_name'?: io.flow.shopify.external.v0.enums.ShopifyPlanName;
120
131
  }
121
132
 
122
133
  interface ShopifyMarketsShopForm {
@@ -127,6 +138,7 @@ declare namespace io.flow.shopify.markets.internal.v0.models {
127
138
  readonly 'api_key'?: string;
128
139
  readonly 'api_password'?: string;
129
140
  readonly 'access_token'?: string;
141
+ readonly 'shopify_plan_name'?: io.flow.shopify.external.v0.enums.ShopifyPlanName;
130
142
  }
131
143
 
132
144
  interface ShopifyMarketsShopSummary {
@@ -172,6 +184,7 @@ declare namespace io.flow.shopify.markets.internal.v0.models {
172
184
  readonly 'initial_catalog_synced_at'?: string;
173
185
  readonly 'catalog_sync_duration'?: number;
174
186
  readonly 'catalog_products_count'?: number;
187
+ readonly 'initial_product_restrictions_synced_at'?: string;
175
188
  }
176
189
 
177
190
  interface ThirdPartyLogisticsPartner {
@@ -23,7 +23,7 @@ declare namespace io.flow.shopify.markets.v0.enums {
23
23
  type ShopifyOrderFulfillmentStatusType = 'fulfilled' | 'null' | 'partial';
24
24
  type ShopifyOrderInventoryBehaviour = 'bypass' | 'decrement_ignoring_policy' | 'decrement_obeying_policy';
25
25
  type ShopifyOrderKindType = 'authorization' | 'capture' | 'sale' | 'void' | 'refund';
26
- type ShopifyOrderPaymentGatewayNames = 'flow_commerce' | 'gift_card' | 'manual' | 'shopify_payments';
26
+ type ShopifyOrderPaymentGatewayNames = 'flow_commerce' | 'gift_card' | 'manual' | 'shopify_payments' | 'shop_cash';
27
27
  type ShopifyOrderProcessingMethodType = 'checkout' | 'direct' | 'manual' | 'offsite' | 'express' | 'deferred_payment';
28
28
  type ShopifyOrderRestockType = 'no_restock' | 'cancel' | 'return';
29
29
  type ShopifyOrderStatusType = 'open' | 'closed' | 'cancelled' | 'any';
@@ -32,7 +32,7 @@ declare namespace io.flow.shopify.markets.v0.enums {
32
32
  type ShopifyOrderValueType = 'string' | 'integer';
33
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';
34
34
  type ShopifyWebhookFormat = 'json' | 'xml';
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';
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' | 'shop/update';
36
36
  }
37
37
 
38
38
  declare namespace io.flow.shopify.markets.v0.models {
@@ -1,6 +1,6 @@
1
1
  declare namespace io.flow.trueup.v0.enums {
2
2
  type CarrierChargeReason = 'return_to_origin' | 'rejection' | 'other';
3
- type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction' | 'security' | 'eei_filing' | 'fixed_ddp' | 'fixed_currency_conversion';
3
+ type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction' | 'security' | 'eei_filing' | 'fixed_ddp' | 'fixed_currency_conversion' | 'prohibited_item' | 'undeliverable_shipment' | 'signature_required' | 'direct_delivery' | 'saturday_stop' | 'residential_extended_area_pickup';
4
4
  }
5
5
 
6
6
  declare namespace io.flow.trueup.v0.models {