paypal-server-sdk 1.0.0 → 2.0.0

data/lib/paypal_server_sdk/models/subscription_billing_cycle.rb

@@ -0,0 +1,108 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The billing cycle details.
+  class SubscriptionBillingCycle < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The pricing scheme details.
+    # @return [SubscriptionPricingScheme]
+    attr_accessor :pricing_scheme
+
+    # The frequency of the billing cycle.
+    # @return [Frequency]
+    attr_accessor :frequency
+
+    # The tenure type of the billing cycle. In case of a plan having trial
+    # cycle, only 2 trial cycles are allowed per plan.
+    # @return [TenureType]
+    attr_accessor :tenure_type
+
+    # The order in which this cycle is to run among other billing cycles. For
+    # example, a trial billing cycle has a `sequence` of `1` while a regular
+    # billing cycle has a `sequence` of `2`, so that trial cycle runs before the
+    # regular cycle.
+    # @return [Integer]
+    attr_accessor :sequence
+
+    # The number of times this billing cycle gets executed. Trial billing cycles
+    # can only be executed a finite number of times (value between 1 and 999 for
+    # total_cycles). Regular billing cycles can be executed infinite times
+    # (value of 0 for total_cycles) or a finite number of times (value between 1
+    # and 999 for total_cycles).
+    # @return [Integer]
+    attr_accessor :total_cycles
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['frequency'] = 'frequency'
+      @_hash['tenure_type'] = 'tenure_type'
+      @_hash['sequence'] = 'sequence'
+      @_hash['total_cycles'] = 'total_cycles'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pricing_scheme
+        total_cycles
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(frequency:, tenure_type:, sequence:, pricing_scheme: SKIP,
+                   total_cycles: 1)
+      @pricing_scheme = pricing_scheme unless pricing_scheme == SKIP
+      @frequency = frequency
+      @tenure_type = tenure_type
+      @sequence = sequence
+      @total_cycles = total_cycles unless total_cycles == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      frequency = Frequency.from_hash(hash['frequency']) if hash['frequency']
+      tenure_type = hash.key?('tenure_type') ? hash['tenure_type'] : nil
+      sequence = hash.key?('sequence') ? hash['sequence'] : nil
+      pricing_scheme = SubscriptionPricingScheme.from_hash(hash['pricing_scheme']) if
+        hash['pricing_scheme']
+      total_cycles = hash['total_cycles'] ||= 1
+
+      # Create object from extracted values.
+      SubscriptionBillingCycle.new(frequency: frequency,
+                                   tenure_type: tenure_type,
+                                   sequence: sequence,
+                                   pricing_scheme: pricing_scheme,
+                                   total_cycles: total_cycles)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pricing_scheme: #{@pricing_scheme}, frequency: #{@frequency}, tenure_type:"\
+      " #{@tenure_type}, sequence: #{@sequence}, total_cycles: #{@total_cycles}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pricing_scheme: #{@pricing_scheme.inspect}, frequency:"\
+      " #{@frequency.inspect}, tenure_type: #{@tenure_type.inspect}, sequence:"\
+      " #{@sequence.inspect}, total_cycles: #{@total_cycles.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_billing_information.rb

@@ -0,0 +1,148 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The billing details for the subscription. If the subscription was or is
+  # active, these fields are populated.
+  class SubscriptionBillingInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :outstanding_balance
+
+    # The trial and regular billing executions.
+    # @return [Array[CycleExecution]]
+    attr_accessor :cycle_executions
+
+    # The details for the last payment.
+    # @return [LastPaymentDetails]
+    attr_accessor :last_payment
+
+    # The date and time, in [Internet date and time
+    # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
+    # @return [String]
+    attr_accessor :next_billing_time
+
+    # The date and time, in [Internet date and time
+    # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
+    # @return [String]
+    attr_accessor :final_payment_time
+
+    # The number of consecutive payment failures. Resets to `0` after a
+    # successful payment. If this reaches the `payment_failure_threshold` value,
+    # the subscription updates to the `SUSPENDED` state.
+    # @return [Integer]
+    attr_accessor :failed_payments_count
+
+    # The details for the failed payment of the subscription.
+    # @return [FailedPaymentDetails]
+    attr_accessor :last_failed_payment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['outstanding_balance'] = 'outstanding_balance'
+      @_hash['cycle_executions'] = 'cycle_executions'
+      @_hash['last_payment'] = 'last_payment'
+      @_hash['next_billing_time'] = 'next_billing_time'
+      @_hash['final_payment_time'] = 'final_payment_time'
+      @_hash['failed_payments_count'] = 'failed_payments_count'
+      @_hash['last_failed_payment'] = 'last_failed_payment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cycle_executions
+        last_payment
+        next_billing_time
+        final_payment_time
+        last_failed_payment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(outstanding_balance:, failed_payments_count:,
+                   cycle_executions: SKIP, last_payment: SKIP,
+                   next_billing_time: SKIP, final_payment_time: SKIP,
+                   last_failed_payment: SKIP)
+      @outstanding_balance = outstanding_balance
+      @cycle_executions = cycle_executions unless cycle_executions == SKIP
+      @last_payment = last_payment unless last_payment == SKIP
+      @next_billing_time = next_billing_time unless next_billing_time == SKIP
+      @final_payment_time = final_payment_time unless final_payment_time == SKIP
+      @failed_payments_count = failed_payments_count
+      @last_failed_payment = last_failed_payment unless last_failed_payment == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      outstanding_balance = Money.from_hash(hash['outstanding_balance']) if
+        hash['outstanding_balance']
+      failed_payments_count =
+        hash.key?('failed_payments_count') ? hash['failed_payments_count'] : nil
+      # Parameter is an array, so we need to iterate through it
+      cycle_executions = nil
+      unless hash['cycle_executions'].nil?
+        cycle_executions = []
+        hash['cycle_executions'].each do |structure|
+          cycle_executions << (CycleExecution.from_hash(structure) if structure)
+        end
+      end
+
+      cycle_executions = SKIP unless hash.key?('cycle_executions')
+      last_payment = LastPaymentDetails.from_hash(hash['last_payment']) if hash['last_payment']
+      next_billing_time =
+        hash.key?('next_billing_time') ? hash['next_billing_time'] : SKIP
+      final_payment_time =
+        hash.key?('final_payment_time') ? hash['final_payment_time'] : SKIP
+      last_failed_payment = FailedPaymentDetails.from_hash(hash['last_failed_payment']) if
+        hash['last_failed_payment']
+
+      # Create object from extracted values.
+      SubscriptionBillingInformation.new(outstanding_balance: outstanding_balance,
+                                         failed_payments_count: failed_payments_count,
+                                         cycle_executions: cycle_executions,
+                                         last_payment: last_payment,
+                                         next_billing_time: next_billing_time,
+                                         final_payment_time: final_payment_time,
+                                         last_failed_payment: last_failed_payment)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} outstanding_balance: #{@outstanding_balance}, cycle_executions:"\
+      " #{@cycle_executions}, last_payment: #{@last_payment}, next_billing_time:"\
+      " #{@next_billing_time}, final_payment_time: #{@final_payment_time}, failed_payments_count:"\
+      " #{@failed_payments_count}, last_failed_payment: #{@last_failed_payment}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} outstanding_balance: #{@outstanding_balance.inspect}, cycle_executions:"\
+      " #{@cycle_executions.inspect}, last_payment: #{@last_payment.inspect}, next_billing_time:"\
+      " #{@next_billing_time.inspect}, final_payment_time: #{@final_payment_time.inspect},"\
+      " failed_payments_count: #{@failed_payments_count.inspect}, last_failed_payment:"\
+      " #{@last_failed_payment.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_card_request.rb

@@ -0,0 +1,141 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment card to use to fund a payment. Can be a credit or debit card.
+  class SubscriptionCardRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The card holder's name as it appears on the card.
+    # @return [String]
+    attr_accessor :name
+
+    # The primary account number (PAN) for the payment card.
+    # @return [String]
+    attr_accessor :number
+
+    # The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date
+    # and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
+    # @return [String]
+    attr_accessor :expiry
+
+    # The three- or four-digit security code of the card. Also known as the CVV,
+    # CVC, CVN, CVE, or CID. This parameter cannot be present in the request
+    # when `payment_initiator=MERCHANT`.
+    # @return [String]
+    attr_accessor :security_code
+
+    # Type of card. i.e Credit, Debit and so on.
+    # @return [CardType]
+    attr_accessor :type
+
+    # The card network or brand. Applies to credit, debit, gift, and payment
+    # cards.
+    # @return [SubscriptionsCardBrand]
+    attr_accessor :brand
+
+    # The portable international postal address. Maps to
+    # [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/
+    # wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls:
+    # the autocomplete
+    # attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-co
+    # ntrols-the-autocomplete-attribute).
+    # @return [Address]
+    attr_accessor :billing_address
+
+    # Additional attributes associated with the use of this card.
+    # @return [SubscriptionsCardAttributes]
+    attr_accessor :attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['number'] = 'number'
+      @_hash['expiry'] = 'expiry'
+      @_hash['security_code'] = 'security_code'
+      @_hash['type'] = 'type'
+      @_hash['brand'] = 'brand'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['attributes'] = 'attributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        number
+        expiry
+        security_code
+        type
+        brand
+        billing_address
+        attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, number: SKIP, expiry: SKIP, security_code: SKIP,
+                   type: SKIP, brand: SKIP, billing_address: SKIP,
+                   attributes: SKIP)
+      @name = name unless name == SKIP
+      @number = number unless number == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @security_code = security_code unless security_code == SKIP
+      @type = type unless type == SKIP
+      @brand = brand unless brand == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @attributes = attributes unless attributes == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      security_code = hash.key?('security_code') ? hash['security_code'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+      billing_address = Address.from_hash(hash['billing_address']) if hash['billing_address']
+      attributes = SubscriptionsCardAttributes.from_hash(hash['attributes']) if hash['attributes']
+
+      # Create object from extracted values.
+      SubscriptionCardRequest.new(name: name,
+                                  number: number,
+                                  expiry: expiry,
+                                  security_code: security_code,
+                                  type: type,
+                                  brand: brand,
+                                  billing_address: billing_address,
+                                  attributes: attributes)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, number: #{@number}, expiry: #{@expiry}, security_code:"\
+      " #{@security_code}, type: #{@type}, brand: #{@brand}, billing_address: #{@billing_address},"\
+      " attributes: #{@attributes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, number: #{@number.inspect}, expiry:"\
+      " #{@expiry.inspect}, security_code: #{@security_code.inspect}, type: #{@type.inspect},"\
+      " brand: #{@brand.inspect}, billing_address: #{@billing_address.inspect}, attributes:"\
+      " #{@attributes.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_collection.rb

@@ -0,0 +1,90 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The list of subscriptions.
+  class SubscriptionCollection < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of subscriptions.
+    # @return [Array[Subscription]]
+    attr_accessor :subscriptions
+
+    # An array of request-related [HATEOAS
+    # links](/docs/api/reference/api-responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subscriptions'] = 'subscriptions'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        subscriptions
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subscriptions: SKIP, links: SKIP)
+      @subscriptions = subscriptions unless subscriptions == SKIP
+      @links = links unless links == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      subscriptions = nil
+      unless hash['subscriptions'].nil?
+        subscriptions = []
+        hash['subscriptions'].each do |structure|
+          subscriptions << (Subscription.from_hash(structure) if structure)
+        end
+      end
+
+      subscriptions = SKIP unless hash.key?('subscriptions')
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (LinkDescription.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+
+      # Create object from extracted values.
+      SubscriptionCollection.new(subscriptions: subscriptions,
+                                 links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} subscriptions: #{@subscriptions}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} subscriptions: #{@subscriptions.inspect}, links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_customer_information.rb

@@ -0,0 +1,84 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The details about a customer in PayPal's system of record.
+  class SubscriptionCustomerInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID for a customer generated by PayPal.
+    # @return [String]
+    attr_accessor :id
+
+    # The internationalized email address. Note: Up to 64 characters are allowed
+    # before and 255 characters are allowed after the @ sign. However, the
+    # generally accepted maximum length for an email address is 254 characters.
+    # The pattern verifies that an unquoted @ sign exists.
+    # @return [String]
+    attr_accessor :email_address
+
+    # The phone information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['email_address'] = 'email_address'
+      @_hash['phone'] = 'phone'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        email_address
+        phone
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, email_address: SKIP, phone: SKIP)
+      @id = id unless id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone = phone unless phone == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      phone = PhoneWithType.from_hash(hash['phone']) if hash['phone']
+
+      # Create object from extracted values.
+      SubscriptionCustomerInformation.new(id: id,
+                                          email_address: email_address,
+                                          phone: phone)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, email_address: #{@email_address}, phone: #{@phone}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, email_address: #{@email_address.inspect}, phone:"\
+      " #{@phone.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_patch_application_context.rb

@@ -0,0 +1,122 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The application context, which customizes the payer experience during the
+  # subscription approval process with PayPal.
+  class SubscriptionPatchApplicationContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The label that overrides the business name in the PayPal account on the
+    # PayPal site.
+    # @return [String]
+    attr_accessor :brand_name
+
+    # The BCP 47-formatted locale of pages that the PayPal payment experience
+    # shows. PayPal supports a five-character code. For example, `da-DK`,
+    # `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE`, `th-TH`,
+    # `zh-CN`, `zh-HK`, or `zh-TW`.
+    # @return [String]
+    attr_accessor :locale
+
+    # The location from which the shipping address is derived.
+    # @return [ExperienceContextShippingPreference]
+    attr_accessor :shipping_preference
+
+    # The customer and merchant payment preferences.
+    # @return [PaymentMethod]
+    attr_accessor :payment_method
+
+    # The URL where the customer is redirected after the customer approves the
+    # payment.
+    # @return [String]
+    attr_accessor :return_url
+
+    # The URL where the customer is redirected after the customer cancels the
+    # payment.
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['brand_name'] = 'brand_name'
+      @_hash['locale'] = 'locale'
+      @_hash['shipping_preference'] = 'shipping_preference'
+      @_hash['payment_method'] = 'payment_method'
+      @_hash['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        shipping_preference
+        payment_method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      return_url:, cancel_url:, brand_name: SKIP, locale: SKIP,
+      shipping_preference: ExperienceContextShippingPreference::GET_FROM_FILE,
+      payment_method: SKIP
+    )
+      @brand_name = brand_name unless brand_name == SKIP
+      @locale = locale unless locale == SKIP
+      @shipping_preference = shipping_preference unless shipping_preference == SKIP
+      @payment_method = payment_method unless payment_method == SKIP
+      @return_url = return_url
+      @cancel_url = cancel_url
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      return_url = hash.key?('return_url') ? hash['return_url'] : nil
+      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : nil
+      brand_name = hash.key?('brand_name') ? hash['brand_name'] : SKIP
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+      shipping_preference =
+        hash['shipping_preference'] ||= ExperienceContextShippingPreference::GET_FROM_FILE
+      payment_method = PaymentMethod.from_hash(hash['payment_method']) if hash['payment_method']
+
+      # Create object from extracted values.
+      SubscriptionPatchApplicationContext.new(return_url: return_url,
+                                              cancel_url: cancel_url,
+                                              brand_name: brand_name,
+                                              locale: locale,
+                                              shipping_preference: shipping_preference,
+                                              payment_method: payment_method)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name}, locale: #{@locale}, shipping_preference:"\
+      " #{@shipping_preference}, payment_method: #{@payment_method}, return_url: #{@return_url},"\
+      " cancel_url: #{@cancel_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name.inspect}, locale: #{@locale.inspect},"\
+      " shipping_preference: #{@shipping_preference.inspect}, payment_method:"\
+      " #{@payment_method.inspect}, return_url: #{@return_url.inspect}, cancel_url:"\
+      " #{@cancel_url.inspect}>"
+    end
+  end
+end