paypal-server-sdk 0.6.1 → 0.7.0

data/lib/paypal_server_sdk/models/paypal_wallet_vault_status.rb

@@ -7,13 +7,18 @@ module PaypalServerSdk
   # The vault status.
   class PaypalWalletVaultStatus
     PAYPAL_WALLET_VAULT_STATUS = [
-      # TODO: Write general description for VAULTED
+      # The payment source has been saved in your customer's vault. This vault
+      # status reflects `/v3/vault` status.
       VAULTED = 'VAULTED'.freeze,
 
-      # TODO: Write general description for CREATED
+      # DEPRECATED. The payment source has been saved in your customer's vault.
+      # This status applies to deprecated integration patterns and will not be
+      # returned for v3/vault integrations.
       CREATED = 'CREATED'.freeze,
 
-      # TODO: Write general description for APPROVED
+      # Customer has approved the action of saving the specified payment_source
+      # into their vault. Use v3/vault/payment-tokens with given setup_token to
+      # save the payment source in the vault
       APPROVED = 'APPROVED'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/phone.rb

@@ -73,5 +73,19 @@ module PaypalServerSdk
                 national_number: national_number,
                 extension_number: extension_number)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_code: #{@country_code}, national_number: #{@national_number},"\
+      " extension_number: #{@extension_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_code: #{@country_code.inspect}, national_number:"\
+      " #{@national_number.inspect}, extension_number: #{@extension_number.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/phone_number.rb

@@ -50,5 +50,17 @@ module PaypalServerSdk
       # Create object from extracted values.
       PhoneNumber.new(national_number: national_number)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} national_number: #{@national_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} national_number: #{@national_number.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/phone_number_with_country_code.rb

@@ -5,6 +5,8 @@
 
 module PaypalServerSdk
   # The phone number in its canonical international [E.164 numbering plan
+  # format](https://www.itu.int/rec/T-REC-E.164/en)., The phone number, in its
+  # canonical international [E.164 numbering plan
   # format](https://www.itu.int/rec/T-REC-E.164/en).
   class PhoneNumberWithCountryCode < BaseModel
     SKIP = Object.new
@@ -62,5 +64,18 @@ module PaypalServerSdk
       PhoneNumberWithCountryCode.new(country_code: country_code,
                                      national_number: national_number)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_code: #{@country_code}, national_number: #{@national_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_code: #{@country_code.inspect}, national_number:"\
+      " #{@national_number.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/phone_with_type.rb

@@ -55,5 +55,18 @@ module PaypalServerSdk
       PhoneWithType.new(phone_number: phone_number,
                         phone_type: phone_type)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} phone_type: #{@phone_type}, phone_number: #{@phone_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} phone_type: #{@phone_type.inspect}, phone_number:"\
+      " #{@phone_number.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/plan.rb

@@ -0,0 +1,102 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The merchant level Recurring Billing plan metadata for the Billing
+  # Agreement.
+  class Plan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of billing cycles for trial billing and regular billing. A plan
+    # can have at most two trial cycles and only one regular cycle.
+    # @return [Array[BillingCycle]]
+    attr_accessor :billing_cycles
+
+    # Product details associated with any one-time product purchase.
+    # @return [Object]
+    attr_accessor :product
+
+    # The one-time charge info at the time of checkout.
+    # @return [OneTimeCharge]
+    attr_accessor :one_time_charges
+
+    # Name of the recurring plan.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['billing_cycles'] = 'billing_cycles'
+      @_hash['product'] = 'product'
+      @_hash['one_time_charges'] = 'one_time_charges'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(billing_cycles:, one_time_charges:, product: SKIP,
+                   name: SKIP)
+      @billing_cycles = billing_cycles
+      @product = product unless product == SKIP
+      @one_time_charges = one_time_charges
+      @name = name unless 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.
+      # Parameter is an array, so we need to iterate through it
+      billing_cycles = nil
+      unless hash['billing_cycles'].nil?
+        billing_cycles = []
+        hash['billing_cycles'].each do |structure|
+          billing_cycles << (BillingCycle.from_hash(structure) if structure)
+        end
+      end
+
+      billing_cycles = nil unless hash.key?('billing_cycles')
+      one_time_charges = OneTimeCharge.from_hash(hash['one_time_charges']) if
+        hash['one_time_charges']
+      product = hash.key?('product') ? hash['product'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      Plan.new(billing_cycles: billing_cycles,
+               one_time_charges: one_time_charges,
+               product: product,
+               name: name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} billing_cycles: #{@billing_cycles}, product: #{@product}, one_time_charges:"\
+      " #{@one_time_charges}, name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} billing_cycles: #{@billing_cycles.inspect}, product: #{@product.inspect},"\
+      " one_time_charges: #{@one_time_charges.inspect}, name: #{@name.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/platform_fee.rb

@@ -59,5 +59,17 @@ module PaypalServerSdk
       PlatformFee.new(amount: amount,
                       payee: payee)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, payee: #{@payee}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, payee: #{@payee.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/pricing_model.rb

@@ -0,0 +1,28 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The pricing model for the billing cycle.
+  class PricingModel
+    PRICING_MODEL = [
+      # A fixed pricing scheme where the customer is charged a fixed amount.
+      FIXED = 'FIXED'.freeze,
+
+      # A variable pricing scheme where the customer is charged a variable
+      # amount.
+      VARIABLE = 'VARIABLE'.freeze,
+
+      # A auto-reload pricing scheme where the customer is charged a fixed
+      # amount for reload.
+      AUTO_RELOAD = 'AUTO_RELOAD'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pricing_scheme.rb

@@ -0,0 +1,84 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The pricing scheme details.
+  class PricingScheme < 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 :price
+
+    # The pricing model for the billing cycle.
+    # @return [PricingModel]
+    attr_accessor :pricing_model
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :reload_threshold_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['price'] = 'price'
+      @_hash['pricing_model'] = 'pricing_model'
+      @_hash['reload_threshold_amount'] = 'reload_threshold_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        price
+        reload_threshold_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pricing_model:, price: SKIP, reload_threshold_amount: SKIP)
+      @price = price unless price == SKIP
+      @pricing_model = pricing_model
+      @reload_threshold_amount = reload_threshold_amount unless reload_threshold_amount == 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.
+      pricing_model = hash.key?('pricing_model') ? hash['pricing_model'] : nil
+      price = Money.from_hash(hash['price']) if hash['price']
+      reload_threshold_amount = Money.from_hash(hash['reload_threshold_amount']) if
+        hash['reload_threshold_amount']
+
+      # Create object from extracted values.
+      PricingScheme.new(pricing_model: pricing_model,
+                        price: price,
+                        reload_threshold_amount: reload_threshold_amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price: #{@price}, pricing_model: #{@pricing_model},"\
+      " reload_threshold_amount: #{@reload_threshold_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price: #{@price.inspect}, pricing_model: #{@pricing_model.inspect},"\
+      " reload_threshold_amount: #{@reload_threshold_amount.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/processor_response.rb

@@ -79,5 +79,20 @@ module PaypalServerSdk
                             response_code: response_code,
                             payment_advice_code: payment_advice_code)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} avs_code: #{@avs_code}, cvv_code: #{@cvv_code}, response_code:"\
+      " #{@response_code}, payment_advice_code: #{@payment_advice_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} avs_code: #{@avs_code.inspect}, cvv_code: #{@cvv_code.inspect},"\
+      " response_code: #{@response_code.inspect}, payment_advice_code:"\
+      " #{@payment_advice_code.inspect}>"
+    end
   end
 end