straddle 0.3.0 → 0.4.0

data/lib/straddle/models/charge_update_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute amount
       #   The amount of the charge in cents.
       #
@@ -16,8 +21,8 @@ module Straddle
       # @!attribute description
       #   An arbitrary description for the charge.
       #
-      #   @return [String]
-      required :description, String
+      #   @return [String, nil]
+      required :description, String, nil?: true
 
       # @!attribute payment_date
       #   The desired date on which the payment should be occur. For charges, this means
@@ -53,13 +58,15 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Straddle::Models::ChargeUpdateParams} for more details.
       #
+      #   @param id [String]
+      #
       #   @param amount [Integer] The amount of the charge in cents.
       #
-      #   @param description [String] An arbitrary description for the charge.
+      #   @param description [String, nil] An arbitrary description for the charge.
       #
       #   @param payment_date [Date] The desired date on which the payment should be occur. For charges, this means t
       #

data/lib/straddle/models/charge_v1.rb

@@ -81,8 +81,8 @@ module Straddle
         # @!attribute description
         #   An arbitrary description for the charge.
         #
-        #   @return [String]
-        required :description, String
+        #   @return [String, nil]
+        required :description, String, nil?: true
 
         # @!attribute device
         #   Information about the device used when the customer authorized the payment.
@@ -135,6 +135,12 @@ module Straddle
         required :status_history,
                  -> { Straddle::Internal::Type::ArrayOf[Straddle::ChargeV1::Data::StatusHistory] }
 
+        # @!attribute trace_ids
+        #   Trace Ids.
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :trace_ids, Straddle::Internal::Type::HashOf[String]
+
         # @!attribute updated_at
         #   Timestamp of when the charge was last updated.
         #
@@ -180,7 +186,15 @@ module Straddle
         #   @return [Time, nil]
         optional :processed_at, Time, nil?: true
 
-        # @!method initialize(id:, amount:, config:, consent_type:, created_at:, currency:, description:, device:, external_id:, funding_ids:, paykey:, payment_date:, status:, status_details:, status_history:, updated_at:, customer_details: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil)
+        # @!attribute related_payments
+        #   Related payments.
+        #
+        #   @return [Hash{Symbol=>Symbol, Straddle::Models::ChargeV1::Data::RelatedPayment}, nil]
+        optional :related_payments,
+                 -> { Straddle::Internal::Type::HashOf[enum: Straddle::ChargeV1::Data::RelatedPayment] },
+                 nil?: true
+
+        # @!method initialize(id:, amount:, config:, consent_type:, created_at:, currency:, description:, device:, external_id:, funding_ids:, paykey:, payment_date:, status:, status_details:, status_history:, trace_ids:, updated_at:, customer_details: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, related_payments: nil)
         #   Some parameter documentations has been truncated, see
         #   {Straddle::Models::ChargeV1::Data} for more details.
         #
@@ -196,7 +210,7 @@ module Straddle
         #
         #   @param currency [String] The currency of the charge. Only USD is supported.
         #
-        #   @param description [String] An arbitrary description for the charge.
+        #   @param description [String, nil] An arbitrary description for the charge.
         #
         #   @param device [Straddle::Models::DeviceInfoV1] Information about the device used when the customer authorized the payment.
         #
@@ -214,6 +228,8 @@ module Straddle
         #
         #   @param status_history [Array<Straddle::Models::ChargeV1::Data::StatusHistory>] Status history.
         #
+        #   @param trace_ids [Hash{Symbol=>String}] Trace Ids.
+        #
         #   @param updated_at [Time, nil] Timestamp of when the charge was last updated.
         #
         #   @param customer_details [Straddle::Models::CustomerDetailsV1] Information about the customer associated with the charge.
@@ -227,6 +243,8 @@ module Straddle
         #   @param payment_rail [Symbol, Straddle::Models::ChargeV1::Data::PaymentRail] The payment rail that the charge will be processed through.
         #
         #   @param processed_at [Time, nil] Timestamp of when the charge was processed by Straddle and originated to the pay
+        #
+        #   @param related_payments [Hash{Symbol=>Symbol, Straddle::Models::ChargeV1::Data::RelatedPayment}, nil] Related payments.
 
         # @see Straddle::Models::ChargeV1::Data#config
         class Config < Straddle::Internal::Type::BaseModel
@@ -236,17 +254,33 @@ module Straddle
           #   @return [Symbol, Straddle::Models::ChargeV1::Data::Config::BalanceCheck]
           required :balance_check, enum: -> { Straddle::ChargeV1::Data::Config::BalanceCheck }
 
+          # @!attribute auto_hold
+          #   Defines whether to automatically place this charge on hold after being created.
+          #
+          #   @return [Boolean, nil]
+          optional :auto_hold, Straddle::Internal::Type::Boolean, nil?: true
+
+          # @!attribute auto_hold_message
+          #   The reason the charge is being automatically held on creation.
+          #
+          #   @return [String, nil]
+          optional :auto_hold_message, String, nil?: true
+
           # @!attribute sandbox_outcome
           #   Payment will simulate processing if not Standard.
           #
           #   @return [Symbol, Straddle::Models::ChargeV1::Data::Config::SandboxOutcome, nil]
           optional :sandbox_outcome, enum: -> { Straddle::ChargeV1::Data::Config::SandboxOutcome }
 
-          # @!method initialize(balance_check:, sandbox_outcome: nil)
+          # @!method initialize(balance_check:, auto_hold: nil, auto_hold_message: nil, sandbox_outcome: nil)
           #   Configuration options for the charge.
           #
           #   @param balance_check [Symbol, Straddle::Models::ChargeV1::Data::Config::BalanceCheck] Defines whether to check the customer's balance before processing the charge.
           #
+          #   @param auto_hold [Boolean, nil] Defines whether to automatically place this charge on hold after being created.
+          #
+          #   @param auto_hold_message [String, nil] The reason the charge is being automatically held on creation.
+          #
           #   @param sandbox_outcome [Symbol, Straddle::Models::ChargeV1::Data::Config::SandboxOutcome] Payment will simulate processing if not Standard.
 
           # Defines whether to check the customer's balance before processing the charge.
@@ -316,6 +350,7 @@ module Straddle
           PENDING = :pending
           PAID = :paid
           REVERSED = :reversed
+          VALIDATING = :validating
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -405,6 +440,13 @@ module Straddle
             OK = :ok
             OTHER_NETWORK_RETURN = :other_network_return
             PAYOUT_REFUSED = :payout_refused
+            CANCEL_REQUEST = :cancel_request
+            FAILED_VERIFICATION = :failed_verification
+            REQUIRE_REVIEW = :require_review
+            BLOCKED_BY_SYSTEM = :blocked_by_system
+            WATCHTOWER_REVIEW = :watchtower_review
+            VALIDATING = :validating
+            AUTO_HOLD = :auto_hold
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -441,6 +483,7 @@ module Straddle
             PENDING = :pending
             PAID = :paid
             REVERSED = :reversed
+            VALIDATING = :validating
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -458,6 +501,17 @@ module Straddle
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        module RelatedPayment
+          extend Straddle::Internal::Type::Enum
+
+          ORIGINAL = :original
+          RESUBMIT = :resubmit
+          REFUND = :refund
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       # Indicates the structure of the returned content.

data/lib/straddle/models/customer_delete_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute correlation_id
       #
       #   @return [String, nil]
@@ -27,7 +32,8 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
       #   @param correlation_id [String]
       #   @param idempotency_key [String]
       #   @param request_id [String]

data/lib/straddle/models/customer_get_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute correlation_id
       #
       #   @return [String, nil]
@@ -22,7 +27,8 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
       #   @param correlation_id [String]
       #   @param request_id [String]
       #   @param straddle_account_id [String]

data/lib/straddle/models/customer_unmasked_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute correlation_id
       #
       #   @return [String, nil]
@@ -22,7 +27,8 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
       #   @param correlation_id [String]
       #   @param request_id [String]
       #   @param straddle_account_id [String]

data/lib/straddle/models/customer_update_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute device
       #
       #   @return [Straddle::Models::DeviceUnmaskedV1]
@@ -86,10 +91,12 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(device:, email:, name:, phone:, status:, address: nil, compliance_profile: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, device:, email:, name:, phone:, status:, address: nil, compliance_profile: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Straddle::Models::CustomerUpdateParams} for more details.
       #
+      #   @param id [String]
+      #
       #   @param device [Straddle::Models::DeviceUnmaskedV1]
       #
       #   @param email [String] The customer's email address.

data/lib/straddle/models/customers/review_decision_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
         # @!attribute status
         #   The final status of the customer review.
         #
@@ -34,7 +39,9 @@ module Straddle
         #   @return [String, nil]
         optional :straddle_account_id, String
 
-        # @!method initialize(status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        # @!method initialize(id:, status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        #   @param id [String]
+        #
         #   @param status [Symbol, Straddle::Models::Customers::ReviewDecisionParams::Status] The final status of the customer review.
         #
         #   @param correlation_id [String]

data/lib/straddle/models/customers/review_get_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
         # @!attribute correlation_id
         #
         #   @return [String, nil]
@@ -23,7 +28,8 @@ module Straddle
         #   @return [String, nil]
         optional :straddle_account_id, String
 
-        # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        #   @param id [String]
         #   @param correlation_id [String]
         #   @param request_id [String]
         #   @param straddle_account_id [String]

data/lib/straddle/models/customers/review_refresh_review_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
         # @!attribute correlation_id
         #
         #   @return [String, nil]
@@ -28,7 +33,8 @@ module Straddle
         #   @return [String, nil]
         optional :straddle_account_id, String
 
-        # @!method initialize(correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        # @!method initialize(id:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        #   @param id [String]
         #   @param correlation_id [String]
         #   @param idempotency_key [String]
         #   @param request_id [String]

data/lib/straddle/models/embed/account_get_params.rb

@@ -8,6 +8,12 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute account_id
+        #   The unique identifier of the account to retrieve.
+        #
+        #   @return [String]
+        required :account_id, String
+
         # @!attribute correlation_id
         #
         #   @return [String, nil]
@@ -18,9 +24,13 @@ module Straddle
         #   @return [String, nil]
         optional :request_id, String
 
-        # @!method initialize(correlation_id: nil, request_id: nil, request_options: {})
+        # @!method initialize(account_id:, correlation_id: nil, request_id: nil, request_options: {})
+        #   @param account_id [String] The unique identifier of the account to retrieve.
+        #
         #   @param correlation_id [String]
+        #
         #   @param request_id [String]
+        #
         #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/straddle/models/embed/account_onboard_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute account_id
+        #
+        #   @return [String]
+        required :account_id, String
+
         # @!attribute terms_of_service
         #
         #   @return [Straddle::Models::Embed::TermsOfServiceV1]
@@ -28,7 +33,8 @@ module Straddle
         #   @return [String, nil]
         optional :request_id, String
 
-        # @!method initialize(terms_of_service:, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+        # @!method initialize(account_id:, terms_of_service:, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+        #   @param account_id [String]
         #   @param terms_of_service [Straddle::Models::Embed::TermsOfServiceV1]
         #   @param correlation_id [String]
         #   @param idempotency_key [String]

data/lib/straddle/models/embed/account_paged_v1.rb

@@ -439,6 +439,8 @@ module Straddle
                 ONE_DAY = :one_day
                 TWO_DAY = :two_day
                 THREE_DAY = :three_day
+                FOUR_DAY = :four_day
+                FIVE_DAY = :five_day
 
                 # @!method self.values
                 #   @return [Array<Symbol>]
@@ -513,6 +515,8 @@ module Straddle
                 ONE_DAY = :one_day
                 TWO_DAY = :two_day
                 THREE_DAY = :three_day
+                FOUR_DAY = :four_day
+                FIVE_DAY = :five_day
 
                 # @!method self.values
                 #   @return [Array<Symbol>]

data/lib/straddle/models/embed/account_simulate_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute account_id
+        #
+        #   @return [String]
+        required :account_id, String
+
         # @!attribute final_status
         #
         #   @return [Symbol, Straddle::Models::Embed::AccountSimulateParams::FinalStatus, nil]
@@ -28,7 +33,8 @@ module Straddle
         #   @return [String, nil]
         optional :request_id, String
 
-        # @!method initialize(final_status: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+        # @!method initialize(account_id:, final_status: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+        #   @param account_id [String]
         #   @param final_status [Symbol, Straddle::Models::Embed::AccountSimulateParams::FinalStatus]
         #   @param correlation_id [String]
         #   @param idempotency_key [String]

data/lib/straddle/models/embed/account_update_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute account_id
+        #
+        #   @return [String]
+        required :account_id, String
+
         # @!attribute business_profile
         #
         #   @return [Straddle::Models::Embed::BusinessProfileV1]
@@ -42,10 +47,12 @@ module Straddle
         #   @return [String, nil]
         optional :request_id, String
 
-        # @!method initialize(business_profile:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+        # @!method initialize(account_id:, business_profile:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Straddle::Models::Embed::AccountUpdateParams} for more details.
         #
+        #   @param account_id [String]
+        #
         #   @param business_profile [Straddle::Models::Embed::BusinessProfileV1]
         #
         #   @param external_id [String, nil] Unique identifier for the account in your database, used for cross-referencing b

data/lib/straddle/models/embed/account_v1.rb

@@ -439,6 +439,8 @@ module Straddle
                 ONE_DAY = :one_day
                 TWO_DAY = :two_day
                 THREE_DAY = :three_day
+                FOUR_DAY = :four_day
+                FIVE_DAY = :five_day
 
                 # @!method self.values
                 #   @return [Array<Symbol>]
@@ -512,6 +514,8 @@ module Straddle
                 ONE_DAY = :one_day
                 TWO_DAY = :two_day
                 THREE_DAY = :three_day
+                FOUR_DAY = :four_day
+                FIVE_DAY = :five_day
 
                 # @!method self.values
                 #   @return [Array<Symbol>]

data/lib/straddle/models/embed/accounts/capability_request_create_params.rb

@@ -9,6 +9,11 @@ module Straddle
           extend Straddle::Internal::Type::RequestParameters::Converter
           include Straddle::Internal::Type::RequestParameters
 
+          # @!attribute account_id
+          #
+          #   @return [String]
+          required :account_id, String
+
           # @!attribute businesses
           #   Allows the account to accept payments from businesses.
           #
@@ -63,11 +68,13 @@ module Straddle
           #   @return [String, nil]
           optional :request_id, String
 
-          # @!method initialize(businesses: nil, charges: nil, individuals: nil, internet: nil, payouts: nil, signed_agreement: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+          # @!method initialize(account_id:, businesses: nil, charges: nil, individuals: nil, internet: nil, payouts: nil, signed_agreement: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams} for more
           #   details.
           #
+          #   @param account_id [String]
+          #
           #   @param businesses [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Businesses] Allows the account to accept payments from businesses.
           #
           #   @param charges [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Charges] The charges capability settings for the account.

data/lib/straddle/models/embed/accounts/capability_request_list_params.rb

@@ -9,6 +9,11 @@ module Straddle
           extend Straddle::Internal::Type::RequestParameters::Converter
           include Straddle::Internal::Type::RequestParameters
 
+          # @!attribute account_id
+          #
+          #   @return [String]
+          required :account_id, String
+
           # @!attribute category
           #   Filter capability requests by category.
           #
@@ -61,7 +66,9 @@ module Straddle
           #   @return [String, nil]
           optional :request_id, String
 
-          # @!method initialize(category: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, status: nil, type: nil, correlation_id: nil, request_id: nil, request_options: {})
+          # @!method initialize(account_id:, category: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, status: nil, type: nil, correlation_id: nil, request_id: nil, request_options: {})
+          #   @param account_id [String]
+          #
           #   @param category [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestListParams::Category] Filter capability requests by category.
           #
           #   @param page_number [Integer] Results page number. Starts at page 1.

data/lib/straddle/models/embed/accounts/capability_request_paged_v1.rb

@@ -68,6 +68,12 @@ module Straddle
             #   @return [Time]
             required :created_at, Time
 
+            # @!attribute enable
+            #   Whether this capability request is to enable or disable the capability.
+            #
+            #   @return [Boolean]
+            required :enable, Straddle::Internal::Type::Boolean
+
             # @!attribute status
             #   The current status of the capability request.
             #
@@ -94,7 +100,7 @@ module Straddle
                      Straddle::Internal::Type::HashOf[Straddle::Internal::Type::Unknown],
                      nil?: true
 
-            # @!method initialize(id:, account_id:, category:, created_at:, status:, type:, updated_at:, settings: nil)
+            # @!method initialize(id:, account_id:, category:, created_at:, enable:, status:, type:, updated_at:, settings: nil)
             #   Some parameter documentations has been truncated, see
             #   {Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data} for more
             #   details.
@@ -107,6 +113,8 @@ module Straddle
             #
             #   @param created_at [Time] Timestamp of when the capability request was created.
             #
+            #   @param enable [Boolean] Whether this capability request is to enable or disable the capability.
+            #
             #   @param status [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data::Status] The current status of the capability request.
             #
             #   @param type [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data::Type] The specific type of capability being requested within the category.

data/lib/straddle/models/embed/address_v1.rb

@@ -4,35 +4,29 @@ module Straddle
   module Models
     module Embed
       class AddressV1 < Straddle::Internal::Type::BaseModel
-        # @!attribute address1
-        #   Primary address line (e.g., street, PO Box).
-        #
-        #   @return [String]
-        required :address1, String
-
         # @!attribute city
         #   City, district, suburb, town, or village.
         #
         #   @return [String, nil]
         required :city, String, nil?: true
 
-        # @!attribute state
-        #   Two-letter state code.
+        # @!attribute line1
+        #   Primary address line (e.g., street, PO Box).
         #
         #   @return [String, nil]
-        required :state, String, nil?: true
+        required :line1, String, nil?: true
 
-        # @!attribute zip
-        #   Zip or postal code.
+        # @!attribute postal_code
+        #   Postal or ZIP code.
         #
-        #   @return [String]
-        required :zip, String
+        #   @return [String, nil]
+        required :postal_code, String, nil?: true
 
-        # @!attribute address2
-        #   Secondary address line (e.g., apartment, suite, unit, or building).
+        # @!attribute state
+        #   Two-letter state code.
         #
         #   @return [String, nil]
-        optional :address2, String, nil?: true
+        required :state, String, nil?: true
 
         # @!attribute country
         #   The country of the address, in ISO 3166-1 alpha-2 format.
@@ -40,44 +34,26 @@ module Straddle
         #   @return [String, nil]
         optional :country, String, nil?: true
 
-        # @!attribute line1
-        #   Primary address line (e.g., street, PO Box).
-        #
-        #   @return [String, nil]
-        optional :line1, String, nil?: true
-
         # @!attribute line2
         #   Secondary address line (e.g., apartment, suite, unit, or building).
         #
         #   @return [String, nil]
         optional :line2, String, nil?: true
 
-        # @!attribute postal_code
-        #   Postal or ZIP code.
-        #
-        #   @return [String, nil]
-        optional :postal_code, String, nil?: true
-
-        # @!method initialize(address1:, city:, state:, zip:, address2: nil, country: nil, line1: nil, line2: nil, postal_code: nil)
+        # @!method initialize(city:, line1:, postal_code:, state:, country: nil, line2: nil)
         #   The address object is optional. If provided, it must be a valid address.
         #
-        #   @param address1 [String] Primary address line (e.g., street, PO Box).
-        #
         #   @param city [String, nil] City, district, suburb, town, or village.
         #
-        #   @param state [String, nil] Two-letter state code.
+        #   @param line1 [String, nil] Primary address line (e.g., street, PO Box).
         #
-        #   @param zip [String] Zip or postal code.
+        #   @param postal_code [String, nil] Postal or ZIP code.
         #
-        #   @param address2 [String, nil] Secondary address line (e.g., apartment, suite, unit, or building).
+        #   @param state [String, nil] Two-letter state code.
         #
         #   @param country [String, nil] The country of the address, in ISO 3166-1 alpha-2 format.
         #
-        #   @param line1 [String, nil] Primary address line (e.g., street, PO Box).
-        #
         #   @param line2 [String, nil] Secondary address line (e.g., apartment, suite, unit, or building).
-        #
-        #   @param postal_code [String, nil] Postal or ZIP code.
       end
     end
   end