paypal-server-sdk 1.0.0 → 2.0.0

data/lib/paypal_server_sdk/models/subscription_payer_name.rb

@@ -0,0 +1,114 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The name of the party.
+  class SubscriptionPayerName < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The prefix, or title, to the party's name.
+    # @return [String]
+    attr_accessor :prefix
+
+    # When the party is a person, the party's given, or first, name.
+    # @return [String]
+    attr_accessor :given_name
+
+    # When the party is a person, the party's surname or family name. Also known
+    # as the last name. Required when the party is a person. Use also to store
+    # multiple surnames including the matronymic, or mother's, surname.
+    # @return [String]
+    attr_accessor :surname
+
+    # When the party is a person, the party's middle name. Use also to store
+    # multiple middle names including the patronymic, or father's, middle name.
+    # @return [String]
+    attr_accessor :middle_name
+
+    # The suffix for the party's name.
+    # @return [String]
+    attr_accessor :suffix
+
+    # When the party is a person, the party's full name.
+    # @return [String]
+    attr_accessor :full_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['prefix'] = 'prefix'
+      @_hash['given_name'] = 'given_name'
+      @_hash['surname'] = 'surname'
+      @_hash['middle_name'] = 'middle_name'
+      @_hash['suffix'] = 'suffix'
+      @_hash['full_name'] = 'full_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        prefix
+        given_name
+        surname
+        middle_name
+        suffix
+        full_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(prefix: SKIP, given_name: SKIP, surname: SKIP,
+                   middle_name: SKIP, suffix: SKIP, full_name: SKIP)
+      @prefix = prefix unless prefix == SKIP
+      @given_name = given_name unless given_name == SKIP
+      @surname = surname unless surname == SKIP
+      @middle_name = middle_name unless middle_name == SKIP
+      @suffix = suffix unless suffix == SKIP
+      @full_name = full_name unless full_name == 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.
+      prefix = hash.key?('prefix') ? hash['prefix'] : SKIP
+      given_name = hash.key?('given_name') ? hash['given_name'] : SKIP
+      surname = hash.key?('surname') ? hash['surname'] : SKIP
+      middle_name = hash.key?('middle_name') ? hash['middle_name'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
+      full_name = hash.key?('full_name') ? hash['full_name'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionPayerName.new(prefix: prefix,
+                                given_name: given_name,
+                                surname: surname,
+                                middle_name: middle_name,
+                                suffix: suffix,
+                                full_name: full_name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} prefix: #{@prefix}, given_name: #{@given_name}, surname: #{@surname},"\
+      " middle_name: #{@middle_name}, suffix: #{@suffix}, full_name: #{@full_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} prefix: #{@prefix.inspect}, given_name: #{@given_name.inspect}, surname:"\
+      " #{@surname.inspect}, middle_name: #{@middle_name.inspect}, suffix: #{@suffix.inspect},"\
+      " full_name: #{@full_name.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_payment_source.rb

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

data/lib/paypal_server_sdk/models/subscription_payment_source_response.rb

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

data/lib/paypal_server_sdk/models/subscription_plan_status.rb

@@ -0,0 +1,28 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The plan status.
+  class SubscriptionPlanStatus
+    SUBSCRIPTION_PLAN_STATUS = [
+      # The plan was created. You cannot create subscriptions for a plan in this
+      # state.
+      CREATED = 'CREATED'.freeze,
+
+      # The plan is inactive.
+      INACTIVE = 'INACTIVE'.freeze,
+
+      # The plan is active. You can only create subscriptions for a plan in this
+      # state.
+      ACTIVE = 'ACTIVE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_pricing_model.rb

@@ -0,0 +1,23 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The pricing model for tiered plan. The `tiers` parameter is required.
+  class SubscriptionPricingModel
+    SUBSCRIPTION_PRICING_MODEL = [
+      # A volume pricing model.
+      VOLUME = 'VOLUME'.freeze,
+
+      # A tiered pricing model.
+      TIERED = 'TIERED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_pricing_scheme.rb

@@ -0,0 +1,129 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The pricing scheme details.
+  class SubscriptionPricingScheme < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The version of the pricing scheme.
+    # @return [Integer]
+    attr_accessor :version
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :fixed_price
+
+    # The pricing model for tiered plan. The `tiers` parameter is required.
+    # @return [SubscriptionPricingModel]
+    attr_accessor :pricing_model
+
+    # An array of pricing tiers which are used for billing volume/tiered plans.
+    # pricing_model field has to be specified.
+    # @return [Array[PricingTier]]
+    attr_accessor :tiers
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['version'] = 'version'
+      @_hash['fixed_price'] = 'fixed_price'
+      @_hash['pricing_model'] = 'pricing_model'
+      @_hash['tiers'] = 'tiers'
+      @_hash['create_time'] = 'create_time'
+      @_hash['update_time'] = 'update_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        version
+        fixed_price
+        pricing_model
+        tiers
+        create_time
+        update_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(version: SKIP, fixed_price: SKIP, pricing_model: SKIP,
+                   tiers: SKIP, create_time: SKIP, update_time: SKIP)
+      @version = version unless version == SKIP
+      @fixed_price = fixed_price unless fixed_price == SKIP
+      @pricing_model = pricing_model unless pricing_model == SKIP
+      @tiers = tiers unless tiers == SKIP
+      @create_time = create_time unless create_time == SKIP
+      @update_time = update_time unless update_time == 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.
+      version = hash.key?('version') ? hash['version'] : SKIP
+      fixed_price = Money.from_hash(hash['fixed_price']) if hash['fixed_price']
+      pricing_model = hash.key?('pricing_model') ? hash['pricing_model'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      tiers = nil
+      unless hash['tiers'].nil?
+        tiers = []
+        hash['tiers'].each do |structure|
+          tiers << (PricingTier.from_hash(structure) if structure)
+        end
+      end
+
+      tiers = SKIP unless hash.key?('tiers')
+      create_time = hash.key?('create_time') ? hash['create_time'] : SKIP
+      update_time = hash.key?('update_time') ? hash['update_time'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionPricingScheme.new(version: version,
+                                    fixed_price: fixed_price,
+                                    pricing_model: pricing_model,
+                                    tiers: tiers,
+                                    create_time: create_time,
+                                    update_time: update_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} version: #{@version}, fixed_price: #{@fixed_price}, pricing_model:"\
+      " #{@pricing_model}, tiers: #{@tiers}, create_time: #{@create_time}, update_time:"\
+      " #{@update_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} version: #{@version.inspect}, fixed_price: #{@fixed_price.inspect},"\
+      " pricing_model: #{@pricing_model.inspect}, tiers: #{@tiers.inspect}, create_time:"\
+      " #{@create_time.inspect}, update_time: #{@update_time.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_transaction_details.rb

@@ -0,0 +1,118 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The transaction details.
+  class SubscriptionTransactionDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status of the captured payment.
+    # @return [CaptureStatus]
+    attr_accessor :status
+
+    # The PayPal-generated transaction ID.
+    # @return [String]
+    attr_accessor :id
+
+    # The breakdown details for the amount. Includes the gross, tax, fee, and
+    # shipping amounts.
+    # @return [SubscriptionAmountWithBreakdown]
+    attr_accessor :amount_with_breakdown
+
+    # The name of the party.
+    # @return [SubscriptionPayerName]
+    attr_accessor :payer_name
+
+    # The internationalized email address. Note: Up to 64 characters are allowed
+    # before and 255 characters are allowed after the @ sign. However, the
+    # generally accepted maximum length for an email address is 254 characters.
+    # The pattern verifies that an unquoted @ sign exists.
+    # @return [String]
+    attr_accessor :payer_email
+
+    # 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 :time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['id'] = 'id'
+      @_hash['amount_with_breakdown'] = 'amount_with_breakdown'
+      @_hash['payer_name'] = 'payer_name'
+      @_hash['payer_email'] = 'payer_email'
+      @_hash['time'] = 'time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        payer_name
+        payer_email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, amount_with_breakdown:, time:, status: SKIP,
+                   payer_name: SKIP, payer_email: SKIP)
+      @status = status unless status == SKIP
+      @id = id
+      @amount_with_breakdown = amount_with_breakdown
+      @payer_name = payer_name unless payer_name == SKIP
+      @payer_email = payer_email unless payer_email == SKIP
+      @time = time
+    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'] : nil
+      if hash['amount_with_breakdown']
+        amount_with_breakdown = SubscriptionAmountWithBreakdown.from_hash(hash['amount_with_breakdown'])
+      end
+      time = hash.key?('time') ? hash['time'] : nil
+      status = hash.key?('status') ? hash['status'] : SKIP
+      payer_name = SubscriptionPayerName.from_hash(hash['payer_name']) if hash['payer_name']
+      payer_email = hash.key?('payer_email') ? hash['payer_email'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionTransactionDetails.new(id: id,
+                                         amount_with_breakdown: amount_with_breakdown,
+                                         time: time,
+                                         status: status,
+                                         payer_name: payer_name,
+                                         payer_email: payer_email)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, id: #{@id}, amount_with_breakdown:"\
+      " #{@amount_with_breakdown}, payer_name: #{@payer_name}, payer_email: #{@payer_email}, time:"\
+      " #{@time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, id: #{@id.inspect}, amount_with_breakdown:"\
+      " #{@amount_with_breakdown.inspect}, payer_name: #{@payer_name.inspect}, payer_email:"\
+      " #{@payer_email.inspect}, time: #{@time.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscriptions_card_attributes.rb

@@ -0,0 +1,83 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Additional attributes associated with the use of this card.
+  class SubscriptionsCardAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The details about a customer in PayPal's system of record.
+    # @return [CardCustomer]
+    attr_accessor :customer
+
+    # Basic vault instruction specification that can be extended by specific
+    # payment sources that supports vaulting.
+    # @return [VaultInstructionBase]
+    attr_accessor :vault
+
+    # The API caller can opt in to verify the card through PayPal offered
+    # verification services (e.g. Smart Dollar Auth, 3DS).
+    # @return [CardVerification]
+    attr_accessor :verification
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer'] = 'customer'
+      @_hash['vault'] = 'vault'
+      @_hash['verification'] = 'verification'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer
+        vault
+        verification
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer: SKIP, vault: SKIP, verification: SKIP)
+      @customer = customer unless customer == SKIP
+      @vault = vault unless vault == SKIP
+      @verification = verification unless verification == 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 = CardCustomer.from_hash(hash['customer']) if hash['customer']
+      vault = VaultInstructionBase.from_hash(hash['vault']) if hash['vault']
+      verification = CardVerification.from_hash(hash['verification']) if hash['verification']
+
+      # Create object from extracted values.
+      SubscriptionsCardAttributes.new(customer: customer,
+                                      vault: vault,
+                                      verification: verification)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer}, vault: #{@vault}, verification: #{@verification}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer.inspect}, vault: #{@vault.inspect}, verification:"\
+      " #{@verification.inspect}>"
+    end
+  end
+end