@flowio/api-types 0.0.210 → 0.0.212

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.
@@ -0,0 +1,289 @@
1
+ declare namespace io.flow.billing.reporting.v0.enums {
2
+ type ReportStatus = 'created' | 'completed' | 'completed_no_records' | 'failed';
3
+ type ReportType = 'sales_record' | 'trueup_overview' | 'non_channel_payment_bank_account';
4
+ type ReportingFulfillmentIsVirtual = 'all' | 'mixed' | 'none';
5
+ type RevenueRecordType = 'sales' | 'refund';
6
+ }
7
+
8
+ declare namespace io.flow.billing.reporting.v0.models {
9
+ interface FulfillmentShopperBreakdown {
10
+ readonly 'shipping': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
11
+ readonly 'fees': io.flow.billing.reporting.v0.models.ReportingShopperFees;
12
+ readonly 'product': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
13
+ readonly 'subtotal': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
14
+ readonly 'tax': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
15
+ readonly 'duty': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
16
+ readonly 'discount': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
17
+ readonly 'total': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
18
+ }
19
+
20
+ interface MarkedAsFinal {
21
+ readonly 'products': boolean;
22
+ readonly 'shipping': boolean;
23
+ }
24
+
25
+ interface NonChannelPaymentBankAccount {
26
+ readonly 'payment': io.flow.billing.reporting.v0.models.ReportPayment;
27
+ readonly 'bank_account': io.flow.billing.reporting.v0.models.ReportBankAccount;
28
+ readonly 'account': io.flow.billing.reporting.v0.models.ReportAccount;
29
+ }
30
+
31
+ interface RecordReference {
32
+ readonly 'id': string;
33
+ }
34
+
35
+ interface Report {
36
+ readonly 'id': string;
37
+ readonly 'status': io.flow.billing.reporting.v0.enums.ReportStatus;
38
+ readonly 'type': io.flow.billing.reporting.v0.enums.ReportType;
39
+ readonly 'from': string;
40
+ readonly 'to': string;
41
+ readonly 'url'?: string;
42
+ readonly 'processed_at'?: string;
43
+ }
44
+
45
+ interface ReportAccount {
46
+ readonly 'id': string;
47
+ readonly 'source': io.flow.billing.internal.v0.models.AccountSource;
48
+ }
49
+
50
+ interface ReportBankAccount {
51
+ readonly 'id'?: string;
52
+ readonly 'last4'?: string;
53
+ }
54
+
55
+ interface ReportForm {
56
+ readonly 'from': string;
57
+ readonly 'to': string;
58
+ readonly 'type': io.flow.billing.reporting.v0.enums.ReportType;
59
+ }
60
+
61
+ interface ReportPayment {
62
+ readonly 'id': string;
63
+ readonly 'created_at': string;
64
+ }
65
+
66
+ interface ReportingAuthorizationReference {
67
+ readonly 'id': string;
68
+ }
69
+
70
+ interface ReportingBusiness {
71
+ readonly 'vat_registration_number': string;
72
+ readonly 'name'?: string;
73
+ }
74
+
75
+ interface ReportingConversionRates {
76
+ readonly 'merchant': number;
77
+ readonly 'entity': number;
78
+ readonly 'usd': number;
79
+ readonly 'eur': number;
80
+ }
81
+
82
+ interface ReportingCountry {
83
+ readonly 'code': string;
84
+ readonly 'is_eu': boolean;
85
+ }
86
+
87
+ interface ReportingCurrencies {
88
+ readonly 'transaction': string;
89
+ readonly 'merchant': string;
90
+ readonly 'entity': string;
91
+ }
92
+
93
+ interface ReportingDebug {
94
+ readonly 'console_order_link': string;
95
+ readonly 'allocation_order_totals_delta'?: number;
96
+ readonly 'allocation_order_item_discount_delta'?: number;
97
+ readonly 'missing_item_subsidies'?: io.flow.billing.reporting.v0.models.ReportingDebugMissingSubsidies;
98
+ readonly 'missing_shipping_subsidies'?: io.flow.billing.reporting.v0.models.ReportingDebugMissingSubsidies;
99
+ }
100
+
101
+ interface ReportingDebugMissingSubsidies {
102
+ readonly 'price'?: boolean;
103
+ readonly 'tax'?: boolean;
104
+ readonly 'duty'?: boolean;
105
+ }
106
+
107
+ interface ReportingDestination {
108
+ readonly 'country': io.flow.billing.reporting.v0.models.ReportingCountry;
109
+ readonly 'province'?: io.flow.billing.reporting.v0.models.ReportingProvince;
110
+ }
111
+
112
+ interface ReportingEntity {
113
+ readonly 'id': string;
114
+ }
115
+
116
+ interface ReportingFulfillment {
117
+ readonly 'id': string;
118
+ readonly 'sequence_number': number;
119
+ readonly 'fulfilled_at': string;
120
+ readonly 'completes_order': boolean;
121
+ readonly 'payment': io.flow.billing.reporting.v0.models.ReportingPayment;
122
+ readonly 'refund'?: io.flow.billing.reporting.v0.models.ReportingRefundReference;
123
+ readonly 'value': io.flow.billing.reporting.v0.models.FulfillmentShopperBreakdown;
124
+ readonly 'dispatch_country'?: io.flow.billing.reporting.v0.models.ReportingCountry;
125
+ readonly 'destination'?: io.flow.billing.reporting.v0.models.ReportingDestination;
126
+ readonly 'shipment'?: io.flow.billing.reporting.v0.models.ReportingShipment;
127
+ readonly 'is': io.flow.billing.reporting.v0.models.ReportingFulfillmentIs;
128
+ readonly 'has': io.flow.billing.reporting.v0.models.ReportingFulfillmentHas;
129
+ readonly 'fx': io.flow.billing.reporting.v0.models.ReportingFx;
130
+ readonly 'business'?: io.flow.billing.reporting.v0.models.ReportingBusiness;
131
+ }
132
+
133
+ interface ReportingFulfillmentHas {
134
+ readonly 'zero_vat_product': boolean;
135
+ }
136
+
137
+ interface ReportingFulfillmentIs {
138
+ readonly 'replacement': boolean;
139
+ readonly 'virtual': io.flow.billing.reporting.v0.enums.ReportingFulfillmentIsVirtual;
140
+ readonly 'duties_guaranteed': boolean;
141
+ readonly 'wyol': boolean;
142
+ readonly 'b2b': boolean;
143
+ readonly 'domestic': boolean;
144
+ }
145
+
146
+ interface ReportingFx {
147
+ readonly 'shipping': io.flow.billing.reporting.v0.models.ReportingUsd;
148
+ readonly 'fees': io.flow.billing.reporting.v0.models.ReportingUsd;
149
+ readonly 'product': io.flow.billing.reporting.v0.models.ReportingUsd;
150
+ readonly 'tax': io.flow.billing.reporting.v0.models.ReportingUsd;
151
+ readonly 'duty': io.flow.billing.reporting.v0.models.ReportingUsd;
152
+ readonly 'total': io.flow.billing.reporting.v0.models.ReportingUsd;
153
+ }
154
+
155
+ interface ReportingMerchantBreakdown {
156
+ readonly 'subsidies': io.flow.billing.reporting.v0.models.ReportingMerchantSubsidies;
157
+ readonly 'fees': io.flow.billing.reporting.v0.models.ReportingMerchantFees;
158
+ readonly 'transactions': io.flow.billing.reporting.v0.models.ReportingMerchantTransactions;
159
+ }
160
+
161
+ interface ReportingMerchantFees {
162
+ readonly 'duty_guarantee': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
163
+ readonly 'mor': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
164
+ readonly 'fraud': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
165
+ readonly 'fx': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
166
+ readonly 'processing': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
167
+ readonly 'rate_lock': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
168
+ readonly 'transfer': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
169
+ }
170
+
171
+ interface ReportingMerchantSubsidies {
172
+ readonly 'shipping': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
173
+ readonly 'tax': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
174
+ readonly 'duty': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
175
+ readonly 'ccf': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
176
+ }
177
+
178
+ interface ReportingMerchantTransactions {
179
+ readonly 'adjustment': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
180
+ readonly 'reversal': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
181
+ readonly 'tax': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
182
+ readonly 'duty': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
183
+ readonly 'freight': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
184
+ readonly 'refund': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
185
+ }
186
+
187
+ interface ReportingMonetaryValue {
188
+ readonly 'transaction': number;
189
+ readonly 'merchant': number;
190
+ readonly 'entity': number;
191
+ readonly 'usd': number;
192
+ readonly 'eur': number;
193
+ }
194
+
195
+ interface ReportingOrderSummary {
196
+ readonly 'id': string;
197
+ readonly 'number': string;
198
+ readonly 'submitted_at': string;
199
+ }
200
+
201
+ interface ReportingOrganizationSummary {
202
+ readonly 'id': string;
203
+ readonly 'name': string;
204
+ }
205
+
206
+ interface ReportingPayment {
207
+ readonly 'metadata'?: io.flow.billing.reporting.v0.models.ReportingPaymentMetadata;
208
+ readonly 'psp': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
209
+ readonly 'credit': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
210
+ readonly 'total': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
211
+ }
212
+
213
+ interface ReportingPaymentMetadata {
214
+ readonly 'gateway': io.flow.payment.internal.v0.enums.Processor;
215
+ readonly 'method': string;
216
+ readonly 'psp_reference'?: string;
217
+ readonly 'authorization'?: io.flow.billing.reporting.v0.models.ReportingAuthorizationReference;
218
+ readonly 'settlement_date': string;
219
+ readonly 'additional_authorizations'?: io.flow.billing.reporting.v0.models.ReportingPaymentMetadataAdditionalAuthorizations;
220
+ }
221
+
222
+ interface ReportingPaymentMetadataAdditionalAuthorizations {
223
+ readonly 'ids': string;
224
+ }
225
+
226
+ interface ReportingProvince {
227
+ readonly 'code'?: string;
228
+ readonly 'name': string;
229
+ }
230
+
231
+ interface ReportingReconciliation {
232
+ readonly 'date': string;
233
+ readonly 'month': number;
234
+ readonly 'year': number;
235
+ }
236
+
237
+ interface ReportingRefundReference {
238
+ readonly 'id': string;
239
+ }
240
+
241
+ interface ReportingShipment {
242
+ readonly 'carrier': string;
243
+ readonly 'tracking_number'?: string;
244
+ }
245
+
246
+ interface ReportingShopperFees {
247
+ readonly 'fuel': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
248
+ readonly 'remote_area': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
249
+ readonly 'oversize': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
250
+ readonly 'ccf': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
251
+ readonly 'emergency': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
252
+ readonly 'peak': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
253
+ }
254
+
255
+ interface ReportingUsd {
256
+ readonly 'usd': number;
257
+ }
258
+
259
+ interface ReportingVatRemittance {
260
+ readonly 'currency': string;
261
+ readonly 'rate': io.flow.billing.reporting.v0.models.ReportingVatRemittanceRate;
262
+ }
263
+
264
+ interface ReportingVatRemittanceRate {
265
+ readonly 'entity': number;
266
+ }
267
+
268
+ interface ReportingVendor {
269
+ readonly 'id': string;
270
+ }
271
+
272
+ interface RevenueRecord {
273
+ readonly 'id': string;
274
+ readonly 'organization': io.flow.billing.reporting.v0.models.ReportingOrganizationSummary;
275
+ readonly 'parent'?: io.flow.billing.reporting.v0.models.RecordReference;
276
+ readonly 'type': io.flow.billing.reporting.v0.enums.RevenueRecordType;
277
+ readonly 'order': io.flow.billing.reporting.v0.models.ReportingOrderSummary;
278
+ readonly 'entity': io.flow.billing.reporting.v0.models.ReportingEntity;
279
+ readonly 'vendor': io.flow.billing.reporting.v0.models.ReportingVendor;
280
+ readonly 'currencies': io.flow.billing.reporting.v0.models.ReportingCurrencies;
281
+ readonly 'conversion_rate': io.flow.billing.reporting.v0.models.ReportingConversionRates;
282
+ readonly 'reconciliation': io.flow.billing.reporting.v0.models.ReportingReconciliation;
283
+ readonly 'merchant': io.flow.billing.reporting.v0.models.ReportingMerchantBreakdown;
284
+ readonly 'fulfillment': io.flow.billing.reporting.v0.models.ReportingFulfillment;
285
+ readonly 'vat_remittance': io.flow.billing.reporting.v0.models.ReportingVatRemittance;
286
+ readonly 'marked_as_final': io.flow.billing.reporting.v0.models.MarkedAsFinal;
287
+ readonly 'debug': io.flow.billing.reporting.v0.models.ReportingDebug;
288
+ }
289
+ }
@@ -4,7 +4,7 @@ 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' | 'trueup' | 'shipping_label_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
7
+ type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'trueup' | 'carrier_charge' | 'shipping_label_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
8
8
  type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
9
9
  type WithholdingDeductionType = 'tax' | 'duty' | 'freight' | 'insurance';
10
10
  }
@@ -260,6 +260,13 @@ declare namespace io.flow.billing.v0.models {
260
260
  readonly 'updated_at': string;
261
261
  }
262
262
 
263
+ interface TransactionMetadataCarrierCharge {
264
+ readonly 'discriminator': 'carrier_charge';
265
+ readonly 'reason': io.flow.trueup.v0.enums.CarrierChargeReason;
266
+ readonly 'carrier_id': string;
267
+ readonly 'carrier_tracking_number': string;
268
+ }
269
+
263
270
  interface TransactionMetadataChannel {
264
271
  readonly 'discriminator': 'channel';
265
272
  readonly 'method': string;
@@ -347,5 +354,5 @@ declare namespace io.flow.billing.v0.unions {
347
354
  type BankAccountForm = (io.flow.billing.v0.models.BankAccountFormInfo | io.flow.billing.v0.models.BankAccountFormSimple);
348
355
  type PayoutStatus = (io.flow.billing.v0.models.PayoutStatusScheduled | io.flow.billing.v0.models.PayoutStatusSent | io.flow.billing.v0.models.PayoutStatusFailed);
349
356
  type Settlement = (io.flow.billing.v0.models.SettlementNoPayout | io.flow.billing.v0.models.SettlementPayout);
350
- 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.TransactionMetadataManual);
357
+ 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.TransactionMetadataCarrierCharge | io.flow.billing.v0.models.TransactionMetadataManual);
351
358
  }
@@ -49,6 +49,11 @@ declare namespace io.flow.channel.internal.v0.models {
49
49
  readonly 'order_updated_at'?: string;
50
50
  }
51
51
 
52
+ interface ChannelOrderAcceptanceDetails {
53
+ readonly 'order_acceptance': io.flow.channel.internal.v0.models.ChannelOrderAcceptance;
54
+ readonly 'external_order': any/*object*/;
55
+ }
56
+
52
57
  interface ChannelOrderAcceptanceForm {
53
58
  readonly 'status': io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceStatus;
54
59
  }