paypal-server-sdk 1.1.0 → 2.0.0

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.

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.

data/lib/paypal_server_sdk/models/eci_flag.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
   # Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data

data/lib/paypal_server_sdk/models/enrollment_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
   # Status of Authentication eligibility.

data/lib/paypal_server_sdk/models/eps_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 eps.

data/lib/paypal_server_sdk/models/eps_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 eps.

data/lib/paypal_server_sdk/models/error_details.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 error details. Required for client-side `4XX` errors.

data/lib/paypal_server_sdk/models/exchange_rate.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 exchange rate that determines the amount to convert from one currency to

data/lib/paypal_server_sdk/models/experience_context.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
   # Customizes the payer experience during the approval process for the payment.
@@ -27,7 +27,7 @@ module PaypalServerSdk
     attr_accessor :locale
 
     # The location from which the shipping address is derived.
-    # @return [ShippingPreference]
+    # @return [ExperienceContextShippingPreference]
     attr_accessor :shipping_preference
 
     # Describes the URL.
@@ -65,9 +65,11 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(brand_name: SKIP, locale: SKIP,
-                   shipping_preference: ShippingPreference::GET_FROM_FILE,
-                   return_url: SKIP, cancel_url: SKIP)
+    def initialize(
+      brand_name: SKIP, locale: SKIP,
+      shipping_preference: ExperienceContextShippingPreference::GET_FROM_FILE,
+      return_url: SKIP, cancel_url: SKIP
+    )
       @brand_name = brand_name unless brand_name == SKIP
       @locale = locale unless locale == SKIP
       @shipping_preference = shipping_preference unless shipping_preference == SKIP
@@ -83,7 +85,7 @@ module PaypalServerSdk
       brand_name = hash.key?('brand_name') ? hash['brand_name'] : SKIP
       locale = hash.key?('locale') ? hash['locale'] : SKIP
       shipping_preference =
-        hash['shipping_preference'] ||= ShippingPreference::GET_FROM_FILE
+        hash['shipping_preference'] ||= ExperienceContextShippingPreference::GET_FROM_FILE
       return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
       cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
 

data/lib/paypal_server_sdk/models/experience_context_shipping_preference.rb

@@ -0,0 +1,32 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The location from which the shipping address is derived., The shipping
+  # preference. This only applies to PayPal payment source., The shipping
+  # preference. This only applies to PayPal payment source., The location from
+  # which the shipping address is derived.
+  class ExperienceContextShippingPreference
+    EXPERIENCE_CONTEXT_SHIPPING_PREFERENCE = [
+      # Get the customer-provided shipping address on the PayPal site.
+      GET_FROM_FILE = 'GET_FROM_FILE'.freeze,
+
+      # Redacts the shipping address from the PayPal site. Recommended for
+      # digital goods.
+      NO_SHIPPING = 'NO_SHIPPING'.freeze,
+
+      # Merchant sends the shipping address using
+      # purchase_units.shipping.address. The customer cannot change this address
+      # on the PayPal site.
+      SET_PROVIDED_ADDRESS = 'SET_PROVIDED_ADDRESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/experience_status.rb

@@ -0,0 +1,33 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # This field indicates the status of PayPal's Checkout experience throughout
+  # the order lifecycle. The values reflect the current stage of the checkout
+  # process.
+  class ExperienceStatus
+    EXPERIENCE_STATUS = [
+      # PayPal checkout process has not yet begun.
+      NOT_STARTED = 'NOT_STARTED'.freeze,
+
+      # PayPal checkout initiated. User is on the checkout page for order review
+      # before approval.
+      IN_PROGRESS = 'IN_PROGRESS'.freeze,
+
+      # PayPal checkout is canceled (by closing the checkout window or clicking
+      # cancel) before the order approval.
+      CANCELED = 'CANCELED'.freeze,
+
+      # Order is approved. User has completed the checkout process.
+      APPROVED = 'APPROVED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/failed_payment_details.rb

@@ -0,0 +1,98 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The details for the failed payment of the subscription.
+  class FailedPaymentDetails < 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 :amount
+
+    # 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
+
+    # The reason code for the payment failure.
+    # @return [ReasonCode]
+    attr_accessor :reason_code
+
+    # 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 :next_payment_retry_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['time'] = 'time'
+      @_hash['reason_code'] = 'reason_code'
+      @_hash['next_payment_retry_time'] = 'next_payment_retry_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason_code
+        next_payment_retry_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, time:, reason_code: SKIP,
+                   next_payment_retry_time: SKIP)
+      @amount = amount
+      @time = time
+      @reason_code = reason_code unless reason_code == SKIP
+      @next_payment_retry_time = next_payment_retry_time unless next_payment_retry_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.
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      time = hash.key?('time') ? hash['time'] : nil
+      reason_code = hash.key?('reason_code') ? hash['reason_code'] : SKIP
+      next_payment_retry_time =
+        hash.key?('next_payment_retry_time') ? hash['next_payment_retry_time'] : SKIP
+
+      # Create object from extracted values.
+      FailedPaymentDetails.new(amount: amount,
+                               time: time,
+                               reason_code: reason_code,
+                               next_payment_retry_time: next_payment_retry_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, time: #{@time}, reason_code: #{@reason_code},"\
+      " next_payment_retry_time: #{@next_payment_retry_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, time: #{@time.inspect}, reason_code:"\
+      " #{@reason_code.inspect}, next_payment_retry_time: #{@next_payment_retry_time.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/frequency.rb

@@ -0,0 +1,75 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The frequency of the billing cycle.
+  class Frequency < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The interval at which the subscription is charged or billed.
+    # @return [IntervalUnit]
+    attr_accessor :interval_unit
+
+    # The number of intervals after which a subscriber is billed. For example,
+    # if the `interval_unit` is `DAY` with an `interval_count` of  `2`, the
+    # subscription is billed once every two days. The following table lists the
+    # maximum allowed values for the `interval_count` for each `interval_unit`:
+    # Interval unit Maximum interval count DAY 365 WEEK 52 MONTH 12 YEAR 1
+    # @return [Integer]
+    attr_accessor :interval_count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['interval_unit'] = 'interval_unit'
+      @_hash['interval_count'] = 'interval_count'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        interval_count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(interval_unit:, interval_count: 1)
+      @interval_unit = interval_unit
+      @interval_count = interval_count unless interval_count == 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.
+      interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : nil
+      interval_count = hash['interval_count'] ||= 1
+
+      # Create object from extracted values.
+      Frequency.new(interval_unit: interval_unit,
+                    interval_count: interval_count)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} interval_unit: #{@interval_unit}, interval_count: #{@interval_count}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} interval_unit: #{@interval_unit.inspect}, interval_count:"\
+      " #{@interval_count.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/fulfillment_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
   # A classification for the method of purchase fulfillment (e.g shipping,

data/lib/paypal_server_sdk/models/giropay_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 needed to pay using giropay.

data/lib/paypal_server_sdk/models/giropay_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 giropay.

data/lib/paypal_server_sdk/models/google_pay_authentication_method.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
   # Authentication Method which is used for the card transaction.

data/lib/paypal_server_sdk/models/google_pay_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
   # The payment card used to fund a Google Pay payment. Can be a credit or debit

data/lib/paypal_server_sdk/models/google_pay_card_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
   # The payment card to use to fund a Google Pay payment response. Can be a

data/lib/paypal_server_sdk/models/google_pay_decrypted_token_data.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 shared by Google for the merchant to be shared with PayPal. This is

data/lib/paypal_server_sdk/models/google_pay_experience_context.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
   # Customizes the payer experience during the approval process for the payment.

data/lib/paypal_server_sdk/models/google_pay_payment_method.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 type of the payment credential. Currently, only CARD is supported.

data/lib/paypal_server_sdk/models/google_pay_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 Google Pay.

data/lib/paypal_server_sdk/models/google_pay_request_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
   # The payment card used to fund a Google Pay payment. Can be a credit or debit

data/lib/paypal_server_sdk/models/google_pay_wallet_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
   # Google Pay Wallet payment data.

data/lib/paypal_server_sdk/models/ideal_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 iDEAL.

data/lib/paypal_server_sdk/models/ideal_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 iDEAL.