@flowio/api-types 0.0.204 → 0.0.205

package/generated/io.flow.billing.csv.v0.billing-csv.d.ts

@@ -309,9 +309,8 @@ declare namespace io.flow.billing.csv.v0.models {
     readonly 'id': string;
     readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
     readonly 'account': io.flow.billing.csv.v0.models.BillingCsvTransactionAccount;
-    readonly 'metadata'?: io.flow.billing.v0.unions.TransactionMetadata;
-    readonly 'order'?: io.flow.billing.v0.models.BillingChannelOrderSummary;
-    readonly 'payment_request'?: io.flow.billing.v0.models.BillingChannelPaymentRequestReference;
+    readonly 'metadata'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadata;
+    readonly 'order'?: io.flow.billing.csv.v0.models.BillingCsvTransactionOrderSummary;
     readonly 'currency': string;
     readonly 'source': io.flow.billing.v0.enums.TransactionSource;
     readonly 'parent'?: io.flow.billing.v0.models.ParentTransactionSummary;
@@ -320,7 +319,7 @@ declare namespace io.flow.billing.csv.v0.models {
     readonly 'withholdings': io.flow.billing.csv.v0.models.BillingCsvTransactionWithholdings;
     readonly 'discount': io.flow.billing.csv.v0.models.BillingCsvTransactionDiscount;
     readonly 'net': number;
-    readonly 'identifiers': Record<string, string>;
+    readonly 'identifiers': io.flow.billing.csv.v0.models.BillingCsvTransactionIdentifiers;
     readonly 'created_at': string;
     readonly 'updated_at': string;
   }
@@ -351,6 +350,44 @@ declare namespace io.flow.billing.csv.v0.models {
     readonly 'transfer': number;
   }
 
+  interface BillingCsvTransactionIdentifiers {
+    readonly 'reference_id'?: string;
+  }
+
+  interface BillingCsvTransactionMetadata {
+    readonly 'channel'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataChannel;
+    readonly 'shipping_label'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataShippingLabel;
+    readonly 'trueup'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataTrueup;
+    readonly 'manual'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataManual;
+  }
+
+  interface BillingCsvTransactionMetadataChannel {
+    readonly 'method': string;
+    readonly 'card'?: io.flow.billing.v0.models.TransactionMetadataChannelCardMetadata;
+  }
+
+  interface BillingCsvTransactionMetadataManual {
+    readonly 'original': io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
+  }
+
+  interface BillingCsvTransactionMetadataShippingLabel {
+    readonly 'request_method'?: io.flow.label.v0.enums.LabelRequestMethod;
+  }
+
+  interface BillingCsvTransactionMetadataTrueup {
+    readonly 'original': io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
+  }
+
+  interface BillingCsvTransactionOrderSummary {
+    readonly 'organization': io.flow.common.v0.models.OrganizationReference;
+    readonly 'number': string;
+    readonly 'identifiers': io.flow.billing.csv.v0.models.BillingCsvTransactionOrderSummaryIdentifiers;
+  }
+
+  interface BillingCsvTransactionOrderSummaryIdentifiers {
+    readonly 'shopify_order_id'?: string;
+  }
+
   interface BillingCsvTransactionWithholdings {
     readonly 'tax': number;
     readonly 'duty': number;

package/generated/io.flow.billing.internal.v0.billing-internal.d.ts

@@ -15,12 +15,12 @@ declare namespace io.flow.billing.internal.v0.enums {
   type FeesSource = 'settings' | 'authorization_bundle';
   type LabelTransactionType = 'adjustment' | 'reversal' | 'billable_label' | 'fee' | 'revenue_share';
   type MainTransactionStatus = 'scheduled' | 'pending_proof';
-  type ManualTransactionCategory = 'cancelled_order_refund' | 'channel_partner_initiated' | 'client_accepted_chargeback' | 'fee_reimbursement' | 'partial_refund' | 'platform_fee' | 'shipping_true_up' | 'tax_credit';
+  type ManualTransactionCategory = 'cancelled_order_refund' | 'channel_partner_initiated' | 'client_accepted_chargeback' | 'fee_reimbursement' | 'partial_refund' | 'platform_fee' | 'shipping_true_up' | 'tax_credit' | 'carrier_credit';
   type OrderCancellationInitiatedBy = 'flow' | 'organization';
   type OrderTransactionType = 'adjustment' | 'reversal' | 'order_service';
   type PreferredBillingSchedule = 'monthly' | 'bi-monthly';
   type ProcessingTransactionType = 'adjustment' | 'reversal' | 'capture' | 'refund' | 'fully_subsidized_order' | 'credit_payment';
-  type QueuedRecordType = 'capture' | 'channel_transaction' | 'consumer_invoice' | 'fulfillment_in_transit' | 'fulfillment_shipping_notification' | 'fulfillment_external' | 'fulfillment_order_cancellation' | 'label_tracking_summary' | 'label_invoice_request' | 'carrier_charge' | 'carrier_charge_file' | 'label_origin' | 'order' | 'order_identifier' | 'organization_onboarding_state' | 'refund' | 'refund_over_capture' | 'sales_record' | 'statement_batch' | 'statement_email' | 'statement_summary_email';
+  type QueuedRecordType = 'capture' | 'channel_transaction' | 'consumer_invoice' | 'fulfillment_in_transit' | 'fulfillment_shipping_notification' | 'fulfillment_external' | 'fulfillment_order_cancellation' | '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';
   type ResponsibleParty = 'flow' | 'organization';
   type StatementTransferTransactionLocation = 'transactions_file' | 'summary';
   type SubscriptionFrequency = 'yearly' | 'monthly';
@@ -654,6 +654,7 @@ declare namespace io.flow.billing.internal.v0.models {
   interface ManualTransaction {
     readonly 'discriminator': 'manual_transaction';
     readonly 'category'?: io.flow.billing.internal.v0.enums.ManualTransactionCategory;
+    readonly 'original_transaction'?: io.flow.billing.internal.v0.models.TransactionReference;
     readonly 'order'?: io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
     readonly 'attributes'?: Record<string, string>;
     readonly 'id': string;
@@ -673,6 +674,7 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'category'?: io.flow.billing.internal.v0.enums.ManualTransactionCategory;
     readonly 'posted_at'?: string;
     readonly 'order'?: io.flow.billing.internal.v0.models.ManualTransactionFormOrder;
+    readonly 'original_transaction_id'?: string;
     readonly 'attributes'?: Record<string, string>;
   }
 
@@ -859,6 +861,11 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'order_cancellation_id': string;
   }
 
+  interface ProofOfPostingOrderCombinedShipment {
+    readonly 'discriminator': 'order_combined_shipment';
+    readonly 'order_combined_shipment_id': string;
+  }
+
   interface ProofOfPostingShippingNotification {
     readonly 'discriminator': 'shipping_notification';
     readonly 'shipping_notification_id': string;
@@ -1024,7 +1031,7 @@ declare namespace io.flow.billing.internal.v0.unions {
   type ChannelRateMetadata = (io.flow.billing.internal.v0.models.ChannelRateMetadataIdentity | io.flow.billing.internal.v0.models.ChannelRateMetadataRate);
   type OrderCancellationEvidence = (io.flow.billing.internal.v0.models.OrderCancellationEvidenceManual | io.flow.billing.internal.v0.models.OrderCancellationEvidenceFullyRefundedNotFulfilled | io.flow.billing.internal.v0.models.OrderCancellationEvidenceReturnToSender);
   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);
-  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);
+  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);
   type SpotRateMetadata = (io.flow.billing.internal.v0.models.SpotRateMetadataIdentity | io.flow.billing.internal.v0.models.SpotRateMetadataRate);
   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);
 }

package/generated/io.flow.billing.reporting.csv.v0.billing-reporting-csv.d.ts

@@ -80,11 +80,6 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
     readonly 'debug_console_order_link': string;
   }
 
-  interface ReportingAddenda {
-    readonly 'allocation_order_totals_delta'?: number;
-    readonly 'allocation_order_item_discount_delta'?: number;
-  }
-
   interface ReportingAuthorizationReference {
     readonly 'id': string;
   }
@@ -114,7 +109,16 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
 
   interface ReportingDebug {
     readonly 'console_order_link': string;
-    readonly 'addenda'?: io.flow.billing.reporting.csv.v0.models.ReportingAddenda;
+    readonly 'allocation_order_totals_delta'?: number;
+    readonly 'allocation_order_item_discount_delta'?: number;
+    readonly 'missing_item_subsidies'?: io.flow.billing.reporting.csv.v0.models.ReportingDebugMissingSubsidies;
+    readonly 'missing_shipping_subsidies'?: io.flow.billing.reporting.csv.v0.models.ReportingDebugMissingSubsidies;
+  }
+
+  interface ReportingDebugMissingSubsidies {
+    readonly 'price'?: boolean;
+    readonly 'tax'?: boolean;
+    readonly 'duty'?: boolean;
   }
 
   interface ReportingDestination {
@@ -201,6 +205,14 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
     readonly 'ccf': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
   }
 
+  interface ReportingMerchantTransactions {
+    readonly 'adjustment': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
+    readonly 'reversal': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
+    readonly 'tax': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
+    readonly 'duty': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
+    readonly 'freight': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
+  }
+
   interface ReportingMonetaryValue {
     readonly 'transaction': number;
     readonly 'merchant': number;
@@ -271,6 +283,7 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
     readonly 'marked_as_final': io.flow.billing.reporting.csv.v0.models.MarkedAsFinal;
     readonly 'merchant_subsidies': io.flow.billing.reporting.csv.v0.models.ReportingMerchantSubsidies;
     readonly 'merchant_fees': io.flow.billing.reporting.csv.v0.models.ReportingMerchantFees;
+    readonly 'merchant_transactions': io.flow.billing.reporting.csv.v0.models.ReportingMerchantTransactions;
     readonly 'vat_remittance': io.flow.billing.reporting.csv.v0.models.ReportingVatRemittance;
     readonly 'debug': io.flow.billing.reporting.csv.v0.models.ReportingDebug;
   }

package/generated/io.flow.billing.v0.billing.d.ts

@@ -2,11 +2,10 @@ declare namespace io.flow.billing.v0.enums {
   type FeeDeductionType = 'duty_guarantee' | 'mor' | 'fraud' | 'fx' | 'processing' | 'rate_lock' | 'transfer';
   type PayoutAttachmentType = 'transactions';
   type PayoutStatusFailureCode = 'invalid_account_number' | 'account_closed' | 'could_not_process';
-  type PendingPayoutTransactionReasonCode = 'waiting_for_full_refund' | 'waiting_for_fulfillment' | 'waiting_for_in_transit' | 'waiting_for_next_payout_date' | 'external_fulfillment_missing_tracking_info' | 'waiting_for_positive_account_balance';
+  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';
   type StatementAttachmentType = 'csv';
   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';
   type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
-  type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction';
   type WithholdingDeductionType = 'tax' | 'duty' | 'freight' | 'insurance';
 }
 
@@ -90,6 +89,9 @@ declare namespace io.flow.billing.v0.models {
     readonly 'id': string;
     readonly 'reason': io.flow.billing.v0.models.PendingPayoutTransactionReason;
     readonly 'timeout'?: io.flow.billing.v0.models.PendingPayoutTransactionTimeout;
+    readonly 'created_at': string;
+    readonly 'updated_at': string;
+    readonly 'deleted_at'?: string;
   }
 
   interface ChannelStatement {
@@ -156,6 +158,9 @@ declare namespace io.flow.billing.v0.models {
     readonly 'id': string;
     readonly 'reason': io.flow.billing.v0.models.PendingPayoutTransactionReason;
     readonly 'timeout'?: io.flow.billing.v0.models.PendingPayoutTransactionTimeout;
+    readonly 'created_at': string;
+    readonly 'updated_at': string;
+    readonly 'deleted_at'?: string;
   }
 
   interface ParentTransactionSummary {
@@ -271,14 +276,29 @@ declare namespace io.flow.billing.v0.models {
     readonly 'country': string;
   }
 
+  interface TransactionMetadataManual {
+    readonly 'discriminator': 'manual';
+    readonly 'original': io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
+  }
+
+  interface TransactionMetadataOriginalTransaction {
+    readonly 'id': string;
+  }
+
   interface TransactionMetadataShippingLabel {
     readonly 'discriminator': 'shipping_label';
     readonly 'request_method'?: io.flow.label.v0.enums.LabelRequestMethod;
+    readonly 'carrier': io.flow.billing.v0.models.TransactionMetadataShippingLabelCarrier;
+  }
+
+  interface TransactionMetadataShippingLabelCarrier {
+    readonly 'id': string;
+    readonly 'tracking_number': string;
   }
 
   interface TransactionMetadataTrueup {
     readonly 'discriminator': 'trueup';
-    readonly 'original': io.flow.billing.v0.models.TransactionMetadataTrueupOriginalTransaction;
+    readonly 'original': io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
     readonly 'estimate': io.flow.billing.v0.models.TransactionMetadataTrueupData;
     readonly 'actual': io.flow.billing.v0.models.TransactionMetadataTrueupData;
   }
@@ -289,10 +309,8 @@ declare namespace io.flow.billing.v0.models {
     readonly 'base': io.flow.billing.v0.models.TrueupLabelBase;
     readonly 'surcharges': io.flow.billing.v0.models.TrueupLabelSurcharge[];
     readonly 'total': number;
-  }
-
-  interface TransactionMetadataTrueupOriginalTransaction {
-    readonly 'id': string;
+    readonly 'dead'?: io.flow.trueup.v0.models.DeadWeight;
+    readonly 'dimensional'?: io.flow.trueup.v0.models.DimensionalWeight;
   }
 
   interface TransactionReference {
@@ -306,7 +324,7 @@ declare namespace io.flow.billing.v0.models {
 
   interface TrueupLabelSurcharge {
     readonly 'amount': number;
-    readonly 'type': io.flow.billing.v0.enums.TrueupSurchargeType;
+    readonly 'type': io.flow.trueup.v0.enums.TrueupSurchargeType;
     readonly 'percentage'?: number;
     readonly 'per_weight_unit'?: number;
   }
@@ -327,5 +345,5 @@ declare namespace io.flow.billing.v0.unions {
   type BankAccountForm = (io.flow.billing.v0.models.BankAccountFormInfo | io.flow.billing.v0.models.BankAccountFormSimple);
   type PayoutStatus = (io.flow.billing.v0.models.PayoutStatusScheduled | io.flow.billing.v0.models.PayoutStatusSent | io.flow.billing.v0.models.PayoutStatusFailed);
   type Settlement = (io.flow.billing.v0.models.SettlementNoPayout | io.flow.billing.v0.models.SettlementPayout);
-  type TransactionMetadata = (io.flow.billing.v0.models.TransactionMetadataShippingLabel | io.flow.billing.v0.models.TransactionMetadataChannel | io.flow.billing.v0.models.TransactionMetadataTrueup);
+  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);
 }

package/generated/io.flow.external.paypal.v1.paypal.d.ts

@@ -11,6 +11,7 @@ declare namespace io.flow.external.paypal.v1.enums {
   type DisputeOutcomeCode = 'RESOLVED_BUYER_FAVOUR' | 'RESOLVED_SELLER_FAVOUR' | 'RESOLVED_WITH_PAYOUT' | 'CANCELED_BY_BUYER' | 'ACCEPTED' | 'DENIED' | 'NONE';
   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';
   type DisputeStatus = 'OPEN' | 'WAITING_FOR_BUYER_RESPONSE' | 'WAITING_FOR_SELLER_RESPONSE' | 'UNDER_REVIEW' | 'RESOLVED' | 'OTHER';
+  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';
   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';
   type FailureReason = 'UNABLE_TO_COMPLETE_TRANSACTION' | 'INVALID_PAYMENT_METHOD' | 'PAYER_CANNOT_PAY' | 'CANNOT_PAY_THIS_PAYEE' | 'REDIRECT_REQUIRED' | 'PAYEE_FILTER_RESTRICTIONS';
   type GrantType = 'client_credentials';
@@ -29,6 +30,7 @@ declare namespace io.flow.external.paypal.v1.enums {
   type RefundState = 'pending' | 'completed' | 'cancelled' | 'failed';
   type ReturnAcknowledgementType = 'ITEM_RECEIVED' | 'ITEM_NOT_RECEIVED' | 'DAMAGED' | 'EMPTY_PACKAGE_OR_DIFFERENT' | 'MISSING_ITEMS';
   type ReturnMode = 'SHIPPED' | 'IN_PERSON';
+  type SaleState = 'pending' | 'completed' | 'denied' | 'partially_refunded' | 'refunded';
   type ServiceStarted = 'YES' | 'NO' | 'RETURNED';
   type ShippingDisplayPreference = 'NO_SHIPPING' | 'GET_FROM_FILE' | 'SET_PROVIDED_ADDRESS';
   type State = 'created' | 'approved' | 'failed';
@@ -375,24 +377,24 @@ declare namespace io.flow.external.paypal.v1.models {
 
   interface Refund {
     readonly 'id': string;
-    readonly 'amount': io.flow.external.paypal.v1.models.RefundAmount;
+    readonly 'amount'?: io.flow.external.paypal.v1.models.SimpleAmount;
     readonly 'state': io.flow.external.paypal.v1.enums.RefundState;
     readonly 'sale_id': string;
-    readonly 'invoice_number': string;
+    readonly 'invoice_number'?: string;
     readonly 'capture_id'?: string;
     readonly 'parent_payment'?: string;
     readonly 'reason_code'?: string;
     readonly 'refund_reason_code'?: string;
     readonly 'refund_funding_type'?: string;
-    readonly 'create_time': string;
+    readonly 'refund_from_received_amount'?: io.flow.external.paypal.v1.models.Money;
+    readonly 'refund_from_transaction_fee'?: io.flow.external.paypal.v1.models.Money;
+    readonly 'total_refunded_amount'?: io.flow.external.paypal.v1.models.Money;
+    readonly 'refund_to_payer'?: io.flow.external.paypal.v1.models.Money;
+    readonly 'custom'?: string;
+    readonly 'create_time'?: string;
     readonly 'update_time'?: string;
   }
 
-  interface RefundAmount {
-    readonly 'total': string;
-    readonly 'currency': string;
-  }
-
   interface RefundDetails {
     readonly 'allowed_refund_amount'?: io.flow.external.paypal.v1.models.Money;
   }
@@ -402,7 +404,7 @@ declare namespace io.flow.external.paypal.v1.models {
   }
 
   interface RefundRequest {
-    readonly 'amount': io.flow.external.paypal.v1.models.RefundAmount;
+    readonly 'amount': io.flow.external.paypal.v1.models.SimpleAmount;
     readonly 'invoice_number': string;
   }
 
@@ -414,6 +416,28 @@ declare namespace io.flow.external.paypal.v1.models {
     readonly 'returned'?: boolean;
   }
 
+  interface Sale {
+    readonly 'id': string;
+    readonly 'state': io.flow.external.paypal.v1.enums.SaleState;
+    readonly 'parent_payment': string;
+    readonly 'invoice_number'?: string;
+    readonly 'amount'?: io.flow.external.paypal.v1.models.SimpleAmount;
+    readonly 'payment_mode'?: string;
+    readonly 'reason_code'?: string;
+    readonly 'protection_eligibility'?: string;
+    readonly 'protection_eligibility_type'?: string;
+    readonly 'receipt_id'?: string;
+    readonly 'soft_descriptor'?: string;
+    readonly 'exchange_rate'?: string;
+    readonly 'payment_hold_status'?: string;
+    readonly 'payment_hold_reasons'?: string[];
+    readonly 'transaction_fee'?: io.flow.external.paypal.v1.models.Money;
+    readonly 'receivable_amount'?: io.flow.external.paypal.v1.models.Money;
+    readonly 'custom'?: string;
+    readonly 'create_time'?: string;
+    readonly 'update_time'?: string;
+  }
+
   interface Seller {
     readonly 'email'?: string;
     readonly 'merchant_id'?: string;
@@ -439,6 +463,11 @@ declare namespace io.flow.external.paypal.v1.models {
     readonly 'state'?: string;
   }
 
+  interface SimpleAmount {
+    readonly 'total': string;
+    readonly 'currency': string;
+  }
+
   interface SupportingInfo {
     readonly 'notes'?: string;
     readonly 'source'?: io.flow.external.paypal.v1.enums.SupportingInfoSource;