@flowio/api-prop-types 10.16.72 → 10.16.74

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/lib/api.d.ts CHANGED
@@ -2246,9 +2246,6 @@ declare namespace io.flow.v0.enums {
2246
2246
  type OrderPaymentType = 'card' | 'online' | 'credit' | 'external' | 'subsidized' | 'installment_plan' | 'cash_on_delivery';
2247
2247
  type OrderPriceDetailComponentKey = 'adjustment' | 'vat_deminimis' | 'duty_deminimis' | 'duties_item_price' | 'duties_freight' | 'duties_insurance' | 'vat_item_price' | 'vat_freight' | 'vat_insurance' | 'vat_duties_item_price' | 'vat_duties_freight' | 'vat_duties_insurance' | 'item_price' | 'item_discount' | 'rounding' | 'insurance' | 'shipping' | 'shipping_discount' | 'order_discount' | 'subtotal_percent_sales_margin' | 'subtotal_vat_percent_sales_margin' | 'subtotal_duty_percent_sales_margin' | 'vat_subsidy' | 'duty_subsidy' | 'remote_area_surcharge' | 'fuel_surcharge' | 'emergency_situation_surcharge' | 'peak_surcharge' | 'duties_taxes_paid_surcharge' | 'tip';
2248
2248
  type OrderPriceDetailKey = 'adjustment' | 'subtotal' | 'vat' | 'duty' | 'shipping' | 'insurance' | 'discount' | 'surcharges' | 'tip';
2249
- type OrderQuoteAddressType = 'shipping';
2250
- type OrderQuoteErrorCode = 'contact_email_invalid' | 'contact_email_required' | 'contact_phone_invalid' | 'contact_phone_required' | 'country_not_supported' | 'currency_invalid' | 'first_name_invalid' | 'first_name_required' | 'geo_required_when_no_session' | 'language_invalid' | 'last_name_invalid' | 'last_name_required' | 'line_item_number_invalid' | 'line_item_number_not_available' | 'line_not_found' | 'line_quantity_invalid' | 'line_value_threshold_exceeded' | 'name_missing_first_or_last' | 'name_required' | 'order_quote_requires_at_least_one_line' | 'session_not_found' | 'session_organization_mismatch';
2251
- type OrderQuoteLineErrorCode = 'line_item_number_invalid' | 'line_item_number_not_available' | 'line_quantity_invalid' | 'line_value_threshold_exceeded';
2252
2249
  type OrderRefundSummaryIncludes = 'duties' | 'vat' | 'shipping';
2253
2250
  type OrderRefundSummaryPartialCharged = 'per_item' | 'for_order' | 'by_value_percentage' | 'by_quantity_percentage';
2254
2251
  type OrderStatus = 'open' | 'submitted';
@@ -2257,7 +2254,7 @@ declare namespace io.flow.v0.enums {
2257
2254
  type OrganizationPaymentMethodTag = 'deny';
2258
2255
  type OrganizationStatus = 'active' | 'inactive' | 'deactivated' | 'provisioned';
2259
2256
  type OrganizationType = 'standalone' | 'channel';
2260
- type PackageDimensionsSource = 'provided' | 'dimensions_estimated';
2257
+ type PackageDimensionsSource = 'provided' | 'item_dimensions_estimated' | 'dimensions_estimated' | 'default_item_dimensions_estimated';
2261
2258
  type PaymentActionType = 'redirect' | 'redirect_get' | 'redirect_post' | 'select_payment_option' | 'use_sdk_klarna_v1' | 'use_sdk_applepay_js' | 'use_sdk_googlepay' | 'use_sdk_paypal' | 'use_sdk_stripe_v3' | 'use_sdk_adyen_v3' | 'use_sdk_adyen_v4' | 'execute_script' | 'display_inline_window';
2262
2259
  type PaymentErrorCode = 'duplicate' | 'invalid_amount' | 'invalid_currency' | 'invalid_method' | 'invalid_order' | 'invalid_customer' | 'invalid_destination' | 'unknown';
2263
2260
  type PaymentFailureCode = 'action_expired' | 'action_cancelled' | 'action_failed' | 'authorization_declined' | 'not_supported' | 'fraudulent' | 'error' | 'payment_checks_declined';
@@ -2292,6 +2289,7 @@ declare namespace io.flow.v0.enums {
2292
2289
  type RefundDeclineCode = 'expired' | 'insufficient_funds' | 'unknown';
2293
2290
  type RefundStatus = 'pending' | 'succeeded' | 'failed' | 'canceled';
2294
2291
  type RegionType = 'state' | 'province' | 'jurisdiction';
2292
+ type RestrictedReviewStatus = 'in_review' | 'reviewed';
2295
2293
  type ReturnItemStatus = 'returnable' | 'non-returnable';
2296
2294
  type ReturnPolicyState = 'current' | 'deleting' | 'updating';
2297
2295
  type ReturnStatus = 'open' | 'refunded';
@@ -2336,7 +2334,7 @@ declare namespace io.flow.v0.enums {
2336
2334
  type TradeAgreementStatus = 'supported' | 'not_supported';
2337
2335
  type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | 'carrier_charge' | 'carrier_charge_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
2338
2336
  type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
2339
- type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction' | 'security_ratecard_fee' | 'eei_filing_ratecard_fee' | 'fixed_ddp_ratecard_fee' | 'fixed_currency_conversion_ratecard_fee';
2337
+ type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction' | 'security' | 'eei_filing' | 'fixed_ddp' | 'fixed_currency_conversion';
2340
2338
  type UnitOfLength = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'meter';
2341
2339
  type UnitOfMeasurement = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'cubic_inch' | 'cubic_meter' | 'gram' | 'kilogram' | 'meter' | 'ounce' | 'pound';
2342
2340
  type UnitOfTime = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute';
@@ -7976,150 +7974,6 @@ declare namespace io.flow.v0.models {
7976
7974
  readonly 'device_details'?: io.flow.v0.unions.DeviceDetails;
7977
7975
  }
7978
7976
 
7979
- interface OrderQuote {
7980
- readonly 'id': string;
7981
- readonly 'form': io.flow.v0.models.OrderQuotePutForm;
7982
- readonly 'summary'?: io.flow.v0.models.OrderQuoteSummary;
7983
- }
7984
-
7985
- interface OrderQuoteAddress {
7986
- readonly 'name'?: string;
7987
- readonly 'first_name'?: string;
7988
- readonly 'last_name'?: string;
7989
- readonly 'country'?: string;
7990
- readonly 'streets'?: string[];
7991
- readonly 'city'?: string;
7992
- readonly 'province'?: string;
7993
- readonly 'postal'?: string;
7994
- readonly 'company'?: string;
7995
- }
7996
-
7997
- interface OrderQuoteContact {
7998
- readonly 'email'?: string;
7999
- readonly 'phone'?: string;
8000
- }
8001
-
8002
- interface OrderQuoteError {
8003
- readonly 'errors': io.flow.v0.models.OrderQuoteErrorDetails[];
8004
- }
8005
-
8006
- interface OrderQuoteErrorDetails {
8007
- readonly 'code': io.flow.v0.enums.OrderQuoteErrorCode;
8008
- readonly 'message': string;
8009
- }
8010
-
8011
- interface OrderQuoteGeoPutForm {
8012
- readonly 'country'?: string;
8013
- readonly 'ip'?: string;
8014
- readonly 'currency'?: string;
8015
- readonly 'language'?: string;
8016
- }
8017
-
8018
- interface OrderQuoteLine {
8019
- readonly 'id': string;
8020
- readonly 'item': io.flow.v0.models.OrderSummaryItem;
8021
- readonly 'errors'?: io.flow.v0.models.OrderQuoteLineError[];
8022
- readonly 'quantity': number;
8023
- readonly 'discount'?: io.flow.v0.models.OrderQuoteLineDiscount;
8024
- readonly 'tax'?: io.flow.v0.models.OrderQuoteSummaryTax;
8025
- readonly 'duty'?: io.flow.v0.models.OrderQuoteSummaryDuty;
8026
- readonly 'unit_price': io.flow.v0.unions.OrderQuotePrice;
8027
- readonly 'total': io.flow.v0.unions.OrderQuotePrice;
8028
- readonly 'price_attributes': Record<string, io.flow.v0.models.OrderQuotePriceStandard>;
8029
- readonly 'attributes': Record<string, string>;
8030
- }
8031
-
8032
- interface OrderQuoteLineDiscount {
8033
- readonly 'applied': io.flow.v0.models.OrderQuotePriceStandard;
8034
- readonly 'label'?: string;
8035
- }
8036
-
8037
- interface OrderQuoteLineError {
8038
- readonly 'code': io.flow.v0.enums.OrderQuoteLineErrorCode;
8039
- readonly 'message': string;
8040
- }
8041
-
8042
- interface OrderQuotePriceEstimated {
8043
- readonly 'discriminator': 'estimated';
8044
- readonly 'amount': number;
8045
- readonly 'currency': string;
8046
- readonly 'label': string;
8047
- }
8048
-
8049
- interface OrderQuotePriceFree {
8050
- readonly 'discriminator': 'free';
8051
- readonly 'placeholder'?: string;
8052
- }
8053
-
8054
- interface OrderQuotePriceIncluded {
8055
- readonly 'discriminator': 'included';
8056
- readonly 'placeholder'?: string;
8057
- }
8058
-
8059
- interface OrderQuotePriceNotYetKnown {
8060
- readonly 'discriminator': 'not_yet_known';
8061
- readonly 'placeholder'?: string;
8062
- }
8063
-
8064
- interface OrderQuotePriceStandard {
8065
- readonly 'discriminator': 'price';
8066
- readonly 'amount': number;
8067
- readonly 'currency': string;
8068
- readonly 'label': string;
8069
- }
8070
-
8071
- interface OrderQuotePutForm {
8072
- readonly 'line_items'?: io.flow.v0.models.LineItemForm[];
8073
- readonly 'session'?: io.flow.v0.models.SessionReference;
8074
- readonly 'geo'?: io.flow.v0.models.OrderQuoteGeoPutForm;
8075
- }
8076
-
8077
- interface OrderQuoteReference {
8078
- readonly 'id': string;
8079
- }
8080
-
8081
- interface OrderQuoteSummary {
8082
- readonly 'items': io.flow.v0.models.OrderQuoteSummaryItems;
8083
- readonly 'shipping'?: io.flow.v0.models.OrderQuoteSummaryShipping;
8084
- readonly 'tax'?: io.flow.v0.models.OrderQuoteSummaryTax;
8085
- readonly 'duty'?: io.flow.v0.models.OrderQuoteSummaryDuty;
8086
- readonly 'total': io.flow.v0.models.OrderQuoteSummaryTotal;
8087
- readonly 'balance': io.flow.v0.unions.OrderQuotePrice;
8088
- }
8089
-
8090
- interface OrderQuoteSummaryDuty {
8091
- readonly 'name': string;
8092
- readonly 'total': io.flow.v0.unions.OrderQuotePrice;
8093
- }
8094
-
8095
- interface OrderQuoteSummaryItems {
8096
- readonly 'lines': io.flow.v0.models.OrderQuoteLine[];
8097
- readonly 'total': io.flow.v0.unions.OrderQuotePrice;
8098
- }
8099
-
8100
- interface OrderQuoteSummaryShipping {
8101
- readonly 'total': io.flow.v0.unions.OrderQuotePrice;
8102
- readonly 'freight'?: io.flow.v0.models.OrderQuoteSummaryShippingFreight;
8103
- readonly 'surcharges'?: io.flow.v0.models.OrderQuoteSummaryShippingSurcharges;
8104
- }
8105
-
8106
- interface OrderQuoteSummaryShippingFreight {
8107
- readonly 'total': io.flow.v0.unions.OrderQuotePrice;
8108
- }
8109
-
8110
- interface OrderQuoteSummaryShippingSurcharges {
8111
- readonly 'total': io.flow.v0.unions.OrderQuotePrice;
8112
- }
8113
-
8114
- interface OrderQuoteSummaryTax {
8115
- readonly 'name': string;
8116
- readonly 'total': io.flow.v0.unions.OrderQuotePrice;
8117
- }
8118
-
8119
- interface OrderQuoteSummaryTotal {
8120
- readonly 'total': io.flow.v0.unions.OrderQuotePrice;
8121
- }
8122
-
8123
7977
  interface OrderReference {
8124
7978
  readonly 'discriminator': 'order_reference';
8125
7979
  readonly 'id': string;
@@ -9801,6 +9655,7 @@ declare namespace io.flow.v0.models {
9801
9655
  readonly 'product_id': string;
9802
9656
  readonly 'item_numbers': string[];
9803
9657
  readonly 'prohibited_regions': string[];
9658
+ readonly 'reasons_per_region'?: io.flow.v0.models.ReasonsPerRegion[];
9804
9659
  readonly 'review_status'?: io.flow.v0.enums.ReviewStatus;
9805
9660
  readonly 'rules'?: io.flow.v0.enums.ProductRestrictionRule[];
9806
9661
  readonly 'updated_by'?: string;
@@ -10267,6 +10122,12 @@ declare namespace io.flow.v0.models {
10267
10122
  readonly 'ready_to_fulfill': io.flow.v0.models.ReadyToFulfillDetails;
10268
10123
  }
10269
10124
 
10125
+ interface ReasonsPerRegion {
10126
+ readonly 'region': string;
10127
+ readonly 'reasons': string[];
10128
+ readonly 'review_status': io.flow.v0.enums.RestrictedReviewStatus;
10129
+ }
10130
+
10270
10131
  interface RedirectAuthorizationDetails {
10271
10132
  readonly 'discriminator': 'redirect_authorization_details';
10272
10133
  readonly 'id': string;
@@ -12741,7 +12602,6 @@ declare namespace io.flow.v0.unions {
12741
12602
  type OrderNumberGenerator = (io.flow.v0.models.OrderNumberGeneratorUuid | io.flow.v0.models.OrderNumberGeneratorHexadecimal | io.flow.v0.models.OrderNumberGeneratorPrefixSuffix);
12742
12603
  type OrderPromotion = (io.flow.v0.models.FreeShippingOrderPromotion);
12743
12604
  type OrderPromotionForm = (io.flow.v0.models.FreeShippingOrderPromotionForm);
12744
- type OrderQuotePrice = (io.flow.v0.models.OrderQuotePriceFree | io.flow.v0.models.OrderQuotePriceNotYetKnown | io.flow.v0.models.OrderQuotePriceIncluded | io.flow.v0.models.OrderQuotePriceStandard | io.flow.v0.models.OrderQuotePriceEstimated);
12745
12605
  type OrderRefundSummaryForm = (io.flow.v0.models.OrderRefundSummaryFullForm | io.flow.v0.models.OrderRefundSummaryPartialForm);
12746
12606
  type PartnerCenterFee = (io.flow.v0.models.CommercialInvoiceFee | io.flow.v0.models.InboundCartonFee | io.flow.v0.models.OutboundCartonFee);
12747
12607
  type Payment = (io.flow.v0.models.PaymentPaypal | io.flow.v0.models.PaymentCryptopay);
@@ -12916,9 +12776,6 @@ export const orderMerchantOfRecord: PropTypes.Requireable<io.flow.v0.enums.Order
12916
12776
  export const orderPaymentType: PropTypes.Requireable<io.flow.v0.enums.OrderPaymentType>;
12917
12777
  export const orderPriceDetailComponentKey: PropTypes.Requireable<io.flow.v0.enums.OrderPriceDetailComponentKey>;
12918
12778
  export const orderPriceDetailKey: PropTypes.Requireable<io.flow.v0.enums.OrderPriceDetailKey>;
12919
- export const orderQuoteAddressType: PropTypes.Requireable<io.flow.v0.enums.OrderQuoteAddressType>;
12920
- export const orderQuoteErrorCode: PropTypes.Requireable<io.flow.v0.enums.OrderQuoteErrorCode>;
12921
- export const orderQuoteLineErrorCode: PropTypes.Requireable<io.flow.v0.enums.OrderQuoteLineErrorCode>;
12922
12779
  export const orderRefundSummaryIncludes: PropTypes.Requireable<io.flow.v0.enums.OrderRefundSummaryIncludes>;
12923
12780
  export const orderRefundSummaryPartialCharged: PropTypes.Requireable<io.flow.v0.enums.OrderRefundSummaryPartialCharged>;
12924
12781
  export const orderStatus: PropTypes.Requireable<io.flow.v0.enums.OrderStatus>;
@@ -12962,6 +12819,7 @@ export const ratecardOwner: PropTypes.Requireable<io.flow.v0.enums.RatecardOwner
12962
12819
  export const refundDeclineCode: PropTypes.Requireable<io.flow.v0.enums.RefundDeclineCode>;
12963
12820
  export const refundStatus: PropTypes.Requireable<io.flow.v0.enums.RefundStatus>;
12964
12821
  export const regionType: PropTypes.Requireable<io.flow.v0.enums.RegionType>;
12822
+ export const restrictedReviewStatus: PropTypes.Requireable<io.flow.v0.enums.RestrictedReviewStatus>;
12965
12823
  export const returnItemStatus: PropTypes.Requireable<io.flow.v0.enums.ReturnItemStatus>;
12966
12824
  export const returnPolicyState: PropTypes.Requireable<io.flow.v0.enums.ReturnPolicyState>;
12967
12825
  export const returnStatus: PropTypes.Requireable<io.flow.v0.enums.ReturnStatus>;
@@ -13807,30 +13665,6 @@ export const orderPriceDetail: PropTypes.Requireable<io.flow.v0.models.OrderPric
13807
13665
  export const orderPriceDetailComponent: PropTypes.Requireable<io.flow.v0.models.OrderPriceDetailComponent>;
13808
13666
  export const orderPromotionTrigger: PropTypes.Requireable<io.flow.v0.models.OrderPromotionTrigger>;
13809
13667
  export const orderPutForm: PropTypes.Requireable<io.flow.v0.models.OrderPutForm>;
13810
- export const orderQuote: PropTypes.Requireable<io.flow.v0.models.OrderQuote>;
13811
- export const orderQuoteAddress: PropTypes.Requireable<io.flow.v0.models.OrderQuoteAddress>;
13812
- export const orderQuoteContact: PropTypes.Requireable<io.flow.v0.models.OrderQuoteContact>;
13813
- export const orderQuoteError: PropTypes.Requireable<io.flow.v0.models.OrderQuoteError>;
13814
- export const orderQuoteErrorDetails: PropTypes.Requireable<io.flow.v0.models.OrderQuoteErrorDetails>;
13815
- export const orderQuoteGeoPutForm: PropTypes.Requireable<io.flow.v0.models.OrderQuoteGeoPutForm>;
13816
- export const orderQuoteLine: PropTypes.Requireable<io.flow.v0.models.OrderQuoteLine>;
13817
- export const orderQuoteLineDiscount: PropTypes.Requireable<io.flow.v0.models.OrderQuoteLineDiscount>;
13818
- export const orderQuoteLineError: PropTypes.Requireable<io.flow.v0.models.OrderQuoteLineError>;
13819
- export const orderQuotePriceEstimated: PropTypes.Requireable<io.flow.v0.models.OrderQuotePriceEstimated>;
13820
- export const orderQuotePriceFree: PropTypes.Requireable<io.flow.v0.models.OrderQuotePriceFree>;
13821
- export const orderQuotePriceIncluded: PropTypes.Requireable<io.flow.v0.models.OrderQuotePriceIncluded>;
13822
- export const orderQuotePriceNotYetKnown: PropTypes.Requireable<io.flow.v0.models.OrderQuotePriceNotYetKnown>;
13823
- export const orderQuotePriceStandard: PropTypes.Requireable<io.flow.v0.models.OrderQuotePriceStandard>;
13824
- export const orderQuotePutForm: PropTypes.Requireable<io.flow.v0.models.OrderQuotePutForm>;
13825
- export const orderQuoteReference: PropTypes.Requireable<io.flow.v0.models.OrderQuoteReference>;
13826
- export const orderQuoteSummary: PropTypes.Requireable<io.flow.v0.models.OrderQuoteSummary>;
13827
- export const orderQuoteSummaryDuty: PropTypes.Requireable<io.flow.v0.models.OrderQuoteSummaryDuty>;
13828
- export const orderQuoteSummaryItems: PropTypes.Requireable<io.flow.v0.models.OrderQuoteSummaryItems>;
13829
- export const orderQuoteSummaryShipping: PropTypes.Requireable<io.flow.v0.models.OrderQuoteSummaryShipping>;
13830
- export const orderQuoteSummaryShippingFreight: PropTypes.Requireable<io.flow.v0.models.OrderQuoteSummaryShippingFreight>;
13831
- export const orderQuoteSummaryShippingSurcharges: PropTypes.Requireable<io.flow.v0.models.OrderQuoteSummaryShippingSurcharges>;
13832
- export const orderQuoteSummaryTax: PropTypes.Requireable<io.flow.v0.models.OrderQuoteSummaryTax>;
13833
- export const orderQuoteSummaryTotal: PropTypes.Requireable<io.flow.v0.models.OrderQuoteSummaryTotal>;
13834
13668
  export const orderReference: PropTypes.Requireable<io.flow.v0.models.OrderReference>;
13835
13669
  export const orderRefundSummary: PropTypes.Requireable<io.flow.v0.models.OrderRefundSummary>;
13836
13670
  export const orderRefundSummaryAmounts: PropTypes.Requireable<io.flow.v0.models.OrderRefundSummaryAmounts>;
@@ -14128,6 +13962,7 @@ export const ratecardVersion: PropTypes.Requireable<io.flow.v0.models.RatecardVe
14128
13962
  export const readyToFulfill: PropTypes.Requireable<io.flow.v0.models.ReadyToFulfill>;
14129
13963
  export const readyToFulfillDetails: PropTypes.Requireable<io.flow.v0.models.ReadyToFulfillDetails>;
14130
13964
  export const readyToFulfillV2: PropTypes.Requireable<io.flow.v0.models.ReadyToFulfillV2>;
13965
+ export const reasonsPerRegion: PropTypes.Requireable<io.flow.v0.models.ReasonsPerRegion>;
14131
13966
  export const redirectAuthorizationDetails: PropTypes.Requireable<io.flow.v0.models.RedirectAuthorizationDetails>;
14132
13967
  export const redirectAuthorizationForm: PropTypes.Requireable<io.flow.v0.models.RedirectAuthorizationForm>;
14133
13968
  export const refund: PropTypes.Requireable<io.flow.v0.models.Refund>;
@@ -14519,7 +14354,6 @@ export const orderInformation: PropTypes.Requireable<io.flow.v0.unions.OrderInfo
14519
14354
  export const orderNumberGenerator: PropTypes.Requireable<io.flow.v0.unions.OrderNumberGenerator>;
14520
14355
  export const orderPromotion: PropTypes.Requireable<io.flow.v0.unions.OrderPromotion>;
14521
14356
  export const orderPromotionForm: PropTypes.Requireable<io.flow.v0.unions.OrderPromotionForm>;
14522
- export const orderQuotePrice: PropTypes.Requireable<io.flow.v0.unions.OrderQuotePrice>;
14523
14357
  export const orderRefundSummaryForm: PropTypes.Requireable<io.flow.v0.unions.OrderRefundSummaryForm>;
14524
14358
  export const partnerCenterFee: PropTypes.Requireable<io.flow.v0.unions.PartnerCenterFee>;
14525
14359
  export const payment: PropTypes.Requireable<io.flow.v0.unions.Payment>;