@flowio/api-types 0.0.225 → 0.0.227
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/generated/io.flow.billing.accounting.v0.billing-accounting.d.ts +21 -1
- package/generated/io.flow.billing.bank.account.v0.billing-bank-account.d.ts +1 -1
- package/generated/io.flow.billing.internal.v0.billing-internal.d.ts +27 -24
- package/generated/io.flow.billing.reporting.csv.v0.billing-reporting-csv.d.ts +0 -1
- package/generated/io.flow.billing.reporting.v0.billing-reporting.d.ts +33 -21
- package/generated/io.flow.billing.v0.billing.d.ts +67 -14
- package/generated/io.flow.channel.internal.v0.channel-internal.d.ts +1 -1
- package/generated/io.flow.experiment.internal.v0.experiment-internal.d.ts +191 -0
- package/generated/io.flow.internal.v0.api-internal.d.ts +746 -399
- package/generated/io.flow.label.v0.label.d.ts +7 -0
- package/generated/io.flow.organization.onboarding.state.v0.organization-onboarding-state.d.ts +6 -1
- package/generated/io.flow.payment.gateway.v0.payment-gateway.d.ts +7 -1
- package/generated/io.flow.payment.v0.payment.d.ts +11 -1
- package/generated/io.flow.shopify.external.v0.shopify-external.d.ts +1 -0
- package/generated/io.flow.shopify.markets.internal.event.v0.shopify-markets-internal-event.d.ts +32 -1
- package/generated/io.flow.shopify.markets.internal.v0.shopify-markets-internal.d.ts +18 -0
- package/generated/io.flow.shopify.markets.v0.shopify-markets.d.ts +1 -1
- package/generated/io.flow.stripe.v0.stripe.d.ts +162 -5
- package/generated/io.flow.trueup.v0.trueup.d.ts +1 -1
- package/generated/io.flow.v0.api.d.ts +116 -19
- package/index.d.ts +1 -14
- package/package.json +2 -2
- package/generated/io.flow.billing.csv.v0.billing-csv.d.ts +0 -451
- package/generated/io.flow.checkout.analytics.v0.checkout-analytics.d.ts +0 -137
- package/generated/io.flow.checkout.backend.v0.checkout-backend.d.ts +0 -539
- package/generated/io.flow.checkout.common.v0.checkout-common.d.ts +0 -57
- package/generated/io.flow.checkout.configuration.v0.checkout-configuration.d.ts +0 -113
- package/generated/io.flow.checkout.protocol.v0.checkout-protocol.d.ts +0 -1347
- package/generated/io.flow.consumer.invoice.v0.consumer-invoice.d.ts +0 -204
- package/generated/io.flow.content.internal.v0.content-internal.d.ts +0 -168
- package/generated/io.flow.currency.internal.v0.currency-internal.d.ts +0 -119
- package/generated/io.flow.experience.internal.v0.experience-internal.d.ts +0 -247
- package/generated/io.flow.feature.v0.feature.d.ts +0 -121
- package/generated/io.flow.optin.internal.v0.optin-internal.d.ts +0 -73
- package/generated/io.flow.price.internal.v0.price-internal.d.ts +0 -4
- package/generated/io.flow.svb.v0.svb.d.ts +0 -166
|
@@ -4,11 +4,13 @@ declare namespace io.flow.billing.accounting.v0.models {
|
|
|
4
4
|
readonly 'order': io.flow.billing.accounting.v0.models.OrderSummary;
|
|
5
5
|
readonly 'shopper': io.flow.billing.accounting.v0.models.ShopperSummary;
|
|
6
6
|
readonly 'remittance': io.flow.billing.accounting.v0.models.RemittanceResponsibility;
|
|
7
|
+
readonly 'payment'?: io.flow.billing.accounting.v0.models.PaymentSummary;
|
|
7
8
|
readonly 'merchant': io.flow.billing.accounting.v0.models.MerchantSummary;
|
|
8
9
|
readonly 'sequence_number': number;
|
|
9
10
|
readonly 'posting_cutoff': string;
|
|
10
|
-
readonly 'trigger'
|
|
11
|
+
readonly 'trigger'?: io.flow.billing.accounting.v0.unions.FulfillmentTrigger;
|
|
11
12
|
readonly 'fulfilled_at': string;
|
|
13
|
+
readonly 'carrier'?: io.flow.billing.accounting.v0.models.FulfillmentCarrier;
|
|
12
14
|
readonly 'owner': io.flow.billing.internal.v0.enums.ResponsibleParty;
|
|
13
15
|
readonly 'origin'?: io.flow.billing.accounting.v0.models.FulfillmentOrigin;
|
|
14
16
|
readonly 'business'?: io.flow.billing.accounting.v0.models.FulfillmentBusiness;
|
|
@@ -19,6 +21,12 @@ declare namespace io.flow.billing.accounting.v0.models {
|
|
|
19
21
|
readonly 'vat_registration_number': string;
|
|
20
22
|
}
|
|
21
23
|
|
|
24
|
+
interface FulfillmentCarrier {
|
|
25
|
+
readonly 'id': string;
|
|
26
|
+
readonly 'service_id'?: string;
|
|
27
|
+
readonly 'tracking_number'?: string;
|
|
28
|
+
}
|
|
29
|
+
|
|
22
30
|
interface FulfillmentOrigin {
|
|
23
31
|
readonly 'country': string;
|
|
24
32
|
readonly 'province_code'?: string;
|
|
@@ -141,11 +149,21 @@ declare namespace io.flow.billing.accounting.v0.models {
|
|
|
141
149
|
readonly 'currency': string;
|
|
142
150
|
}
|
|
143
151
|
|
|
152
|
+
interface PaymentSummary {
|
|
153
|
+
readonly 'psp': number;
|
|
154
|
+
readonly 'credit': number;
|
|
155
|
+
readonly 'subsidized': number;
|
|
156
|
+
readonly 'manual': number;
|
|
157
|
+
readonly 'cod': number;
|
|
158
|
+
readonly 'total': number;
|
|
159
|
+
}
|
|
160
|
+
|
|
144
161
|
interface PendingOrder {
|
|
145
162
|
readonly 'id': string;
|
|
146
163
|
readonly 'order': io.flow.billing.accounting.v0.models.OrderSummary;
|
|
147
164
|
readonly 'shopper': io.flow.billing.accounting.v0.models.ShopperSummary;
|
|
148
165
|
readonly 'merchant': io.flow.billing.accounting.v0.models.MerchantSummary;
|
|
166
|
+
readonly 'payment'?: io.flow.billing.accounting.v0.models.PaymentSummary;
|
|
149
167
|
readonly 'remittance': io.flow.billing.accounting.v0.models.RemittanceResponsibility;
|
|
150
168
|
readonly 'sequence_number': number;
|
|
151
169
|
readonly 'posting_cutoff': string;
|
|
@@ -162,6 +180,7 @@ declare namespace io.flow.billing.accounting.v0.models {
|
|
|
162
180
|
readonly 'shopper': io.flow.billing.accounting.v0.models.ShopperSummary;
|
|
163
181
|
readonly 'merchant': io.flow.billing.accounting.v0.models.MerchantSummary;
|
|
164
182
|
readonly 'remittance': io.flow.billing.accounting.v0.models.RemittanceResponsibility;
|
|
183
|
+
readonly 'payment'?: io.flow.billing.accounting.v0.models.PaymentSummary;
|
|
165
184
|
readonly 'sequence_number': number;
|
|
166
185
|
readonly 'posting_cutoff': string;
|
|
167
186
|
readonly 'trigger': io.flow.billing.accounting.v0.unions.ReturnTrigger;
|
|
@@ -214,6 +233,7 @@ declare namespace io.flow.billing.accounting.v0.models {
|
|
|
214
233
|
readonly 'product': io.flow.billing.accounting.v0.models.ShopperLines;
|
|
215
234
|
readonly 'fees': io.flow.billing.accounting.v0.models.ShopperFees;
|
|
216
235
|
readonly 'freight': io.flow.billing.accounting.v0.models.ShopperFreight;
|
|
236
|
+
readonly 'tips'?: number;
|
|
217
237
|
readonly 'order_discount': number;
|
|
218
238
|
readonly 'total': number;
|
|
219
239
|
}
|
|
@@ -32,4 +32,4 @@ declare namespace io.flow.billing.bank.account.v0.models {
|
|
|
32
32
|
|
|
33
33
|
declare namespace io.flow.billing.bank.account.v0.unions {
|
|
34
34
|
type BankAccountInfo = (io.flow.billing.bank.account.v0.models.BankAccountInfoUsa | io.flow.billing.bank.account.v0.models.BankAccountInfoCan | io.flow.billing.bank.account.v0.models.BankAccountInfoGbr | io.flow.billing.bank.account.v0.models.BankAccountInfoFra | io.flow.billing.bank.account.v0.models.BankAccountInfoIta);
|
|
35
|
-
}
|
|
35
|
+
}
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
declare namespace io.flow.billing.internal.v0.enums {
|
|
2
|
-
type AccountPaymentHoldReason = 'fraudulent' | 'invalid_bank_account';
|
|
2
|
+
type AccountPaymentHoldReason = 'fraudulent' | 'frozen' | 'invalid_bank_account';
|
|
3
3
|
type AccountSettingLiabilitiesMethod = 'withholding' | 'transaction';
|
|
4
4
|
type AccountType = 'channel' | 'organization';
|
|
5
5
|
type AdjustmentTransactionType = 'adjustment' | 'reversal';
|
|
6
6
|
type BankPaymentPromiseCompletedMethod = 'credit' | 'time';
|
|
7
7
|
type BankPaymentStatusCode = 'scheduled' | 'sent' | 'failed';
|
|
8
8
|
type BillingAllocationKey = 'freight_cost' | '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' | 'order_discount' | 'subtotal_percent_sales_margin' | 'subtotal_vat_percent_sales_margin' | 'subtotal_duty_percent_sales_margin' | 'vat_subsidy' | 'duty_subsidy' | 'fuel_surcharge' | 'remote_area_surcharge';
|
|
9
|
-
type BillingStatementAttachmentKey = 'invoice' | 'statement' | 'consumer_invoice' | 'credit_memo' | 'channel_billed' | 'transactions' | 'virtual_card' | 'tax_remittance' | 'manual' | 'orders' | 'label' | 'order_service' | 'tax' | 'duty' | 'trueup' | 'carrier_charge' | '
|
|
9
|
+
type BillingStatementAttachmentKey = 'invoice' | 'statement' | 'consumer_invoice' | 'credit_memo' | 'channel_billed' | 'transactions' | 'virtual_card' | 'tax_remittance' | 'manual' | 'orders' | 'label' | 'order_service' | 'tax' | 'duty' | 'trueup' | 'carrier_charge' | 'all';
|
|
10
10
|
type BillingTransactionStatus = 'pending_proof' | 'posted';
|
|
11
|
-
type BillingTransactionType = 'manual' | 'subscription' | 'invoice' | 'transfer' | 'adjustment' | 'reversal' | 'capture' | 'refund' | 'virtual_card_capture' | 'virtual_card_refund' | 'tax_remittance' | 'fully_subsidized_order' | 'credit_payment' | 'dispute' | 'channel' | 'label' | 'order' | 'channel_billed' | 'tax' | 'duty' | 'trueup' | 'carrier_charge'
|
|
11
|
+
type BillingTransactionType = 'manual' | 'subscription' | 'invoice' | 'transfer' | 'adjustment' | 'reversal' | 'capture' | 'refund' | 'virtual_card_capture' | 'virtual_card_refund' | 'tax_remittance' | 'fully_subsidized_order' | 'credit_payment' | 'dispute' | 'channel' | 'label' | 'order' | 'channel_billed' | 'tax' | 'duty' | 'trueup' | 'carrier_charge';
|
|
12
12
|
type CarrierChargeTransactionType = 'adjustment' | 'reversal' | 'charge' | 'revenue_share';
|
|
13
|
-
type CarrierFeeTransactionType = 'adjustment' | 'reversal' | 'fee';
|
|
14
13
|
type ChannelBilledTransactionType = 'adjustment' | 'reversal' | 'channel_initiated';
|
|
15
14
|
type ChannelTransactionType = 'adjustment' | 'reversal' | 'processing';
|
|
16
15
|
type DisputeTransactionType = 'adjustment' | 'dispute';
|
|
17
16
|
type DutyTransactionType = 'adjustment' | 'reversal' | 'duty';
|
|
18
17
|
type FeesSource = 'settings' | 'authorization_bundle';
|
|
19
18
|
type LabelTransactionType = 'adjustment' | 'reversal' | 'billable_label' | 'fee' | 'revenue_share';
|
|
20
|
-
type ManualTransactionCategory = 'cancelled_order_refund' | '
|
|
19
|
+
type ManualTransactionCategory = 'cancelled_order_refund' | 'client_accepted_chargeback' | 'fee_reimbursement' | 'platform_fee' | 'shipping_true_up' | 'tax_credit' | 'carrier_credit' | 'negative_balance_guarantee' | 'bank_payment_failure';
|
|
21
20
|
type OrderCancellationInitiatedBy = 'flow' | 'organization';
|
|
22
21
|
type OrderTransactionType = 'adjustment' | 'reversal' | 'order_service';
|
|
23
22
|
type PreferredBillingSchedule = 'monthly' | 'bi-monthly';
|
|
@@ -123,6 +122,7 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
123
122
|
readonly 'liabilities_method': io.flow.billing.internal.v0.enums.AccountSettingLiabilitiesMethod;
|
|
124
123
|
readonly 'enable_fee_reversals': boolean;
|
|
125
124
|
readonly 'record_reason_for_transactions_pending_payout': boolean;
|
|
125
|
+
readonly 'enable_negative_debits': boolean;
|
|
126
126
|
}
|
|
127
127
|
|
|
128
128
|
interface AccountSource {
|
|
@@ -203,6 +203,16 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
203
203
|
readonly 'attributes'?: Record<string, string>;
|
|
204
204
|
}
|
|
205
205
|
|
|
206
|
+
interface BankPaymentOrder {
|
|
207
|
+
readonly 'id': string;
|
|
208
|
+
readonly 'payment': io.flow.billing.internal.v0.models.BankPaymentReference;
|
|
209
|
+
readonly 'order': io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
interface BankPaymentReference {
|
|
213
|
+
readonly 'id': string;
|
|
214
|
+
}
|
|
215
|
+
|
|
206
216
|
interface BankPaymentStatusForm {
|
|
207
217
|
readonly 'code': io.flow.billing.internal.v0.enums.BankPaymentStatusCode;
|
|
208
218
|
readonly 'failure_reason'?: io.flow.billing.v0.enums.PayoutStatusFailureCode;
|
|
@@ -347,7 +357,6 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
347
357
|
readonly 'duty': io.flow.common.v0.models.Price;
|
|
348
358
|
readonly 'trueup': io.flow.common.v0.models.Price;
|
|
349
359
|
readonly 'carrier_charge': io.flow.common.v0.models.Price;
|
|
350
|
-
readonly 'carrier_fee': io.flow.common.v0.models.Price;
|
|
351
360
|
readonly 'ending_balance': io.flow.common.v0.models.Price;
|
|
352
361
|
}
|
|
353
362
|
|
|
@@ -381,23 +390,6 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
381
390
|
readonly 'created_at': string;
|
|
382
391
|
}
|
|
383
392
|
|
|
384
|
-
interface CarrierFeeTransaction {
|
|
385
|
-
readonly 'discriminator': 'carrier_fee_transaction';
|
|
386
|
-
readonly 'label_reference': io.flow.billing.internal.v0.models.CarrierFeeTransactionLabelReference;
|
|
387
|
-
readonly 'id': string;
|
|
388
|
-
readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
|
|
389
|
-
readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
|
|
390
|
-
readonly 'posted_at'?: string;
|
|
391
|
-
readonly 'value': io.flow.common.v0.models.Price;
|
|
392
|
-
readonly 'description': string;
|
|
393
|
-
readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
|
|
394
|
-
readonly 'created_at': string;
|
|
395
|
-
}
|
|
396
|
-
|
|
397
|
-
interface CarrierFeeTransactionLabelReference {
|
|
398
|
-
readonly 'id': string;
|
|
399
|
-
}
|
|
400
|
-
|
|
401
393
|
interface ChannelAccount {
|
|
402
394
|
readonly 'channel': io.flow.common.v0.models.ChannelReference;
|
|
403
395
|
readonly 'id': string;
|
|
@@ -498,6 +490,17 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
498
490
|
readonly 'timestamp': string;
|
|
499
491
|
}
|
|
500
492
|
|
|
493
|
+
interface CliLogEntry {
|
|
494
|
+
readonly 'id': string;
|
|
495
|
+
readonly 'user': io.flow.common.v0.models.UserReference;
|
|
496
|
+
readonly 'task': string;
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
interface CliLogEntryForm {
|
|
500
|
+
readonly 'user_id': string;
|
|
501
|
+
readonly 'task': string;
|
|
502
|
+
}
|
|
503
|
+
|
|
501
504
|
interface Components {
|
|
502
505
|
readonly 'vat': io.flow.common.v0.models.Price;
|
|
503
506
|
readonly 'duty': io.flow.common.v0.models.Price;
|
|
@@ -1131,5 +1134,5 @@ declare namespace io.flow.billing.internal.v0.unions {
|
|
|
1131
1134
|
type PlatformFee = (io.flow.billing.internal.v0.models.PlatformFeePause | io.flow.billing.internal.v0.models.PlatformFeeFlat | io.flow.billing.internal.v0.models.PlatformFeePercentage | io.flow.billing.internal.v0.models.PlatformFeeDisabled);
|
|
1132
1135
|
type ProofOfPosting = (io.flow.billing.internal.v0.models.ProofOfPostingFulfilled | io.flow.billing.internal.v0.models.ProofOfPostingExternallyFulfilled | io.flow.billing.internal.v0.models.ProofOfPostingShippingNotification | io.flow.billing.internal.v0.models.ProofOfPostingOrderCancellation | io.flow.billing.internal.v0.models.ProofOfPostingOrderCombinedShipment | io.flow.billing.internal.v0.models.ProofOfPostingTimeElapsed);
|
|
1133
1136
|
type SpotRateMetadata = (io.flow.billing.internal.v0.models.SpotRateMetadataIdentity | io.flow.billing.internal.v0.models.SpotRateMetadataRate);
|
|
1134
|
-
type Transaction = (io.flow.billing.internal.v0.models.InvoiceTransaction | io.flow.billing.internal.v0.models.ManualTransaction | io.flow.billing.internal.v0.models.ProcessingTransaction | io.flow.billing.internal.v0.models.SubscriptionTransaction | io.flow.billing.internal.v0.models.TaxRemittanceTransaction | io.flow.billing.internal.v0.models.TransferTransaction | io.flow.billing.internal.v0.models.VirtualCardTransaction | io.flow.billing.internal.v0.models.DisputeTransaction | io.flow.billing.internal.v0.models.ChannelTransaction | io.flow.billing.internal.v0.models.LabelTransaction | io.flow.billing.internal.v0.models.OrderTransaction | io.flow.billing.internal.v0.models.ChannelBilledTransaction | io.flow.billing.internal.v0.models.TaxTransaction | io.flow.billing.internal.v0.models.DutyTransaction | io.flow.billing.internal.v0.models.TrueupTransaction | io.flow.billing.internal.v0.models.CarrierChargeTransaction
|
|
1137
|
+
type Transaction = (io.flow.billing.internal.v0.models.InvoiceTransaction | io.flow.billing.internal.v0.models.ManualTransaction | io.flow.billing.internal.v0.models.ProcessingTransaction | io.flow.billing.internal.v0.models.SubscriptionTransaction | io.flow.billing.internal.v0.models.TaxRemittanceTransaction | io.flow.billing.internal.v0.models.TransferTransaction | io.flow.billing.internal.v0.models.VirtualCardTransaction | io.flow.billing.internal.v0.models.DisputeTransaction | io.flow.billing.internal.v0.models.ChannelTransaction | io.flow.billing.internal.v0.models.LabelTransaction | io.flow.billing.internal.v0.models.OrderTransaction | io.flow.billing.internal.v0.models.ChannelBilledTransaction | io.flow.billing.internal.v0.models.TaxTransaction | io.flow.billing.internal.v0.models.DutyTransaction | io.flow.billing.internal.v0.models.TrueupTransaction | io.flow.billing.internal.v0.models.CarrierChargeTransaction);
|
|
1135
1138
|
}
|
|
@@ -4,7 +4,6 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
|
|
|
4
4
|
readonly 'sequence_number': number;
|
|
5
5
|
readonly 'fulfilled_at': string;
|
|
6
6
|
readonly 'completes_order': boolean;
|
|
7
|
-
readonly 'payment': io.flow.billing.reporting.v0.models.ReportingPayment;
|
|
8
7
|
readonly 'value': io.flow.billing.reporting.v0.models.FulfillmentShopperBreakdown;
|
|
9
8
|
readonly 'dispatch_country'?: io.flow.billing.reporting.v0.models.ReportingCountry;
|
|
10
9
|
readonly 'destination': io.flow.billing.reporting.v0.models.ReportingDestination;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
declare namespace io.flow.billing.reporting.v0.enums {
|
|
2
|
+
type ReportPaymentType = 'credit' | 'debit';
|
|
2
3
|
type ReportStatus = 'created' | 'completed' | 'completed_no_records' | 'failed';
|
|
3
|
-
type ReportType = 'sales_record' | 'trueup_overview' | 'non_channel_payment_bank_account' | 'scheduled_payment' | 'account_quarterly_balances';
|
|
4
|
+
type ReportType = 'sales_record' | 'refund_record' | 'other_record' | 'pending_record' | 'trueup_overview' | 'non_channel_payment_bank_account' | 'scheduled_payment' | 'account_quarterly_balances' | 'invariants' | 'payments';
|
|
4
5
|
type ReportingFulfillmentIsVirtual = 'all' | 'mixed' | 'none';
|
|
5
6
|
type RevenueRecordType = 'pending' | 'sales' | 'refund';
|
|
6
7
|
}
|
|
@@ -13,6 +14,7 @@ declare namespace io.flow.billing.reporting.v0.models {
|
|
|
13
14
|
readonly 'subtotal': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
14
15
|
readonly 'tax': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
15
16
|
readonly 'duty': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
17
|
+
readonly 'tips'?: io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
16
18
|
readonly 'discount': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
17
19
|
readonly 'total': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
18
20
|
}
|
|
@@ -36,8 +38,9 @@ declare namespace io.flow.billing.reporting.v0.models {
|
|
|
36
38
|
readonly 'id': string;
|
|
37
39
|
readonly 'status': io.flow.billing.reporting.v0.enums.ReportStatus;
|
|
38
40
|
readonly 'type': io.flow.billing.reporting.v0.enums.ReportType;
|
|
39
|
-
readonly 'from'
|
|
40
|
-
readonly 'to'
|
|
41
|
+
readonly 'from'?: string;
|
|
42
|
+
readonly 'to'?: string;
|
|
43
|
+
readonly 'payment_type'?: io.flow.billing.reporting.v0.enums.ReportPaymentType;
|
|
41
44
|
readonly 'url'?: string;
|
|
42
45
|
readonly 'processed_at'?: string;
|
|
43
46
|
}
|
|
@@ -60,9 +63,20 @@ declare namespace io.flow.billing.reporting.v0.models {
|
|
|
60
63
|
}
|
|
61
64
|
|
|
62
65
|
interface ReportForm {
|
|
63
|
-
readonly 'from': string;
|
|
64
|
-
readonly 'to': string;
|
|
65
66
|
readonly 'type': io.flow.billing.reporting.v0.enums.ReportType;
|
|
67
|
+
readonly 'from'?: string;
|
|
68
|
+
readonly 'to'?: string;
|
|
69
|
+
readonly 'payment_type'?: io.flow.billing.reporting.v0.enums.ReportPaymentType;
|
|
70
|
+
readonly 'orders'?: io.flow.billing.reporting.v0.models.ReportOrderReference[];
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
interface ReportMerchant {
|
|
74
|
+
readonly 'id': string;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
interface ReportOrderReference {
|
|
78
|
+
readonly 'organization_id': string;
|
|
79
|
+
readonly 'order_number': string;
|
|
66
80
|
}
|
|
67
81
|
|
|
68
82
|
interface ReportOwner {
|
|
@@ -130,11 +144,11 @@ declare namespace io.flow.billing.reporting.v0.models {
|
|
|
130
144
|
readonly 'sequence_number': number;
|
|
131
145
|
readonly 'fulfilled_at': string;
|
|
132
146
|
readonly 'completes_order': boolean;
|
|
133
|
-
readonly 'payment': io.flow.billing.reporting.v0.models.ReportingPayment;
|
|
134
147
|
readonly 'refund'?: io.flow.billing.reporting.v0.models.ReportingRefundReference;
|
|
135
148
|
readonly 'value': io.flow.billing.reporting.v0.models.FulfillmentShopperBreakdown;
|
|
136
149
|
readonly 'dispatch_country'?: io.flow.billing.reporting.v0.models.ReportingCountry;
|
|
137
150
|
readonly 'destination'?: io.flow.billing.reporting.v0.models.ReportingDestination;
|
|
151
|
+
readonly 'payment'?: io.flow.billing.reporting.v0.models.ReportingPayment;
|
|
138
152
|
readonly 'shipment'?: io.flow.billing.reporting.v0.models.ReportingShipment;
|
|
139
153
|
readonly 'is': io.flow.billing.reporting.v0.models.ReportingFulfillmentIs;
|
|
140
154
|
readonly 'has': io.flow.billing.reporting.v0.models.ReportingFulfillmentHas;
|
|
@@ -153,6 +167,9 @@ declare namespace io.flow.billing.reporting.v0.models {
|
|
|
153
167
|
readonly 'wyol': boolean;
|
|
154
168
|
readonly 'b2b': boolean;
|
|
155
169
|
readonly 'domestic': boolean;
|
|
170
|
+
readonly 'combined_shipment'?: boolean;
|
|
171
|
+
readonly 'order_cancelled'?: boolean;
|
|
172
|
+
readonly 'lvg'?: boolean;
|
|
156
173
|
}
|
|
157
174
|
|
|
158
175
|
interface ReportingFx {
|
|
@@ -161,6 +178,7 @@ declare namespace io.flow.billing.reporting.v0.models {
|
|
|
161
178
|
readonly 'product': io.flow.billing.reporting.v0.models.ReportingUsd;
|
|
162
179
|
readonly 'tax': io.flow.billing.reporting.v0.models.ReportingUsd;
|
|
163
180
|
readonly 'duty': io.flow.billing.reporting.v0.models.ReportingUsd;
|
|
181
|
+
readonly 'tips'?: io.flow.billing.reporting.v0.models.ReportingUsd;
|
|
164
182
|
readonly 'total': io.flow.billing.reporting.v0.models.ReportingUsd;
|
|
165
183
|
}
|
|
166
184
|
|
|
@@ -178,6 +196,7 @@ declare namespace io.flow.billing.reporting.v0.models {
|
|
|
178
196
|
readonly 'processing': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
179
197
|
readonly 'rate_lock': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
180
198
|
readonly 'transfer': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
199
|
+
readonly 'total'?: io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
181
200
|
}
|
|
182
201
|
|
|
183
202
|
interface ReportingMerchantSubsidies {
|
|
@@ -185,6 +204,7 @@ declare namespace io.flow.billing.reporting.v0.models {
|
|
|
185
204
|
readonly 'tax': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
186
205
|
readonly 'duty': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
187
206
|
readonly 'ccf': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
207
|
+
readonly 'total'?: io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
188
208
|
}
|
|
189
209
|
|
|
190
210
|
interface ReportingMerchantTransactions {
|
|
@@ -193,7 +213,8 @@ declare namespace io.flow.billing.reporting.v0.models {
|
|
|
193
213
|
readonly 'tax': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
194
214
|
readonly 'duty': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
195
215
|
readonly 'freight': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
196
|
-
readonly '
|
|
216
|
+
readonly 'discount'?: io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
217
|
+
readonly 'total'?: io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
197
218
|
}
|
|
198
219
|
|
|
199
220
|
interface ReportingMonetaryValue {
|
|
@@ -216,25 +237,14 @@ declare namespace io.flow.billing.reporting.v0.models {
|
|
|
216
237
|
}
|
|
217
238
|
|
|
218
239
|
interface ReportingPayment {
|
|
219
|
-
readonly 'metadata'?: io.flow.billing.reporting.v0.models.ReportingPaymentMetadata;
|
|
220
240
|
readonly 'psp': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
221
241
|
readonly 'credit': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
242
|
+
readonly 'subsidized': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
243
|
+
readonly 'manual': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
244
|
+
readonly 'cod': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
222
245
|
readonly 'total': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
223
246
|
}
|
|
224
247
|
|
|
225
|
-
interface ReportingPaymentMetadata {
|
|
226
|
-
readonly 'gateway': io.flow.payment.internal.v0.enums.Processor;
|
|
227
|
-
readonly 'method': string;
|
|
228
|
-
readonly 'psp_reference'?: string;
|
|
229
|
-
readonly 'authorization'?: io.flow.billing.reporting.v0.models.ReportingAuthorizationReference;
|
|
230
|
-
readonly 'settlement_date': string;
|
|
231
|
-
readonly 'additional_authorizations'?: io.flow.billing.reporting.v0.models.ReportingPaymentMetadataAdditionalAuthorizations;
|
|
232
|
-
}
|
|
233
|
-
|
|
234
|
-
interface ReportingPaymentMetadataAdditionalAuthorizations {
|
|
235
|
-
readonly 'ids': string;
|
|
236
|
-
}
|
|
237
|
-
|
|
238
248
|
interface ReportingProvince {
|
|
239
249
|
readonly 'code'?: string;
|
|
240
250
|
readonly 'name': string;
|
|
@@ -263,6 +273,7 @@ declare namespace io.flow.billing.reporting.v0.models {
|
|
|
263
273
|
readonly 'ccf': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
264
274
|
readonly 'emergency': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
265
275
|
readonly 'peak': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
276
|
+
readonly 'total'?: io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
|
|
266
277
|
}
|
|
267
278
|
|
|
268
279
|
interface ReportingUsd {
|
|
@@ -304,6 +315,7 @@ declare namespace io.flow.billing.reporting.v0.models {
|
|
|
304
315
|
readonly 'payment': io.flow.billing.reporting.v0.models.ReportPayment;
|
|
305
316
|
readonly 'bank_account': io.flow.billing.reporting.v0.models.ReportBankAccountCleartext;
|
|
306
317
|
readonly 'account': io.flow.billing.reporting.v0.models.ReportAccount;
|
|
318
|
+
readonly 'merchant': io.flow.billing.reporting.v0.models.ReportMerchant;
|
|
307
319
|
readonly 'owner': io.flow.billing.reporting.v0.models.ReportOwner;
|
|
308
320
|
readonly 'description': string;
|
|
309
321
|
}
|
|
@@ -4,8 +4,8 @@ declare namespace io.flow.billing.v0.enums {
|
|
|
4
4
|
type PayoutStatusFailureCode = 'invalid_account_number' | 'account_closed' | 'could_not_process';
|
|
5
5
|
type PendingPayoutTransactionReasonCode = 'waiting_for_full_refund' | 'waiting_for_fulfillment' | 'waiting_for_in_transit' | 'waiting_for_next_payout_date' | 'waiting_for_tracking_info' | 'waiting_for_positive_account_balance';
|
|
6
6
|
type StatementAttachmentType = 'csv';
|
|
7
|
-
type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | '
|
|
8
|
-
type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
|
|
7
|
+
type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | 'trueup_base' | 'trueup_surcharge' | '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' | 'failed_payout';
|
|
8
|
+
type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl' | 'ups';
|
|
9
9
|
type WithholdingDeductionType = 'tax' | 'duty' | 'freight' | 'insurance';
|
|
10
10
|
}
|
|
11
11
|
|
|
@@ -297,21 +297,11 @@ declare namespace io.flow.billing.v0.models {
|
|
|
297
297
|
readonly 'outbound'?: io.flow.billing.v0.models.TransactionMetadataOutboundTransaction;
|
|
298
298
|
}
|
|
299
299
|
|
|
300
|
-
interface TransactionMetadataCarrierFee {
|
|
301
|
-
readonly 'discriminator': 'carrier_fee';
|
|
302
|
-
readonly 'outbound': io.flow.billing.v0.models.TransactionMetadataOutboundTransaction;
|
|
303
|
-
readonly 'estimate': io.flow.billing.v0.models.TransactionMetadataCarrierFeeData;
|
|
304
|
-
readonly 'actual': io.flow.billing.v0.models.TransactionMetadataCarrierFeeData;
|
|
305
|
-
}
|
|
306
|
-
|
|
307
|
-
interface TransactionMetadataCarrierFeeData {
|
|
308
|
-
readonly 'surcharges': io.flow.billing.v0.models.TrueupLabelSurcharge[];
|
|
309
|
-
}
|
|
310
|
-
|
|
311
300
|
interface TransactionMetadataChannel {
|
|
312
301
|
readonly 'discriminator': 'channel';
|
|
313
302
|
readonly 'method': string;
|
|
314
303
|
readonly 'card'?: io.flow.billing.v0.models.TransactionMetadataChannelCardMetadata;
|
|
304
|
+
readonly 'organization_transaction': io.flow.billing.v0.models.TransactionMetadataChannelOrganizationTransaction;
|
|
315
305
|
}
|
|
316
306
|
|
|
317
307
|
interface TransactionMetadataChannelCardMetadata {
|
|
@@ -324,6 +314,20 @@ declare namespace io.flow.billing.v0.models {
|
|
|
324
314
|
readonly 'country': string;
|
|
325
315
|
}
|
|
326
316
|
|
|
317
|
+
interface TransactionMetadataChannelOrganizationTransaction {
|
|
318
|
+
readonly 'id': string;
|
|
319
|
+
readonly 'metadata': io.flow.billing.v0.models.TransactionMetadataPaymentTransaction;
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
interface TransactionMetadataFailedPayout {
|
|
323
|
+
readonly 'discriminator': 'failed_payout';
|
|
324
|
+
readonly 'failed_payout': io.flow.billing.v0.models.TransactionMetadataFailedPayoutReference;
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
interface TransactionMetadataFailedPayoutReference {
|
|
328
|
+
readonly 'id': string;
|
|
329
|
+
}
|
|
330
|
+
|
|
327
331
|
interface TransactionMetadataManual {
|
|
328
332
|
readonly 'discriminator': 'manual';
|
|
329
333
|
readonly 'description': string;
|
|
@@ -341,6 +345,7 @@ declare namespace io.flow.billing.v0.models {
|
|
|
341
345
|
|
|
342
346
|
interface TransactionMetadataPaymentTransaction {
|
|
343
347
|
readonly 'discriminator': 'payment_transaction';
|
|
348
|
+
readonly 'id'?: string;
|
|
344
349
|
readonly 'key'?: string;
|
|
345
350
|
}
|
|
346
351
|
|
|
@@ -363,6 +368,22 @@ declare namespace io.flow.billing.v0.models {
|
|
|
363
368
|
readonly 'actual': io.flow.billing.v0.models.TransactionMetadataTrueupData;
|
|
364
369
|
}
|
|
365
370
|
|
|
371
|
+
interface TransactionMetadataTrueupBase {
|
|
372
|
+
readonly 'discriminator': 'trueup_base';
|
|
373
|
+
readonly 'original': io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
|
|
374
|
+
readonly 'estimate': io.flow.billing.v0.models.TransactionMetadataTrueupBaseData;
|
|
375
|
+
readonly 'actual': io.flow.billing.v0.models.TransactionMetadataTrueupBaseData;
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
interface TransactionMetadataTrueupBaseData {
|
|
379
|
+
readonly 'source': io.flow.billing.v0.enums.TrueupSource;
|
|
380
|
+
readonly 'weights': io.flow.billing.v0.models.TrueupLabelWeights;
|
|
381
|
+
readonly 'units': io.flow.billing.v0.models.TrueupLabelUnits;
|
|
382
|
+
readonly 'base': io.flow.billing.v0.models.TrueupLabelBaseV2;
|
|
383
|
+
readonly 'fuel'?: io.flow.billing.v0.models.TrueupLabelFuel;
|
|
384
|
+
readonly 'total': number;
|
|
385
|
+
}
|
|
386
|
+
|
|
366
387
|
interface TransactionMetadataTrueupData {
|
|
367
388
|
readonly 'source': io.flow.billing.v0.enums.TrueupSource;
|
|
368
389
|
readonly 'units': io.flow.billing.v0.models.TrueupLabelUnits;
|
|
@@ -373,6 +394,18 @@ declare namespace io.flow.billing.v0.models {
|
|
|
373
394
|
readonly 'dimensional'?: io.flow.trueup.v0.models.DimensionalWeight;
|
|
374
395
|
}
|
|
375
396
|
|
|
397
|
+
interface TransactionMetadataTrueupSurcharge {
|
|
398
|
+
readonly 'discriminator': 'trueup_surcharge';
|
|
399
|
+
readonly 'original': io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
|
|
400
|
+
readonly 'estimate': io.flow.billing.v0.models.TransactionMetadataTrueupSurchargeData;
|
|
401
|
+
readonly 'actual': io.flow.billing.v0.models.TransactionMetadataTrueupSurchargeData;
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
interface TransactionMetadataTrueupSurchargeData {
|
|
405
|
+
readonly 'source': io.flow.billing.v0.enums.TrueupSource;
|
|
406
|
+
readonly 'surcharge': io.flow.billing.v0.models.TrueupLabelSurcharge;
|
|
407
|
+
}
|
|
408
|
+
|
|
376
409
|
interface TransactionReference {
|
|
377
410
|
readonly 'id': string;
|
|
378
411
|
}
|
|
@@ -382,6 +415,20 @@ declare namespace io.flow.billing.v0.models {
|
|
|
382
415
|
readonly 'weight': number;
|
|
383
416
|
}
|
|
384
417
|
|
|
418
|
+
interface TrueupLabelBaseV2 {
|
|
419
|
+
readonly 'amount': number;
|
|
420
|
+
}
|
|
421
|
+
|
|
422
|
+
interface TrueupLabelBaseWeight {
|
|
423
|
+
readonly 'weight': number;
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
interface TrueupLabelFuel {
|
|
427
|
+
readonly 'amount': number;
|
|
428
|
+
readonly 'percentage'?: number;
|
|
429
|
+
readonly 'per_weight_unit'?: number;
|
|
430
|
+
}
|
|
431
|
+
|
|
385
432
|
interface TrueupLabelSurcharge {
|
|
386
433
|
readonly 'amount': number;
|
|
387
434
|
readonly 'type': io.flow.trueup.v0.enums.TrueupSurchargeType;
|
|
@@ -394,6 +441,12 @@ declare namespace io.flow.billing.v0.models {
|
|
|
394
441
|
readonly 'length'?: io.flow.units.v0.enums.UnitOfLength;
|
|
395
442
|
}
|
|
396
443
|
|
|
444
|
+
interface TrueupLabelWeights {
|
|
445
|
+
readonly 'base': io.flow.billing.v0.models.TrueupLabelBaseWeight;
|
|
446
|
+
readonly 'dead'?: io.flow.trueup.v0.models.DeadWeight;
|
|
447
|
+
readonly 'dimensional'?: io.flow.trueup.v0.models.DimensionalWeight;
|
|
448
|
+
}
|
|
449
|
+
|
|
397
450
|
interface WithholdingDeduction {
|
|
398
451
|
readonly 'type': io.flow.billing.v0.enums.WithholdingDeductionType;
|
|
399
452
|
readonly 'amount': number;
|
|
@@ -405,5 +458,5 @@ declare namespace io.flow.billing.v0.unions {
|
|
|
405
458
|
type BankAccountForm = (io.flow.billing.v0.models.BankAccountFormInfo | io.flow.billing.v0.models.BankAccountFormSimple);
|
|
406
459
|
type PayoutStatus = (io.flow.billing.v0.models.PayoutStatusScheduled | io.flow.billing.v0.models.PayoutStatusSent | io.flow.billing.v0.models.PayoutStatusFailed);
|
|
407
460
|
type Settlement = (io.flow.billing.v0.models.SettlementNoPayout | io.flow.billing.v0.models.SettlementPayout);
|
|
408
|
-
type TransactionMetadata = (io.flow.billing.v0.models.TransactionMetadataShippingLabel | io.flow.billing.v0.models.TransactionMetadataChannel | io.flow.billing.v0.models.TransactionMetadataTrueup | io.flow.billing.v0.models.
|
|
461
|
+
type TransactionMetadata = (io.flow.billing.v0.models.TransactionMetadataShippingLabel | io.flow.billing.v0.models.TransactionMetadataChannel | io.flow.billing.v0.models.TransactionMetadataTrueup | io.flow.billing.v0.models.TransactionMetadataTrueupBase | io.flow.billing.v0.models.TransactionMetadataTrueupSurcharge | io.flow.billing.v0.models.TransactionMetadataCarrierCharge | io.flow.billing.v0.models.TransactionMetadataManual | io.flow.billing.v0.models.TransactionMetadataFailedPayout | io.flow.billing.v0.models.TransactionMetadataPaymentTransaction);
|
|
409
462
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
declare namespace io.flow.channel.internal.v0.enums {
|
|
2
2
|
type ChannelOrderAcceptanceErrorAction = 'auto_reject' | 'auto_accept';
|
|
3
3
|
type ChannelOrderAcceptanceNextActionFrom = 'cx_team' | 'core_team' | 'core_team_investigate' | 'mex_team' | 'payments_team' | 'tc_team' | 'logistics_team';
|
|
4
|
-
type ChannelOrderAcceptanceRejectionReason = 'unsupported_origin_country' | 'unsupported_destination_country' | 'domestic_order' | 'order_contains_gift_card' | 'order_contains_restricted_goods' | 'missing_order_information' | 'unsupported_payment_information' | 'unsupported_shop_currency' | 'unsupported_free_order' | 'extracting_distribution_info_failed' | 'shipping_estimation_failed' | 'payment_authorization_failed' | 'unsupported_subsidized_order' | 'unsupported_virtual_goods' | 'non_matching_currencies' | 'unsupported_order_edit';
|
|
4
|
+
type ChannelOrderAcceptanceRejectionReason = 'unsupported_origin_country' | 'unsupported_destination_country' | 'domestic_order' | 'order_contains_gift_card' | 'order_contains_restricted_goods' | 'missing_order_information' | 'unsupported_payment_information' | 'unsupported_shop_currency' | 'unsupported_free_order' | 'extracting_distribution_info_failed' | 'shipping_estimation_failed' | 'payment_authorization_failed' | 'unsupported_subsidized_order' | 'unsupported_virtual_goods' | 'non_matching_currencies' | 'unsupported_order_edit' | 'order_missing';
|
|
5
5
|
type ChannelOrderAcceptanceStatus = 'accepted' | 'rejected' | 'review' | 'edit_review' | 'edit_accepted';
|
|
6
6
|
}
|
|
7
7
|
|