paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/address_details.rb

@@ -0,0 +1,160 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Address request details.
+  class AddressDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The first line of the address, such as number and street, for example,
+    # `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks.
+    # This field needs to pass the full address.
+    # @return [String]
+    attr_accessor :address_line_1
+
+    # The second line of the address, for example, a suite or apartment number.
+    # @return [String]
+    attr_accessor :address_line_2
+
+    # A city, town, or village. Smaller than `admin_area_level_1`.
+    # @return [String]
+    attr_accessor :admin_area_2
+
+    # The highest-level sub-division in a country, which is usually a province,
+    # state, or ISO-3166-2 subdivision. This data is formatted for postal
+    # delivery, for example, `CA` and not `California`. Value, by country,
+    # is:<ul><li>UK. A county.</li><li>US. A state.</li><li>Canada. A
+    # province.</li><li>Japan. A prefecture.</li><li>Switzerland. A
+    # *kanton*.</li></ul>
+    # @return [String]
+    attr_accessor :admin_area_1
+
+    # The postal code, which is the ZIP code or equivalent. Typically required
+    # for countries with a postal code or an equivalent. See [postal
+    # code](https://en.wikipedia.org/wiki/Postal_code).
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The [2-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 name of the party.
+    # @return [Name]
+    attr_accessor :name
+
+    # The resource ID of the address.
+    # @return [String]
+    attr_accessor :id
+
+    # The name of the company or business associated to the address.
+    # @return [String]
+    attr_accessor :company
+
+    # The phone number that can go on the mailing label with the address to
+    # track the shipping. Phone number is in E.164 format.
+    # @return [String]
+    attr_accessor :phone
+
+    # The phone number, in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [Phone]
+    attr_accessor :phone_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address_line_1'] = 'address_line_1'
+      @_hash['address_line_2'] = 'address_line_2'
+      @_hash['admin_area_2'] = 'admin_area_2'
+      @_hash['admin_area_1'] = 'admin_area_1'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['country_code'] = 'country_code'
+      @_hash['name'] = 'name'
+      @_hash['id'] = 'id'
+      @_hash['company'] = 'company'
+      @_hash['phone'] = 'phone'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address_line_1
+        address_line_2
+        admin_area_2
+        admin_area_1
+        postal_code
+        name
+        id
+        company
+        phone
+        phone_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_code:, address_line_1: SKIP, address_line_2: SKIP,
+                   admin_area_2: SKIP, admin_area_1: SKIP, postal_code: SKIP,
+                   name: SKIP, id: SKIP, company: SKIP, phone: SKIP,
+                   phone_number: SKIP)
+      @address_line_1 = address_line_1 unless address_line_1 == SKIP
+      @address_line_2 = address_line_2 unless address_line_2 == SKIP
+      @admin_area_2 = admin_area_2 unless admin_area_2 == SKIP
+      @admin_area_1 = admin_area_1 unless admin_area_1 == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @country_code = country_code
+      @name = name unless name == SKIP
+      @id = id unless id == SKIP
+      @company = company unless company == SKIP
+      @phone = phone unless phone == SKIP
+      @phone_number = phone_number unless phone_number == 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.
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      address_line_1 =
+        hash.key?('address_line_1') ? hash['address_line_1'] : SKIP
+      address_line_2 =
+        hash.key?('address_line_2') ? hash['address_line_2'] : SKIP
+      admin_area_2 = hash.key?('admin_area_2') ? hash['admin_area_2'] : SKIP
+      admin_area_1 = hash.key?('admin_area_1') ? hash['admin_area_1'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+      name = Name.from_hash(hash['name']) if hash['name']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      company = hash.key?('company') ? hash['company'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      phone_number = Phone.from_hash(hash['phone_number']) if hash['phone_number']
+
+      # Create object from extracted values.
+      AddressDetails.new(country_code: country_code,
+                         address_line_1: address_line_1,
+                         address_line_2: address_line_2,
+                         admin_area_2: admin_area_2,
+                         admin_area_1: admin_area_1,
+                         postal_code: postal_code,
+                         name: name,
+                         id: id,
+                         company: company,
+                         phone: phone,
+                         phone_number: phone_number)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/amount_breakdown.rb

@@ -0,0 +1,115 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The breakdown of the amount. Breakdown provides details such as total item
+  # amount, total tax amount, shipping, handling, insurance, and discounts, if
+  # any.
+  class AmountBreakdown < 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 :item_total
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :shipping
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :handling
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :tax_total
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :insurance
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :shipping_discount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :discount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['item_total'] = 'item_total'
+      @_hash['shipping'] = 'shipping'
+      @_hash['handling'] = 'handling'
+      @_hash['tax_total'] = 'tax_total'
+      @_hash['insurance'] = 'insurance'
+      @_hash['shipping_discount'] = 'shipping_discount'
+      @_hash['discount'] = 'discount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        item_total
+        shipping
+        handling
+        tax_total
+        insurance
+        shipping_discount
+        discount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(item_total: SKIP, shipping: SKIP, handling: SKIP,
+                   tax_total: SKIP, insurance: SKIP, shipping_discount: SKIP,
+                   discount: SKIP)
+      @item_total = item_total unless item_total == SKIP
+      @shipping = shipping unless shipping == SKIP
+      @handling = handling unless handling == SKIP
+      @tax_total = tax_total unless tax_total == SKIP
+      @insurance = insurance unless insurance == SKIP
+      @shipping_discount = shipping_discount unless shipping_discount == SKIP
+      @discount = discount unless discount == 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.
+      item_total = Money.from_hash(hash['item_total']) if hash['item_total']
+      shipping = Money.from_hash(hash['shipping']) if hash['shipping']
+      handling = Money.from_hash(hash['handling']) if hash['handling']
+      tax_total = Money.from_hash(hash['tax_total']) if hash['tax_total']
+      insurance = Money.from_hash(hash['insurance']) if hash['insurance']
+      shipping_discount = Money.from_hash(hash['shipping_discount']) if hash['shipping_discount']
+      discount = Money.from_hash(hash['discount']) if hash['discount']
+
+      # Create object from extracted values.
+      AmountBreakdown.new(item_total: item_total,
+                          shipping: shipping,
+                          handling: handling,
+                          tax_total: tax_total,
+                          insurance: insurance,
+                          shipping_discount: shipping_discount,
+                          discount: discount)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/amount_with_breakdown.rb

@@ -0,0 +1,80 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The total order amount with an optional breakdown that provides details,
+  # such as the total item amount, total tax amount, shipping, handling,
+  # insurance, and discounts, if any.<br/>If you specify `amount.breakdown`, the
+  # amount equals `item_total` plus `tax_total` plus `shipping` plus `handling`
+  # plus `insurance` minus `shipping_discount` minus discount.<br/>The amount
+  # must be a positive number. For listed of supported currencies and decimal
+  # precision, see the PayPal REST APIs <a
+  # href="/docs/integration/direct/rest/currency-codes/">Currency Codes</a>.
+  class AmountWithBreakdown < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The [three-character ISO-4217 currency
+    # code](/api/rest/reference/currency-codes/) that identifies the currency.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # The value, which might be:<ul><li>An integer for currencies like `JPY`
+    # that are not typically fractional.</li><li>A decimal fraction for
+    # currencies like `TND` that are subdivided into thousandths.</li></ul>For
+    # the required number of decimal places for a currency code, see [Currency
+    # Codes](/api/rest/reference/currency-codes/).
+    # @return [String]
+    attr_accessor :value
+
+    # The breakdown of the amount. Breakdown provides details such as total item
+    # amount, total tax amount, shipping, handling, insurance, and discounts, if
+    # any.
+    # @return [AmountBreakdown]
+    attr_accessor :breakdown
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency_code'] = 'currency_code'
+      @_hash['value'] = 'value'
+      @_hash['breakdown'] = 'breakdown'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        breakdown
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency_code:, value:, breakdown: SKIP)
+      @currency_code = currency_code
+      @value = value
+      @breakdown = breakdown unless breakdown == 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.
+      currency_code = hash.key?('currency_code') ? hash['currency_code'] : nil
+      value = hash.key?('value') ? hash['value'] : nil
+      breakdown = AmountBreakdown.from_hash(hash['breakdown']) if hash['breakdown']
+
+      # Create object from extracted values.
+      AmountWithBreakdown.new(currency_code: currency_code,
+                              value: value,
+                              breakdown: breakdown)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_attributes.rb

@@ -0,0 +1,60 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Additional attributes associated with apple pay.
+  class ApplePayAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The details about a customer in PayPal's system of record.
+    # @return [CustomerInformation]
+    attr_accessor :customer
+
+    # Base vaulting specification. The object can be extended for specific use
+    # cases within each payment_source that supports vaulting.
+    # @return [VaultInstruction]
+    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 = CustomerInformation.from_hash(hash['customer']) if hash['customer']
+      vault = VaultInstruction.from_hash(hash['vault']) if hash['vault']
+
+      # Create object from extracted values.
+      ApplePayAttributes.new(customer: customer,
+                             vault: vault)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_attributes_response.rb

@@ -0,0 +1,50 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Additional attributes associated with the use of Apple Pay.
+  class ApplePayAttributesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The details about a saved payment source.
+    # @return [VaultResponse]
+    attr_accessor :vault
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['vault'] = 'vault'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        vault
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(vault: 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.
+      vault = VaultResponse.from_hash(hash['vault']) if hash['vault']
+
+      # Create object from extracted values.
+      ApplePayAttributesResponse.new(vault: vault)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_card.rb

@@ -0,0 +1,94 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The payment card to be used to fund a payment. Can be a credit or debit
+  # card.
+  class ApplePayCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The card holder's name as it appears on the card.
+    # @return [String]
+    attr_accessor :name
+
+    # The last digits of the payment card.
+    # @return [String]
+    attr_accessor :last_digits
+
+    # 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 [CardBrand]
+    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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['last_digits'] = 'last_digits'
+      @_hash['type'] = 'type'
+      @_hash['brand'] = 'brand'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        last_digits
+        type
+        brand
+        billing_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, last_digits: SKIP, type: SKIP, brand: SKIP,
+                   billing_address: SKIP)
+      @name = name unless name == SKIP
+      @last_digits = last_digits unless last_digits == SKIP
+      @type = type unless type == SKIP
+      @brand = brand unless brand == SKIP
+      @billing_address = billing_address unless billing_address == 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
+      last_digits = hash.key?('last_digits') ? hash['last_digits'] : 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']
+
+      # Create object from extracted values.
+      ApplePayCard.new(name: name,
+                       last_digits: last_digits,
+                       type: type,
+                       brand: brand,
+                       billing_address: billing_address)
+    end
+  end
+end