@flowio/api-types 0.0.202 → 0.0.203
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.
|
@@ -219,7 +219,7 @@ declare namespace io.flow.internal.v0.enums {
|
|
|
219
219
|
type PromptCheckoutDisplayPosition = 'email' | 'submission';
|
|
220
220
|
type PromptOptions = 'notice_only' | 'require_consent' | 'consent_by_default';
|
|
221
221
|
type PromptTarget = 'browse' | 'checkout';
|
|
222
|
-
type QueuedRecordType = 'capture' | '
|
|
222
|
+
type QueuedRecordType = 'capture' | 'channel_transaction' | 'consumer_invoice' | 'fulfillment_in_transit' | 'fulfillment_shipping_notification' | 'fulfillment_external' | 'fulfillment_order_cancellation' | 'label_tracking_summary' | 'label_invoice_request' | 'carrier_charge' | 'carrier_charge_file' | 'label_origin' | 'order' | 'order_identifier' | 'organization_onboarding_state' | 'refund' | 'refund_over_capture' | 'sales_record' | 'statement_batch' | 'statement_email' | 'statement_summary_email';
|
|
223
223
|
type QuoteRequestType = 'generate' | 'delete' | 'update_currency_rate' | 'update_country';
|
|
224
224
|
type RateLevelKey = 'shopify_small_usa' | 'shopify_medium_usa' | 'shopify_enterprise_usa' | 'shopify_small_sdc_usa';
|
|
225
225
|
type RateSource = 'calculated' | 'market';
|
|
@@ -1704,6 +1704,53 @@ declare namespace io.flow.internal.v0.models {
|
|
|
1704
1704
|
readonly 'error_message'?: string;
|
|
1705
1705
|
}
|
|
1706
1706
|
|
|
1707
|
+
interface CarrierChargeFile {
|
|
1708
|
+
readonly 'id': string;
|
|
1709
|
+
readonly 'url': string;
|
|
1710
|
+
readonly 'created_at': string;
|
|
1711
|
+
readonly 'result'?: io.flow.internal.v0.models.CarrierChargeFileResult;
|
|
1712
|
+
}
|
|
1713
|
+
|
|
1714
|
+
interface CarrierChargeFileForm {
|
|
1715
|
+
readonly 'url': string;
|
|
1716
|
+
}
|
|
1717
|
+
|
|
1718
|
+
interface CarrierChargeFileResult {
|
|
1719
|
+
readonly 'processed_at': string;
|
|
1720
|
+
readonly 'number_lines_successful': number;
|
|
1721
|
+
readonly 'number_lines_with_errors': number;
|
|
1722
|
+
readonly 'errors_url'?: string;
|
|
1723
|
+
}
|
|
1724
|
+
|
|
1725
|
+
interface CarrierChargeFormLabel {
|
|
1726
|
+
readonly 'discriminator': 'label';
|
|
1727
|
+
readonly 'id': string;
|
|
1728
|
+
readonly 'label_invoice_request_id': string;
|
|
1729
|
+
readonly 'units': io.flow.internal.v0.models.CarrierChargeUnits;
|
|
1730
|
+
readonly 'base': io.flow.internal.v0.models.LabelBase;
|
|
1731
|
+
readonly 'surcharges': io.flow.internal.v0.models.LabelSurchargeForm;
|
|
1732
|
+
readonly 'total': number;
|
|
1733
|
+
readonly 'attributes'?: Record<string, string>;
|
|
1734
|
+
}
|
|
1735
|
+
|
|
1736
|
+
interface CarrierChargeFormReturnToOrigin {
|
|
1737
|
+
readonly 'discriminator': 'return_to_origin';
|
|
1738
|
+
readonly 'id': string;
|
|
1739
|
+
readonly 'carrier_id': string;
|
|
1740
|
+
readonly 'carrier_tracking_number': string;
|
|
1741
|
+
readonly 'units': io.flow.internal.v0.models.CarrierChargeUnits;
|
|
1742
|
+
readonly 'base': io.flow.internal.v0.models.LabelBase;
|
|
1743
|
+
readonly 'surcharges': io.flow.internal.v0.models.LabelSurchargeForm;
|
|
1744
|
+
readonly 'total': number;
|
|
1745
|
+
readonly 'attributes'?: Record<string, string>;
|
|
1746
|
+
}
|
|
1747
|
+
|
|
1748
|
+
interface CarrierChargeUnits {
|
|
1749
|
+
readonly 'currency': string;
|
|
1750
|
+
readonly 'weight': io.flow.units.v0.enums.UnitOfWeight;
|
|
1751
|
+
readonly 'length'?: io.flow.units.v0.enums.UnitOfLength;
|
|
1752
|
+
}
|
|
1753
|
+
|
|
1707
1754
|
interface CarrierInvoice {
|
|
1708
1755
|
readonly 'number': string;
|
|
1709
1756
|
readonly 'timestamp': string;
|
|
@@ -6422,16 +6469,28 @@ declare namespace io.flow.internal.v0.models {
|
|
|
6422
6469
|
interface FulfillmentProofExternalFulfillmentProofReference {
|
|
6423
6470
|
readonly 'discriminator': 'external_fulfillment';
|
|
6424
6471
|
readonly 'id': string;
|
|
6472
|
+
readonly 'carrier_id'?: string;
|
|
6473
|
+
readonly 'carrier_service_id'?: string;
|
|
6474
|
+
readonly 'carrier_tracking_number'?: string;
|
|
6475
|
+
readonly 'label_id'?: string;
|
|
6425
6476
|
}
|
|
6426
6477
|
|
|
6427
6478
|
interface FulfillmentProofLabelTrackingReference {
|
|
6428
6479
|
readonly 'discriminator': 'label_tracking';
|
|
6429
6480
|
readonly 'id': string;
|
|
6481
|
+
readonly 'carrier_id'?: string;
|
|
6482
|
+
readonly 'carrier_service_id'?: string;
|
|
6483
|
+
readonly 'carrier_tracking_number'?: string;
|
|
6484
|
+
readonly 'label_id'?: string;
|
|
6430
6485
|
}
|
|
6431
6486
|
|
|
6432
6487
|
interface FulfillmentProofShippingNotificationReference {
|
|
6433
6488
|
readonly 'discriminator': 'shipping_notification';
|
|
6434
6489
|
readonly 'id': string;
|
|
6490
|
+
readonly 'carrier_id'?: string;
|
|
6491
|
+
readonly 'carrier_service_id'?: string;
|
|
6492
|
+
readonly 'carrier_tracking_number'?: string;
|
|
6493
|
+
readonly 'label_id'?: string;
|
|
6435
6494
|
}
|
|
6436
6495
|
|
|
6437
6496
|
interface FulfillmentReference {
|
|
@@ -8060,33 +8119,6 @@ declare namespace io.flow.internal.v0.models {
|
|
|
8060
8119
|
readonly 'label_invoice_request': io.flow.internal.v0.models.LabelInvoiceRequest;
|
|
8061
8120
|
}
|
|
8062
8121
|
|
|
8063
|
-
interface LabelInvoiceResponseFile {
|
|
8064
|
-
readonly 'id': string;
|
|
8065
|
-
readonly 'url': string;
|
|
8066
|
-
readonly 'created_at': string;
|
|
8067
|
-
readonly 'result'?: io.flow.internal.v0.models.LabelInvoiceResponseFileResult;
|
|
8068
|
-
}
|
|
8069
|
-
|
|
8070
|
-
interface LabelInvoiceResponseFileForm {
|
|
8071
|
-
readonly 'url': string;
|
|
8072
|
-
}
|
|
8073
|
-
|
|
8074
|
-
interface LabelInvoiceResponseFileResult {
|
|
8075
|
-
readonly 'processed_at': string;
|
|
8076
|
-
readonly 'number_lines_successful': number;
|
|
8077
|
-
readonly 'number_lines_with_errors': number;
|
|
8078
|
-
readonly 'errors_url'?: string;
|
|
8079
|
-
}
|
|
8080
|
-
|
|
8081
|
-
interface LabelInvoiceResponseForm {
|
|
8082
|
-
readonly 'id': string;
|
|
8083
|
-
readonly 'label_invoice_request_id': string;
|
|
8084
|
-
readonly 'units': io.flow.internal.v0.models.LabelResponseUnits;
|
|
8085
|
-
readonly 'base': io.flow.internal.v0.models.LabelBase;
|
|
8086
|
-
readonly 'surcharges': io.flow.internal.v0.models.LabelSurchargeForm;
|
|
8087
|
-
readonly 'total': number;
|
|
8088
|
-
}
|
|
8089
|
-
|
|
8090
8122
|
interface LabelMetadata {
|
|
8091
8123
|
readonly 'ratecard': io.flow.internal.v0.models.MetadataRatecard;
|
|
8092
8124
|
readonly 'weights': io.flow.internal.v0.models.MetadataWeights;
|
|
@@ -8122,12 +8154,6 @@ declare namespace io.flow.internal.v0.models {
|
|
|
8122
8154
|
readonly 'label_request_error': io.flow.internal.v0.models.LabelRequestError;
|
|
8123
8155
|
}
|
|
8124
8156
|
|
|
8125
|
-
interface LabelResponseUnits {
|
|
8126
|
-
readonly 'currency': string;
|
|
8127
|
-
readonly 'weight': io.flow.units.v0.enums.UnitOfWeight;
|
|
8128
|
-
readonly 'length'?: io.flow.units.v0.enums.UnitOfLength;
|
|
8129
|
-
}
|
|
8130
|
-
|
|
8131
8157
|
interface LabelSummary {
|
|
8132
8158
|
readonly 'id': string;
|
|
8133
8159
|
readonly 'commercial_invoice'?: string;
|
|
@@ -8930,6 +8956,10 @@ declare namespace io.flow.internal.v0.models {
|
|
|
8930
8956
|
}
|
|
8931
8957
|
|
|
8932
8958
|
interface MerchantCharges {
|
|
8959
|
+
readonly 'adjustment': number;
|
|
8960
|
+
readonly 'reversal': number;
|
|
8961
|
+
readonly 'tax': number;
|
|
8962
|
+
readonly 'duty': number;
|
|
8933
8963
|
readonly 'labels': number;
|
|
8934
8964
|
readonly 'total': number;
|
|
8935
8965
|
}
|
|
@@ -9584,6 +9614,7 @@ declare namespace io.flow.internal.v0.models {
|
|
|
9584
9614
|
readonly 'id': string;
|
|
9585
9615
|
readonly 'deactivate_at': string;
|
|
9586
9616
|
readonly 'created_at': string;
|
|
9617
|
+
readonly 'reason'?: string;
|
|
9587
9618
|
}
|
|
9588
9619
|
|
|
9589
9620
|
interface OrganizationDeactivationDeleted {
|
|
@@ -9596,6 +9627,7 @@ declare namespace io.flow.internal.v0.models {
|
|
|
9596
9627
|
|
|
9597
9628
|
interface OrganizationDeactivationForm {
|
|
9598
9629
|
readonly 'deactivate_at': string;
|
|
9630
|
+
readonly 'reason'?: string;
|
|
9599
9631
|
}
|
|
9600
9632
|
|
|
9601
9633
|
interface OrganizationDeactivationUpserted {
|
|
@@ -13170,6 +13202,7 @@ declare namespace io.flow.internal.v0.unions {
|
|
|
13170
13202
|
type AuthorizedOrderCharge = (io.flow.internal.v0.models.AuthorizedShippingCharge);
|
|
13171
13203
|
type BlazeConsumerMessage = (io.flow.internal.v0.models.BlazeAddOrderAttributesMessage | io.flow.internal.v0.models.BlazeAddToCartMessage | io.flow.internal.v0.models.BlazeCreateByCartToken | io.flow.internal.v0.models.BlazeInitializeByOrderQuoteMessage | io.flow.internal.v0.models.BlazeInitializeBySessionMessage | io.flow.internal.v0.models.BlazeInitializeMessage | io.flow.internal.v0.models.BlazeSetCartItemsMessage | io.flow.internal.v0.models.BlazeSetCheckoutIdMessage | io.flow.internal.v0.models.BlazeStartCheckoutMessage | io.flow.internal.v0.models.BlazeUpdateCartItemsMessage | io.flow.internal.v0.models.BlazeApplepayAvailabilityResponse | io.flow.internal.v0.models.BlazeSetPromotionCodeMessage);
|
|
13172
13204
|
type BlazeProviderMessage = (io.flow.internal.v0.models.BlazeCheckoutCompleteMessage | io.flow.internal.v0.models.BlazeCheckoutProgressMessage | io.flow.internal.v0.models.BlazeCheckoutEventMessage | io.flow.internal.v0.models.BlazeStartCheckoutMessage | io.flow.internal.v0.models.BlazeExitCheckoutMessage | io.flow.internal.v0.models.BlazeExitCheckoutConfirmationMessage | io.flow.internal.v0.models.BlazeRedirectConfirmationMessage | io.flow.internal.v0.models.BlazeSynInitializeMessage | io.flow.internal.v0.models.BlazeApplepayAvailabilityRequest | io.flow.internal.v0.models.BlazePaymentAuthStartMessage | io.flow.internal.v0.models.BlazePaymentAuthCompleteMessage);
|
|
13205
|
+
type CarrierChargeForm = (io.flow.internal.v0.models.CarrierChargeFormLabel | io.flow.internal.v0.models.CarrierChargeFormReturnToOrigin);
|
|
13173
13206
|
type CarrierCredentials = (io.flow.internal.v0.models.SfExpress | io.flow.internal.v0.models.DhlEcommerce | io.flow.internal.v0.models.Landmark | io.flow.internal.v0.models.Dhl | io.flow.internal.v0.models.FedexCrossborder | io.flow.internal.v0.models.Ups | io.flow.internal.v0.models.Fedex);
|
|
13174
13207
|
type ChannelRateMetadata = (io.flow.internal.v0.models.ChannelRateMetadataIdentity | io.flow.internal.v0.models.ChannelRateMetadataRate);
|
|
13175
13208
|
type CheckoutAddressBookEdit = (io.flow.internal.v0.models.CheckoutAddressBookContactRemoved);
|
|
@@ -20,6 +20,7 @@ declare namespace io.flow.shopify.markets.v0.enums {
|
|
|
20
20
|
type ShopifyOrderFulfillmentStatusType = 'fulfilled' | 'null' | 'partial';
|
|
21
21
|
type ShopifyOrderInventoryBehaviour = 'bypass' | 'decrement_ignoring_policy' | 'decrement_obeying_policy';
|
|
22
22
|
type ShopifyOrderKindType = 'authorization' | 'capture' | 'sale' | 'void' | 'refund';
|
|
23
|
+
type ShopifyOrderPaymentGatewayNames = 'flow_commerce' | 'gift_card' | 'manual' | 'shopify_payments';
|
|
23
24
|
type ShopifyOrderProcessingMethodType = 'checkout' | 'direct' | 'manual' | 'offsite' | 'express';
|
|
24
25
|
type ShopifyOrderRestockType = 'no_restock' | 'cancel' | 'return';
|
|
25
26
|
type ShopifyOrderStatusType = 'open' | 'closed' | 'cancelled' | 'any';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flowio/api-types",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.203",
|
|
4
4
|
"description": "Global TypeScript typings for Flow Commerce API",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,5 +14,5 @@
|
|
|
14
14
|
"scripts": {
|
|
15
15
|
"generate": "apibuilder update && node scripts/generate-index.js"
|
|
16
16
|
},
|
|
17
|
-
"gitHead": "
|
|
17
|
+
"gitHead": "2eaa54ec47aea1e42dad859077feb3852172583c"
|
|
18
18
|
}
|