@flowio/api-types 0.0.204 → 0.0.206
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.csv.v0.billing-csv.d.ts +42 -4
- package/generated/io.flow.billing.internal.v0.billing-internal.d.ts +11 -3
- package/generated/io.flow.billing.reporting.csv.v0.billing-reporting-csv.d.ts +19 -6
- package/generated/io.flow.billing.v0.billing.d.ts +28 -9
- package/generated/io.flow.channel.internal.v0.channel-internal.d.ts +64 -0
- package/generated/io.flow.external.paypal.v1.paypal.d.ts +38 -9
- package/generated/io.flow.internal.v0.api-internal.d.ts +239 -137
- package/generated/io.flow.label.v0.label.d.ts +4 -3
- package/generated/io.flow.payment.v0.payment.d.ts +13 -0
- package/generated/io.flow.ratecard.v0.ratecard.d.ts +14 -0
- package/generated/io.flow.shopify.markets.internal.event.v0.shopify-markets-internal-event.d.ts +104 -0
- package/generated/io.flow.shopify.markets.internal.v0.shopify-markets-internal.d.ts +189 -0
- package/generated/io.flow.shopify.markets.v0.shopify-markets.d.ts +1 -1
- package/generated/io.flow.stripe.v0.stripe.d.ts +9 -0
- package/generated/io.flow.trueup.v0.trueup.d.ts +52 -0
- package/generated/io.flow.v0.api.d.ts +114 -10
- package/index.d.ts +4 -1
- package/package.json +2 -2
- package/generated/io.flow.billing.true.up.v0.billing-true-up.d.ts +0 -164
|
@@ -309,9 +309,8 @@ declare namespace io.flow.billing.csv.v0.models {
|
|
|
309
309
|
readonly 'id': string;
|
|
310
310
|
readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
|
|
311
311
|
readonly 'account': io.flow.billing.csv.v0.models.BillingCsvTransactionAccount;
|
|
312
|
-
readonly 'metadata'?: io.flow.billing.v0.
|
|
313
|
-
readonly 'order'?: io.flow.billing.v0.models.
|
|
314
|
-
readonly 'payment_request'?: io.flow.billing.v0.models.BillingChannelPaymentRequestReference;
|
|
312
|
+
readonly 'metadata'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadata;
|
|
313
|
+
readonly 'order'?: io.flow.billing.csv.v0.models.BillingCsvTransactionOrderSummary;
|
|
315
314
|
readonly 'currency': string;
|
|
316
315
|
readonly 'source': io.flow.billing.v0.enums.TransactionSource;
|
|
317
316
|
readonly 'parent'?: io.flow.billing.v0.models.ParentTransactionSummary;
|
|
@@ -320,7 +319,7 @@ declare namespace io.flow.billing.csv.v0.models {
|
|
|
320
319
|
readonly 'withholdings': io.flow.billing.csv.v0.models.BillingCsvTransactionWithholdings;
|
|
321
320
|
readonly 'discount': io.flow.billing.csv.v0.models.BillingCsvTransactionDiscount;
|
|
322
321
|
readonly 'net': number;
|
|
323
|
-
readonly 'identifiers':
|
|
322
|
+
readonly 'identifiers': io.flow.billing.csv.v0.models.BillingCsvTransactionIdentifiers;
|
|
324
323
|
readonly 'created_at': string;
|
|
325
324
|
readonly 'updated_at': string;
|
|
326
325
|
}
|
|
@@ -351,6 +350,45 @@ declare namespace io.flow.billing.csv.v0.models {
|
|
|
351
350
|
readonly 'transfer': number;
|
|
352
351
|
}
|
|
353
352
|
|
|
353
|
+
interface BillingCsvTransactionIdentifiers {
|
|
354
|
+
readonly 'reference_id'?: string;
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
interface BillingCsvTransactionMetadata {
|
|
358
|
+
readonly 'channel'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataChannel;
|
|
359
|
+
readonly 'shipping_label'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataShippingLabel;
|
|
360
|
+
readonly 'trueup'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataTrueup;
|
|
361
|
+
readonly 'manual'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataManual;
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
interface BillingCsvTransactionMetadataChannel {
|
|
365
|
+
readonly 'method': string;
|
|
366
|
+
readonly 'card'?: io.flow.billing.v0.models.TransactionMetadataChannelCardMetadata;
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
interface BillingCsvTransactionMetadataManual {
|
|
370
|
+
readonly 'original'?: io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
|
|
371
|
+
readonly 'url'?: string;
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
interface BillingCsvTransactionMetadataShippingLabel {
|
|
375
|
+
readonly 'request_method'?: io.flow.label.v0.enums.LabelRequestMethod;
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
interface BillingCsvTransactionMetadataTrueup {
|
|
379
|
+
readonly 'original': io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
interface BillingCsvTransactionOrderSummary {
|
|
383
|
+
readonly 'organization': io.flow.common.v0.models.OrganizationReference;
|
|
384
|
+
readonly 'number': string;
|
|
385
|
+
readonly 'identifiers': io.flow.billing.csv.v0.models.BillingCsvTransactionOrderSummaryIdentifiers;
|
|
386
|
+
}
|
|
387
|
+
|
|
388
|
+
interface BillingCsvTransactionOrderSummaryIdentifiers {
|
|
389
|
+
readonly 'shopify_order_id'?: string;
|
|
390
|
+
}
|
|
391
|
+
|
|
354
392
|
interface BillingCsvTransactionWithholdings {
|
|
355
393
|
readonly 'tax': number;
|
|
356
394
|
readonly 'duty': number;
|
|
@@ -15,12 +15,12 @@ declare namespace io.flow.billing.internal.v0.enums {
|
|
|
15
15
|
type FeesSource = 'settings' | 'authorization_bundle';
|
|
16
16
|
type LabelTransactionType = 'adjustment' | 'reversal' | 'billable_label' | 'fee' | 'revenue_share';
|
|
17
17
|
type MainTransactionStatus = 'scheduled' | 'pending_proof';
|
|
18
|
-
type ManualTransactionCategory = 'cancelled_order_refund' | 'channel_partner_initiated' | 'client_accepted_chargeback' | 'fee_reimbursement' | 'partial_refund' | 'platform_fee' | 'shipping_true_up' | 'tax_credit';
|
|
18
|
+
type ManualTransactionCategory = 'cancelled_order_refund' | 'channel_partner_initiated' | 'client_accepted_chargeback' | 'fee_reimbursement' | 'partial_refund' | 'platform_fee' | 'shipping_true_up' | 'tax_credit' | 'carrier_credit' | 'negative_balance_guarantee';
|
|
19
19
|
type OrderCancellationInitiatedBy = 'flow' | 'organization';
|
|
20
20
|
type OrderTransactionType = 'adjustment' | 'reversal' | 'order_service';
|
|
21
21
|
type PreferredBillingSchedule = 'monthly' | 'bi-monthly';
|
|
22
22
|
type ProcessingTransactionType = 'adjustment' | 'reversal' | 'capture' | 'refund' | 'fully_subsidized_order' | 'credit_payment';
|
|
23
|
-
type QueuedRecordType = 'capture' | 'channel_transaction' | 'consumer_invoice' | 'fulfillment_in_transit' | 'fulfillment_shipping_notification' | 'fulfillment_external' | '
|
|
23
|
+
type QueuedRecordType = 'capture' | 'channel_transaction' | 'consumer_invoice' | 'fulfillment_in_transit' | 'fulfillment_shipping_notification' | 'fulfillment_external' | 'fulfillment_order_combined_shipment' | 'fulfillment_order_time' | 'label_tracking_summary' | 'label_invoice_request' | 'carrier_charge' | 'carrier_charge_file' | 'order' | 'order_identifier' | 'organization_onboarding_state' | 'posting_proof' | 'refund' | 'refund_over_capture' | 'sales_record' | 'statement_batch' | 'statement_email' | 'statement_summary_email' | 'pending_payout_transaction_event' | 'credit_and_subsidy' | 'negative_balance_guarantee';
|
|
24
24
|
type ResponsibleParty = 'flow' | 'organization';
|
|
25
25
|
type StatementTransferTransactionLocation = 'transactions_file' | 'summary';
|
|
26
26
|
type SubscriptionFrequency = 'yearly' | 'monthly';
|
|
@@ -100,6 +100,7 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
100
100
|
readonly 'merchant_of_record_fee'?: number;
|
|
101
101
|
readonly 'duty_guarantee_fee'?: number;
|
|
102
102
|
readonly 'transfer_fee'?: number;
|
|
103
|
+
readonly 'negative_balance_guarantee_fee'?: number;
|
|
103
104
|
readonly 'order_service_fee'?: io.flow.billing.internal.v0.models.TieredFee;
|
|
104
105
|
readonly 'label_fees'?: io.flow.billing.internal.v0.models.AccountSettingLabelFees;
|
|
105
106
|
readonly 'charge_label_cost_directly': boolean;
|
|
@@ -654,6 +655,7 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
654
655
|
interface ManualTransaction {
|
|
655
656
|
readonly 'discriminator': 'manual_transaction';
|
|
656
657
|
readonly 'category'?: io.flow.billing.internal.v0.enums.ManualTransactionCategory;
|
|
658
|
+
readonly 'original_transaction'?: io.flow.billing.internal.v0.models.TransactionReference;
|
|
657
659
|
readonly 'order'?: io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
|
|
658
660
|
readonly 'attributes'?: Record<string, string>;
|
|
659
661
|
readonly 'id': string;
|
|
@@ -673,6 +675,7 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
673
675
|
readonly 'category'?: io.flow.billing.internal.v0.enums.ManualTransactionCategory;
|
|
674
676
|
readonly 'posted_at'?: string;
|
|
675
677
|
readonly 'order'?: io.flow.billing.internal.v0.models.ManualTransactionFormOrder;
|
|
678
|
+
readonly 'original_transaction_id'?: string;
|
|
676
679
|
readonly 'attributes'?: Record<string, string>;
|
|
677
680
|
}
|
|
678
681
|
|
|
@@ -859,6 +862,11 @@ declare namespace io.flow.billing.internal.v0.models {
|
|
|
859
862
|
readonly 'order_cancellation_id': string;
|
|
860
863
|
}
|
|
861
864
|
|
|
865
|
+
interface ProofOfPostingOrderCombinedShipment {
|
|
866
|
+
readonly 'discriminator': 'order_combined_shipment';
|
|
867
|
+
readonly 'order_combined_shipment_id': string;
|
|
868
|
+
}
|
|
869
|
+
|
|
862
870
|
interface ProofOfPostingShippingNotification {
|
|
863
871
|
readonly 'discriminator': 'shipping_notification';
|
|
864
872
|
readonly 'shipping_notification_id': string;
|
|
@@ -1024,7 +1032,7 @@ declare namespace io.flow.billing.internal.v0.unions {
|
|
|
1024
1032
|
type ChannelRateMetadata = (io.flow.billing.internal.v0.models.ChannelRateMetadataIdentity | io.flow.billing.internal.v0.models.ChannelRateMetadataRate);
|
|
1025
1033
|
type OrderCancellationEvidence = (io.flow.billing.internal.v0.models.OrderCancellationEvidenceManual | io.flow.billing.internal.v0.models.OrderCancellationEvidenceFullyRefundedNotFulfilled | io.flow.billing.internal.v0.models.OrderCancellationEvidenceReturnToSender);
|
|
1026
1034
|
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);
|
|
1027
|
-
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);
|
|
1035
|
+
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);
|
|
1028
1036
|
type SpotRateMetadata = (io.flow.billing.internal.v0.models.SpotRateMetadataIdentity | io.flow.billing.internal.v0.models.SpotRateMetadataRate);
|
|
1029
1037
|
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);
|
|
1030
1038
|
}
|
|
@@ -80,11 +80,6 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
|
|
|
80
80
|
readonly 'debug_console_order_link': string;
|
|
81
81
|
}
|
|
82
82
|
|
|
83
|
-
interface ReportingAddenda {
|
|
84
|
-
readonly 'allocation_order_totals_delta'?: number;
|
|
85
|
-
readonly 'allocation_order_item_discount_delta'?: number;
|
|
86
|
-
}
|
|
87
|
-
|
|
88
83
|
interface ReportingAuthorizationReference {
|
|
89
84
|
readonly 'id': string;
|
|
90
85
|
}
|
|
@@ -114,7 +109,16 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
|
|
|
114
109
|
|
|
115
110
|
interface ReportingDebug {
|
|
116
111
|
readonly 'console_order_link': string;
|
|
117
|
-
readonly '
|
|
112
|
+
readonly 'allocation_order_totals_delta'?: number;
|
|
113
|
+
readonly 'allocation_order_item_discount_delta'?: number;
|
|
114
|
+
readonly 'missing_item_subsidies'?: io.flow.billing.reporting.csv.v0.models.ReportingDebugMissingSubsidies;
|
|
115
|
+
readonly 'missing_shipping_subsidies'?: io.flow.billing.reporting.csv.v0.models.ReportingDebugMissingSubsidies;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
interface ReportingDebugMissingSubsidies {
|
|
119
|
+
readonly 'price'?: boolean;
|
|
120
|
+
readonly 'tax'?: boolean;
|
|
121
|
+
readonly 'duty'?: boolean;
|
|
118
122
|
}
|
|
119
123
|
|
|
120
124
|
interface ReportingDestination {
|
|
@@ -201,6 +205,14 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
|
|
|
201
205
|
readonly 'ccf': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
202
206
|
}
|
|
203
207
|
|
|
208
|
+
interface ReportingMerchantTransactions {
|
|
209
|
+
readonly 'adjustment': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
210
|
+
readonly 'reversal': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
211
|
+
readonly 'tax': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
212
|
+
readonly 'duty': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
213
|
+
readonly 'freight': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
214
|
+
}
|
|
215
|
+
|
|
204
216
|
interface ReportingMonetaryValue {
|
|
205
217
|
readonly 'transaction': number;
|
|
206
218
|
readonly 'merchant': number;
|
|
@@ -271,6 +283,7 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
|
|
|
271
283
|
readonly 'marked_as_final': io.flow.billing.reporting.csv.v0.models.MarkedAsFinal;
|
|
272
284
|
readonly 'merchant_subsidies': io.flow.billing.reporting.csv.v0.models.ReportingMerchantSubsidies;
|
|
273
285
|
readonly 'merchant_fees': io.flow.billing.reporting.csv.v0.models.ReportingMerchantFees;
|
|
286
|
+
readonly 'merchant_transactions': io.flow.billing.reporting.csv.v0.models.ReportingMerchantTransactions;
|
|
274
287
|
readonly 'vat_remittance': io.flow.billing.reporting.csv.v0.models.ReportingVatRemittance;
|
|
275
288
|
readonly 'debug': io.flow.billing.reporting.csv.v0.models.ReportingDebug;
|
|
276
289
|
}
|
|
@@ -2,11 +2,10 @@ declare namespace io.flow.billing.v0.enums {
|
|
|
2
2
|
type FeeDeductionType = 'duty_guarantee' | 'mor' | 'fraud' | 'fx' | 'processing' | 'rate_lock' | 'transfer';
|
|
3
3
|
type PayoutAttachmentType = 'transactions';
|
|
4
4
|
type PayoutStatusFailureCode = 'invalid_account_number' | 'account_closed' | 'could_not_process';
|
|
5
|
-
type PendingPayoutTransactionReasonCode = 'waiting_for_full_refund' | 'waiting_for_fulfillment' | 'waiting_for_in_transit' | 'waiting_for_next_payout_date' | '
|
|
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
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';
|
|
8
8
|
type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
|
|
9
|
-
type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction';
|
|
10
9
|
type WithholdingDeductionType = 'tax' | 'duty' | 'freight' | 'insurance';
|
|
11
10
|
}
|
|
12
11
|
|
|
@@ -90,6 +89,9 @@ declare namespace io.flow.billing.v0.models {
|
|
|
90
89
|
readonly 'id': string;
|
|
91
90
|
readonly 'reason': io.flow.billing.v0.models.PendingPayoutTransactionReason;
|
|
92
91
|
readonly 'timeout'?: io.flow.billing.v0.models.PendingPayoutTransactionTimeout;
|
|
92
|
+
readonly 'created_at': string;
|
|
93
|
+
readonly 'updated_at': string;
|
|
94
|
+
readonly 'deleted_at'?: string;
|
|
93
95
|
}
|
|
94
96
|
|
|
95
97
|
interface ChannelStatement {
|
|
@@ -156,6 +158,9 @@ declare namespace io.flow.billing.v0.models {
|
|
|
156
158
|
readonly 'id': string;
|
|
157
159
|
readonly 'reason': io.flow.billing.v0.models.PendingPayoutTransactionReason;
|
|
158
160
|
readonly 'timeout'?: io.flow.billing.v0.models.PendingPayoutTransactionTimeout;
|
|
161
|
+
readonly 'created_at': string;
|
|
162
|
+
readonly 'updated_at': string;
|
|
163
|
+
readonly 'deleted_at'?: string;
|
|
159
164
|
}
|
|
160
165
|
|
|
161
166
|
interface ParentTransactionSummary {
|
|
@@ -271,14 +276,30 @@ declare namespace io.flow.billing.v0.models {
|
|
|
271
276
|
readonly 'country': string;
|
|
272
277
|
}
|
|
273
278
|
|
|
279
|
+
interface TransactionMetadataManual {
|
|
280
|
+
readonly 'discriminator': 'manual';
|
|
281
|
+
readonly 'original'?: io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
|
|
282
|
+
readonly 'url'?: string;
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
interface TransactionMetadataOriginalTransaction {
|
|
286
|
+
readonly 'id': string;
|
|
287
|
+
}
|
|
288
|
+
|
|
274
289
|
interface TransactionMetadataShippingLabel {
|
|
275
290
|
readonly 'discriminator': 'shipping_label';
|
|
276
291
|
readonly 'request_method'?: io.flow.label.v0.enums.LabelRequestMethod;
|
|
292
|
+
readonly 'carrier': io.flow.billing.v0.models.TransactionMetadataShippingLabelCarrier;
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
interface TransactionMetadataShippingLabelCarrier {
|
|
296
|
+
readonly 'id': string;
|
|
297
|
+
readonly 'tracking_number': string;
|
|
277
298
|
}
|
|
278
299
|
|
|
279
300
|
interface TransactionMetadataTrueup {
|
|
280
301
|
readonly 'discriminator': 'trueup';
|
|
281
|
-
readonly 'original': io.flow.billing.v0.models.
|
|
302
|
+
readonly 'original': io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
|
|
282
303
|
readonly 'estimate': io.flow.billing.v0.models.TransactionMetadataTrueupData;
|
|
283
304
|
readonly 'actual': io.flow.billing.v0.models.TransactionMetadataTrueupData;
|
|
284
305
|
}
|
|
@@ -289,10 +310,8 @@ declare namespace io.flow.billing.v0.models {
|
|
|
289
310
|
readonly 'base': io.flow.billing.v0.models.TrueupLabelBase;
|
|
290
311
|
readonly 'surcharges': io.flow.billing.v0.models.TrueupLabelSurcharge[];
|
|
291
312
|
readonly 'total': number;
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
interface TransactionMetadataTrueupOriginalTransaction {
|
|
295
|
-
readonly 'id': string;
|
|
313
|
+
readonly 'dead'?: io.flow.trueup.v0.models.DeadWeight;
|
|
314
|
+
readonly 'dimensional'?: io.flow.trueup.v0.models.DimensionalWeight;
|
|
296
315
|
}
|
|
297
316
|
|
|
298
317
|
interface TransactionReference {
|
|
@@ -306,7 +325,7 @@ declare namespace io.flow.billing.v0.models {
|
|
|
306
325
|
|
|
307
326
|
interface TrueupLabelSurcharge {
|
|
308
327
|
readonly 'amount': number;
|
|
309
|
-
readonly 'type': io.flow.
|
|
328
|
+
readonly 'type': io.flow.trueup.v0.enums.TrueupSurchargeType;
|
|
310
329
|
readonly 'percentage'?: number;
|
|
311
330
|
readonly 'per_weight_unit'?: number;
|
|
312
331
|
}
|
|
@@ -327,5 +346,5 @@ declare namespace io.flow.billing.v0.unions {
|
|
|
327
346
|
type BankAccountForm = (io.flow.billing.v0.models.BankAccountFormInfo | io.flow.billing.v0.models.BankAccountFormSimple);
|
|
328
347
|
type PayoutStatus = (io.flow.billing.v0.models.PayoutStatusScheduled | io.flow.billing.v0.models.PayoutStatusSent | io.flow.billing.v0.models.PayoutStatusFailed);
|
|
329
348
|
type Settlement = (io.flow.billing.v0.models.SettlementNoPayout | io.flow.billing.v0.models.SettlementPayout);
|
|
330
|
-
type TransactionMetadata = (io.flow.billing.v0.models.TransactionMetadataShippingLabel | io.flow.billing.v0.models.TransactionMetadataChannel | io.flow.billing.v0.models.TransactionMetadataTrueup);
|
|
349
|
+
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);
|
|
331
350
|
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
declare namespace io.flow.channel.internal.v0.enums {
|
|
2
|
+
type ChannelOrderAcceptanceErrorAction = 'auto_reject' | 'auto_accept';
|
|
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';
|
|
5
|
+
type ChannelOrderAcceptanceStatus = 'accepted' | 'rejected' | 'review';
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
declare namespace io.flow.channel.internal.v0.models {
|
|
9
|
+
interface ChannelCurrencyForm {
|
|
10
|
+
readonly 'currency': string;
|
|
11
|
+
readonly 'channel_id': string;
|
|
12
|
+
readonly 'capabilities': io.flow.channel.v0.enums.ChannelCurrencyCapability[];
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
interface ChannelForm {
|
|
16
|
+
readonly 'name': string;
|
|
17
|
+
readonly 'environment': io.flow.common.v0.enums.Environment;
|
|
18
|
+
readonly 'organization_id_prefix'?: string;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
interface ChannelMembership {
|
|
22
|
+
readonly 'id': string;
|
|
23
|
+
readonly 'channel': io.flow.common.v0.models.ChannelReference;
|
|
24
|
+
readonly 'user': io.flow.common.v0.unions.ExpandableUser;
|
|
25
|
+
readonly 'role'?: io.flow.common.v0.enums.Role;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
interface ChannelMembershipForm {
|
|
29
|
+
readonly 'channel_id': string;
|
|
30
|
+
readonly 'user_id': string;
|
|
31
|
+
readonly 'role'?: io.flow.common.v0.enums.Role;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
interface ChannelMembershipPutForm {
|
|
35
|
+
readonly 'role'?: io.flow.common.v0.enums.Role;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
interface ChannelOrderAcceptance {
|
|
39
|
+
readonly 'id': string;
|
|
40
|
+
readonly 'organization_id': string;
|
|
41
|
+
readonly 'order_number': string;
|
|
42
|
+
readonly 'channel_id': string;
|
|
43
|
+
readonly 'external_order_reference': string;
|
|
44
|
+
readonly 'payment_request_id'?: string;
|
|
45
|
+
readonly 'status': io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceStatus;
|
|
46
|
+
readonly 'reasons': io.flow.channel.internal.v0.models.ChannelOrderAcceptanceReason[];
|
|
47
|
+
readonly 'next_action_from'?: io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceNextActionFrom;
|
|
48
|
+
readonly 'order_created_at'?: string;
|
|
49
|
+
readonly 'order_updated_at'?: string;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
interface ChannelOrderAcceptanceForm {
|
|
53
|
+
readonly 'status': io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceStatus;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
interface ChannelOrderAcceptanceReason {
|
|
57
|
+
readonly 'description': string;
|
|
58
|
+
readonly 'rejection_reason'?: io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceRejectionReason;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
interface FlowChannelOrganization {
|
|
62
|
+
readonly 'placeholder'?: string;
|
|
63
|
+
}
|
|
64
|
+
}
|
|
@@ -11,6 +11,7 @@ declare namespace io.flow.external.paypal.v1.enums {
|
|
|
11
11
|
type DisputeOutcomeCode = 'RESOLVED_BUYER_FAVOUR' | 'RESOLVED_SELLER_FAVOUR' | 'RESOLVED_WITH_PAYOUT' | 'CANCELED_BY_BUYER' | 'ACCEPTED' | 'DENIED' | 'NONE';
|
|
12
12
|
type DisputeReason = 'MERCHANDISE_OR_SERVICE_NOT_RECEIVED' | 'MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED' | 'UNAUTHORISED' | 'CREDIT_NOT_PROCESSED' | 'DUPLICATE_TRANSACTION' | 'INCORRECT_AMOUNT' | 'PAYMENT_BY_OTHER_MEANS' | 'CANCELED_RECURRING_BILLING' | 'PROBLEM_WITH_REMITTANCE' | 'OTHER';
|
|
13
13
|
type DisputeStatus = 'OPEN' | 'WAITING_FOR_BUYER_RESPONSE' | 'WAITING_FOR_SELLER_RESPONSE' | 'UNDER_REVIEW' | 'RESOLVED' | 'OTHER';
|
|
14
|
+
type EventType = 'PAYMENT.AUTHORIZATION.CREATED' | 'PAYMENT.AUTHORIZATION.VOIDED' | 'PAYMENT.CAPTURE.DECLINED' | 'PAYMENT.CAPTURE.COMPLETED' | 'PAYMENT.CAPTURE.PENDING' | 'PAYMENT.CAPTURE.REVERSED' | 'PAYMENT.CAPTURE.DENIED' | 'PAYMENT.ORDER.CANCELLED' | 'PAYMENT.ORDER.CREATED' | 'PAYMENT.SALE.COMPLETED' | 'PAYMENT.SALE.DENIED' | 'PAYMENT.SALE.PENDING' | 'PAYMENT.SALE.REFUNDED' | 'PAYMENT.SALE.REVERSED' | 'PAYMENTS.PAYMENT.CREATED' | 'CHECKOUT.ORDER.APPROVED' | 'CHECKOUT.CHECKOUT.BUYER-APPROVED' | 'CHECKOUT.ORDER.COMPLETED' | 'CUSTOMER.DISPUTE.CREATED' | 'CUSTOMER.DISPUTE.RESOLVED' | 'CUSTOMER.DISPUTE.UPDATED' | 'CHECKOUT.PAYMENT-APPROVAL.REVERSED';
|
|
14
15
|
type EvidenceType = 'PROOF_OF_FULFILLMENT' | 'PROOF_OF_REFUND' | 'PROOF_OF_DELIVERY_SIGNATURE' | 'PROOF_OF_RECEIPT_COPY' | 'RETURN_POLICY' | 'BILLING_AGREEMENT' | 'PROOF_OF_RESHIPMENT' | 'ITEM_DESCRIPTION' | 'POLICE_REPORT' | 'AFFIDAVIT' | 'PAID_WITH_OTHER_METHOD' | 'COPY_OF_CONTRACT' | 'TERMINAL_ATM_RECEIPT' | 'PRICE_DIFFERENCE_REASON' | 'SOURCE_CONVERSION_RATE' | 'BANK_STATEMENT' | 'CREDIT_DUE_REASON' | 'REQUEST_CREDIT_RECEIPT' | 'PROOF_OF_RETURN' | 'CREATE' | 'CHANGE_REASON' | 'PROOF_OF_REFUND_OUTSIDE_PAYPAL' | 'RECEIPT_OF_MERCHANDISE' | 'CUSTOMS_DOCUMENT' | 'CUSTOMS_FEE_RECEIPT' | 'INFORMATION_ON_RESOLUTION' | 'ADDITIONAL_INFORMATION_OF_ITEM' | 'DETAILS_OF_PURCHASE' | 'PROOF_OF_SIGNIFICANT_DIFFERENCE' | 'PROOF_OF_SOFTWARE_OR_SERVICE_NOT_AS_DESCRIBED' | 'PROOF_OF_CONFISCATION' | 'PROOF_OF_DAMAGE' | 'COPY_OF_LAW_ENFORCEMENT_AGENCY_REPORT' | 'ADDITIONAL_PROOF_OF_SHIPMENT' | 'PROOF_OF_DENIAL_BY_CARRIER' | 'THIRDPARTY_PROOF_FOR_DAMAGE_OR_SIGNIFICANT_DIFFERENCE' | 'VALID_SUPPORTING_DOCUMENT' | 'LEGIBLE_SUPPORTING_DOCUMENT' | 'RETURN_TRACKING_INFORMATION' | 'DELIVERY_RECEIPT' | 'PROOF_OF_INSTORE_RECEIPT' | 'ADDITIONAL_TRACKING_INFORMATION' | 'PROOF_OF_SHIPMENT_POSTAGE' | 'ONLINE_TRACKING_INFORMATION' | 'PROOF_OF_INSTORE_REFUND' | 'PROOF_FOR_SOFTWARE_OR_SERVICE_DELIVERED' | 'RETURN_ADDRESS_FOR_SHIPPING' | 'COPY_OF_THE_EPARCEL_MANIFEST' | 'COPY_OF_SHIPPING_MANIFEST' | 'APPEAL_AFFIDAVIT' | 'RECEIPT_OF_REPLACEMENT' | 'COPY_OF_DRIVERS_LICENSE' | 'ACCOUNT_CHANGE_INFORMATION' | 'DELIVERY_ADDRESS' | 'CONFIRMATION_OF_RESOLUTION' | 'MERCHANT_RESPONSE' | 'PERMISSION_DESCRIPTION' | 'STATUS_OF_MERCHANDISE' | 'LOST_CARD_DETAILS' | 'LAST_VALID_TRANSACTION_DETAILS' | 'ADDITIONAL_PROOF_OF_RETURN' | 'OTHER';
|
|
15
16
|
type FailureReason = 'UNABLE_TO_COMPLETE_TRANSACTION' | 'INVALID_PAYMENT_METHOD' | 'PAYER_CANNOT_PAY' | 'CANNOT_PAY_THIS_PAYEE' | 'REDIRECT_REQUIRED' | 'PAYEE_FILTER_RESTRICTIONS';
|
|
16
17
|
type GrantType = 'client_credentials';
|
|
@@ -29,6 +30,7 @@ declare namespace io.flow.external.paypal.v1.enums {
|
|
|
29
30
|
type RefundState = 'pending' | 'completed' | 'cancelled' | 'failed';
|
|
30
31
|
type ReturnAcknowledgementType = 'ITEM_RECEIVED' | 'ITEM_NOT_RECEIVED' | 'DAMAGED' | 'EMPTY_PACKAGE_OR_DIFFERENT' | 'MISSING_ITEMS';
|
|
31
32
|
type ReturnMode = 'SHIPPED' | 'IN_PERSON';
|
|
33
|
+
type SaleState = 'pending' | 'completed' | 'denied' | 'partially_refunded' | 'refunded';
|
|
32
34
|
type ServiceStarted = 'YES' | 'NO' | 'RETURNED';
|
|
33
35
|
type ShippingDisplayPreference = 'NO_SHIPPING' | 'GET_FROM_FILE' | 'SET_PROVIDED_ADDRESS';
|
|
34
36
|
type State = 'created' | 'approved' | 'failed';
|
|
@@ -375,24 +377,24 @@ declare namespace io.flow.external.paypal.v1.models {
|
|
|
375
377
|
|
|
376
378
|
interface Refund {
|
|
377
379
|
readonly 'id': string;
|
|
378
|
-
readonly 'amount'
|
|
380
|
+
readonly 'amount'?: io.flow.external.paypal.v1.models.SimpleAmount;
|
|
379
381
|
readonly 'state': io.flow.external.paypal.v1.enums.RefundState;
|
|
380
382
|
readonly 'sale_id': string;
|
|
381
|
-
readonly 'invoice_number'
|
|
383
|
+
readonly 'invoice_number'?: string;
|
|
382
384
|
readonly 'capture_id'?: string;
|
|
383
385
|
readonly 'parent_payment'?: string;
|
|
384
386
|
readonly 'reason_code'?: string;
|
|
385
387
|
readonly 'refund_reason_code'?: string;
|
|
386
388
|
readonly 'refund_funding_type'?: string;
|
|
387
|
-
readonly '
|
|
389
|
+
readonly 'refund_from_received_amount'?: io.flow.external.paypal.v1.models.Money;
|
|
390
|
+
readonly 'refund_from_transaction_fee'?: io.flow.external.paypal.v1.models.Money;
|
|
391
|
+
readonly 'total_refunded_amount'?: io.flow.external.paypal.v1.models.Money;
|
|
392
|
+
readonly 'refund_to_payer'?: io.flow.external.paypal.v1.models.Money;
|
|
393
|
+
readonly 'custom'?: string;
|
|
394
|
+
readonly 'create_time'?: string;
|
|
388
395
|
readonly 'update_time'?: string;
|
|
389
396
|
}
|
|
390
397
|
|
|
391
|
-
interface RefundAmount {
|
|
392
|
-
readonly 'total': string;
|
|
393
|
-
readonly 'currency': string;
|
|
394
|
-
}
|
|
395
|
-
|
|
396
398
|
interface RefundDetails {
|
|
397
399
|
readonly 'allowed_refund_amount'?: io.flow.external.paypal.v1.models.Money;
|
|
398
400
|
}
|
|
@@ -402,7 +404,7 @@ declare namespace io.flow.external.paypal.v1.models {
|
|
|
402
404
|
}
|
|
403
405
|
|
|
404
406
|
interface RefundRequest {
|
|
405
|
-
readonly 'amount': io.flow.external.paypal.v1.models.
|
|
407
|
+
readonly 'amount': io.flow.external.paypal.v1.models.SimpleAmount;
|
|
406
408
|
readonly 'invoice_number': string;
|
|
407
409
|
}
|
|
408
410
|
|
|
@@ -414,6 +416,28 @@ declare namespace io.flow.external.paypal.v1.models {
|
|
|
414
416
|
readonly 'returned'?: boolean;
|
|
415
417
|
}
|
|
416
418
|
|
|
419
|
+
interface Sale {
|
|
420
|
+
readonly 'id': string;
|
|
421
|
+
readonly 'state': io.flow.external.paypal.v1.enums.SaleState;
|
|
422
|
+
readonly 'parent_payment': string;
|
|
423
|
+
readonly 'invoice_number'?: string;
|
|
424
|
+
readonly 'amount'?: io.flow.external.paypal.v1.models.SimpleAmount;
|
|
425
|
+
readonly 'payment_mode'?: string;
|
|
426
|
+
readonly 'reason_code'?: string;
|
|
427
|
+
readonly 'protection_eligibility'?: string;
|
|
428
|
+
readonly 'protection_eligibility_type'?: string;
|
|
429
|
+
readonly 'receipt_id'?: string;
|
|
430
|
+
readonly 'soft_descriptor'?: string;
|
|
431
|
+
readonly 'exchange_rate'?: string;
|
|
432
|
+
readonly 'payment_hold_status'?: string;
|
|
433
|
+
readonly 'payment_hold_reasons'?: string[];
|
|
434
|
+
readonly 'transaction_fee'?: io.flow.external.paypal.v1.models.Money;
|
|
435
|
+
readonly 'receivable_amount'?: io.flow.external.paypal.v1.models.Money;
|
|
436
|
+
readonly 'custom'?: string;
|
|
437
|
+
readonly 'create_time'?: string;
|
|
438
|
+
readonly 'update_time'?: string;
|
|
439
|
+
}
|
|
440
|
+
|
|
417
441
|
interface Seller {
|
|
418
442
|
readonly 'email'?: string;
|
|
419
443
|
readonly 'merchant_id'?: string;
|
|
@@ -439,6 +463,11 @@ declare namespace io.flow.external.paypal.v1.models {
|
|
|
439
463
|
readonly 'state'?: string;
|
|
440
464
|
}
|
|
441
465
|
|
|
466
|
+
interface SimpleAmount {
|
|
467
|
+
readonly 'total': string;
|
|
468
|
+
readonly 'currency': string;
|
|
469
|
+
}
|
|
470
|
+
|
|
442
471
|
interface SupportingInfo {
|
|
443
472
|
readonly 'notes'?: string;
|
|
444
473
|
readonly 'source'?: io.flow.external.paypal.v1.enums.SupportingInfoSource;
|