@flowio/types 11.9.3 → 11.9.5

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.
@@ -1249,6 +1249,7 @@ declare namespace io.flow.checkout.protocol.v0.enums {
1249
1249
  type CheckoutInfoOrderSummaryKeyField = 'shipping_country' | 'shipping_province' | 'shipping_postal' | 'delivery_option_id';
1250
1250
  type CheckoutInfoPaymentAuthorizationParametersKeyField = 'value' | 'currency' | 'shipping_country';
1251
1251
  type CheckoutInfoPaymentDetailsKeyField = 'value' | 'currency' | 'payment_method_id';
1252
+ type CheckoutInfoPaymentsFormDataKeyField = 'value' | 'currency' | 'shipping_country';
1252
1253
  type CheckoutInitiatePaymentErrorCode = 'payment_failed' | 'authorization_form_not_supported' | 'authorization_invalid_amount' | 'authorization_invalid_currency' | 'authorization_amount_exceeds_balance' | 'address_street1_required';
1253
1254
  type CheckoutSetAddressCityErrorCode = 'address_city_invalid' | 'address_city_required';
1254
1255
  type CheckoutSetAddressCountryErrorCode = 'address_country_invalid' | 'address_country_required' | 'country_not_supported';
@@ -1491,8 +1492,13 @@ declare namespace io.flow.checkout.protocol.v0.models {
1491
1492
  }
1492
1493
  interface CheckoutInfoPaymentsFormData {
1493
1494
  readonly discriminator: 'checkout_info_payments_form_data';
1495
+ readonly key: io.flow.checkout.protocol.v0.models.CheckoutInfoPaymentsFormDataKey[];
1494
1496
  readonly data: io.flow.checkout.backend.v0.models.CheckoutOrderFormPaymentsData;
1495
1497
  }
1498
+ interface CheckoutInfoPaymentsFormDataKey {
1499
+ readonly field: io.flow.checkout.protocol.v0.enums.CheckoutInfoPaymentsFormDataKeyField;
1500
+ readonly value: string;
1501
+ }
1496
1502
  interface CheckoutInfoPublicKey {
1497
1503
  readonly discriminator: 'checkout_info_public_key';
1498
1504
  readonly data: io.flow.payment.v0.models.PublicKey;
@@ -6441,6 +6447,7 @@ declare namespace io.flow.common.v0.models {
6441
6447
  interface EntityIdentifier {
6442
6448
  readonly name: io.flow.common.v0.enums.EntityIdentifierType;
6443
6449
  readonly number: string;
6450
+ readonly issuing_country?: string;
6444
6451
  }
6445
6452
  interface Exception {
6446
6453
  readonly type: io.flow.common.v0.enums.ExceptionType;
@@ -8546,6 +8553,7 @@ declare namespace io.flow.catalog.v0.enums {
8546
8553
  type FulfillmentMethodType = 'fulfillment_method';
8547
8554
  type FulfillmentMethodValue = 'digital' | 'physical';
8548
8555
  type ImageTag = 'thumbnail' | 'checkout';
8556
+ type ReturnItemStatus = 'returnable' | 'non-returnable';
8549
8557
  type SubcatalogItemStatus = 'excluded' | 'included' | 'restricted';
8550
8558
  type TaxabilityType = 'tax_rule';
8551
8559
  type TaxabilityValue = 'exempt';
@@ -12247,6 +12255,7 @@ declare namespace io.flow.checkout.backend.v0.models {
12247
12255
  readonly discriminator: 'initiate_redirect_payment_form';
12248
12256
  readonly payment_method_id: string;
12249
12257
  readonly redirect_urls: io.flow.payment.v0.models.PostPaymentRedirectUrls;
12258
+ readonly issuer_reference?: io.flow.payment.v0.models.IssuerReference;
12250
12259
  }
12251
12260
  interface CheckoutInlineAuthorizationRequirement {
12252
12261
  readonly discriminator: 'checkout_inline_authorization_requirement';
@@ -12465,6 +12474,11 @@ declare namespace io.flow.checkout.backend.v0.models {
12465
12474
  readonly type: io.flow.reference.v0.enums.PaymentMethodType;
12466
12475
  readonly name: string;
12467
12476
  readonly images: io.flow.reference.v0.models.PaymentMethodImages;
12477
+ readonly issuers?: io.flow.checkout.backend.v0.models.CheckoutPaymentMethodIssuer[];
12478
+ }
12479
+ interface CheckoutPaymentMethodIssuer {
12480
+ readonly id: string;
12481
+ readonly name: string;
12468
12482
  }
12469
12483
  interface CheckoutPaypalAuthorizationPayload {
12470
12484
  readonly discriminator: 'paypal_authorization_payload';
@@ -13124,6 +13138,7 @@ declare namespace io.flow.internal.v0.enums {
13124
13138
  type CheckoutInfoOrderSummaryKeyField = 'shipping_country' | 'shipping_province' | 'shipping_postal' | 'delivery_option_id';
13125
13139
  type CheckoutInfoPaymentAuthorizationParametersKeyField = 'value' | 'currency' | 'shipping_country';
13126
13140
  type CheckoutInfoPaymentDetailsKeyField = 'value' | 'currency' | 'payment_method_id';
13141
+ type CheckoutInfoPaymentsFormDataKeyField = 'value' | 'currency' | 'shipping_country';
13127
13142
  type CheckoutInitiatePaymentErrorCode = 'payment_failed' | 'authorization_form_not_supported' | 'authorization_invalid_amount' | 'authorization_invalid_currency' | 'authorization_amount_exceeds_balance' | 'address_street1_required';
13128
13143
  type CheckoutLineErrorCode = 'line_quantity_invalid' | 'line_item_number_invalid' | 'line_item_number_not_available' | 'line_value_threshold_exceeded';
13129
13144
  type CheckoutPaymentGroupType = 'credit' | 'debit' | 'all_cards';
@@ -14727,8 +14742,13 @@ declare namespace io.flow.internal.v0.models {
14727
14742
  }
14728
14743
  interface CheckoutInfoPaymentsFormData {
14729
14744
  readonly discriminator: 'checkout_info_payments_form_data';
14745
+ readonly key: io.flow.internal.v0.models.CheckoutInfoPaymentsFormDataKey[];
14730
14746
  readonly data: io.flow.checkout.backend.v0.models.CheckoutOrderFormPaymentsData;
14731
14747
  }
14748
+ interface CheckoutInfoPaymentsFormDataKey {
14749
+ readonly field: io.flow.internal.v0.enums.CheckoutInfoPaymentsFormDataKeyField;
14750
+ readonly value: string;
14751
+ }
14732
14752
  interface CheckoutInfoPublicKey {
14733
14753
  readonly discriminator: 'checkout_info_public_key';
14734
14754
  readonly data: io.flow.payment.v0.models.PublicKey;
@@ -14745,6 +14765,7 @@ declare namespace io.flow.internal.v0.models {
14745
14765
  readonly discriminator: 'initiate_redirect_payment_form';
14746
14766
  readonly payment_method_id: string;
14747
14767
  readonly redirect_urls: io.flow.payment.v0.models.PostPaymentRedirectUrls;
14768
+ readonly issuer_reference?: io.flow.payment.v0.models.IssuerReference;
14748
14769
  }
14749
14770
  interface CheckoutInlineAuthorizationRequirement {
14750
14771
  readonly discriminator: 'checkout_inline_authorization_requirement';
@@ -15088,6 +15109,11 @@ declare namespace io.flow.internal.v0.models {
15088
15109
  readonly type: io.flow.reference.v0.enums.PaymentMethodType;
15089
15110
  readonly name: string;
15090
15111
  readonly images: io.flow.reference.v0.models.PaymentMethodImages;
15112
+ readonly issuers?: io.flow.internal.v0.models.CheckoutPaymentMethodIssuer[];
15113
+ }
15114
+ interface CheckoutPaymentMethodIssuer {
15115
+ readonly id: string;
15116
+ readonly name: string;
15091
15117
  }
15092
15118
  interface CheckoutPaypalAuthorizationPayload {
15093
15119
  readonly discriminator: 'paypal_authorization_payload';
@@ -16956,6 +16982,10 @@ declare namespace io.flow.internal.v0.models {
16956
16982
  readonly visitor_id?: string;
16957
16983
  readonly step: string;
16958
16984
  }
16985
+ interface HeapCheckoutStarted {
16986
+ readonly discriminator: 'checkout_started';
16987
+ readonly placeholder?: string;
16988
+ }
16959
16989
  interface HeapContinueClick {
16960
16990
  readonly discriminator: 'continue_click';
16961
16991
  readonly checkout_id?: string;
@@ -18339,7 +18369,7 @@ declare namespace io.flow.internal.v0.models {
18339
18369
  }
18340
18370
  interface MerchantOfRecordEntitySettingsForm {
18341
18371
  readonly name: string;
18342
- readonly vat: io.flow.common.v0.models.MerchantOfRecordEntityRegistration;
18372
+ readonly vat?: io.flow.common.v0.models.MerchantOfRecordEntityRegistration;
18343
18373
  readonly streets: string[];
18344
18374
  readonly city: string;
18345
18375
  readonly province?: string;
@@ -20492,7 +20522,7 @@ declare namespace io.flow.internal.v0.unions {
20492
20522
  type FeatureTaskData = io.flow.internal.v0.models.FeatureTaskDataSyncFeature | io.flow.internal.v0.models.FeatureTaskDataSyncOrganization;
20493
20523
  type FeatureValue = io.flow.internal.v0.models.BooleanFeatureValue | io.flow.internal.v0.models.StringFeatureValue;
20494
20524
  type GlobalSearchResult = io.flow.internal.v0.models.SearchExperienceSummary | io.flow.internal.v0.models.SearchExperimentSummary | io.flow.internal.v0.models.SearchOrderSummary | io.flow.internal.v0.models.SearchItemSummary;
20495
- type HeapEvent = io.flow.internal.v0.models.HeapAddressPredictionClick | io.flow.internal.v0.models.HeapAfterpayPopupOpened | io.flow.internal.v0.models.HeapAfterpayPopupClosed | io.flow.internal.v0.models.HeapAuthorizationDeclined | io.flow.internal.v0.models.HeapAuthorizationError | io.flow.internal.v0.models.HeapCardError | io.flow.internal.v0.models.HeapCheckoutProgress | io.flow.internal.v0.models.HeapContinueClick | io.flow.internal.v0.models.HeapDeliveryFormDataReceived | io.flow.internal.v0.models.HeapDeliveryFormDataTimeout | io.flow.internal.v0.models.HeapDeliveryOptionCount | io.flow.internal.v0.models.HeapDeliveryOptionSelected | io.flow.internal.v0.models.HeapExitCheckout | io.flow.internal.v0.models.HeapFieldBlur | io.flow.internal.v0.models.HeapFieldErrorTooltipShown | io.flow.internal.v0.models.HeapFieldFocus | io.flow.internal.v0.models.HeapFieldValidation | io.flow.internal.v0.models.HeapGiftCardApply | io.flow.internal.v0.models.HeapGiftCardOpen | io.flow.internal.v0.models.HeapGiftCardWithPin | io.flow.internal.v0.models.HeapOptinPromptDeselected | io.flow.internal.v0.models.HeapOptinPromptSelected | io.flow.internal.v0.models.HeapOrderSummaryClose | io.flow.internal.v0.models.HeapOrderSummaryOpen | io.flow.internal.v0.models.HeapPayClick | io.flow.internal.v0.models.HeapPaymentFormDataReceived | io.flow.internal.v0.models.HeapPaymentFormDataTimeout | io.flow.internal.v0.models.HeapPaymentMethodSelected | io.flow.internal.v0.models.HeapPerformance | io.flow.internal.v0.models.HeapPromoCodeApply | io.flow.internal.v0.models.HeapPromoCodeError | io.flow.internal.v0.models.HeapPromoCodeOpen | io.flow.internal.v0.models.HeapPurchase | io.flow.internal.v0.models.HeapRageClick | io.flow.internal.v0.models.HeapScriptError | io.flow.internal.v0.models.HeapSequencedError | io.flow.internal.v0.models.HeapSequencedTiming | io.flow.internal.v0.models.HeapStartCheckout | io.flow.internal.v0.models.HeapStreamError | io.flow.internal.v0.models.HeapSubmitError | io.flow.internal.v0.models.HeapWebsocketClose | io.flow.internal.v0.models.HeapWebsocketError | io.flow.internal.v0.models.HeapWebsocketGiveUp | io.flow.internal.v0.models.HeapWebsocketOpen | io.flow.internal.v0.models.HeapWebsocketRetry;
20525
+ type HeapEvent = io.flow.internal.v0.models.HeapAddressPredictionClick | io.flow.internal.v0.models.HeapAfterpayPopupOpened | io.flow.internal.v0.models.HeapAfterpayPopupClosed | io.flow.internal.v0.models.HeapAuthorizationDeclined | io.flow.internal.v0.models.HeapAuthorizationError | io.flow.internal.v0.models.HeapCardError | io.flow.internal.v0.models.HeapCheckoutProgress | io.flow.internal.v0.models.HeapCheckoutStarted | io.flow.internal.v0.models.HeapContinueClick | io.flow.internal.v0.models.HeapDeliveryFormDataReceived | io.flow.internal.v0.models.HeapDeliveryFormDataTimeout | io.flow.internal.v0.models.HeapDeliveryOptionCount | io.flow.internal.v0.models.HeapDeliveryOptionSelected | io.flow.internal.v0.models.HeapExitCheckout | io.flow.internal.v0.models.HeapFieldBlur | io.flow.internal.v0.models.HeapFieldErrorTooltipShown | io.flow.internal.v0.models.HeapFieldFocus | io.flow.internal.v0.models.HeapFieldValidation | io.flow.internal.v0.models.HeapGiftCardApply | io.flow.internal.v0.models.HeapGiftCardOpen | io.flow.internal.v0.models.HeapGiftCardWithPin | io.flow.internal.v0.models.HeapOptinPromptDeselected | io.flow.internal.v0.models.HeapOptinPromptSelected | io.flow.internal.v0.models.HeapOrderSummaryClose | io.flow.internal.v0.models.HeapOrderSummaryOpen | io.flow.internal.v0.models.HeapPayClick | io.flow.internal.v0.models.HeapPaymentFormDataReceived | io.flow.internal.v0.models.HeapPaymentFormDataTimeout | io.flow.internal.v0.models.HeapPaymentMethodSelected | io.flow.internal.v0.models.HeapPerformance | io.flow.internal.v0.models.HeapPromoCodeApply | io.flow.internal.v0.models.HeapPromoCodeError | io.flow.internal.v0.models.HeapPromoCodeOpen | io.flow.internal.v0.models.HeapPurchase | io.flow.internal.v0.models.HeapRageClick | io.flow.internal.v0.models.HeapScriptError | io.flow.internal.v0.models.HeapSequencedError | io.flow.internal.v0.models.HeapSequencedTiming | io.flow.internal.v0.models.HeapStartCheckout | io.flow.internal.v0.models.HeapStreamError | io.flow.internal.v0.models.HeapSubmitError | io.flow.internal.v0.models.HeapWebsocketClose | io.flow.internal.v0.models.HeapWebsocketError | io.flow.internal.v0.models.HeapWebsocketGiveUp | io.flow.internal.v0.models.HeapWebsocketOpen | io.flow.internal.v0.models.HeapWebsocketRetry;
20496
20526
  type IndexTaskType = io.flow.internal.v0.models.CatalogItemIndexTask | io.flow.internal.v0.models.CatalogItemBatchIndexTask | io.flow.internal.v0.models.CatalogItemDeleteIndexTask | io.flow.internal.v0.models.ChangeSettingsIndexTask | io.flow.internal.v0.models.DeleteIndexTask;
20497
20527
  type InlineAuthorizationParameters = io.flow.internal.v0.models.KlarnaAuthorizationParameters;
20498
20528
  type InternalAuthorizationDetails = io.flow.internal.v0.models.InternalPaypalAuthorizationDetails | io.flow.internal.v0.models.InternalBitpayAuthorizationDetails | io.flow.internal.v0.models.InternalStripeAuthorizationDetails | io.flow.internal.v0.models.InternalAdyenAuthorizationDetails | io.flow.internal.v0.models.InternalAfterpayAuthorizationDetails | io.flow.internal.v0.models.InternalFiservAuthorizationDetails;
@@ -20859,6 +20889,8 @@ export declare type CheckoutInfoPaymentDetails = io.flow.internal.v0.models.Chec
20859
20889
  export declare type CheckoutInfoPaymentDetailsKey = io.flow.internal.v0.models.CheckoutInfoPaymentDetailsKey;
20860
20890
  export declare type CheckoutInfoPaymentDetailsKeyField = io.flow.internal.v0.enums.CheckoutInfoPaymentDetailsKeyField;
20861
20891
  export declare type CheckoutInfoPaymentsFormData = io.flow.internal.v0.models.CheckoutInfoPaymentsFormData;
20892
+ export declare type CheckoutInfoPaymentsFormDataKey = io.flow.internal.v0.models.CheckoutInfoPaymentsFormDataKey;
20893
+ export declare type CheckoutInfoPaymentsFormDataKeyField = io.flow.internal.v0.enums.CheckoutInfoPaymentsFormDataKeyField;
20862
20894
  export declare type CheckoutInfoPublicKey = io.flow.internal.v0.models.CheckoutInfoPublicKey;
20863
20895
  export declare type CheckoutInitiateInlinePaymentForm = io.flow.internal.v0.models.CheckoutInitiateInlinePaymentForm;
20864
20896
  export declare type CheckoutInitiatePaymentError = io.flow.internal.v0.models.CheckoutInitiatePaymentError;
@@ -20940,6 +20972,7 @@ export declare type CheckoutPaymentContent = io.flow.internal.v0.models.Checkout
20940
20972
  export declare type CheckoutPaymentDetailsForm = io.flow.internal.v0.unions.CheckoutPaymentDetailsForm;
20941
20973
  export declare type CheckoutPaymentGroupType = io.flow.internal.v0.enums.CheckoutPaymentGroupType;
20942
20974
  export declare type CheckoutPaymentMethod = io.flow.internal.v0.models.CheckoutPaymentMethod;
20975
+ export declare type CheckoutPaymentMethodIssuer = io.flow.internal.v0.models.CheckoutPaymentMethodIssuer;
20943
20976
  export declare type CheckoutPaymentRedirectMethod = io.flow.internal.v0.enums.CheckoutPaymentRedirectMethod;
20944
20977
  export declare type CheckoutPaypalAuthorizationPayload = io.flow.internal.v0.models.CheckoutPaypalAuthorizationPayload;
20945
20978
  export declare type CheckoutPlatformData = io.flow.internal.v0.models.CheckoutPlatformData;
@@ -21374,6 +21407,7 @@ export declare type HeapAuthorizationDeclined = io.flow.internal.v0.models.HeapA
21374
21407
  export declare type HeapAuthorizationError = io.flow.internal.v0.models.HeapAuthorizationError;
21375
21408
  export declare type HeapCardError = io.flow.internal.v0.models.HeapCardError;
21376
21409
  export declare type HeapCheckoutProgress = io.flow.internal.v0.models.HeapCheckoutProgress;
21410
+ export declare type HeapCheckoutStarted = io.flow.internal.v0.models.HeapCheckoutStarted;
21377
21411
  export declare type HeapContinueClick = io.flow.internal.v0.models.HeapContinueClick;
21378
21412
  export declare type HeapDeliveryFormDataReceived = io.flow.internal.v0.models.HeapDeliveryFormDataReceived;
21379
21413
  export declare type HeapDeliveryFormDataTimeout = io.flow.internal.v0.models.HeapDeliveryFormDataTimeout;
package/dist/api.d.ts CHANGED
@@ -924,6 +924,8 @@ declare namespace io.flow.v0.enums {
924
924
  type RatecardOwner = 'flow' | 'organization';
925
925
  type RefundDeclineCode = 'expired' | 'insufficient_funds' | 'unknown';
926
926
  type RefundStatus = 'pending' | 'succeeded' | 'failed' | 'canceled';
927
+ type ReturnItemStatus = 'returnable' | 'non-returnable';
928
+ type ReturnPolicyState = 'current' | 'deleting' | 'updating';
927
929
  type ReturnStatus = 'open' | 'refunded';
928
930
  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';
929
931
  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';
@@ -2800,6 +2802,7 @@ declare namespace io.flow.v0.models {
2800
2802
  interface EntityIdentifier {
2801
2803
  readonly name: io.flow.v0.enums.EntityIdentifierType;
2802
2804
  readonly number: string;
2805
+ readonly issuing_country?: string;
2803
2806
  }
2804
2807
  interface EstimatedDimensions {
2805
2808
  readonly depth: io.flow.v0.models.Measurement;
@@ -6164,6 +6167,35 @@ declare namespace io.flow.v0.models {
6164
6167
  readonly discriminator: 'return_package_ratecard_fee';
6165
6168
  readonly amount: number;
6166
6169
  }
6170
+ interface ReturnPolicy {
6171
+ readonly id: string;
6172
+ readonly q: string;
6173
+ readonly query: io.flow.v0.models.Query;
6174
+ readonly status: io.flow.v0.enums.ReturnItemStatus;
6175
+ readonly description?: string;
6176
+ readonly statistics: io.flow.v0.models.ReturnPolicyStatistic;
6177
+ }
6178
+ interface ReturnPolicyForm {
6179
+ readonly q: string;
6180
+ readonly description?: string;
6181
+ }
6182
+ interface ReturnPolicyItemResult {
6183
+ readonly id: string;
6184
+ readonly organization_id: string;
6185
+ readonly catalog_item_id: string;
6186
+ readonly return_policy_id: string;
6187
+ readonly status: io.flow.v0.enums.ReturnItemStatus;
6188
+ }
6189
+ interface ReturnPolicyStatistic {
6190
+ readonly state: io.flow.v0.enums.ReturnPolicyState;
6191
+ readonly number_items: number;
6192
+ }
6193
+ interface ReturnPolicyVersion {
6194
+ readonly id: string;
6195
+ readonly timestamp: string;
6196
+ readonly type: io.flow.v0.enums.ChangeType;
6197
+ readonly return_policy: io.flow.v0.models.ReturnPolicy;
6198
+ }
6167
6199
  interface ReturnReason {
6168
6200
  readonly name: string;
6169
6201
  }
@@ -8594,9 +8626,16 @@ export declare type ReturnDeleted = io.flow.v0.models.ReturnDeleted;
8594
8626
  export declare type ReturnDeletedV2 = io.flow.v0.models.ReturnDeletedV2;
8595
8627
  export declare type ReturnForm = io.flow.v0.models.ReturnForm;
8596
8628
  export declare type ReturnItemReference = io.flow.v0.models.ReturnItemReference;
8629
+ export declare type ReturnItemStatus = io.flow.v0.enums.ReturnItemStatus;
8597
8630
  export declare type ReturnLineItem = io.flow.v0.models.ReturnLineItem;
8598
8631
  export declare type ReturnOrderReference = io.flow.v0.models.ReturnOrderReference;
8599
8632
  export declare type ReturnPackageRatecardFee = io.flow.v0.models.ReturnPackageRatecardFee;
8633
+ export declare type ReturnPolicy = io.flow.v0.models.ReturnPolicy;
8634
+ export declare type ReturnPolicyForm = io.flow.v0.models.ReturnPolicyForm;
8635
+ export declare type ReturnPolicyItemResult = io.flow.v0.models.ReturnPolicyItemResult;
8636
+ export declare type ReturnPolicyState = io.flow.v0.enums.ReturnPolicyState;
8637
+ export declare type ReturnPolicyStatistic = io.flow.v0.models.ReturnPolicyStatistic;
8638
+ export declare type ReturnPolicyVersion = io.flow.v0.models.ReturnPolicyVersion;
8600
8639
  export declare type ReturnReason = io.flow.v0.models.ReturnReason;
8601
8640
  export declare type ReturnReasonForm = io.flow.v0.models.ReturnReasonForm;
8602
8641
  export declare type ReturnReasonPutForm = io.flow.v0.models.ReturnReasonPutForm;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flowio/types",
3
- "version": "11.9.3",
3
+ "version": "11.9.5",
4
4
  "description": "TypeScript type definitions for custom types found in Flow API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -25,5 +25,5 @@
25
25
  "maintainers": [
26
26
  "Christian Muñoz <christian.munoz@flow.io>"
27
27
  ],
28
- "gitHead": "d69f05ae85ab73444207be06f2e7fd1cb8f5a410"
28
+ "gitHead": "15fd85cc5d7cbfb89d3226c8158381ccba253fcb"
29
29
  }
@@ -1633,6 +1633,10 @@ declare namespace io.flow.checkout.protocol.v0.enums {
1633
1633
  | 'value'
1634
1634
  | 'currency'
1635
1635
  | 'payment_method_id';
1636
+ type CheckoutInfoPaymentsFormDataKeyField =
1637
+ | 'value'
1638
+ | 'currency'
1639
+ | 'shipping_country';
1636
1640
  type CheckoutInitiatePaymentErrorCode =
1637
1641
  | 'payment_failed'
1638
1642
  | 'authorization_form_not_supported'
@@ -2031,9 +2035,15 @@ declare namespace io.flow.checkout.protocol.v0.models {
2031
2035
 
2032
2036
  interface CheckoutInfoPaymentsFormData {
2033
2037
  readonly discriminator: 'checkout_info_payments_form_data';
2038
+ readonly key: io.flow.checkout.protocol.v0.models.CheckoutInfoPaymentsFormDataKey[];
2034
2039
  readonly data: io.flow.checkout.backend.v0.models.CheckoutOrderFormPaymentsData;
2035
2040
  }
2036
2041
 
2042
+ interface CheckoutInfoPaymentsFormDataKey {
2043
+ readonly field: io.flow.checkout.protocol.v0.enums.CheckoutInfoPaymentsFormDataKeyField;
2044
+ readonly value: string;
2045
+ }
2046
+
2037
2047
  interface CheckoutInfoPublicKey {
2038
2048
  readonly discriminator: 'checkout_info_public_key';
2039
2049
  readonly data: io.flow.payment.v0.models.PublicKey;
@@ -8701,6 +8711,7 @@ declare namespace io.flow.common.v0.models {
8701
8711
  interface EntityIdentifier {
8702
8712
  readonly name: io.flow.common.v0.enums.EntityIdentifierType;
8703
8713
  readonly number: string;
8714
+ readonly issuing_country?: string;
8704
8715
  }
8705
8716
 
8706
8717
  interface Exception {
@@ -11337,6 +11348,7 @@ declare namespace io.flow.catalog.v0.enums {
11337
11348
  type FulfillmentMethodType = 'fulfillment_method';
11338
11349
  type FulfillmentMethodValue = 'digital' | 'physical';
11339
11350
  type ImageTag = 'thumbnail' | 'checkout';
11351
+ type ReturnItemStatus = 'returnable' | 'non-returnable';
11340
11352
  type SubcatalogItemStatus = 'excluded' | 'included' | 'restricted';
11341
11353
  type TaxabilityType = 'tax_rule';
11342
11354
  type TaxabilityValue = 'exempt';
@@ -15977,6 +15989,7 @@ declare namespace io.flow.checkout.backend.v0.models {
15977
15989
  readonly discriminator: 'initiate_redirect_payment_form';
15978
15990
  readonly payment_method_id: string;
15979
15991
  readonly redirect_urls: io.flow.payment.v0.models.PostPaymentRedirectUrls;
15992
+ readonly issuer_reference?: io.flow.payment.v0.models.IssuerReference;
15980
15993
  }
15981
15994
 
15982
15995
  interface CheckoutInlineAuthorizationRequirement {
@@ -16239,6 +16252,12 @@ declare namespace io.flow.checkout.backend.v0.models {
16239
16252
  readonly type: io.flow.reference.v0.enums.PaymentMethodType;
16240
16253
  readonly name: string;
16241
16254
  readonly images: io.flow.reference.v0.models.PaymentMethodImages;
16255
+ readonly issuers?: io.flow.checkout.backend.v0.models.CheckoutPaymentMethodIssuer[];
16256
+ }
16257
+
16258
+ interface CheckoutPaymentMethodIssuer {
16259
+ readonly id: string;
16260
+ readonly name: string;
16242
16261
  }
16243
16262
 
16244
16263
  interface CheckoutPaypalAuthorizationPayload {
@@ -17173,6 +17192,10 @@ declare namespace io.flow.internal.v0.enums {
17173
17192
  | 'value'
17174
17193
  | 'currency'
17175
17194
  | 'payment_method_id';
17195
+ type CheckoutInfoPaymentsFormDataKeyField =
17196
+ | 'value'
17197
+ | 'currency'
17198
+ | 'shipping_country';
17176
17199
  type CheckoutInitiatePaymentErrorCode =
17177
17200
  | 'payment_failed'
17178
17201
  | 'authorization_form_not_supported'
@@ -19480,9 +19503,15 @@ declare namespace io.flow.internal.v0.models {
19480
19503
 
19481
19504
  interface CheckoutInfoPaymentsFormData {
19482
19505
  readonly discriminator: 'checkout_info_payments_form_data';
19506
+ readonly key: io.flow.internal.v0.models.CheckoutInfoPaymentsFormDataKey[];
19483
19507
  readonly data: io.flow.checkout.backend.v0.models.CheckoutOrderFormPaymentsData;
19484
19508
  }
19485
19509
 
19510
+ interface CheckoutInfoPaymentsFormDataKey {
19511
+ readonly field: io.flow.internal.v0.enums.CheckoutInfoPaymentsFormDataKeyField;
19512
+ readonly value: string;
19513
+ }
19514
+
19486
19515
  interface CheckoutInfoPublicKey {
19487
19516
  readonly discriminator: 'checkout_info_public_key';
19488
19517
  readonly data: io.flow.payment.v0.models.PublicKey;
@@ -19502,6 +19531,7 @@ declare namespace io.flow.internal.v0.models {
19502
19531
  readonly discriminator: 'initiate_redirect_payment_form';
19503
19532
  readonly payment_method_id: string;
19504
19533
  readonly redirect_urls: io.flow.payment.v0.models.PostPaymentRedirectUrls;
19534
+ readonly issuer_reference?: io.flow.payment.v0.models.IssuerReference;
19505
19535
  }
19506
19536
 
19507
19537
  interface CheckoutInlineAuthorizationRequirement {
@@ -19913,6 +19943,12 @@ declare namespace io.flow.internal.v0.models {
19913
19943
  readonly type: io.flow.reference.v0.enums.PaymentMethodType;
19914
19944
  readonly name: string;
19915
19945
  readonly images: io.flow.reference.v0.models.PaymentMethodImages;
19946
+ readonly issuers?: io.flow.internal.v0.models.CheckoutPaymentMethodIssuer[];
19947
+ }
19948
+
19949
+ interface CheckoutPaymentMethodIssuer {
19950
+ readonly id: string;
19951
+ readonly name: string;
19916
19952
  }
19917
19953
 
19918
19954
  interface CheckoutPaypalAuthorizationPayload {
@@ -22117,6 +22153,11 @@ declare namespace io.flow.internal.v0.models {
22117
22153
  readonly step: string;
22118
22154
  }
22119
22155
 
22156
+ interface HeapCheckoutStarted {
22157
+ readonly discriminator: 'checkout_started';
22158
+ readonly placeholder?: string;
22159
+ }
22160
+
22120
22161
  interface HeapContinueClick {
22121
22162
  readonly discriminator: 'continue_click';
22122
22163
  readonly checkout_id?: string;
@@ -23696,7 +23737,7 @@ declare namespace io.flow.internal.v0.models {
23696
23737
 
23697
23738
  interface MerchantOfRecordEntitySettingsForm {
23698
23739
  readonly name: string;
23699
- readonly vat: io.flow.common.v0.models.MerchantOfRecordEntityRegistration;
23740
+ readonly vat?: io.flow.common.v0.models.MerchantOfRecordEntityRegistration;
23700
23741
  readonly streets: string[];
23701
23742
  readonly city: string;
23702
23743
  readonly province?: string;
@@ -26579,6 +26620,7 @@ declare namespace io.flow.internal.v0.unions {
26579
26620
  | io.flow.internal.v0.models.HeapAuthorizationError
26580
26621
  | io.flow.internal.v0.models.HeapCardError
26581
26622
  | io.flow.internal.v0.models.HeapCheckoutProgress
26623
+ | io.flow.internal.v0.models.HeapCheckoutStarted
26582
26624
  | io.flow.internal.v0.models.HeapContinueClick
26583
26625
  | io.flow.internal.v0.models.HeapDeliveryFormDataReceived
26584
26626
  | io.flow.internal.v0.models.HeapDeliveryFormDataTimeout
@@ -27090,6 +27132,8 @@ export type CheckoutInfoPaymentDetails = io.flow.internal.v0.models.CheckoutInfo
27090
27132
  export type CheckoutInfoPaymentDetailsKey = io.flow.internal.v0.models.CheckoutInfoPaymentDetailsKey;
27091
27133
  export type CheckoutInfoPaymentDetailsKeyField = io.flow.internal.v0.enums.CheckoutInfoPaymentDetailsKeyField;
27092
27134
  export type CheckoutInfoPaymentsFormData = io.flow.internal.v0.models.CheckoutInfoPaymentsFormData;
27135
+ export type CheckoutInfoPaymentsFormDataKey = io.flow.internal.v0.models.CheckoutInfoPaymentsFormDataKey;
27136
+ export type CheckoutInfoPaymentsFormDataKeyField = io.flow.internal.v0.enums.CheckoutInfoPaymentsFormDataKeyField;
27093
27137
  export type CheckoutInfoPublicKey = io.flow.internal.v0.models.CheckoutInfoPublicKey;
27094
27138
  export type CheckoutInitiateInlinePaymentForm = io.flow.internal.v0.models.CheckoutInitiateInlinePaymentForm;
27095
27139
  export type CheckoutInitiatePaymentError = io.flow.internal.v0.models.CheckoutInitiatePaymentError;
@@ -27171,6 +27215,7 @@ export type CheckoutPaymentContent = io.flow.internal.v0.models.CheckoutPaymentC
27171
27215
  export type CheckoutPaymentDetailsForm = io.flow.internal.v0.unions.CheckoutPaymentDetailsForm;
27172
27216
  export type CheckoutPaymentGroupType = io.flow.internal.v0.enums.CheckoutPaymentGroupType;
27173
27217
  export type CheckoutPaymentMethod = io.flow.internal.v0.models.CheckoutPaymentMethod;
27218
+ export type CheckoutPaymentMethodIssuer = io.flow.internal.v0.models.CheckoutPaymentMethodIssuer;
27174
27219
  export type CheckoutPaymentRedirectMethod = io.flow.internal.v0.enums.CheckoutPaymentRedirectMethod;
27175
27220
  export type CheckoutPaypalAuthorizationPayload = io.flow.internal.v0.models.CheckoutPaypalAuthorizationPayload;
27176
27221
  export type CheckoutPlatformData = io.flow.internal.v0.models.CheckoutPlatformData;
@@ -27605,6 +27650,7 @@ export type HeapAuthorizationDeclined = io.flow.internal.v0.models.HeapAuthoriza
27605
27650
  export type HeapAuthorizationError = io.flow.internal.v0.models.HeapAuthorizationError;
27606
27651
  export type HeapCardError = io.flow.internal.v0.models.HeapCardError;
27607
27652
  export type HeapCheckoutProgress = io.flow.internal.v0.models.HeapCheckoutProgress;
27653
+ export type HeapCheckoutStarted = io.flow.internal.v0.models.HeapCheckoutStarted;
27608
27654
  export type HeapContinueClick = io.flow.internal.v0.models.HeapContinueClick;
27609
27655
  export type HeapDeliveryFormDataReceived = io.flow.internal.v0.models.HeapDeliveryFormDataReceived;
27610
27656
  export type HeapDeliveryFormDataTimeout = io.flow.internal.v0.models.HeapDeliveryFormDataTimeout;
package/src/api.ts CHANGED
@@ -1573,6 +1573,8 @@ declare namespace io.flow.v0.enums {
1573
1573
  type RatecardOwner = 'flow' | 'organization';
1574
1574
  type RefundDeclineCode = 'expired' | 'insufficient_funds' | 'unknown';
1575
1575
  type RefundStatus = 'pending' | 'succeeded' | 'failed' | 'canceled';
1576
+ type ReturnItemStatus = 'returnable' | 'non-returnable';
1577
+ type ReturnPolicyState = 'current' | 'deleting' | 'updating';
1576
1578
  type ReturnStatus = 'open' | 'refunded';
1577
1579
  type ReturnTrackingStatus =
1578
1580
  | 'awaiting_customs_clearance'
@@ -3802,6 +3804,7 @@ declare namespace io.flow.v0.models {
3802
3804
  interface EntityIdentifier {
3803
3805
  readonly name: io.flow.v0.enums.EntityIdentifierType;
3804
3806
  readonly number: string;
3807
+ readonly issuing_country?: string;
3805
3808
  }
3806
3809
 
3807
3810
  interface EstimatedDimensions {
@@ -7710,6 +7713,40 @@ declare namespace io.flow.v0.models {
7710
7713
  readonly amount: number;
7711
7714
  }
7712
7715
 
7716
+ interface ReturnPolicy {
7717
+ readonly id: string;
7718
+ readonly q: string;
7719
+ readonly query: io.flow.v0.models.Query;
7720
+ readonly status: io.flow.v0.enums.ReturnItemStatus;
7721
+ readonly description?: string;
7722
+ readonly statistics: io.flow.v0.models.ReturnPolicyStatistic;
7723
+ }
7724
+
7725
+ interface ReturnPolicyForm {
7726
+ readonly q: string;
7727
+ readonly description?: string;
7728
+ }
7729
+
7730
+ interface ReturnPolicyItemResult {
7731
+ readonly id: string;
7732
+ readonly organization_id: string;
7733
+ readonly catalog_item_id: string;
7734
+ readonly return_policy_id: string;
7735
+ readonly status: io.flow.v0.enums.ReturnItemStatus;
7736
+ }
7737
+
7738
+ interface ReturnPolicyStatistic {
7739
+ readonly state: io.flow.v0.enums.ReturnPolicyState;
7740
+ readonly number_items: number;
7741
+ }
7742
+
7743
+ interface ReturnPolicyVersion {
7744
+ readonly id: string;
7745
+ readonly timestamp: string;
7746
+ readonly type: io.flow.v0.enums.ChangeType;
7747
+ readonly return_policy: io.flow.v0.models.ReturnPolicy;
7748
+ }
7749
+
7713
7750
  interface ReturnReason {
7714
7751
  readonly name: string;
7715
7752
  }
@@ -10686,9 +10723,16 @@ export type ReturnDeleted = io.flow.v0.models.ReturnDeleted;
10686
10723
  export type ReturnDeletedV2 = io.flow.v0.models.ReturnDeletedV2;
10687
10724
  export type ReturnForm = io.flow.v0.models.ReturnForm;
10688
10725
  export type ReturnItemReference = io.flow.v0.models.ReturnItemReference;
10726
+ export type ReturnItemStatus = io.flow.v0.enums.ReturnItemStatus;
10689
10727
  export type ReturnLineItem = io.flow.v0.models.ReturnLineItem;
10690
10728
  export type ReturnOrderReference = io.flow.v0.models.ReturnOrderReference;
10691
10729
  export type ReturnPackageRatecardFee = io.flow.v0.models.ReturnPackageRatecardFee;
10730
+ export type ReturnPolicy = io.flow.v0.models.ReturnPolicy;
10731
+ export type ReturnPolicyForm = io.flow.v0.models.ReturnPolicyForm;
10732
+ export type ReturnPolicyItemResult = io.flow.v0.models.ReturnPolicyItemResult;
10733
+ export type ReturnPolicyState = io.flow.v0.enums.ReturnPolicyState;
10734
+ export type ReturnPolicyStatistic = io.flow.v0.models.ReturnPolicyStatistic;
10735
+ export type ReturnPolicyVersion = io.flow.v0.models.ReturnPolicyVersion;
10692
10736
  export type ReturnReason = io.flow.v0.models.ReturnReason;
10693
10737
  export type ReturnReasonForm = io.flow.v0.models.ReturnReasonForm;
10694
10738
  export type ReturnReasonPutForm = io.flow.v0.models.ReturnReasonPutForm;