@flowio/api-prop-types 10.16.39 → 10.16.40

package/lib/api.d.ts

@@ -1446,7 +1446,6 @@ declare namespace io.flow.shopify.external.v0.models {
     readonly 'id': number;
     readonly 'quantity': number;
     readonly 'fulfillable_quantity'?: number;
-    readonly 'fulfillment_service': string;
     readonly 'fulfillment_status'?: io.flow.shopify.external.v0.enums.FulfillmentStatusType;
     readonly 'grams'?: number;
     readonly 'price'?: string;
@@ -1467,7 +1466,6 @@ declare namespace io.flow.shopify.external.v0.models {
 
   interface ShopifyLineItemForm {
     readonly 'fulfillable_quantity'?: number;
-    readonly 'fulfillment_service': string;
     readonly 'fulfillment_status'?: io.flow.shopify.external.v0.enums.FulfillmentStatusType;
     readonly 'grams'?: number;
     readonly 'price'?: string;
@@ -1648,7 +1646,6 @@ declare namespace io.flow.shopify.external.v0.models {
     readonly 'title': string;
     readonly 'tax_lines': io.flow.shopify.external.v0.models.ShopifyTaxLine[];
     readonly 'carrier_identifier'?: string;
-    readonly 'requested_fulfillment_service_id'?: string;
   }
 
   interface ShopifyTaxLine {
@@ -1770,7 +1767,7 @@ declare namespace io.flow.shopify.external.v0.models {
 }
 
 declare namespace io.flow.apple.pay.v0.enums {
-  type ApplePayContactField = 'email' | 'name' | 'phone' | 'postal_address' | 'phonetic_name';
+  type ApplePayContactField = 'email' | 'name' | 'phone' | 'postalAddress' | 'phoneticName';
   type ApplePayLineItemType = 'final' | 'pending';
   type ApplePayMerchantCapability = 'supports3DS' | 'supportsCredit' | 'supportsDebit' | 'supportsEMV';
   type ApplePayShippingType = 'shipping' | 'delivery' | 'store_pickup' | 'service_pickup';
@@ -1781,7 +1778,7 @@ declare namespace io.flow.apple.pay.v0.models {
   interface ApplePayLineItem {
     readonly 'label': string;
     readonly 'type': io.flow.apple.pay.v0.enums.ApplePayLineItemType;
-    readonly 'amount': number;
+    readonly 'amount': string;
   }
 
   interface ApplePayPaymentContact {
@@ -1832,7 +1829,7 @@ declare namespace io.flow.apple.pay.v0.models {
   interface ApplePayShippingMethod {
     readonly 'label': string;
     readonly 'detail': string;
-    readonly 'amount': number;
+    readonly 'amount': string;
     readonly 'identifier': string;
   }
 }
@@ -1844,7 +1841,6 @@ declare namespace io.flow.v0.enums {
   type AddressVerificationResultFieldCode = 'matched' | 'not_available' | 'not_checked' | 'not_matched';
   type AdjustmentReasonKey = 'duty_deminimis' | 'vat_deminimis';
   type Aggregate = 'maximum' | 'minimum';
-  type AttachmentType = 'csv';
   type AttributeDataType = 'boolean' | 'integer' | 'decimal' | 'string' | 'json_array';
   type AttributeIntent = 'brand' | 'color' | 'countries_of_origin' | 'product_id' | 'fulfillment_method' | 'hazardous' | 'price' | 'size' | 'sku' | 'taxability' | 'consumer_url' | 'gtin' | 'mpn' | 'facet' | 'eccn' | 'returnable' | 'searchable' | 'barcode' | 'min_days_to_ship' | 'max_days_to_ship' | 'commercial_invoice_item_number' | 'include_in_product_feeds';
   type AuthenticationTechnique = 'anonymous' | 'session' | 'token' | 'partner_token' | 'user';
@@ -1973,7 +1969,8 @@ declare namespace io.flow.v0.enums {
   type PaymentSourceConfirmationActionType = 'cvv' | 'billing_address' | 'number';
   type PaymentStatus = 'requires_payment_method' | 'requires_action' | 'processing' | 'cancelled' | 'expired' | 'authorized' | 'reversed' | 'captured' | 'refunded' | 'in_dispute' | 'charged_back';
   type PaymentType = 'card' | 'klarna' | 'googlepay' | 'paypal' | 'applepay' | 'ideal' | 'sofort' | 'afterpay' | 'bancontact';
-  type PayoutStatusCode = 'scheduled' | 'sent' | 'cancelled' | 'failed' | 'succeeded';
+  type PayoutAttachmentType = 'transactions';
+  type PayoutStatusFailureCode = 'invalid_account_number' | 'could_not_process';
   type PermittedHttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
   type PhysicalDeliverySpecialSerivce = 'cold_storage' | 'hazardous' | 'perishable';
   type PostalType = 'eircode' | 'pin' | 'postal' | 'zip';
@@ -2007,6 +2004,7 @@ declare namespace io.flow.v0.enums {
   type ShopifyLocalizationMethod = 'api' | 'ssr';
   type ShopifySyncCheck = 'localized_variants' | 'flow_variant_metafields';
   type SortDirection = 'ascending' | 'descending';
+  type StatementAttachmentType = 'csv';
   type Strategy = 'range' | 'from' | 'to';
   type SubcatalogItemStatus = 'excluded' | 'included' | 'restricted';
   type SurchargeResponsibleParty = 'organization' | 'customer';
@@ -2471,7 +2469,7 @@ declare namespace io.flow.v0.models {
   }
 
   interface Attachment {
-    readonly 'type': io.flow.v0.enums.AttachmentType;
+    readonly 'type': io.flow.v0.enums.StatementAttachmentType;
     readonly 'url': string;
   }
 
@@ -3461,6 +3459,16 @@ declare namespace io.flow.v0.models {
     readonly 'channel_organization': io.flow.v0.models.ChannelOrganization;
   }
 
+  interface ChannelPayout {
+    readonly 'id': string;
+    readonly 'account': io.flow.v0.models.AccountReference;
+    readonly 'status': io.flow.v0.unions.PayoutStatus;
+    readonly 'amount': number;
+    readonly 'attachments': io.flow.v0.models.PayoutAttachment[];
+    readonly 'created_at': string;
+    readonly 'updated_at': string;
+  }
+
   interface ChannelRate {
     readonly 'placeholder'?: string;
   }
@@ -3524,6 +3532,7 @@ declare namespace io.flow.v0.models {
     readonly 'payment_request'?: io.flow.v0.models.BillingChannelPaymentRequestReference;
     readonly 'currency': string;
     readonly 'source': io.flow.v0.enums.TransactionSource;
+    readonly 'parent'?: io.flow.v0.models.ParentTransactionSummary;
     readonly 'gross': number;
     readonly 'fees': io.flow.v0.models.FeeDeduction[];
     readonly 'withholdings': io.flow.v0.models.WithholdingDeduction[];
@@ -3531,6 +3540,7 @@ declare namespace io.flow.v0.models {
     readonly 'net': number;
     readonly 'identifiers': Record<string, string>;
     readonly 'created_at': string;
+    readonly 'updated_at': string;
   }
 
   interface ChannelTransactionDeleted {
@@ -6771,11 +6781,6 @@ declare namespace io.flow.v0.models {
     readonly 'available_quantity': number;
   }
 
-  interface NoPayout {
-    readonly 'discriminator': 'no_payout';
-    readonly 'placeholder'?: string;
-  }
-
   interface NotificationDeletedV2 {
     readonly 'discriminator': 'notification_deleted_v2';
     readonly 'event_id': string;
@@ -7763,6 +7768,16 @@ declare namespace io.flow.v0.models {
     readonly 'organization_onboarding_state': io.flow.v0.models.OrganizationOnboardingState;
   }
 
+  interface OrganizationPayout {
+    readonly 'id': string;
+    readonly 'account': io.flow.v0.models.AccountReference;
+    readonly 'status': io.flow.v0.unions.PayoutStatus;
+    readonly 'amount': number;
+    readonly 'attachments': io.flow.v0.models.PayoutAttachment[];
+    readonly 'created_at': string;
+    readonly 'updated_at': string;
+  }
+
   interface OrganizationPutForm {
     readonly 'name'?: string;
     readonly 'environment'?: io.flow.v0.enums.Environment;
@@ -7933,6 +7948,11 @@ declare namespace io.flow.v0.models {
     readonly 'number'?: string;
   }
 
+  interface ParentTransactionSummary {
+    readonly 'id': string;
+    readonly 'source': io.flow.v0.enums.TransactionSource;
+  }
+
   interface PartnerCenter {
     readonly 'partner_reference': io.flow.v0.models.PartnerReference;
     readonly 'number'?: string;
@@ -8568,16 +8588,25 @@ declare namespace io.flow.v0.models {
     readonly 'payment': io.flow.v0.unions.Payment;
   }
 
-  interface Payout {
-    readonly 'discriminator': 'payout';
-    readonly 'status': io.flow.v0.models.PayoutStatus;
-    readonly 'amount': number;
-    readonly 'sent_on'?: string;
+  interface PayoutAttachment {
+    readonly 'type': io.flow.v0.enums.PayoutAttachmentType;
+    readonly 'url': string;
   }
 
-  interface PayoutStatus {
-    readonly 'code': io.flow.v0.enums.PayoutStatusCode;
-    readonly 'reason'?: string;
+  interface PayoutStatusFailed {
+    readonly 'code': 'failed';
+    readonly 'timestamp': string;
+    readonly 'reason': io.flow.v0.enums.PayoutStatusFailureCode;
+  }
+
+  interface PayoutStatusScheduled {
+    readonly 'code': 'scheduled';
+    readonly 'placeholder'?: string;
+  }
+
+  interface PayoutStatusSent {
+    readonly 'code': 'sent';
+    readonly 'timestamp': string;
   }
 
   interface PaypalAuthorizationDetails {
@@ -9987,6 +10016,18 @@ declare namespace io.flow.v0.models {
     readonly 'id': string;
   }
 
+  interface SettlementNoPayout {
+    readonly 'discriminator': 'no_payout';
+    readonly 'placeholder'?: string;
+  }
+
+  interface SettlementPayout {
+    readonly 'discriminator': 'payout';
+    readonly 'status': io.flow.v0.unions.PayoutStatus;
+    readonly 'amount': number;
+    readonly 'sent_on'?: string;
+  }
+
   interface SetupBlocked {
     readonly 'discriminator': 'setup_blocked';
     readonly 'reasons': io.flow.v0.enums.OnboardingBlockedReason[];
@@ -9994,7 +10035,7 @@ declare namespace io.flow.v0.models {
 
   interface SetupCompleted {
     readonly 'discriminator': 'setup_completed';
-    readonly 'placeholder'?: boolean;
+    readonly 'third_party_logistics_guid': string;
   }
 
   interface SetupInProgress {
@@ -11367,6 +11408,7 @@ declare namespace io.flow.v0.models {
     readonly 'payment_request'?: io.flow.v0.models.BillingChannelPaymentRequestReference;
     readonly 'currency': string;
     readonly 'source': io.flow.v0.enums.TransactionSource;
+    readonly 'parent'?: io.flow.v0.models.ParentTransactionSummary;
     readonly 'gross': number;
     readonly 'fees': io.flow.v0.models.FeeDeduction[];
     readonly 'withholdings': io.flow.v0.models.WithholdingDeduction[];
@@ -11374,6 +11416,7 @@ declare namespace io.flow.v0.models {
     readonly 'net': number;
     readonly 'identifiers': Record<string, string>;
     readonly 'created_at': string;
+    readonly 'updated_at': string;
   }
 
   interface TransactionDetailsCard {
@@ -11715,6 +11758,7 @@ declare namespace io.flow.v0.unions {
   type PaymentOrderReference = (io.flow.v0.models.AuthorizationOrderReference | io.flow.v0.models.PaymentPaymentRequestReference);
   type PaymentSource = (io.flow.v0.models.CardPaymentSource);
   type PaymentSourceForm = (io.flow.v0.models.CardPaymentSourceForm);
+  type PayoutStatus = (io.flow.v0.models.PayoutStatusScheduled | io.flow.v0.models.PayoutStatusSent | io.flow.v0.models.PayoutStatusFailed);
   type PriceSource = (io.flow.v0.models.PriceSourcePriceBook | io.flow.v0.models.PriceSourceCatalog | io.flow.v0.models.PriceSourceProvided);
   type Promotion = (io.flow.v0.models.FreeShipping | io.flow.v0.models.Discount);
   type QueryBuilderForm = (io.flow.v0.models.QueryBuilderFilterForm | io.flow.v0.models.QueryBuilderQueryForm);
@@ -11730,7 +11774,7 @@ declare namespace io.flow.v0.unions {
   type ServiceFee = (io.flow.v0.models.FuelSurchargeServiceFee | io.flow.v0.models.FuelSurchargeAmountByWeightServiceFee | io.flow.v0.models.RemoteAreaServiceFee | io.flow.v0.models.EmergencySituationSurchargeServiceFee | io.flow.v0.models.PeakSurchargeServiceFee | io.flow.v0.models.PeakSurchargeByWeightServiceFee | io.flow.v0.models.DutiesTaxesPaidSurchargeServiceFee);
   type Session = (io.flow.v0.models.OrganizationSession);
   type SessionAuthorization = (io.flow.v0.models.OrganizationSessionAuthorization);
-  type Settlement = (io.flow.v0.models.NoPayout | io.flow.v0.models.Payout);
+  type Settlement = (io.flow.v0.models.SettlementNoPayout | io.flow.v0.models.SettlementPayout);
   type ShippingLabelForm = (io.flow.v0.models.DetailedShippingLabelForm | io.flow.v0.models.SummaryShippingLabelForm);
   type ShippingNotificationForm = (io.flow.v0.models.DetailedShippingNotificationForm | io.flow.v0.models.SinglePackageShippingNotificationForm | io.flow.v0.models.SummaryShippingNotificationForm);
   type ShopifyCartAddForm = (io.flow.v0.models.ShopifyCartAddSingleForm | io.flow.v0.models.ShopifyCartAddMultipleForm);
@@ -11752,7 +11796,6 @@ export const addressFieldName: PropTypes.Requireable<io.flow.v0.enums.AddressFie
 export const addressVerificationResultFieldCode: PropTypes.Requireable<io.flow.v0.enums.AddressVerificationResultFieldCode>;
 export const adjustmentReasonKey: PropTypes.Requireable<io.flow.v0.enums.AdjustmentReasonKey>;
 export const aggregate: PropTypes.Requireable<io.flow.v0.enums.Aggregate>;
-export const attachmentType: PropTypes.Requireable<io.flow.v0.enums.AttachmentType>;
 export const attributeDataType: PropTypes.Requireable<io.flow.v0.enums.AttributeDataType>;
 export const attributeIntent: PropTypes.Requireable<io.flow.v0.enums.AttributeIntent>;
 export const authenticationTechnique: PropTypes.Requireable<io.flow.v0.enums.AuthenticationTechnique>;
@@ -11881,7 +11924,8 @@ export const paymentMethodType: PropTypes.Requireable<io.flow.v0.enums.PaymentMe
 export const paymentSourceConfirmationActionType: PropTypes.Requireable<io.flow.v0.enums.PaymentSourceConfirmationActionType>;
 export const paymentStatus: PropTypes.Requireable<io.flow.v0.enums.PaymentStatus>;
 export const paymentType: PropTypes.Requireable<io.flow.v0.enums.PaymentType>;
-export const payoutStatusCode: PropTypes.Requireable<io.flow.v0.enums.PayoutStatusCode>;
+export const payoutAttachmentType: PropTypes.Requireable<io.flow.v0.enums.PayoutAttachmentType>;
+export const payoutStatusFailureCode: PropTypes.Requireable<io.flow.v0.enums.PayoutStatusFailureCode>;
 export const permittedHttpMethod: PropTypes.Requireable<io.flow.v0.enums.PermittedHttpMethod>;
 export const physicalDeliverySpecialSerivce: PropTypes.Requireable<io.flow.v0.enums.PhysicalDeliverySpecialSerivce>;
 export const postalType: PropTypes.Requireable<io.flow.v0.enums.PostalType>;
@@ -11915,6 +11959,7 @@ export const shopifyGrant: PropTypes.Requireable<io.flow.v0.enums.ShopifyGrant>;
 export const shopifyLocalizationMethod: PropTypes.Requireable<io.flow.v0.enums.ShopifyLocalizationMethod>;
 export const shopifySyncCheck: PropTypes.Requireable<io.flow.v0.enums.ShopifySyncCheck>;
 export const sortDirection: PropTypes.Requireable<io.flow.v0.enums.SortDirection>;
+export const statementAttachmentType: PropTypes.Requireable<io.flow.v0.enums.StatementAttachmentType>;
 export const strategy: PropTypes.Requireable<io.flow.v0.enums.Strategy>;
 export const subcatalogItemStatus: PropTypes.Requireable<io.flow.v0.enums.SubcatalogItemStatus>;
 export const surchargeResponsibleParty: PropTypes.Requireable<io.flow.v0.enums.SurchargeResponsibleParty>;
@@ -12140,6 +12185,7 @@ export const channelOrganizationDeleted: PropTypes.Requireable<io.flow.v0.models
 export const channelOrganizationForm: PropTypes.Requireable<io.flow.v0.models.ChannelOrganizationForm>;
 export const channelOrganizationPutForm: PropTypes.Requireable<io.flow.v0.models.ChannelOrganizationPutForm>;
 export const channelOrganizationUpserted: PropTypes.Requireable<io.flow.v0.models.ChannelOrganizationUpserted>;
+export const channelPayout: PropTypes.Requireable<io.flow.v0.models.ChannelPayout>;
 export const channelRate: PropTypes.Requireable<io.flow.v0.models.ChannelRate>;
 export const channelReference: PropTypes.Requireable<io.flow.v0.models.ChannelReference>;
 export const channelStatement: PropTypes.Requireable<io.flow.v0.models.ChannelStatement>;
@@ -12615,7 +12661,6 @@ export const name: PropTypes.Requireable<io.flow.v0.models.Name>;
 export const nameForm: PropTypes.Requireable<io.flow.v0.models.NameForm>;
 export const noInventoryReservationError: PropTypes.Requireable<io.flow.v0.models.NoInventoryReservationError>;
 export const noInventoryReservationErrorItem: PropTypes.Requireable<io.flow.v0.models.NoInventoryReservationErrorItem>;
-export const noPayout: PropTypes.Requireable<io.flow.v0.models.NoPayout>;
 export const notificationDeletedV2: PropTypes.Requireable<io.flow.v0.models.NotificationDeletedV2>;
 export const notificationUpsertedV2: PropTypes.Requireable<io.flow.v0.models.NotificationUpsertedV2>;
 export const numberRange: PropTypes.Requireable<io.flow.v0.models.NumberRange>;
@@ -12752,6 +12797,7 @@ export const organizationForm: PropTypes.Requireable<io.flow.v0.models.Organizat
 export const organizationOnboardingState: PropTypes.Requireable<io.flow.v0.models.OrganizationOnboardingState>;
 export const organizationOnboardingStateDeleted: PropTypes.Requireable<io.flow.v0.models.OrganizationOnboardingStateDeleted>;
 export const organizationOnboardingStateUpserted: PropTypes.Requireable<io.flow.v0.models.OrganizationOnboardingStateUpserted>;
+export const organizationPayout: PropTypes.Requireable<io.flow.v0.models.OrganizationPayout>;
 export const organizationPutForm: PropTypes.Requireable<io.flow.v0.models.OrganizationPutForm>;
 export const organizationRatesData: PropTypes.Requireable<io.flow.v0.models.OrganizationRatesData>;
 export const organizationRatesPublished: PropTypes.Requireable<io.flow.v0.models.OrganizationRatesPublished>;
@@ -12774,6 +12820,7 @@ export const originalPrices: PropTypes.Requireable<io.flow.v0.models.OriginalPri
 export const outboundCartonFee: PropTypes.Requireable<io.flow.v0.models.OutboundCartonFee>;
 export const oversizedShipmentRatecardFee: PropTypes.Requireable<io.flow.v0.models.OversizedShipmentRatecardFee>;
 export const packaging: PropTypes.Requireable<io.flow.v0.models.Packaging>;
+export const parentTransactionSummary: PropTypes.Requireable<io.flow.v0.models.ParentTransactionSummary>;
 export const partnerCenter: PropTypes.Requireable<io.flow.v0.models.PartnerCenter>;
 export const partnerCenterForm: PropTypes.Requireable<io.flow.v0.models.PartnerCenterForm>;
 export const partnerReference: PropTypes.Requireable<io.flow.v0.models.PartnerReference>;
@@ -12874,8 +12921,10 @@ export const paymentSourceConfirmationAction: PropTypes.Requireable<io.flow.v0.m
 export const paymentTax: PropTypes.Requireable<io.flow.v0.models.PaymentTax>;
 export const paymentUpserted: PropTypes.Requireable<io.flow.v0.models.PaymentUpserted>;
 export const paymentVersion: PropTypes.Requireable<io.flow.v0.models.PaymentVersion>;
-export const payout: PropTypes.Requireable<io.flow.v0.models.Payout>;
-export const payoutStatus: PropTypes.Requireable<io.flow.v0.models.PayoutStatus>;
+export const payoutAttachment: PropTypes.Requireable<io.flow.v0.models.PayoutAttachment>;
+export const payoutStatusFailed: PropTypes.Requireable<io.flow.v0.models.PayoutStatusFailed>;
+export const payoutStatusScheduled: PropTypes.Requireable<io.flow.v0.models.PayoutStatusScheduled>;
+export const payoutStatusSent: PropTypes.Requireable<io.flow.v0.models.PayoutStatusSent>;
 export const paypalAuthorizationDetails: PropTypes.Requireable<io.flow.v0.models.PaypalAuthorizationDetails>;
 export const paypalAuthorizationForm: PropTypes.Requireable<io.flow.v0.models.PaypalAuthorizationForm>;
 export const peakSurchargeByWeightServiceFee: PropTypes.Requireable<io.flow.v0.models.PeakSurchargeByWeightServiceFee>;
@@ -13070,6 +13119,8 @@ export const sessionPutForm: PropTypes.Requireable<io.flow.v0.models.SessionPutF
 export const sessionReference: PropTypes.Requireable<io.flow.v0.models.SessionReference>;
 export const sessionVisit: PropTypes.Requireable<io.flow.v0.models.SessionVisit>;
 export const sessionVisitor: PropTypes.Requireable<io.flow.v0.models.SessionVisitor>;
+export const settlementNoPayout: PropTypes.Requireable<io.flow.v0.models.SettlementNoPayout>;
+export const settlementPayout: PropTypes.Requireable<io.flow.v0.models.SettlementPayout>;
 export const setupBlocked: PropTypes.Requireable<io.flow.v0.models.SetupBlocked>;
 export const setupCompleted: PropTypes.Requireable<io.flow.v0.models.SetupCompleted>;
 export const setupInProgress: PropTypes.Requireable<io.flow.v0.models.SetupInProgress>;
@@ -13360,6 +13411,7 @@ export const paymentMethodTag: PropTypes.Requireable<io.flow.v0.unions.PaymentMe
 export const paymentOrderReference: PropTypes.Requireable<io.flow.v0.unions.PaymentOrderReference>;
 export const paymentSource: PropTypes.Requireable<io.flow.v0.unions.PaymentSource>;
 export const paymentSourceForm: PropTypes.Requireable<io.flow.v0.unions.PaymentSourceForm>;
+export const payoutStatus: PropTypes.Requireable<io.flow.v0.unions.PayoutStatus>;
 export const priceSource: PropTypes.Requireable<io.flow.v0.unions.PriceSource>;
 export const promotion: PropTypes.Requireable<io.flow.v0.unions.Promotion>;
 export const queryBuilderForm: PropTypes.Requireable<io.flow.v0.unions.QueryBuilderForm>;