paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/blik_experience_context.rb

@@ -0,0 +1,122 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Customizes the payer experience during the approval process for the BLIK
+  # payment.
+  class BLIKExperienceContext < 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 [ShippingPreference]
+    attr_accessor :shipping_preference
+
+    # Describes the URL.
+    # @return [String]
+    attr_accessor :return_url
+
+    # Describes the URL.
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # An Internet Protocol address (IP address). This address assigns a
+    # numerical label to each device that is connected to a computer network
+    # through the Internet Protocol. Supports IPv4 and IPv6 addresses.
+    # @return [String]
+    attr_accessor :consumer_ip
+
+    # The payer's User Agent. For example, Mozilla/5.0 (Macintosh; Intel Mac OS
+    # X x.y; rv:42.0).
+    # @return [String]
+    attr_accessor :consumer_user_agent
+
+    # 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['consumer_ip'] = 'consumer_ip'
+      @_hash['consumer_user_agent'] = 'consumer_user_agent'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        shipping_preference
+        return_url
+        cancel_url
+        consumer_ip
+        consumer_user_agent
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(brand_name: SKIP, locale: SKIP,
+                   shipping_preference: ShippingPreference::GET_FROM_FILE,
+                   return_url: SKIP, cancel_url: SKIP, consumer_ip: SKIP,
+                   consumer_user_agent: 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
+      @consumer_ip = consumer_ip unless consumer_ip == SKIP
+      @consumer_user_agent = consumer_user_agent unless consumer_user_agent == 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'] ||= ShippingPreference::GET_FROM_FILE
+      return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
+      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
+      consumer_ip = hash.key?('consumer_ip') ? hash['consumer_ip'] : SKIP
+      consumer_user_agent =
+        hash.key?('consumer_user_agent') ? hash['consumer_user_agent'] : SKIP
+
+      # Create object from extracted values.
+      BLIKExperienceContext.new(brand_name: brand_name,
+                                locale: locale,
+                                shipping_preference: shipping_preference,
+                                return_url: return_url,
+                                cancel_url: cancel_url,
+                                consumer_ip: consumer_ip,
+                                consumer_user_agent: consumer_user_agent)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/blik_level0_payment_object.rb

@@ -0,0 +1,48 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using BLIK level_0 flow.
+  class BLIKLevel0PaymentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The 6-digit code used to authenticate a consumer within BLIK.
+    # @return [String]
+    attr_accessor :auth_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auth_code'] = 'auth_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(auth_code:)
+      @auth_code = auth_code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      auth_code = hash.key?('auth_code') ? hash['auth_code'] : nil
+
+      # Create object from extracted values.
+      BLIKLevel0PaymentObject.new(auth_code: auth_code)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/blik_one_click_payment_object.rb

@@ -0,0 +1,52 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using BLIK one-click flow.
+  class BLIKOneClickPaymentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The merchant generated, unique reference serving as a primary identifier
+    # for accounts connected between Blik and a merchant.
+    # @return [String]
+    attr_accessor :consumer_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['consumer_reference'] = 'consumer_reference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        consumer_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(consumer_reference: SKIP)
+      @consumer_reference = consumer_reference unless consumer_reference == 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.
+      consumer_reference =
+        hash.key?('consumer_reference') ? hash['consumer_reference'] : SKIP
+
+      # Create object from extracted values.
+      BLIKOneClickPaymentObject.new(consumer_reference: consumer_reference)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/blik_one_click_payment_request.rb

@@ -0,0 +1,82 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using BLIK one-click flow.
+  class BLIKOneClickPaymentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The 6-digit code used to authenticate a consumer within BLIK.
+    # @return [String]
+    attr_accessor :auth_code
+
+    # The merchant generated, unique reference serving as a primary identifier
+    # for accounts connected between Blik and a merchant.
+    # @return [String]
+    attr_accessor :consumer_reference
+
+    # A bank defined identifier used as a display name to allow the payer to
+    # differentiate between multiple registered bank accounts.
+    # @return [String]
+    attr_accessor :alias_label
+
+    # A Blik-defined identifier for a specific Blik-enabled bank account that is
+    # associated with a given merchant. Used only in conjunction with a Consumer
+    # Reference.
+    # @return [String]
+    attr_accessor :alias_key
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auth_code'] = 'auth_code'
+      @_hash['consumer_reference'] = 'consumer_reference'
+      @_hash['alias_label'] = 'alias_label'
+      @_hash['alias_key'] = 'alias_key'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auth_code
+        alias_label
+        alias_key
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(consumer_reference:, auth_code: SKIP, alias_label: SKIP,
+                   alias_key: SKIP)
+      @auth_code = auth_code unless auth_code == SKIP
+      @consumer_reference = consumer_reference
+      @alias_label = alias_label unless alias_label == SKIP
+      @alias_key = alias_key unless alias_key == 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.
+      consumer_reference =
+        hash.key?('consumer_reference') ? hash['consumer_reference'] : nil
+      auth_code = hash.key?('auth_code') ? hash['auth_code'] : SKIP
+      alias_label = hash.key?('alias_label') ? hash['alias_label'] : SKIP
+      alias_key = hash.key?('alias_key') ? hash['alias_key'] : SKIP
+
+      # Create object from extracted values.
+      BLIKOneClickPaymentRequest.new(consumer_reference: consumer_reference,
+                                     auth_code: auth_code,
+                                     alias_label: alias_label,
+                                     alias_key: alias_key)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/blik_payment_object.rb

@@ -0,0 +1,86 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using BLIK.
+  class BLIKPaymentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
+    # that identifies the country or region.<blockquote><strong>Note:</strong>
+    # The country code for Great Britain is <code>GB</code> and not
+    # <code>UK</code> as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.</blockquote>
+    # @return [String]
+    attr_accessor :country_code
+
+    # The internationalized email address.<blockquote><strong>Note:</strong> Up
+    # to 64 characters are allowed before and 255 characters are allowed after
+    # the <code>@</code> sign. However, the generally accepted maximum length
+    # for an email address is 254 characters. The pattern verifies that an
+    # unquoted <code>@</code> sign exists.</blockquote>
+    # @return [String]
+    attr_accessor :email
+
+    # Information used to pay using BLIK one-click flow.
+    # @return [BLIKOneClickPaymentObject]
+    attr_accessor :one_click
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['country_code'] = 'country_code'
+      @_hash['email'] = 'email'
+      @_hash['one_click'] = 'one_click'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        country_code
+        email
+        one_click
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, country_code: SKIP, email: SKIP, one_click: SKIP)
+      @name = name unless name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @email = email unless email == SKIP
+      @one_click = one_click unless one_click == 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
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      one_click = BLIKOneClickPaymentObject.from_hash(hash['one_click']) if hash['one_click']
+
+      # Create object from extracted values.
+      BLIKPaymentObject.new(name: name,
+                            country_code: country_code,
+                            email: email,
+                            one_click: one_click)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/blik_payment_request.rb

@@ -0,0 +1,105 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using BLIK.
+  class BLIKPaymentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
+    # that identifies the country or region.<blockquote><strong>Note:</strong>
+    # The country code for Great Britain is <code>GB</code> and not
+    # <code>UK</code> as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.</blockquote>
+    # @return [String]
+    attr_accessor :country_code
+
+    # The internationalized email address.<blockquote><strong>Note:</strong> Up
+    # to 64 characters are allowed before and 255 characters are allowed after
+    # the <code>@</code> sign. However, the generally accepted maximum length
+    # for an email address is 254 characters. The pattern verifies that an
+    # unquoted <code>@</code> sign exists.</blockquote>
+    # @return [String]
+    attr_accessor :email
+
+    # Customizes the payer experience during the approval process for the BLIK
+    # payment.
+    # @return [BLIKExperienceContext]
+    attr_accessor :experience_context
+
+    # Information used to pay using BLIK level_0 flow.
+    # @return [BLIKLevel0PaymentObject]
+    attr_accessor :level_0
+
+    # Information used to pay using BLIK one-click flow.
+    # @return [BLIKOneClickPaymentRequest]
+    attr_accessor :one_click
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['country_code'] = 'country_code'
+      @_hash['email'] = 'email'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash['level_0'] = 'level_0'
+      @_hash['one_click'] = 'one_click'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email
+        experience_context
+        level_0
+        one_click
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, country_code:, email: SKIP, experience_context: SKIP,
+                   level_0: SKIP, one_click: SKIP)
+      @name = name
+      @country_code = country_code
+      @email = email unless email == SKIP
+      @experience_context = experience_context unless experience_context == SKIP
+      @level_0 = level_0 unless level_0 == SKIP
+      @one_click = one_click unless one_click == 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'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      email = hash.key?('email') ? hash['email'] : SKIP
+      experience_context = BLIKExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+      level_0 = BLIKLevel0PaymentObject.from_hash(hash['level_0']) if hash['level_0']
+      one_click = BLIKOneClickPaymentRequest.from_hash(hash['one_click']) if hash['one_click']
+
+      # Create object from extracted values.
+      BLIKPaymentRequest.new(name: name,
+                             country_code: country_code,
+                             email: email,
+                             experience_context: experience_context,
+                             level_0: level_0,
+                             one_click: one_click)
+    end
+  end
+end