paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/pay_pal_wallet_attributes.rb

@@ -0,0 +1,59 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Additional attributes associated with the use of this PayPal Wallet.
+  class PayPalWalletAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PayPalWalletCustomerRequest]
+    attr_accessor :customer
+
+    # TODO: Write general description for this method
+    # @return [PayPalWalletVaultInstruction]
+    attr_accessor :vault
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer'] = 'customer'
+      @_hash['vault'] = 'vault'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer
+        vault
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer: SKIP, vault: SKIP)
+      @customer = customer unless customer == SKIP
+      @vault = vault unless vault == 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.
+      customer = PayPalWalletCustomerRequest.from_hash(hash['customer']) if hash['customer']
+      vault = PayPalWalletVaultInstruction.from_hash(hash['vault']) if hash['vault']
+
+      # Create object from extracted values.
+      PayPalWalletAttributes.new(customer: customer,
+                                 vault: vault)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pay_pal_wallet_attributes_response.rb

@@ -0,0 +1,70 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Additional attributes associated with the use of a PayPal Wallet.
+  class PayPalWalletAttributesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The details about a saved PayPal Wallet payment source.
+    # @return [PayPalWalletVaultResponse]
+    attr_accessor :vault
+
+    # An array of merchant cobranded cards used by buyer to complete an order.
+    # This array will be present if a merchant has onboarded their cobranded
+    # card with PayPal and provided corresponding label(s).
+    # @return [Array[CobrandedCard]]
+    attr_accessor :cobranded_cards
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['vault'] = 'vault'
+      @_hash['cobranded_cards'] = 'cobranded_cards'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        vault
+        cobranded_cards
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(vault: SKIP, cobranded_cards: SKIP)
+      @vault = vault unless vault == SKIP
+      @cobranded_cards = cobranded_cards unless cobranded_cards == 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.
+      vault = PayPalWalletVaultResponse.from_hash(hash['vault']) if hash['vault']
+      # Parameter is an array, so we need to iterate through it
+      cobranded_cards = nil
+      unless hash['cobranded_cards'].nil?
+        cobranded_cards = []
+        hash['cobranded_cards'].each do |structure|
+          cobranded_cards << (CobrandedCard.from_hash(structure) if structure)
+        end
+      end
+
+      cobranded_cards = SKIP unless hash.key?('cobranded_cards')
+
+      # Create object from extracted values.
+      PayPalWalletAttributesResponse.new(vault: vault,
+                                         cobranded_cards: cobranded_cards)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pay_pal_wallet_customer.rb

@@ -0,0 +1,85 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The details about a customer in PayPal's system of record.
+  class PayPalWalletCustomer < 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.<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_address
+
+    # The phone information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
+    # Merchants and partners may already have a data-store where their customer
+    # information is persisted. Use merchant_customer_id to associate the
+    # PayPal-generated customer.id to your representation of a customer.
+    # @return [String]
+    attr_accessor :merchant_customer_id
+
+    # 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['merchant_customer_id'] = 'merchant_customer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        email_address
+        phone
+        merchant_customer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, email_address: SKIP, phone: SKIP,
+                   merchant_customer_id: SKIP)
+      @id = id unless id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone = phone unless phone == SKIP
+      @merchant_customer_id = merchant_customer_id unless merchant_customer_id == 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']
+      merchant_customer_id =
+        hash.key?('merchant_customer_id') ? hash['merchant_customer_id'] : SKIP
+
+      # Create object from extracted values.
+      PayPalWalletCustomer.new(id: id,
+                               email_address: email_address,
+                               phone: phone,
+                               merchant_customer_id: merchant_customer_id)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pay_pal_wallet_customer_request.rb

@@ -0,0 +1,85 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # PayPalWalletCustomerRequest Model.
+  class PayPalWalletCustomerRequest < 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.<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_address
+
+    # The phone information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
+    # Merchants and partners may already have a data-store where their customer
+    # information is persisted. Use merchant_customer_id to associate the
+    # PayPal-generated customer.id to your representation of a customer.
+    # @return [String]
+    attr_accessor :merchant_customer_id
+
+    # 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['merchant_customer_id'] = 'merchant_customer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        email_address
+        phone
+        merchant_customer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, email_address: SKIP, phone: SKIP,
+                   merchant_customer_id: SKIP)
+      @id = id unless id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone = phone unless phone == SKIP
+      @merchant_customer_id = merchant_customer_id unless merchant_customer_id == 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']
+      merchant_customer_id =
+        hash.key?('merchant_customer_id') ? hash['merchant_customer_id'] : SKIP
+
+      # Create object from extracted values.
+      PayPalWalletCustomerRequest.new(id: id,
+                                      email_address: email_address,
+                                      phone: phone,
+                                      merchant_customer_id: merchant_customer_id)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pay_pal_wallet_experience_context.rb

@@ -0,0 +1,140 @@
+# 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 payment with
+  # PayPal.<blockquote><strong>Note:</strong> Partners and Marketplaces might
+  # configure <code>brand_name</code> and <code>shipping_preference</code>
+  # during partner account setup, which overrides the request
+  # values.</blockquote>
+  class PayPalWalletExperienceContext < 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
+
+    # The type of landing page to show on the PayPal site for customer checkout.
+    # @return [PayPalExperienceLandingPage]
+    attr_accessor :landing_page
+
+    # Configures a <strong>Continue</strong> or <strong>Pay Now</strong>
+    # checkout flow.
+    # @return [PayPalExperienceUserAction]
+    attr_accessor :user_action
+
+    # The merchant-preferred payment methods.
+    # @return [PayeePaymentMethodPreference]
+    attr_accessor :payment_method_preference
+
+    # 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['landing_page'] = 'landing_page'
+      @_hash['user_action'] = 'user_action'
+      @_hash['payment_method_preference'] = 'payment_method_preference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        shipping_preference
+        return_url
+        cancel_url
+        landing_page
+        user_action
+        payment_method_preference
+      ]
+    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,
+      landing_page: PayPalExperienceLandingPage::NO_PREFERENCE,
+      user_action: PayPalExperienceUserAction::CONTINUE,
+      payment_method_preference: PayeePaymentMethodPreference::UNRESTRICTED
+    )
+      @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
+      @landing_page = landing_page unless landing_page == SKIP
+      @user_action = user_action unless user_action == SKIP
+      unless payment_method_preference == SKIP
+        @payment_method_preference =
+          payment_method_preference
+      end
+    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
+      landing_page =
+        hash['landing_page'] ||= PayPalExperienceLandingPage::NO_PREFERENCE
+      user_action = hash['user_action'] ||= PayPalExperienceUserAction::CONTINUE
+      payment_method_preference =
+        hash['payment_method_preference'] ||= PayeePaymentMethodPreference::UNRESTRICTED
+
+      # Create object from extracted values.
+      PayPalWalletExperienceContext.new(brand_name: brand_name,
+                                        locale: locale,
+                                        shipping_preference: shipping_preference,
+                                        return_url: return_url,
+                                        cancel_url: cancel_url,
+                                        landing_page: landing_page,
+                                        user_action: user_action,
+                                        payment_method_preference: payment_method_preference)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pay_pal_wallet_response.rb

@@ -0,0 +1,166 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The PayPal Wallet response.
+  class PayPalWalletResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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_address
+
+    # The PayPal payer ID, which is a masked version of the PayPal account
+    # number intended for use with third parties. The account number is
+    # reversibly encrypted and a proprietary variant of Base32 is used to encode
+    # the result.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The account status indicates whether the buyer has verified the financial
+    # details associated with their PayPal account.
+    # @return [PayPalWalletAccountVerificationStatus]
+    attr_accessor :account_status
+
+    # The name of the party.
+    # @return [Name]
+    attr_accessor :name
+
+    # The phone type.
+    # @return [PhoneType]
+    attr_accessor :phone_type
+
+    # The phone number in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [PhoneNumber]
+    attr_accessor :phone_number
+
+    # The stand-alone date, in [Internet date and time
+    # format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent
+    # special legal values, such as a date of birth, you should use dates with
+    # no associated time or time-zone data. Whenever possible, use the standard
+    # `date_time` type. This regular expression does not validate all dates. For
+    # example, February 31 is valid and nothing is known about leap years.
+    # @return [String]
+    attr_accessor :birth_date
+
+    # The business name of the PayPal account holder (populated for business
+    # accounts only)
+    # @return [String]
+    attr_accessor :business_name
+
+    # The tax ID of the customer. The customer is also known as the payer. Both
+    # `tax_id` and `tax_id_type` are required.
+    # @return [TaxInfo]
+    attr_accessor :tax_info
+
+    # 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 :address
+
+    # Additional attributes associated with the use of a PayPal Wallet.
+    # @return [PayPalWalletAttributesResponse]
+    attr_accessor :attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email_address'] = 'email_address'
+      @_hash['account_id'] = 'account_id'
+      @_hash['account_status'] = 'account_status'
+      @_hash['name'] = 'name'
+      @_hash['phone_type'] = 'phone_type'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['birth_date'] = 'birth_date'
+      @_hash['business_name'] = 'business_name'
+      @_hash['tax_info'] = 'tax_info'
+      @_hash['address'] = 'address'
+      @_hash['attributes'] = 'attributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email_address
+        account_id
+        account_status
+        name
+        phone_type
+        phone_number
+        birth_date
+        business_name
+        tax_info
+        address
+        attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email_address: SKIP, account_id: SKIP, account_status: SKIP,
+                   name: SKIP, phone_type: SKIP, phone_number: SKIP,
+                   birth_date: SKIP, business_name: SKIP, tax_info: SKIP,
+                   address: SKIP, attributes: SKIP)
+      @email_address = email_address unless email_address == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @account_status = account_status unless account_status == SKIP
+      @name = name unless name == SKIP
+      @phone_type = phone_type unless phone_type == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @birth_date = birth_date unless birth_date == SKIP
+      @business_name = business_name unless business_name == SKIP
+      @tax_info = tax_info unless tax_info == SKIP
+      @address = address unless 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.
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
+      account_status =
+        hash.key?('account_status') ? hash['account_status'] : SKIP
+      name = Name.from_hash(hash['name']) if hash['name']
+      phone_type = hash.key?('phone_type') ? hash['phone_type'] : SKIP
+      phone_number = PhoneNumber.from_hash(hash['phone_number']) if hash['phone_number']
+      birth_date = hash.key?('birth_date') ? hash['birth_date'] : SKIP
+      business_name = hash.key?('business_name') ? hash['business_name'] : SKIP
+      tax_info = TaxInfo.from_hash(hash['tax_info']) if hash['tax_info']
+      address = Address.from_hash(hash['address']) if hash['address']
+      attributes = PayPalWalletAttributesResponse.from_hash(hash['attributes']) if
+        hash['attributes']
+
+      # Create object from extracted values.
+      PayPalWalletResponse.new(email_address: email_address,
+                               account_id: account_id,
+                               account_status: account_status,
+                               name: name,
+                               phone_type: phone_type,
+                               phone_number: phone_number,
+                               birth_date: birth_date,
+                               business_name: business_name,
+                               tax_info: tax_info,
+                               address: address,
+                               attributes: attributes)
+    end
+  end
+end