paypal-server-sdk 1.1.0 → 2.0.0

data/lib/paypal_server_sdk/models/simple_postal_address_coarse_grained.rb

@@ -0,0 +1,130 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A simple postal address with coarse-grained fields. Do not use for an
+  # international address. Use for backward compatibility only. Does not contain
+  # phone.
+  class SimplePostalAddressCoarseGrained < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The first line of the address. For example, number or street.
+    # @return [String]
+    attr_accessor :line1
+
+    # The second line of the address. For example, suite or apartment number.
+    # @return [String]
+    attr_accessor :line2
+
+    # The city name.
+    # @return [String]
+    attr_accessor :city
+
+    # The [code](/docs/api/reference/state-codes/) for a US state or the
+    # equivalent for other countries. Required for transactions if the address
+    # is in one of these countries:
+    # [Argentina](/docs/api/reference/state-codes/#argentina),
+    # [Brazil](/docs/api/reference/state-codes/#brazil),
+    # [Canada](/docs/api/reference/state-codes/#canada),
+    # [China](/docs/api/reference/state-codes/#china),
+    # [India](/docs/api/reference/state-codes/#india),
+    # [Italy](/docs/api/reference/state-codes/#italy),
+    # [Japan](/docs/api/reference/state-codes/#japan),
+    # [Mexico](/docs/api/reference/state-codes/#mexico),
+    # [Thailand](/docs/api/reference/state-codes/#thailand), or [United
+    # States](/docs/api/reference/state-codes/#usa). Maximum length is 40
+    # single-byte characters.
+    # @return [String]
+    attr_accessor :state
+
+    # The [two-character ISO 3166-1
+    # code](/docs/integration/direct/rest/country-codes/) that identifies the
+    # country or region. Note: The country code for Great Britain is GB and not
+    # UK 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.
+    # @return [String]
+    attr_accessor :country_code
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line1'] = 'line1'
+      @_hash['line2'] = 'line2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['country_code'] = 'country_code'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line2
+        state
+        postal_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line1:, city:, country_code:, line2: SKIP, state: SKIP,
+                   postal_code: SKIP)
+      @line1 = line1
+      @line2 = line2 unless line2 == SKIP
+      @city = city
+      @state = state unless state == SKIP
+      @country_code = country_code
+      @postal_code = postal_code unless postal_code == 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.
+      line1 = hash.key?('line1') ? hash['line1'] : nil
+      city = hash.key?('city') ? hash['city'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+
+      # Create object from extracted values.
+      SimplePostalAddressCoarseGrained.new(line1: line1,
+                                           city: city,
+                                           country_code: country_code,
+                                           line2: line2,
+                                           state: state,
+                                           postal_code: postal_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line1: #{@line1}, line2: #{@line2}, city: #{@city}, state: #{@state},"\
+      " country_code: #{@country_code}, postal_code: #{@postal_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line1: #{@line1.inspect}, line2: #{@line2.inspect}, city: #{@city.inspect},"\
+      " state: #{@state.inspect}, country_code: #{@country_code.inspect}, postal_code:"\
+      " #{@postal_code.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/sofort_payment_object.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Information used to pay using Sofort.

data/lib/paypal_server_sdk/models/sofort_payment_request.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Information needed to pay using Sofort.

data/lib/paypal_server_sdk/models/standard_entry_class_code.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # NACHA (the regulatory body governing the ACH network) requires that API

data/lib/paypal_server_sdk/models/store_in_vault_instruction.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Defines how and when the payment source gets vaulted.

data/lib/paypal_server_sdk/models/store_information.rb

@@ -0,0 +1,71 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The store information.
+  class StoreInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of a store for a merchant in the system of record.
+    # @return [String]
+    attr_accessor :store_id
+
+    # The terminal ID for the checkout stand in a merchant store.
+    # @return [String]
+    attr_accessor :terminal_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['store_id'] = 'store_id'
+      @_hash['terminal_id'] = 'terminal_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        store_id
+        terminal_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(store_id: SKIP, terminal_id: SKIP)
+      @store_id = store_id unless store_id == SKIP
+      @terminal_id = terminal_id unless terminal_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.
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+      terminal_id = hash.key?('terminal_id') ? hash['terminal_id'] : SKIP
+
+      # Create object from extracted values.
+      StoreInformation.new(store_id: store_id,
+                           terminal_id: terminal_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} store_id: #{@store_id}, terminal_id: #{@terminal_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} store_id: #{@store_id.inspect}, terminal_id: #{@terminal_id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/stored_payment_source.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Provides additional details to process a payment using a `payment_source`
@@ -32,7 +32,7 @@ module PaypalServerSdk
     attr_accessor :usage
 
     # Reference values used by the card network to identify a transaction.
-    # @return [NetworkTransactionReference]
+    # @return [NetworkTransaction]
     attr_accessor :previous_network_transaction_reference
 
     # A mapping from model property names to API property names.
@@ -81,7 +81,7 @@ module PaypalServerSdk
       payment_type = hash.key?('payment_type') ? hash['payment_type'] : nil
       usage = hash['usage'] ||= StoredPaymentSourceUsageType::DERIVED
       if hash['previous_network_transaction_reference']
-        previous_network_transaction_reference = NetworkTransactionReference.from_hash(hash['previous_network_transaction_reference'])
+        previous_network_transaction_reference = NetworkTransaction.from_hash(hash['previous_network_transaction_reference'])
       end
 
       # Create object from extracted values.

data/lib/paypal_server_sdk/models/stored_payment_source_payment_type.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Indicates the type of the stored payment_source payment.

data/lib/paypal_server_sdk/models/stored_payment_source_usage_type.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Indicates if this is a `first` or `subsequent` payment using a stored

data/lib/paypal_server_sdk/models/subscriber.rb

@@ -0,0 +1,84 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The subscriber response information.
+  class Subscriber < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the party.
+    # @return [Name]
+    attr_accessor :name
+
+    # The shipping details.
+    # @return [ShippingDetails]
+    attr_accessor :shipping_address
+
+    # The payment source used to fund the payment.
+    # @return [SubscriptionPaymentSourceResponse]
+    attr_accessor :payment_source
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['payment_source'] = 'payment_source'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        shipping_address
+        payment_source
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, shipping_address: SKIP, payment_source: SKIP)
+      @name = name unless name == SKIP
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @payment_source = payment_source unless 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.
+      name = Name.from_hash(hash['name']) if hash['name']
+      shipping_address = ShippingDetails.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      payment_source = SubscriptionPaymentSourceResponse.from_hash(hash['payment_source']) if
+        hash['payment_source']
+
+      # Create object from extracted values.
+      Subscriber.new(name: name,
+                     shipping_address: shipping_address,
+                     payment_source: payment_source)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, shipping_address: #{@shipping_address}, payment_source:"\
+      " #{@payment_source}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, shipping_address: #{@shipping_address.inspect},"\
+      " payment_source: #{@payment_source.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscriber_request.rb

@@ -0,0 +1,97 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The subscriber request information .
+  class SubscriberRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the party.
+    # @return [Name]
+    attr_accessor :name
+
+    # The phone information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
+    # The shipping details.
+    # @return [ShippingDetails]
+    attr_accessor :shipping_address
+
+    # The payment source definition. To be eligible to create subscription using
+    # debit or credit card, you will need to sign up here
+    # (https://www.paypal.com/bizsignup/entry/product/ppcp). Please note, its
+    # available only for non-3DS cards and for merchants in US and AU regions.
+    # @return [SubscriptionPaymentSource]
+    attr_accessor :payment_source
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['phone'] = 'phone'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['payment_source'] = 'payment_source'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        phone
+        shipping_address
+        payment_source
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, phone: SKIP, shipping_address: SKIP,
+                   payment_source: SKIP)
+      @name = name unless name == SKIP
+      @phone = phone unless phone == SKIP
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @payment_source = payment_source unless 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.
+      name = Name.from_hash(hash['name']) if hash['name']
+      phone = PhoneWithType.from_hash(hash['phone']) if hash['phone']
+      shipping_address = ShippingDetails.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      payment_source = SubscriptionPaymentSource.from_hash(hash['payment_source']) if
+        hash['payment_source']
+
+      # Create object from extracted values.
+      SubscriberRequest.new(name: name,
+                            phone: phone,
+                            shipping_address: shipping_address,
+                            payment_source: payment_source)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, phone: #{@phone}, shipping_address: #{@shipping_address},"\
+      " payment_source: #{@payment_source}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, phone: #{@phone.inspect}, shipping_address:"\
+      " #{@shipping_address.inspect}, payment_source: #{@payment_source.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription.rb

@@ -0,0 +1,205 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The subscription details.
+  class Subscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The PayPal-generated ID for the subscription.
+    # @return [String]
+    attr_accessor :id
+
+    # The ID of the plan.
+    # @return [String]
+    attr_accessor :plan_id
+
+    # 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 :start_time
+
+    # The quantity of the product in the subscription.
+    # @return [String]
+    attr_accessor :quantity
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :shipping_amount
+
+    # The subscriber response information.
+    # @return [Subscriber]
+    attr_accessor :subscriber
+
+    # The billing details for the subscription. If the subscription was or is
+    # active, these fields are populated.
+    # @return [SubscriptionBillingInformation]
+    attr_accessor :billing_info
+
+    # 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 :create_time
+
+    # 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 :update_time
+
+    # The custom id for the subscription. Can be invoice id.
+    # @return [String]
+    attr_accessor :custom_id
+
+    # Indicates whether the subscription has overridden any plan attributes.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :plan_overridden
+
+    # The plan details.
+    # @return [PlanDetails]
+    attr_accessor :plan
+
+    # An array of request-related [HATEOAS
+    # links](/docs/api/reference/api-responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['plan_id'] = 'plan_id'
+      @_hash['start_time'] = 'start_time'
+      @_hash['quantity'] = 'quantity'
+      @_hash['shipping_amount'] = 'shipping_amount'
+      @_hash['subscriber'] = 'subscriber'
+      @_hash['billing_info'] = 'billing_info'
+      @_hash['create_time'] = 'create_time'
+      @_hash['update_time'] = 'update_time'
+      @_hash['custom_id'] = 'custom_id'
+      @_hash['plan_overridden'] = 'plan_overridden'
+      @_hash['plan'] = 'plan'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        plan_id
+        start_time
+        quantity
+        shipping_amount
+        subscriber
+        billing_info
+        create_time
+        update_time
+        custom_id
+        plan_overridden
+        plan
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, plan_id: SKIP, start_time: SKIP, quantity: SKIP,
+                   shipping_amount: SKIP, subscriber: SKIP, billing_info: SKIP,
+                   create_time: SKIP, update_time: SKIP, custom_id: SKIP,
+                   plan_overridden: SKIP, plan: SKIP, links: SKIP)
+      @id = id unless id == SKIP
+      @plan_id = plan_id unless plan_id == SKIP
+      @start_time = start_time unless start_time == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @shipping_amount = shipping_amount unless shipping_amount == SKIP
+      @subscriber = subscriber unless subscriber == SKIP
+      @billing_info = billing_info unless billing_info == SKIP
+      @create_time = create_time unless create_time == SKIP
+      @update_time = update_time unless update_time == SKIP
+      @custom_id = custom_id unless custom_id == SKIP
+      @plan_overridden = plan_overridden unless plan_overridden == SKIP
+      @plan = plan unless plan == SKIP
+      @links = links unless links == 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
+      plan_id = hash.key?('plan_id') ? hash['plan_id'] : SKIP
+      start_time = hash.key?('start_time') ? hash['start_time'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      shipping_amount = Money.from_hash(hash['shipping_amount']) if hash['shipping_amount']
+      subscriber = Subscriber.from_hash(hash['subscriber']) if hash['subscriber']
+      billing_info = SubscriptionBillingInformation.from_hash(hash['billing_info']) if
+        hash['billing_info']
+      create_time = hash.key?('create_time') ? hash['create_time'] : SKIP
+      update_time = hash.key?('update_time') ? hash['update_time'] : SKIP
+      custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
+      plan_overridden =
+        hash.key?('plan_overridden') ? hash['plan_overridden'] : SKIP
+      plan = PlanDetails.from_hash(hash['plan']) if hash['plan']
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (LinkDescription.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+
+      # Create object from extracted values.
+      Subscription.new(id: id,
+                       plan_id: plan_id,
+                       start_time: start_time,
+                       quantity: quantity,
+                       shipping_amount: shipping_amount,
+                       subscriber: subscriber,
+                       billing_info: billing_info,
+                       create_time: create_time,
+                       update_time: update_time,
+                       custom_id: custom_id,
+                       plan_overridden: plan_overridden,
+                       plan: plan,
+                       links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, plan_id: #{@plan_id}, start_time: #{@start_time}, quantity:"\
+      " #{@quantity}, shipping_amount: #{@shipping_amount}, subscriber: #{@subscriber},"\
+      " billing_info: #{@billing_info}, create_time: #{@create_time}, update_time:"\
+      " #{@update_time}, custom_id: #{@custom_id}, plan_overridden: #{@plan_overridden}, plan:"\
+      " #{@plan}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, plan_id: #{@plan_id.inspect}, start_time:"\
+      " #{@start_time.inspect}, quantity: #{@quantity.inspect}, shipping_amount:"\
+      " #{@shipping_amount.inspect}, subscriber: #{@subscriber.inspect}, billing_info:"\
+      " #{@billing_info.inspect}, create_time: #{@create_time.inspect}, update_time:"\
+      " #{@update_time.inspect}, custom_id: #{@custom_id.inspect}, plan_overridden:"\
+      " #{@plan_overridden.inspect}, plan: #{@plan.inspect}, links: #{@links.inspect}>"
+    end
+  end
+end