@flowio/api-types 0.0.220 → 0.0.222
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 +17 -1
- package/generated/io.flow.billing.csv.v0.billing-csv.d.ts +4 -0
- package/generated/io.flow.billing.internal.v0.billing-internal.d.ts +24 -17
- package/generated/io.flow.billing.reporting.v0.billing-reporting.d.ts +1 -1
- package/generated/io.flow.channel.internal.v0.channel-internal.d.ts +1 -0
- package/generated/io.flow.internal.v0.api-internal.d.ts +256 -65
- package/generated/io.flow.label.v0.label.d.ts +1 -1
- package/generated/io.flow.organization.onboarding.state.v0.organization-onboarding-state.d.ts +8 -2
- package/generated/io.flow.permission.v0.permission.d.ts +1 -1
- package/generated/io.flow.ratecard.v0.ratecard.d.ts +75 -2
- package/generated/io.flow.stripe.v0.stripe.d.ts +54 -3
- package/generated/io.flow.trueup.v0.trueup.d.ts +1 -1
- package/generated/io.flow.v0.api.d.ts +86 -7
- package/package.json +2 -2
|
@@ -88,6 +88,7 @@ declare namespace io.flow.billing.accounting.v0.models {
|
|
|
88
88
|
readonly 'number': string;
|
|
89
89
|
readonly 'fulfillment_method': io.flow.catalog.v0.enums.FulfillmentMethodValue;
|
|
90
90
|
readonly 'country_of_origin'?: string;
|
|
91
|
+
readonly 'tarriff_code'?: string;
|
|
91
92
|
readonly 'inferred'?: boolean;
|
|
92
93
|
}
|
|
93
94
|
|
|
@@ -125,6 +126,11 @@ declare namespace io.flow.billing.accounting.v0.models {
|
|
|
125
126
|
readonly 'total': number;
|
|
126
127
|
}
|
|
127
128
|
|
|
129
|
+
interface OrderReference {
|
|
130
|
+
readonly 'organization': io.flow.common.v0.models.OrganizationReference;
|
|
131
|
+
readonly 'number': string;
|
|
132
|
+
}
|
|
133
|
+
|
|
128
134
|
interface OrderSummary {
|
|
129
135
|
readonly 'id': string;
|
|
130
136
|
readonly 'organization': io.flow.common.v0.models.OrganizationReference;
|
|
@@ -135,6 +141,16 @@ declare namespace io.flow.billing.accounting.v0.models {
|
|
|
135
141
|
readonly 'currency': string;
|
|
136
142
|
}
|
|
137
143
|
|
|
144
|
+
interface PendingOrder {
|
|
145
|
+
readonly 'id': string;
|
|
146
|
+
readonly 'order': io.flow.billing.accounting.v0.models.OrderSummary;
|
|
147
|
+
readonly 'shopper': io.flow.billing.accounting.v0.models.ShopperSummary;
|
|
148
|
+
readonly 'merchant': io.flow.billing.accounting.v0.models.MerchantSummary;
|
|
149
|
+
readonly 'remittance': io.flow.billing.accounting.v0.models.RemittanceResponsibility;
|
|
150
|
+
readonly 'sequence_number': number;
|
|
151
|
+
readonly 'posting_cutoff': string;
|
|
152
|
+
}
|
|
153
|
+
|
|
138
154
|
interface RemittanceResponsibility {
|
|
139
155
|
readonly 'tax': io.flow.billing.internal.v0.enums.ResponsibleParty;
|
|
140
156
|
readonly 'duty': io.flow.billing.internal.v0.enums.ResponsibleParty;
|
|
@@ -144,8 +160,8 @@ declare namespace io.flow.billing.accounting.v0.models {
|
|
|
144
160
|
readonly 'id': string;
|
|
145
161
|
readonly 'order': io.flow.billing.accounting.v0.models.OrderSummary;
|
|
146
162
|
readonly 'shopper': io.flow.billing.accounting.v0.models.ShopperSummary;
|
|
147
|
-
readonly 'remittance': io.flow.billing.accounting.v0.models.RemittanceResponsibility;
|
|
148
163
|
readonly 'merchant': io.flow.billing.accounting.v0.models.MerchantSummary;
|
|
164
|
+
readonly 'remittance': io.flow.billing.accounting.v0.models.RemittanceResponsibility;
|
|
149
165
|
readonly 'sequence_number': number;
|
|
150
166
|
readonly 'posting_cutoff': string;
|
|
151
167
|
readonly 'trigger': io.flow.billing.accounting.v0.unions.ReturnTrigger;
|
|
@@ -273,6 +273,8 @@ declare namespace io.flow.billing.csv.v0.models {
|
|
|
273
273
|
readonly 'fx_fee_description'?: string;
|
|
274
274
|
readonly 'duty_guarantee_fee'?: number;
|
|
275
275
|
readonly 'duty_guarantee_fee_description'?: string;
|
|
276
|
+
readonly 'negative_balance_fee'?: number;
|
|
277
|
+
readonly 'negative_balance_fee_description'?: string;
|
|
276
278
|
}
|
|
277
279
|
|
|
278
280
|
interface BillingCsvProcessingTransactionDelivery {
|
|
@@ -348,6 +350,7 @@ declare namespace io.flow.billing.csv.v0.models {
|
|
|
348
350
|
readonly 'processing': number;
|
|
349
351
|
readonly 'rate_lock': number;
|
|
350
352
|
readonly 'transfer': number;
|
|
353
|
+
readonly 'negative_balance': number;
|
|
351
354
|
}
|
|
352
355
|
|
|
353
356
|
interface BillingCsvTransactionIdentifiers {
|
|
@@ -368,6 +371,7 @@ declare namespace io.flow.billing.csv.v0.models {
|
|
|
368
371
|
readonly 'label_created_at': string;
|
|
369
372
|
readonly 'carrier_id': string;
|
|
370
373
|
readonly 'carrier_tracking_number': string;
|
|
374
|
+
readonly 'revenue_share_percentage': number;
|
|
371
375
|
readonly 'outbound_transaction_id'?: string;
|
|
372
376
|
}
|
|
373
377
|
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
declare namespace io.flow.billing.internal.v0.enums {
|
|
2
|
+
type AccountPaymentHoldReason = 'fraudulent' | 'invalid_bank_account';
|
|
2
3
|
type AccountSettingLiabilitiesMethod = 'withholding' | 'transaction';
|
|
3
4
|
type AccountType = 'channel' | 'organization';
|
|
4
5
|
type AdjustmentTransactionType = 'adjustment' | 'reversal';
|
|
@@ -6,10 +7,9 @@ declare namespace io.flow.billing.internal.v0.enums {
|
|
|
6
7
|
type BankPaymentStatusCode = 'scheduled' | 'sent' | 'failed';
|
|
7
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';
|
|
8
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';
|
|
9
|
-
type BillingStatementBatchFileKey = 'summary';
|
|
10
10
|
type BillingTransactionStatus = 'pending' | 'pending_proof' | 'posted';
|
|
11
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
|
-
type CarrierChargeTransactionType = 'adjustment' | 'reversal' | 'charge';
|
|
12
|
+
type CarrierChargeTransactionType = 'adjustment' | 'reversal' | 'charge' | 'revenue_share';
|
|
13
13
|
type ChannelBilledTransactionType = 'adjustment' | 'reversal' | 'channel_initiated';
|
|
14
14
|
type ChannelTransactionType = 'adjustment' | 'reversal' | 'processing';
|
|
15
15
|
type DisputeTransactionType = 'adjustment' | 'dispute';
|
|
@@ -62,6 +62,17 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
62
62
|
readonly 'country': string;
|
|
63
63
|
}
|
|
64
64
|
|
|
65
|
+
interface AccountPaymentHold {
|
|
66
|
+
readonly 'id': string;
|
|
67
|
+
readonly 'account': io.flow.billing.internal.v0.models.SimpleAccountReference;
|
|
68
|
+
readonly 'reason': io.flow.billing.internal.v0.enums.AccountPaymentHoldReason;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
interface AccountPaymentHoldForm {
|
|
72
|
+
readonly 'account_id': string;
|
|
73
|
+
readonly 'reason': io.flow.billing.internal.v0.enums.AccountPaymentHoldReason;
|
|
74
|
+
}
|
|
75
|
+
|
|
65
76
|
interface AccountProcessingRateForm {
|
|
66
77
|
readonly 'query': string;
|
|
67
78
|
readonly 'capture': number;
|
|
@@ -100,7 +111,7 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
100
111
|
readonly 'merchant_of_record_fee'?: number;
|
|
101
112
|
readonly 'duty_guarantee_fee'?: number;
|
|
102
113
|
readonly 'transfer_fee'?: number;
|
|
103
|
-
readonly '
|
|
114
|
+
readonly 'negative_balance_fee'?: number;
|
|
104
115
|
readonly 'order_service_fee'?: io.flow.billing.internal.v0.models.TieredFee;
|
|
105
116
|
readonly 'label_fees'?: io.flow.billing.internal.v0.models.AccountSettingLabelFees;
|
|
106
117
|
readonly 'charge_label_cost_directly': boolean;
|
|
@@ -285,6 +296,7 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
285
296
|
readonly 'b2b_tax_remittance_days'?: number;
|
|
286
297
|
readonly 'mor_fee'?: number;
|
|
287
298
|
readonly 'duty_guarantee_fee'?: number;
|
|
299
|
+
readonly 'negative_balance_fee'?: number;
|
|
288
300
|
readonly 'order_service_fee'?: io.flow.billing.internal.v0.models.TieredFee;
|
|
289
301
|
readonly 'label_fee'?: io.flow.billing.internal.v0.models.TieredFee;
|
|
290
302
|
}
|
|
@@ -295,20 +307,6 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
295
307
|
readonly 'url': string;
|
|
296
308
|
}
|
|
297
309
|
|
|
298
|
-
interface BillingStatementBatch {
|
|
299
|
-
readonly 'id': string;
|
|
300
|
-
}
|
|
301
|
-
|
|
302
|
-
interface BillingStatementBatchReference {
|
|
303
|
-
readonly 'id': string;
|
|
304
|
-
}
|
|
305
|
-
|
|
306
|
-
interface BillingStatementBatchStatement {
|
|
307
|
-
readonly 'id': string;
|
|
308
|
-
readonly 'batch': io.flow.billing.internal.v0.models.BillingStatementBatchReference;
|
|
309
|
-
readonly 'statement': io.flow.billing.internal.v0.models.BillingStatementReference;
|
|
310
|
-
}
|
|
311
|
-
|
|
312
310
|
interface BillingStatementReference {
|
|
313
311
|
readonly 'id': string;
|
|
314
312
|
}
|
|
@@ -572,6 +570,7 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
572
570
|
readonly 'fx'?: io.flow.billing.internal.v0.models.Fee;
|
|
573
571
|
readonly 'duty_guarantee'?: io.flow.billing.internal.v0.models.Fee;
|
|
574
572
|
readonly 'transfer'?: io.flow.billing.internal.v0.models.Fee;
|
|
573
|
+
readonly 'negative_balance'?: io.flow.billing.internal.v0.models.Fee;
|
|
575
574
|
}
|
|
576
575
|
|
|
577
576
|
interface FinanceBankAccount {
|
|
@@ -612,6 +611,14 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
612
611
|
readonly 'created_at': string;
|
|
613
612
|
}
|
|
614
613
|
|
|
614
|
+
interface FlowBillingStatement {
|
|
615
|
+
readonly 'id': string;
|
|
616
|
+
readonly 'account': io.flow.billing.v0.models.AccountReference;
|
|
617
|
+
readonly 'period': io.flow.common.v0.models.DatetimeRange;
|
|
618
|
+
readonly 'totals': io.flow.billing.internal.v0.models.BillingStatementTotals;
|
|
619
|
+
readonly 'attachments': io.flow.billing.internal.v0.models.BillingStatementAttachment[];
|
|
620
|
+
}
|
|
621
|
+
|
|
615
622
|
interface FxFee {
|
|
616
623
|
readonly 'base': io.flow.common.v0.models.Money;
|
|
617
624
|
readonly 'local': io.flow.common.v0.models.Money;
|
|
@@ -2,7 +2,7 @@ declare namespace io.flow.billing.reporting.v0.enums {
|
|
|
2
2
|
type ReportStatus = 'created' | 'completed' | 'completed_no_records' | 'failed';
|
|
3
3
|
type ReportType = 'sales_record' | 'trueup_overview' | 'non_channel_payment_bank_account' | 'scheduled_payment';
|
|
4
4
|
type ReportingFulfillmentIsVirtual = 'all' | 'mixed' | 'none';
|
|
5
|
-
type RevenueRecordType = 'sales' | 'refund';
|
|
5
|
+
type RevenueRecordType = 'pending' | 'sales' | 'refund';
|
|
6
6
|
}
|
|
7
7
|
|
|
8
8
|
declare namespace io.flow.billing.reporting.v0.models {
|
|
@@ -42,6 +42,7 @@ declare namespace io.flow.channel.internal.v0.models {
|
|
|
42
42
|
readonly 'channel_id': string;
|
|
43
43
|
readonly 'external_order_reference': string;
|
|
44
44
|
readonly 'payment_request_id'?: string;
|
|
45
|
+
readonly 'order_edit_payment_request_ids'?: string[];
|
|
45
46
|
readonly 'status': io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceStatus;
|
|
46
47
|
readonly 'reasons': io.flow.channel.internal.v0.models.ChannelOrderAcceptanceReason[];
|
|
47
48
|
readonly 'next_action_from'?: io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceNextActionFrom;
|