paypal-server-sdk 1.1.0 → 2.1.0

data/lib/paypal_server_sdk/models/card_verification_status.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
   # Verification status of Card.
@@ -19,5 +19,18 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = VERIFIED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'verified' then VERIFIED
+      when 'failed' then FAILED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/cart_information.rb

@@ -0,0 +1,94 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The cart information.
+  class CartInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of item details.
+    # @return [Array[ItemDetails]]
+    attr_accessor :item_details
+
+    # Indicates whether the item amount or the shipping amount already includes
+    # tax.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_inclusive
+
+    # The ID of the invoice. Appears for only PayPal-generated invoices.
+    # @return [String]
+    attr_accessor :paypal_invoice_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['item_details'] = 'item_details'
+      @_hash['tax_inclusive'] = 'tax_inclusive'
+      @_hash['paypal_invoice_id'] = 'paypal_invoice_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        item_details
+        tax_inclusive
+        paypal_invoice_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(item_details: SKIP, tax_inclusive: false,
+                   paypal_invoice_id: SKIP)
+      @item_details = item_details unless item_details == SKIP
+      @tax_inclusive = tax_inclusive unless tax_inclusive == SKIP
+      @paypal_invoice_id = paypal_invoice_id unless paypal_invoice_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.
+      # Parameter is an array, so we need to iterate through it
+      item_details = nil
+      unless hash['item_details'].nil?
+        item_details = []
+        hash['item_details'].each do |structure|
+          item_details << (ItemDetails.from_hash(structure) if structure)
+        end
+      end
+
+      item_details = SKIP unless hash.key?('item_details')
+      tax_inclusive = hash['tax_inclusive'] ||= false
+      paypal_invoice_id =
+        hash.key?('paypal_invoice_id') ? hash['paypal_invoice_id'] : SKIP
+
+      # Create object from extracted values.
+      CartInformation.new(item_details: item_details,
+                          tax_inclusive: tax_inclusive,
+                          paypal_invoice_id: paypal_invoice_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_details: #{@item_details}, tax_inclusive: #{@tax_inclusive},"\
+      " paypal_invoice_id: #{@paypal_invoice_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_details: #{@item_details.inspect}, tax_inclusive:"\
+      " #{@tax_inclusive.inspect}, paypal_invoice_id: #{@paypal_invoice_id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/checkout_option.rb

@@ -0,0 +1,77 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A checkout option as a name-and-value pair.
+  class CheckoutOption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The checkout option name, such as `color` or `texture`.
+    # @return [String]
+    attr_accessor :checkout_option_name
+
+    # The checkout option value. For example, the checkout option `color` might
+    # be `blue` or `red` while the checkout option `texture` might be `smooth`
+    # or `rippled`.
+    # @return [String]
+    attr_accessor :checkout_option_value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['checkout_option_name'] = 'checkout_option_name'
+      @_hash['checkout_option_value'] = 'checkout_option_value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        checkout_option_name
+        checkout_option_value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(checkout_option_name: SKIP, checkout_option_value: SKIP)
+      @checkout_option_name = checkout_option_name unless checkout_option_name == SKIP
+      @checkout_option_value = checkout_option_value unless checkout_option_value == 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.
+      checkout_option_name =
+        hash.key?('checkout_option_name') ? hash['checkout_option_name'] : SKIP
+      checkout_option_value =
+        hash.key?('checkout_option_value') ? hash['checkout_option_value'] : SKIP
+
+      # Create object from extracted values.
+      CheckoutOption.new(checkout_option_name: checkout_option_name,
+                         checkout_option_value: checkout_option_value)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} checkout_option_name: #{@checkout_option_name}, checkout_option_value:"\
+      " #{@checkout_option_value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} checkout_option_name: #{@checkout_option_name.inspect},"\
+      " checkout_option_value: #{@checkout_option_value.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/checkout_payment_intent.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
   # The intent to either capture payment immediately or authorize a payment for
@@ -28,5 +28,18 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = CAPTURE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'capture' then CAPTURE
+      when 'authorize' then AUTHORIZE
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/cobranded_card.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
   # Details about the merchant cobranded card used for order purchase.

data/lib/paypal_server_sdk/models/confirm_order_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
   # Payer confirms the intent to pay for the Order using the provided payment

data/lib/paypal_server_sdk/models/create_subscription_request.rb

@@ -0,0 +1,151 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The create subscription request details.
+  class CreateSubscriptionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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 request information .
+    # @return [SubscriberRequest]
+    attr_accessor :subscriber
+
+    # DEPRECATED. Indicates whether the subscription auto-renews after the
+    # billing cycles complete.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_renewal
+
+    # DEPRECATED. The application context, which customizes the payer experience
+    # during the subscription approval process with PayPal.
+    # @return [SubscriptionApplicationContext]
+    attr_accessor :application_context
+
+    # The custom id for the subscription. Can be invoice id.
+    # @return [String]
+    attr_accessor :custom_id
+
+    # An inline plan object to customise the subscription. You can override plan
+    # level default attributes by providing customised values for the
+    # subscription in this object.
+    # @return [PlanOverride]
+    attr_accessor :plan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['plan_id'] = 'plan_id'
+      @_hash['start_time'] = 'start_time'
+      @_hash['quantity'] = 'quantity'
+      @_hash['shipping_amount'] = 'shipping_amount'
+      @_hash['subscriber'] = 'subscriber'
+      @_hash['auto_renewal'] = 'auto_renewal'
+      @_hash['application_context'] = 'application_context'
+      @_hash['custom_id'] = 'custom_id'
+      @_hash['plan'] = 'plan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_time
+        quantity
+        shipping_amount
+        subscriber
+        auto_renewal
+        application_context
+        custom_id
+        plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(plan_id:, start_time: SKIP, quantity: SKIP,
+                   shipping_amount: SKIP, subscriber: SKIP, auto_renewal: false,
+                   application_context: SKIP, custom_id: SKIP, plan: SKIP)
+      @plan_id = plan_id
+      @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
+      @auto_renewal = auto_renewal unless auto_renewal == SKIP
+      @application_context = application_context unless application_context == SKIP
+      @custom_id = custom_id unless custom_id == SKIP
+      @plan = plan unless plan == 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.
+      plan_id = hash.key?('plan_id') ? hash['plan_id'] : nil
+      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 = SubscriberRequest.from_hash(hash['subscriber']) if hash['subscriber']
+      auto_renewal = hash['auto_renewal'] ||= false
+      application_context = SubscriptionApplicationContext.from_hash(hash['application_context']) if
+        hash['application_context']
+      custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
+      plan = PlanOverride.from_hash(hash['plan']) if hash['plan']
+
+      # Create object from extracted values.
+      CreateSubscriptionRequest.new(plan_id: plan_id,
+                                    start_time: start_time,
+                                    quantity: quantity,
+                                    shipping_amount: shipping_amount,
+                                    subscriber: subscriber,
+                                    auto_renewal: auto_renewal,
+                                    application_context: application_context,
+                                    custom_id: custom_id,
+                                    plan: plan)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plan_id: #{@plan_id}, start_time: #{@start_time}, quantity: #{@quantity},"\
+      " shipping_amount: #{@shipping_amount}, subscriber: #{@subscriber}, auto_renewal:"\
+      " #{@auto_renewal}, application_context: #{@application_context}, custom_id: #{@custom_id},"\
+      " plan: #{@plan}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plan_id: #{@plan_id.inspect}, start_time: #{@start_time.inspect}, quantity:"\
+      " #{@quantity.inspect}, shipping_amount: #{@shipping_amount.inspect}, subscriber:"\
+      " #{@subscriber.inspect}, auto_renewal: #{@auto_renewal.inspect}, application_context:"\
+      " #{@application_context.inspect}, custom_id: #{@custom_id.inspect}, plan:"\
+      " #{@plan.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/customer.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
   # This object defines a customer in your system. Use it to manage customer

data/lib/paypal_server_sdk/models/customer_information.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
   # This object represents a merchant’s customer, allowing them to store contact

data/lib/paypal_server_sdk/models/customer_response.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
   # Customer in merchant's or partner's system of records.

data/lib/paypal_server_sdk/models/customer_vault_payment_tokens_response.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
   # Collection of payment tokens saved for a given customer.

data/lib/paypal_server_sdk/models/cvv_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
   # The card verification value code for for Visa, Discover, Mastercard, or
@@ -64,5 +64,30 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = CVV_E)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cvv_e' then CVV_E
+      when 'cvv_i' then CVV_I
+      when 'cvv_m' then CVV_M
+      when 'cvv_n' then CVV_N
+      when 'cvv_p' then CVV_P
+      when 'cvv_s' then CVV_S
+      when 'cvv_u' then CVV_U
+      when 'cvv_x' then CVV_X
+      when 'enum_all_others' then ENUM_ALL_OTHERS
+      when 'cvv_0' then CVV_0
+      when 'cvv_1' then CVV_1
+      when 'cvv_2' then CVV_2
+      when 'cvv_3' then CVV_3
+      when 'cvv_4' then CVV_4
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/cycle_execution.rb

@@ -0,0 +1,124 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The regular and trial execution details for a billing cycle.
+  class CycleExecution < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of the billing cycle.
+    # @return [TenureType]
+    attr_accessor :tenure_type
+
+    # The order in which to run this cycle among other billing cycles.
+    # @return [Integer]
+    attr_accessor :sequence
+
+    # The number of billing cycles that have completed.
+    # @return [Integer]
+    attr_accessor :cycles_completed
+
+    # For a finite billing cycle, cycles_remaining is the number of remaining
+    # cycles. For an infinite billing cycle, cycles_remaining is set as 0.
+    # @return [Integer]
+    attr_accessor :cycles_remaining
+
+    # The active pricing scheme version for the billing cycle.
+    # @return [Integer]
+    attr_accessor :current_pricing_scheme_version
+
+    # The number of times this billing cycle gets executed. Trial billing cycles
+    # can only be executed a finite number of times (value between 1 and 999 for
+    # total_cycles). Regular billing cycles can be executed infinite times
+    # (value of 0 for total_cycles) or a finite number of times (value between 1
+    # and 999 for total_cycles).
+    # @return [Integer]
+    attr_accessor :total_cycles
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tenure_type'] = 'tenure_type'
+      @_hash['sequence'] = 'sequence'
+      @_hash['cycles_completed'] = 'cycles_completed'
+      @_hash['cycles_remaining'] = 'cycles_remaining'
+      @_hash['current_pricing_scheme_version'] =
+        'current_pricing_scheme_version'
+      @_hash['total_cycles'] = 'total_cycles'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cycles_remaining
+        current_pricing_scheme_version
+        total_cycles
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tenure_type:, sequence:, cycles_completed:,
+                   cycles_remaining: SKIP, current_pricing_scheme_version: SKIP,
+                   total_cycles: SKIP)
+      @tenure_type = tenure_type
+      @sequence = sequence
+      @cycles_completed = cycles_completed
+      @cycles_remaining = cycles_remaining unless cycles_remaining == SKIP
+      unless current_pricing_scheme_version == SKIP
+        @current_pricing_scheme_version =
+          current_pricing_scheme_version
+      end
+      @total_cycles = total_cycles unless total_cycles == 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.
+      tenure_type = hash.key?('tenure_type') ? hash['tenure_type'] : nil
+      sequence = hash.key?('sequence') ? hash['sequence'] : nil
+      cycles_completed =
+        hash.key?('cycles_completed') ? hash['cycles_completed'] : nil
+      cycles_remaining =
+        hash.key?('cycles_remaining') ? hash['cycles_remaining'] : SKIP
+      current_pricing_scheme_version =
+        hash.key?('current_pricing_scheme_version') ? hash['current_pricing_scheme_version'] : SKIP
+      total_cycles = hash.key?('total_cycles') ? hash['total_cycles'] : SKIP
+
+      # Create object from extracted values.
+      CycleExecution.new(tenure_type: tenure_type,
+                         sequence: sequence,
+                         cycles_completed: cycles_completed,
+                         cycles_remaining: cycles_remaining,
+                         current_pricing_scheme_version: current_pricing_scheme_version,
+                         total_cycles: total_cycles)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tenure_type: #{@tenure_type}, sequence: #{@sequence}, cycles_completed:"\
+      " #{@cycles_completed}, cycles_remaining: #{@cycles_remaining},"\
+      " current_pricing_scheme_version: #{@current_pricing_scheme_version}, total_cycles:"\
+      " #{@total_cycles}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tenure_type: #{@tenure_type.inspect}, sequence: #{@sequence.inspect},"\
+      " cycles_completed: #{@cycles_completed.inspect}, cycles_remaining:"\
+      " #{@cycles_remaining.inspect}, current_pricing_scheme_version:"\
+      " #{@current_pricing_scheme_version.inspect}, total_cycles: #{@total_cycles.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/disbursement_mode.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
   # The funds that are held on behalf of the merchant.
@@ -22,5 +22,18 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = INSTANT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'instant' then INSTANT
+      when 'delayed' then DELAYED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/dispute_category.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
   # The condition that is covered for the transaction.
@@ -19,5 +19,18 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = ITEM_NOT_RECEIVED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'item_not_received' then ITEM_NOT_RECEIVED
+      when 'unauthorized_transaction' then UNAUTHORIZED_TRANSACTION
+      else
+        default_value
+      end
+    end
   end
 end