paypal-server-sdk 2.2.0 → 2.4.0

data/lib/paypal_server_sdk/models/experience_context.rb

@@ -1,115 +1,116 @@
-# paypal_server_sdk
-#
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
-
-module PaypalServerSdk
-  # Customizes the payer experience during the approval process for the payment.
-  class ExperienceContext < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # The label that overrides the business name in the PayPal account on the
-    # PayPal site. The pattern is defined by an external party and supports
-    # Unicode.
-    # @return [String]
-    attr_accessor :brand_name
-
-    # The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the
-    # language in which to localize the error-related strings, such as messages,
-    # issues, and suggested actions. The tag is made up of the [ISO 639-2
-    # language code](https://www.loc.gov/standards/iso639-2/php/code_list.php),
-    # the optional [ISO-15924 script
-    # tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166
-    # alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region
-    # code](https://unstats.un.org/unsd/methodology/m49/).
-    # @return [String]
-    attr_accessor :locale
-
-    # The location from which the shipping address is derived.
-    # @return [ExperienceContextShippingPreference]
-    attr_accessor :shipping_preference
-
-    # Describes the URL.
-    # @return [String]
-    attr_accessor :return_url
-
-    # Describes the URL.
-    # @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['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
-        return_url
-        cancel_url
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(
-      brand_name: SKIP, locale: SKIP,
-      shipping_preference: ExperienceContextShippingPreference::GET_FROM_FILE,
-      return_url: SKIP, cancel_url: SKIP
-    )
-      @brand_name = brand_name unless brand_name == SKIP
-      @locale = locale unless locale == SKIP
-      @shipping_preference = shipping_preference unless shipping_preference == SKIP
-      @return_url = return_url unless return_url == SKIP
-      @cancel_url = cancel_url unless cancel_url == 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.
-      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
-      return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
-      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
-
-      # Create object from extracted values.
-      ExperienceContext.new(brand_name: brand_name,
-                            locale: locale,
-                            shipping_preference: shipping_preference,
-                            return_url: return_url,
-                            cancel_url: cancel_url)
-    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}, 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}, return_url: #{@return_url.inspect},"\
-      " cancel_url: #{@cancel_url.inspect}>"
-    end
-  end
-end
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Customizes the payer experience during the approval process for the payment.
+  class ExperienceContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The label that overrides the business name in the PayPal account on the
+    # PayPal site. The pattern is defined by an external party and supports
+    # Unicode.
+    # @return [String]
+    attr_accessor :brand_name
+
+    # The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the
+    # language in which to localize the error-related strings, such as messages,
+    # issues, and suggested actions. The tag is made up of the [ISO 639-2
+    # language code](https://www.loc.gov/standards/iso639-2/php/code_list.php),
+    # the optional [ISO-15924 script
+    # tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166
+    # alpha-2 country
+    # code](https://developer.paypal.com/api/rest/reference/country-codes/) or
+    # [M49 region code](https://unstats.un.org/unsd/methodology/m49/).
+    # @return [String]
+    attr_accessor :locale
+
+    # The location from which the shipping address is derived.
+    # @return [ExperienceContextShippingPreference]
+    attr_accessor :shipping_preference
+
+    # Describes the URL.
+    # @return [String]
+    attr_accessor :return_url
+
+    # Describes the URL.
+    # @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['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
+        return_url
+        cancel_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      brand_name: SKIP, locale: SKIP,
+      shipping_preference: ExperienceContextShippingPreference::GET_FROM_FILE,
+      return_url: SKIP, cancel_url: SKIP
+    )
+      @brand_name = brand_name unless brand_name == SKIP
+      @locale = locale unless locale == SKIP
+      @shipping_preference = shipping_preference unless shipping_preference == SKIP
+      @return_url = return_url unless return_url == SKIP
+      @cancel_url = cancel_url unless cancel_url == 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.
+      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
+      return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
+      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
+
+      # Create object from extracted values.
+      ExperienceContext.new(brand_name: brand_name,
+                            locale: locale,
+                            shipping_preference: shipping_preference,
+                            return_url: return_url,
+                            cancel_url: cancel_url)
+    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}, 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}, return_url: #{@return_url.inspect},"\
+      " cancel_url: #{@cancel_url.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/experience_context_shipping_preference.rb

@@ -1,46 +1,46 @@
-# paypal_server_sdk
-#
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
-
-module PaypalServerSdk
-  # The location from which the shipping address is derived., The shipping
-  # preference. This only applies to PayPal payment source., The shipping
-  # preference. This only applies to PayPal payment source., The location from
-  # which the shipping address is derived.
-  class ExperienceContextShippingPreference
-    EXPERIENCE_CONTEXT_SHIPPING_PREFERENCE = [
-      # Get the customer-provided shipping address on the PayPal site.
-      GET_FROM_FILE = 'GET_FROM_FILE'.freeze,
-
-      # Redacts the shipping address from the PayPal site. Recommended for
-      # digital goods.
-      NO_SHIPPING = 'NO_SHIPPING'.freeze,
-
-      # Merchant sends the shipping address using
-      # purchase_units.shipping.address. The customer cannot change this address
-      # on the PayPal site.
-      SET_PROVIDED_ADDRESS = 'SET_PROVIDED_ADDRESS'.freeze
-    ].freeze
-
-    def self.validate(value)
-      return false if value.nil?
-
-      true
-    end
-
-    def self.from_value(value, default_value = GET_FROM_FILE)
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The location from which the shipping address is derived., The shipping
+  # preference. This only applies to PayPal payment source., The shipping
+  # preference. This only applies to PayPal payment source., The location from
+  # which the shipping address is derived.
+  class ExperienceContextShippingPreference
+    EXPERIENCE_CONTEXT_SHIPPING_PREFERENCE = [
+      # Get the customer-provided shipping address on the PayPal site.
+      GET_FROM_FILE = 'GET_FROM_FILE'.freeze,
+
+      # Redacts the shipping address from the PayPal site. Recommended for
+      # digital goods.
+      NO_SHIPPING = 'NO_SHIPPING'.freeze,
+
+      # Merchant sends the shipping address using
+      # purchase_units.shipping.address. The customer cannot change this address
+      # on the PayPal site.
+      SET_PROVIDED_ADDRESS = 'SET_PROVIDED_ADDRESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = GET_FROM_FILE)
       return default_value if value.nil?
-
-      str = value.to_s.strip
 
-      case str.downcase
-      when 'get_from_file' then GET_FROM_FILE
-      when 'no_shipping' then NO_SHIPPING
-      when 'set_provided_address' then SET_PROVIDED_ADDRESS
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'get_from_file' then GET_FROM_FILE
+      when 'no_shipping' then NO_SHIPPING
+      when 'set_provided_address' then SET_PROVIDED_ADDRESS
       else
         default_value
       end
-    end
-  end
-end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/experience_status.rb

@@ -1,48 +1,48 @@
-# paypal_server_sdk
-#
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
-
-module PaypalServerSdk
-  # This field indicates the status of PayPal's Checkout experience throughout
-  # the order lifecycle. The values reflect the current stage of the checkout
-  # process.
-  class ExperienceStatus
-    EXPERIENCE_STATUS = [
-      # PayPal checkout process has not yet begun.
-      NOT_STARTED = 'NOT_STARTED'.freeze,
-
-      # PayPal checkout initiated. User is on the checkout page for order review
-      # before approval.
-      IN_PROGRESS = 'IN_PROGRESS'.freeze,
-
-      # PayPal checkout is canceled (by closing the checkout window or clicking
-      # cancel) before the order approval.
-      CANCELED = 'CANCELED'.freeze,
-
-      # Order is approved. User has completed the checkout process.
-      APPROVED = 'APPROVED'.freeze
-    ].freeze
-
-    def self.validate(value)
-      return false if value.nil?
-
-      true
-    end
-
-    def self.from_value(value, default_value = NOT_STARTED)
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # This field indicates the status of PayPal's Checkout experience throughout
+  # the order lifecycle. The values reflect the current stage of the checkout
+  # process.
+  class ExperienceStatus
+    EXPERIENCE_STATUS = [
+      # PayPal checkout process has not yet begun.
+      NOT_STARTED = 'NOT_STARTED'.freeze,
+
+      # PayPal checkout initiated. User is on the checkout page for order review
+      # before approval.
+      IN_PROGRESS = 'IN_PROGRESS'.freeze,
+
+      # PayPal checkout is canceled (by closing the checkout window or clicking
+      # cancel) before the order approval.
+      CANCELED = 'CANCELED'.freeze,
+
+      # Order is approved. User has completed the checkout process.
+      APPROVED = 'APPROVED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = NOT_STARTED)
       return default_value if value.nil?
-
-      str = value.to_s.strip
-
-      case str.downcase
-      when 'not_started' then NOT_STARTED
-      when 'in_progress' then IN_PROGRESS
-      when 'canceled' then CANCELED
-      when 'approved' then APPROVED
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'not_started' then NOT_STARTED
+      when 'in_progress' then IN_PROGRESS
+      when 'canceled' then CANCELED
+      when 'approved' then APPROVED
       else
         default_value
       end
-    end
-  end
-end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/failed_payment_details.rb

@@ -1,98 +1,98 @@
-# paypal_server_sdk
-#
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
-
-module PaypalServerSdk
-  # The details for the failed payment of the subscription.
-  class FailedPaymentDetails < 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 :amount
-
-    # 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 :time
-
-    # The reason code for the payment failure.
-    # @return [ReasonCode]
-    attr_accessor :reason_code
-
-    # 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_payment_retry_time
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['amount'] = 'amount'
-      @_hash['time'] = 'time'
-      @_hash['reason_code'] = 'reason_code'
-      @_hash['next_payment_retry_time'] = 'next_payment_retry_time'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        reason_code
-        next_payment_retry_time
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(amount:, time:, reason_code: SKIP,
-                   next_payment_retry_time: SKIP)
-      @amount = amount
-      @time = time
-      @reason_code = reason_code unless reason_code == SKIP
-      @next_payment_retry_time = next_payment_retry_time unless next_payment_retry_time == 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.
-      amount = Money.from_hash(hash['amount']) if hash['amount']
-      time = hash.key?('time') ? hash['time'] : nil
-      reason_code = hash.key?('reason_code') ? hash['reason_code'] : SKIP
-      next_payment_retry_time =
-        hash.key?('next_payment_retry_time') ? hash['next_payment_retry_time'] : SKIP
-
-      # Create object from extracted values.
-      FailedPaymentDetails.new(amount: amount,
-                               time: time,
-                               reason_code: reason_code,
-                               next_payment_retry_time: next_payment_retry_time)
-    end
-
-    # Provides a human-readable string representation of the object.
-    def to_s
-      class_name = self.class.name.split('::').last
-      "<#{class_name} amount: #{@amount}, time: #{@time}, reason_code: #{@reason_code},"\
-      " next_payment_retry_time: #{@next_payment_retry_time}>"
-    end
-
-    # Provides a debugging-friendly string with detailed object information.
-    def inspect
-      class_name = self.class.name.split('::').last
-      "<#{class_name} amount: #{@amount.inspect}, time: #{@time.inspect}, reason_code:"\
-      " #{@reason_code.inspect}, next_payment_retry_time: #{@next_payment_retry_time.inspect}>"
-    end
-  end
-end
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The details for the failed payment of the subscription.
+  class FailedPaymentDetails < 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 :amount
+
+    # 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 :time
+
+    # The reason code for the payment failure.
+    # @return [ReasonCode]
+    attr_accessor :reason_code
+
+    # 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_payment_retry_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['time'] = 'time'
+      @_hash['reason_code'] = 'reason_code'
+      @_hash['next_payment_retry_time'] = 'next_payment_retry_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason_code
+        next_payment_retry_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, time:, reason_code: SKIP,
+                   next_payment_retry_time: SKIP)
+      @amount = amount
+      @time = time
+      @reason_code = reason_code unless reason_code == SKIP
+      @next_payment_retry_time = next_payment_retry_time unless next_payment_retry_time == 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.
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      time = hash.key?('time') ? hash['time'] : nil
+      reason_code = hash.key?('reason_code') ? hash['reason_code'] : SKIP
+      next_payment_retry_time =
+        hash.key?('next_payment_retry_time') ? hash['next_payment_retry_time'] : SKIP
+
+      # Create object from extracted values.
+      FailedPaymentDetails.new(amount: amount,
+                               time: time,
+                               reason_code: reason_code,
+                               next_payment_retry_time: next_payment_retry_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, time: #{@time}, reason_code: #{@reason_code},"\
+      " next_payment_retry_time: #{@next_payment_retry_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, time: #{@time.inspect}, reason_code:"\
+      " #{@reason_code.inspect}, next_payment_retry_time: #{@next_payment_retry_time.inspect}>"
+    end
+  end
+end