@flowio/types 11.24.22 → 11.24.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowio/types",
-  "version": "11.24.22",
+  "version": "11.24.23",
   "description": "TypeScript type definitions for custom types found in Flow API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,5 +25,5 @@
   "maintainers": [
     "Christian Muñoz <christian.munoz@flow.io>"
   ],
-  "gitHead": "864d87fe3c12ee52be8ba5f1e8867318d1bec420"
+  "gitHead": "f35925cb8986e0716d9dcdec6be43879dd1d3c0d"
 }

package/src/api-internal.ts

@@ -1215,120 +1215,6 @@ declare namespace io.flow.reference.v0.models {
   }
 }
 
-declare namespace io.flow.tracking.v0.enums {
-  type TrackingStatus =
-    | 'label_created'
-    | 'pending'
-    | 'info_received'
-    | 'picked_up'
-    | 'in_transit'
-    | 'out_for_delivery'
-    | 'attempt_fail'
-    | 'delivered'
-    | 'exception'
-    | 'returned'
-    | 'expired';
-}
-
-declare namespace io.flow.tracking.v0.models {
-  interface Tracking {
-    readonly id: string;
-    readonly labels: io.flow.tracking.v0.models.TrackingLabel[];
-    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
-    readonly attributes: Record<string, string>;
-    readonly url: string;
-    readonly window?: io.flow.common.v0.models.DatetimeRange;
-    readonly order_number?: string;
-  }
-
-  interface TrackingEvent {
-    readonly id: string;
-    readonly address: io.flow.common.v0.models.Address;
-    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
-    readonly timestamp: string;
-    readonly description?: string;
-  }
-
-  interface TrackingEventForm {
-    readonly tracking_label_id: string;
-    readonly timestamp: string;
-    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
-    readonly description?: string;
-    readonly address?: string;
-  }
-
-  interface TrackingEventSummary {
-    readonly id: string;
-    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
-    readonly timestamp: string;
-  }
-
-  interface TrackingEventVersion {
-    readonly id: string;
-    readonly timestamp: string;
-    readonly type: io.flow.common.v0.enums.ChangeType;
-    readonly tracking_event: io.flow.tracking.v0.models.TrackingEventSummary;
-  }
-
-  interface TrackingForm {
-    readonly status?: io.flow.tracking.v0.enums.TrackingStatus;
-    readonly order_number?: string;
-    readonly attributes?: Record<string, string>;
-    readonly window?: io.flow.common.v0.models.DatetimeRange;
-  }
-
-  interface TrackingLabel {
-    readonly id: string;
-    readonly carrier: string;
-    readonly carrier_tracking_number: string;
-    readonly events: io.flow.tracking.v0.models.TrackingEvent[];
-    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
-    readonly timestamp: string;
-    readonly delivery_estimate?: string;
-    readonly description?: string;
-  }
-
-  interface TrackingLabelForm {
-    readonly tracking_id: string;
-    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
-    readonly carrier: string;
-    readonly carrier_tracking_number: string;
-    readonly delivery_estimate?: string;
-    readonly description?: string;
-    readonly timestamp?: string;
-    readonly cost?: io.flow.common.v0.models.Money;
-    readonly ratecard_owner?: io.flow.fulfillment.v0.enums.RatecardOwner;
-  }
-
-  interface TrackingLabelSummary {
-    readonly id: string;
-    readonly tracking: io.flow.tracking.v0.models.TrackingSummary;
-    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
-    readonly carrier: string;
-    readonly tracking_number: string;
-  }
-
-  interface TrackingLabelVersion {
-    readonly id: string;
-    readonly timestamp: string;
-    readonly type: io.flow.common.v0.enums.ChangeType;
-    readonly tracking_label: io.flow.tracking.v0.models.TrackingLabelSummary;
-  }
-
-  interface TrackingSummary {
-    readonly id: string;
-    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
-    readonly order_number?: string;
-  }
-
-  interface TrackingVersion {
-    readonly id: string;
-    readonly timestamp: string;
-    readonly type: io.flow.common.v0.enums.ChangeType;
-    readonly tracking: io.flow.tracking.v0.models.TrackingSummary;
-  }
-}
-
 declare namespace io.flow.RESERVED_WORD_export.v0.enums {
   type ExportStatus = 'created' | 'processing' | 'completed' | 'failed';
   type ItemIdentifier = 'item_number' | 'sku';
@@ -2354,6 +2240,7 @@ declare namespace io.flow.payment.v0.models {
     readonly discriminator: 'direct_debit';
     readonly routing_number: string;
     readonly last4: string;
+    readonly additional_data?: Record<string, string>;
   }
 
   interface Expiration {
@@ -2750,6 +2637,9 @@ declare namespace io.flow.payment.v0.models {
   interface ThreeDSecure {
     readonly code: io.flow.payment.v0.enums.ThreeDSecureCode;
     readonly description?: string;
+    readonly eci?: string;
+    readonly liability_sift?: boolean;
+    readonly version?: string;
   }
 
   interface ThreedsChallengeActionDetails {
@@ -3897,6 +3787,17 @@ declare namespace io.flow.label.v0.enums {
 }
 
 declare namespace io.flow.label.v0.models {
+  interface BridgeManifest {
+    readonly id: string;
+    readonly service: io.flow.fulfillment.v0.models.ServiceSummary;
+    readonly pdf: string;
+    readonly data: string;
+  }
+
+  interface BridgeManifestForm {
+    readonly order_numbers: string[];
+  }
+
   interface CrossdockShipment {
     readonly partner_id: string;
     readonly center_id: string;
@@ -10331,6 +10232,312 @@ declare namespace io.flow.crypto.v0.models {
   }
 }
 
+declare namespace io.flow.tracking.v0.enums {
+  type TrackingStatus =
+    | 'label_created'
+    | 'pending'
+    | 'info_received'
+    | 'picked_up'
+    | 'in_transit'
+    | 'out_for_delivery'
+    | 'attempt_fail'
+    | 'delivered'
+    | 'exception'
+    | 'returned'
+    | 'expired';
+}
+
+declare namespace io.flow.tracking.v0.models {
+  interface Tracking {
+    readonly id: string;
+    readonly labels: io.flow.tracking.v0.models.TrackingLabel[];
+    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
+    readonly attributes: Record<string, string>;
+    readonly url: string;
+    readonly window?: io.flow.common.v0.models.DatetimeRange;
+    readonly order_number?: string;
+  }
+
+  interface TrackingEvent {
+    readonly id: string;
+    readonly address: io.flow.common.v0.models.Address;
+    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
+    readonly timestamp: string;
+    readonly description?: string;
+  }
+
+  interface TrackingEventForm {
+    readonly tracking_label_id: string;
+    readonly timestamp: string;
+    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
+    readonly description?: string;
+    readonly address?: string;
+  }
+
+  interface TrackingEventSummary {
+    readonly id: string;
+    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
+    readonly timestamp: string;
+  }
+
+  interface TrackingEventVersion {
+    readonly id: string;
+    readonly timestamp: string;
+    readonly type: io.flow.common.v0.enums.ChangeType;
+    readonly tracking_event: io.flow.tracking.v0.models.TrackingEventSummary;
+  }
+
+  interface TrackingForm {
+    readonly status?: io.flow.tracking.v0.enums.TrackingStatus;
+    readonly order_number?: string;
+    readonly attributes?: Record<string, string>;
+    readonly window?: io.flow.common.v0.models.DatetimeRange;
+  }
+
+  interface TrackingLabel {
+    readonly id: string;
+    readonly carrier: string;
+    readonly carrier_tracking_number: string;
+    readonly events: io.flow.tracking.v0.models.TrackingEvent[];
+    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
+    readonly timestamp: string;
+    readonly delivery_estimate?: string;
+    readonly description?: string;
+  }
+
+  interface TrackingLabelForm {
+    readonly tracking_id: string;
+    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
+    readonly carrier: string;
+    readonly carrier_tracking_number: string;
+    readonly delivery_estimate?: string;
+    readonly description?: string;
+    readonly timestamp?: string;
+    readonly cost?: io.flow.common.v0.models.Money;
+    readonly ratecard_owner?: io.flow.fulfillment.v0.enums.RatecardOwner;
+  }
+
+  interface TrackingLabelSummary {
+    readonly id: string;
+    readonly tracking: io.flow.tracking.v0.models.TrackingSummary;
+    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
+    readonly carrier: string;
+    readonly tracking_number: string;
+  }
+
+  interface TrackingLabelVersion {
+    readonly id: string;
+    readonly timestamp: string;
+    readonly type: io.flow.common.v0.enums.ChangeType;
+    readonly tracking_label: io.flow.tracking.v0.models.TrackingLabelSummary;
+  }
+
+  interface TrackingSummary {
+    readonly id: string;
+    readonly status: io.flow.tracking.v0.enums.TrackingStatus;
+    readonly order_number?: string;
+  }
+
+  interface TrackingVersion {
+    readonly id: string;
+    readonly timestamp: string;
+    readonly type: io.flow.common.v0.enums.ChangeType;
+    readonly tracking: io.flow.tracking.v0.models.TrackingSummary;
+  }
+}
+
+declare namespace io.flow.merchant.onboarding.v0.enums {
+  type OnboardingApplicationStatus =
+    | 'to_do'
+    | 'in_progress'
+    | 'on_hold'
+    | 'rejected'
+    | 'accepted';
+  type OnboardingTradeSector =
+    | 'accessories'
+    | 'animals_and_pet_supplies'
+    | 'apparel'
+    | 'apparel_and_accessories'
+    | 'arts_and_entertainment'
+    | 'baby_and_toddler'
+    | 'business_and_industrial'
+    | 'cameras_and_optics'
+    | 'electronics'
+    | 'food_beverages_and_tobacco'
+    | 'furniture'
+    | 'gift_cards'
+    | 'hardware'
+    | 'health_and_beauty'
+    | 'home_and_garden'
+    | 'jewelry'
+    | 'luggage_and_bags'
+    | 'mature'
+    | 'media'
+    | 'office_supplies'
+    | 'paper_and_art'
+    | 'religious_and_ceremonial'
+    | 'software'
+    | 'sporting_goods'
+    | 'sports_and_fitness'
+    | 'toys_and_games'
+    | 'toys_hobbies_gifts'
+    | 'vehicles_and_parts'
+    | 'other';
+  type RegionType = 'state' | 'province' | 'jurisdiction';
+}
+
+declare namespace io.flow.merchant.onboarding.v0.models {
+  interface MerchantInfo {
+    readonly legal_name?: string;
+    readonly country: string;
+    readonly region?: io.flow.merchant.onboarding.v0.enums.RegionType;
+    readonly region_value?: string;
+  }
+
+  interface MerchantOnboardingAddress {
+    readonly full_name?: string;
+    readonly streets?: string[];
+    readonly city?: string;
+    readonly province?: string;
+    readonly postal?: string;
+    readonly country?: string;
+  }
+
+  interface MonthlyAverage {
+    readonly volume?: io.flow.merchant.onboarding.v0.models.MonthlyAverageVolume;
+    readonly number_transactions?: number;
+  }
+
+  interface MonthlyAverageVolume {
+    readonly amount?: number;
+    readonly currency?: string;
+  }
+
+  interface OnboardingMerchantPickupWindow {
+    readonly from: io.flow.merchant.onboarding.v0.models.OnboardingMerchantTime;
+    readonly to: io.flow.merchant.onboarding.v0.models.OnboardingMerchantTime;
+  }
+
+  interface OnboardingMerchantScheduledPickup {
+    readonly day_of_week: io.flow.common.v0.enums.DayOfWeek;
+    readonly window: io.flow.merchant.onboarding.v0.models.OnboardingMerchantPickupWindow;
+    readonly instructions?: string;
+  }
+
+  interface OnboardingMerchantTime {
+    readonly hour_of_day: string;
+    readonly minute_of_hour: string;
+    readonly timezone?: string;
+  }
+
+  interface OnboardingOrganizationReference {
+    readonly id: string;
+    readonly status: io.flow.common.v0.enums.OrganizationStatus;
+  }
+
+  interface OperationsContact {
+    readonly full_name?: string;
+    readonly company?: string;
+    readonly email?: string;
+    readonly phone?: string;
+  }
+
+  interface ShopifyMerchantApplication {
+    readonly discriminator: 'shopify_merchant_application';
+    readonly id: string;
+    readonly organization_id: string;
+    readonly organization_reference: io.flow.merchant.onboarding.v0.models.OnboardingOrganizationReference;
+    readonly status: io.flow.merchant.onboarding.v0.enums.OnboardingApplicationStatus;
+    readonly company?: io.flow.merchant.onboarding.v0.models.MerchantInfo;
+    readonly indirect_tax_number?: string;
+    readonly parent_company?: io.flow.merchant.onboarding.v0.models.MerchantInfo;
+    readonly beneficiary?: string;
+    readonly ultimate_beneficiary_owner?: io.flow.merchant.onboarding.v0.models.UltimateBeneficiaryOwner;
+    readonly business_url?: string;
+    readonly business_description?: string;
+    readonly business_address?: io.flow.common.v0.models.Address;
+    readonly refund_percentage?: number;
+    readonly chargeback_percentage?: number;
+    readonly bank_account_number?: string;
+    readonly aba_routing_transit_number?: string;
+    readonly trade_sectors?: io.flow.merchant.onboarding.v0.enums.OnboardingTradeSector[];
+    readonly other_trade_sector?: string;
+    readonly third_party_logistics_partners?: io.flow.merchant.onboarding.v0.models.ThirdPartyLogisticsPartner[];
+    readonly average_order_weight?: number;
+    readonly package_dimensions?: io.flow.common.v0.models.Dimension[];
+    readonly monthly_average?: io.flow.merchant.onboarding.v0.models.MonthlyAverage;
+    readonly dangerous_goods?: boolean;
+    readonly default_country_of_origin?: string;
+    readonly ratecard?: io.flow.ratecard.v0.models.RatecardReference;
+    readonly rate_card: string;
+    readonly created_at: string;
+    readonly activated_at?: string;
+  }
+
+  interface ShopifyMerchantApplicationForm {
+    readonly discriminator: 'shopify_merchant_application_form';
+    readonly company?: io.flow.merchant.onboarding.v0.models.MerchantInfo;
+    readonly indirect_tax_number?: string;
+    readonly parent_company?: io.flow.merchant.onboarding.v0.models.MerchantInfo;
+    readonly beneficiary?: string;
+    readonly ultimate_beneficiary_owner?: io.flow.merchant.onboarding.v0.models.UltimateBeneficiaryOwner;
+    readonly business_url?: string;
+    readonly business_description?: string;
+    readonly business_address?: io.flow.common.v0.models.Address;
+    readonly refund_percentage?: number;
+    readonly chargeback_percentage?: number;
+    readonly bank_account_number?: string;
+    readonly aba_routing_transit_number?: string;
+    readonly trade_sectors?: io.flow.merchant.onboarding.v0.enums.OnboardingTradeSector[];
+    readonly other_trade_sector?: string;
+    readonly third_party_logistics_partners?: io.flow.merchant.onboarding.v0.models.ThirdPartyLogisticsPartner[];
+    readonly average_order_weight?: number;
+    readonly package_dimensions?: io.flow.common.v0.models.Dimension[];
+    readonly monthly_average_volume_amount?: number;
+    readonly monthly_average_volume_currency?: string;
+    readonly monthly_average_number_transactions?: number;
+    readonly dangerous_goods?: boolean;
+    readonly default_country_of_origin?: string;
+    readonly ratecard_id?: string;
+    readonly rate_card: string;
+  }
+
+  interface ShopifyMerchantApplicationPutForm {
+    readonly discriminator: 'shopify_merchant_application_put_form';
+    readonly status?: io.flow.merchant.onboarding.v0.enums.OnboardingApplicationStatus;
+  }
+
+  interface ShopifyMerchantApplicationsSummary {
+    readonly discriminator: 'shopify_merchant_applications_summary';
+    readonly total: number;
+  }
+
+  interface ThirdPartyLogisticsPartner {
+    readonly warehouse_address: io.flow.merchant.onboarding.v0.models.MerchantOnboardingAddress;
+    readonly warehouse_url?: string;
+    readonly location?: io.flow.merchant.onboarding.v0.models.MerchantOnboardingAddress;
+    readonly scheduled_pickups?: io.flow.merchant.onboarding.v0.models.OnboardingMerchantScheduledPickup[];
+    readonly operations_contact: io.flow.merchant.onboarding.v0.models.OperationsContact;
+    readonly center_id?: string;
+  }
+
+  interface UltimateBeneficiaryOwner {
+    readonly name: string;
+    readonly dob: string;
+  }
+}
+
+declare namespace io.flow.merchant.onboarding.v0.unions {
+  type MerchantApplication =
+    io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplication;
+  type MerchantApplicationForm =
+    io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationForm;
+  type MerchantApplicationPutForm =
+    io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationPutForm;
+  type MerchantApplicationsSummary =
+    io.flow.merchant.onboarding.v0.models.ShopifyMerchantApplicationsSummary;
+}
+
 declare namespace io.flow.catalog.v0.enums {
   type AdjustmentReasonKey = 'duty_deminimis' | 'vat_deminimis';
   type AttributeIntent =
@@ -14630,6 +14837,8 @@ declare namespace io.flow.internal.v0.models {
     readonly adjustment: io.flow.common.v0.models.Price;
     readonly capture: io.flow.common.v0.models.Price;
     readonly refund: io.flow.common.v0.models.Price;
+    readonly credit_payment: io.flow.common.v0.models.Price;
+    readonly fully_subsidized_order: io.flow.common.v0.models.Price;
     readonly virtual_card_capture: io.flow.common.v0.models.Price;
     readonly virtual_card_refund: io.flow.common.v0.models.Price;
     readonly tax_remittance: io.flow.common.v0.models.Price;
@@ -21244,6 +21453,11 @@ declare namespace io.flow.internal.v0.models {
     readonly flow_authorization?: io.flow.payment.v0.unions.Authorization;
   }
 
+  interface MerchantApplicationSummary {
+    readonly merchant_application: io.flow.merchant.onboarding.v0.unions.MerchantApplication;
+    readonly organization_reference: io.flow.common.v0.models.Organization;
+  }
+
   interface MerchantOfRecordEntitySettings {
     readonly id: string;
     readonly merchant_of_record_entity: io.flow.common.v0.models.MerchantOfRecordEntity;
@@ -27691,6 +27905,8 @@ export type MarketingGatewaySourceSummary =
 export type MarketingGatewaySupportedChannelDetails =
   io.flow.internal.v0.models.MarketingGatewaySupportedChannelDetails;
 export type MarketsOrder = io.flow.internal.v0.models.MarketsOrder;
+export type MerchantApplicationSummary =
+  io.flow.internal.v0.models.MerchantApplicationSummary;
 export type MerchantOfRecordEntitySettings =
   io.flow.internal.v0.models.MerchantOfRecordEntitySettings;
 export type MerchantOfRecordEntitySettingsForm =