paypal-server-sdk 2.3.0 → 2.4.0

data/lib/paypal_server_sdk/models/order_confirm_application_context.rb

@@ -1,123 +1,123 @@
-# paypal_server_sdk
-#
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
-
-module PaypalServerSdk
-  # Customizes the payer confirmation experience.
-  class OrderConfirmApplicationContext < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # Label to present to your payer as part of the PayPal hosted web
-    # experience.
-    # @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 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
-
-    # Provides additional details to process a payment using a `payment_source`
-    # that has been stored or is intended to be stored (also referred to as
-    # stored_credential or card-on-file). Parameter compatibility:
-    # `payment_type=ONE_TIME` is compatible only with
-    # `payment_initiator=CUSTOMER`. `usage=FIRST` is compatible only with
-    # `payment_initiator=CUSTOMER`. `previous_transaction_reference` or
-    # `previous_network_transaction_reference` is compatible only with
-    # `payment_initiator=MERCHANT`. Only one of the parameters -
-    # `previous_transaction_reference` and
-    # `previous_network_transaction_reference` - can be present in the request.
-    # @return [StoredPaymentSource]
-    attr_accessor :stored_payment_source
-
-    # 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['return_url'] = 'return_url'
-      @_hash['cancel_url'] = 'cancel_url'
-      @_hash['stored_payment_source'] = 'stored_payment_source'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        brand_name
-        locale
-        return_url
-        cancel_url
-        stored_payment_source
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(brand_name: SKIP, locale: SKIP, return_url: SKIP,
-                   cancel_url: SKIP, stored_payment_source: SKIP)
-      @brand_name = brand_name unless brand_name == SKIP
-      @locale = locale unless locale == SKIP
-      @return_url = return_url unless return_url == SKIP
-      @cancel_url = cancel_url unless cancel_url == SKIP
-      @stored_payment_source = stored_payment_source unless stored_payment_source == 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
-      return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
-      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
-      stored_payment_source = StoredPaymentSource.from_hash(hash['stored_payment_source']) if
-        hash['stored_payment_source']
-
-      # Create object from extracted values.
-      OrderConfirmApplicationContext.new(brand_name: brand_name,
-                                         locale: locale,
-                                         return_url: return_url,
-                                         cancel_url: cancel_url,
-                                         stored_payment_source: stored_payment_source)
-    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}, return_url: #{@return_url},"\
-      " cancel_url: #{@cancel_url}, stored_payment_source: #{@stored_payment_source}>"
-    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}, return_url:"\
-      " #{@return_url.inspect}, cancel_url: #{@cancel_url.inspect}, stored_payment_source:"\
-      " #{@stored_payment_source.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 confirmation experience.
+  class OrderConfirmApplicationContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Label to present to your payer as part of the PayPal hosted web
+    # experience.
+    # @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 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
+
+    # Provides additional details to process a payment using a `payment_source`
+    # that has been stored or is intended to be stored (also referred to as
+    # stored_credential or card-on-file). Parameter compatibility:
+    # `payment_type=ONE_TIME` is compatible only with
+    # `payment_initiator=CUSTOMER`. `usage=FIRST` is compatible only with
+    # `payment_initiator=CUSTOMER`. `previous_transaction_reference` or
+    # `previous_network_transaction_reference` is compatible only with
+    # `payment_initiator=MERCHANT`. Only one of the parameters -
+    # `previous_transaction_reference` and
+    # `previous_network_transaction_reference` - can be present in the request.
+    # @return [StoredPaymentSource]
+    attr_accessor :stored_payment_source
+
+    # 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['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash['stored_payment_source'] = 'stored_payment_source'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        return_url
+        cancel_url
+        stored_payment_source
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(brand_name: SKIP, locale: SKIP, return_url: SKIP,
+                   cancel_url: SKIP, stored_payment_source: SKIP)
+      @brand_name = brand_name unless brand_name == SKIP
+      @locale = locale unless locale == SKIP
+      @return_url = return_url unless return_url == SKIP
+      @cancel_url = cancel_url unless cancel_url == SKIP
+      @stored_payment_source = stored_payment_source unless stored_payment_source == 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
+      return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
+      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
+      stored_payment_source = StoredPaymentSource.from_hash(hash['stored_payment_source']) if
+        hash['stored_payment_source']
+
+      # Create object from extracted values.
+      OrderConfirmApplicationContext.new(brand_name: brand_name,
+                                         locale: locale,
+                                         return_url: return_url,
+                                         cancel_url: cancel_url,
+                                         stored_payment_source: stored_payment_source)
+    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}, return_url: #{@return_url},"\
+      " cancel_url: #{@cancel_url}, stored_payment_source: #{@stored_payment_source}>"
+    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}, return_url:"\
+      " #{@return_url.inspect}, cancel_url: #{@cancel_url.inspect}, stored_payment_source:"\
+      " #{@stored_payment_source.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_request.rb

@@ -1,132 +1,132 @@
-# paypal_server_sdk
-#
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
-
-module PaypalServerSdk
-  # The order request details.
-  class OrderRequest < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # The intent to either capture payment immediately or authorize a payment
-    # for an order after order creation.
-    # @return [CheckoutPaymentIntent]
-    attr_accessor :intent
-
-    # The instruction to process an order.
-    # @return [ProcessingInstruction]
-    attr_accessor :processing_instruction
-
-    # DEPRECATED. The customer is also known as the payer. The Payer object was
-    # intended to only be used with the `payment_source.paypal` object. In order
-    # to make this design more clear, the details in the `payer` object are now
-    # available under `payment_source.paypal`. Please use
-    # `payment_source.paypal`.
-    # @return [Payer]
-    attr_accessor :payer
-
-    # An array of purchase units. Each purchase unit establishes a contract
-    # between a payer and the payee. Each purchase unit represents either a full
-    # or partial order that the payer intends to purchase from the payee.
-    # @return [Array[PurchaseUnitRequest]]
-    attr_accessor :purchase_units
-
-    # The payment source definition.
-    # @return [PaymentSource]
-    attr_accessor :payment_source
-
-    # Customizes the payer experience during the approval process for the
-    # payment with PayPal. Note: Partners and Marketplaces might configure
-    # brand_name and shipping_preference during partner account setup, which
-    # overrides the request values.
-    # @return [OrderApplicationContext]
-    attr_accessor :application_context
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['intent'] = 'intent'
-      @_hash['processing_instruction'] = 'processing_instruction'
-      @_hash['payer'] = 'payer'
-      @_hash['purchase_units'] = 'purchase_units'
-      @_hash['payment_source'] = 'payment_source'
-      @_hash['application_context'] = 'application_context'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        processing_instruction
-        payer
-        payment_source
-        application_context
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(intent:, purchase_units:, processing_instruction: SKIP,
-                   payer: SKIP, payment_source: SKIP, application_context: SKIP)
-      @intent = intent
-      @processing_instruction = processing_instruction unless processing_instruction == SKIP
-      @payer = payer unless payer == SKIP
-      @purchase_units = purchase_units
-      @payment_source = payment_source unless payment_source == SKIP
-      @application_context = application_context unless application_context == 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.
-      intent = hash.key?('intent') ? hash['intent'] : nil
-      # Parameter is an array, so we need to iterate through it
-      purchase_units = nil
-      unless hash['purchase_units'].nil?
-        purchase_units = []
-        hash['purchase_units'].each do |structure|
-          purchase_units << (PurchaseUnitRequest.from_hash(structure) if structure)
-        end
-      end
-
-      purchase_units = nil unless hash.key?('purchase_units')
-      processing_instruction =
-        hash.key?('processing_instruction') ? hash['processing_instruction'] : SKIP
-      payer = Payer.from_hash(hash['payer']) if hash['payer']
-      payment_source = PaymentSource.from_hash(hash['payment_source']) if hash['payment_source']
-      application_context = OrderApplicationContext.from_hash(hash['application_context']) if
-        hash['application_context']
-
-      # Create object from extracted values.
-      OrderRequest.new(intent: intent,
-                       purchase_units: purchase_units,
-                       processing_instruction: processing_instruction,
-                       payer: payer,
-                       payment_source: payment_source,
-                       application_context: application_context)
-    end
-
-    # Provides a human-readable string representation of the object.
-    def to_s
-      class_name = self.class.name.split('::').last
-      "<#{class_name} intent: #{@intent}, processing_instruction: #{@processing_instruction},"\
-      " payer: #{@payer}, purchase_units: #{@purchase_units}, payment_source: #{@payment_source},"\
-      " application_context: #{@application_context}>"
-    end
-
-    # Provides a debugging-friendly string with detailed object information.
-    def inspect
-      class_name = self.class.name.split('::').last
-      "<#{class_name} intent: #{@intent.inspect}, processing_instruction:"\
-      " #{@processing_instruction.inspect}, payer: #{@payer.inspect}, purchase_units:"\
-      " #{@purchase_units.inspect}, payment_source: #{@payment_source.inspect},"\
-      " application_context: #{@application_context.inspect}>"
-    end
-  end
-end
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The order request details.
+  class OrderRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The intent to either capture payment immediately or authorize a payment
+    # for an order after order creation.
+    # @return [CheckoutPaymentIntent]
+    attr_accessor :intent
+
+    # The instruction to process an order.
+    # @return [ProcessingInstruction]
+    attr_accessor :processing_instruction
+
+    # DEPRECATED. The customer is also known as the payer. The Payer object was
+    # intended to only be used with the `payment_source.paypal` object. In order
+    # to make this design more clear, the details in the `payer` object are now
+    # available under `payment_source.paypal`. Please use
+    # `payment_source.paypal`.
+    # @return [Payer]
+    attr_accessor :payer
+
+    # An array of purchase units. Each purchase unit establishes a contract
+    # between a payer and the payee. Each purchase unit represents either a full
+    # or partial order that the payer intends to purchase from the payee.
+    # @return [Array[PurchaseUnitRequest]]
+    attr_accessor :purchase_units
+
+    # The payment source definition.
+    # @return [PaymentSource]
+    attr_accessor :payment_source
+
+    # Customizes the payer experience during the approval process for the
+    # payment with PayPal. Note: Partners and Marketplaces might configure
+    # brand_name and shipping_preference during partner account setup, which
+    # overrides the request values.
+    # @return [OrderApplicationContext]
+    attr_accessor :application_context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['intent'] = 'intent'
+      @_hash['processing_instruction'] = 'processing_instruction'
+      @_hash['payer'] = 'payer'
+      @_hash['purchase_units'] = 'purchase_units'
+      @_hash['payment_source'] = 'payment_source'
+      @_hash['application_context'] = 'application_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        processing_instruction
+        payer
+        payment_source
+        application_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(intent:, purchase_units:, processing_instruction: SKIP,
+                   payer: SKIP, payment_source: SKIP, application_context: SKIP)
+      @intent = intent
+      @processing_instruction = processing_instruction unless processing_instruction == SKIP
+      @payer = payer unless payer == SKIP
+      @purchase_units = purchase_units
+      @payment_source = payment_source unless payment_source == SKIP
+      @application_context = application_context unless application_context == 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.
+      intent = hash.key?('intent') ? hash['intent'] : nil
+      # Parameter is an array, so we need to iterate through it
+      purchase_units = nil
+      unless hash['purchase_units'].nil?
+        purchase_units = []
+        hash['purchase_units'].each do |structure|
+          purchase_units << (PurchaseUnitRequest.from_hash(structure) if structure)
+        end
+      end
+
+      purchase_units = nil unless hash.key?('purchase_units')
+      processing_instruction =
+        hash.key?('processing_instruction') ? hash['processing_instruction'] : SKIP
+      payer = Payer.from_hash(hash['payer']) if hash['payer']
+      payment_source = PaymentSource.from_hash(hash['payment_source']) if hash['payment_source']
+      application_context = OrderApplicationContext.from_hash(hash['application_context']) if
+        hash['application_context']
+
+      # Create object from extracted values.
+      OrderRequest.new(intent: intent,
+                       purchase_units: purchase_units,
+                       processing_instruction: processing_instruction,
+                       payer: payer,
+                       payment_source: payment_source,
+                       application_context: application_context)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} intent: #{@intent}, processing_instruction: #{@processing_instruction},"\
+      " payer: #{@payer}, purchase_units: #{@purchase_units}, payment_source: #{@payment_source},"\
+      " application_context: #{@application_context}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} intent: #{@intent.inspect}, processing_instruction:"\
+      " #{@processing_instruction.inspect}, payer: #{@payer.inspect}, purchase_units:"\
+      " #{@purchase_units.inspect}, payment_source: #{@payment_source.inspect},"\
+      " application_context: #{@application_context.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_status.rb

@@ -1,65 +1,65 @@
-# paypal_server_sdk
-#
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
-
-module PaypalServerSdk
-  # The order status.
-  class OrderStatus
-    ORDER_STATUS = [
-      # The order was created with the specified context.
-      CREATED = 'CREATED'.freeze,
-
-      # The order was saved and persisted. The order status continues to be in
-      # progress until a capture is made with final_capture = true for all
-      # purchase units within the order.
-      SAVED = 'SAVED'.freeze,
-
-      # The customer approved the payment through the PayPal wallet or another
-      # form of guest or unbranded payment. For example, a card, bank account,
-      # or so on.
-      APPROVED = 'APPROVED'.freeze,
-
-      # All purchase units in the order are voided.
-      VOIDED = 'VOIDED'.freeze,
-
-      # The intent of the order was completed and a `payments` resource was
-      # created. Important: Check the payment status in
-      # `purchase_units[].payments.captures[].status` before fulfilling the
-      # order. A completed order can indicate a payment was authorized, an
-      # authorized payment was captured, or a payment was declined.
-      COMPLETED = 'COMPLETED'.freeze,
-
-      # The order requires an action from the payer (e.g. 3DS authentication).
-      # Redirect the payer to the "rel":"payer-action" HATEOAS link returned as
-      # part of the response prior to authorizing or capturing the order. Some
-      # payment sources may not return a payer-action HATEOAS link (eg. MB WAY).
-      # For these payment sources the payer-action is managed by the scheme
-      # itself (eg. through SMS, email, in-app notification, etc).
-      PAYER_ACTION_REQUIRED = 'PAYER_ACTION_REQUIRED'.freeze
-    ].freeze
-
-    def self.validate(value)
-      return false if value.nil?
-
-      true
-    end
-
-    def self.from_value(value, default_value = CREATED)
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The order status.
+  class OrderStatus
+    ORDER_STATUS = [
+      # The order was created with the specified context.
+      CREATED = 'CREATED'.freeze,
+
+      # The order was saved and persisted. The order status continues to be in
+      # progress until a capture is made with final_capture = true for all
+      # purchase units within the order.
+      SAVED = 'SAVED'.freeze,
+
+      # The customer approved the payment through the PayPal wallet or another
+      # form of guest or unbranded payment. For example, a card, bank account,
+      # or so on.
+      APPROVED = 'APPROVED'.freeze,
+
+      # All purchase units in the order are voided.
+      VOIDED = 'VOIDED'.freeze,
+
+      # The intent of the order was completed and a `payments` resource was
+      # created. Important: Check the payment status in
+      # `purchase_units[].payments.captures[].status` before fulfilling the
+      # order. A completed order can indicate a payment was authorized, an
+      # authorized payment was captured, or a payment was declined.
+      COMPLETED = 'COMPLETED'.freeze,
+
+      # The order requires an action from the payer (e.g. 3DS authentication).
+      # Redirect the payer to the "rel":"payer-action" HATEOAS link returned as
+      # part of the response prior to authorizing or capturing the order. Some
+      # payment sources may not return a payer-action HATEOAS link (eg. MB WAY).
+      # For these payment sources the payer-action is managed by the scheme
+      # itself (eg. through SMS, email, in-app notification, etc).
+      PAYER_ACTION_REQUIRED = 'PAYER_ACTION_REQUIRED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CREATED)
       return default_value if value.nil?
-
-      str = value.to_s.strip
 
-      case str.downcase
-      when 'created' then CREATED
-      when 'saved' then SAVED
-      when 'approved' then APPROVED
-      when 'voided' then VOIDED
-      when 'completed' then COMPLETED
-      when 'payer_action_required' then PAYER_ACTION_REQUIRED
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'created' then CREATED
+      when 'saved' then SAVED
+      when 'approved' then APPROVED
+      when 'voided' then VOIDED
+      when 'completed' then COMPLETED
+      when 'payer_action_required' then PAYER_ACTION_REQUIRED
       else
         default_value
       end
-    end
-  end
-end
+    end
+  end
+end