cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/experience_context.rb

@@ -0,0 +1,116 @@
+# paypal_server_sdk
+#
+# 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.
+  class ExperienceContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The label that overrides the business name in the PayPal account on the
+    # PayPal site. The pattern is defined by an external party and supports
+    # Unicode.
+    # @return [String]
+    attr_accessor :brand_name
+
+    # The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the
+    # language in which to localize the error-related strings, such as messages,
+    # issues, and suggested actions. The tag is made up of the [ISO 639-2
+    # language code](https://www.loc.gov/standards/iso639-2/php/code_list.php),
+    # the optional [ISO-15924 script
+    # tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166
+    # alpha-2 country
+    # code](https://developer.paypal.com/api/rest/reference/country-codes/) or
+    # [M49 region code](https://unstats.un.org/unsd/methodology/m49/).
+    # @return [String]
+    attr_accessor :locale
+
+    # The location from which the shipping address is derived.
+    # @return [ExperienceContextShippingPreference]
+    attr_accessor :shipping_preference
+
+    # Describes the URL.
+    # @return [String]
+    attr_accessor :return_url
+
+    # Describes the URL.
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['brand_name'] = 'brand_name'
+      @_hash['locale'] = 'locale'
+      @_hash['shipping_preference'] = 'shipping_preference'
+      @_hash['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        shipping_preference
+        return_url
+        cancel_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    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
+      @return_url = return_url unless return_url == SKIP
+      @cancel_url = cancel_url unless cancel_url == 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.
+      brand_name = hash.key?('brand_name') ? hash['brand_name'] : SKIP
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+      shipping_preference =
+        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
+
+      # Create object from extracted values.
+      ExperienceContext.new(brand_name: brand_name,
+                            locale: locale,
+                            shipping_preference: shipping_preference,
+                            return_url: return_url,
+                            cancel_url: cancel_url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name}, locale: #{@locale}, shipping_preference:"\
+      " #{@shipping_preference}, return_url: #{@return_url}, cancel_url: #{@cancel_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name.inspect}, locale: #{@locale.inspect},"\
+      " shipping_preference: #{@shipping_preference.inspect}, return_url: #{@return_url.inspect},"\
+      " cancel_url: #{@cancel_url.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/experience_context_shipping_preference.rb

@@ -0,0 +1,46 @@
+# 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
+
+    def self.from_value(value, default_value = GET_FROM_FILE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'get_from_file' then GET_FROM_FILE
+      when 'no_shipping' then NO_SHIPPING
+      when 'set_provided_address' then SET_PROVIDED_ADDRESS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/experience_status.rb

@@ -0,0 +1,48 @@
+# 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
+
+    def self.from_value(value, default_value = NOT_STARTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'not_started' then NOT_STARTED
+      when 'in_progress' then IN_PROGRESS
+      when 'canceled' then CANCELED
+      when 'approved' then APPROVED
+      else
+        default_value
+      end
+    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

@@ -0,0 +1,51 @@
+# paypal_server_sdk
+#
+# 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,
+  # in-store pickup, etc). Either `type` or `options` may be present, but not
+  # both.
+  class FulfillmentType
+    FULFILLMENT_TYPE = [
+      # The payer intends to receive the items at a specified address.
+      SHIPPING = 'SHIPPING'.freeze,
+
+      # DEPRECATED. Please use "PICKUP_FROM_PERSON" instead.
+      PICKUP_IN_PERSON = 'PICKUP_IN_PERSON'.freeze,
+
+      # The payer intends to pick up the item(s) from the payee's physical
+      # store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller
+      # protection is provided with this option.
+      PICKUP_IN_STORE = 'PICKUP_IN_STORE'.freeze,
+
+      # The payer intends to pick up the item(s) from the payee in person. Also
+      # termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is
+      # not available, since the payer is receiving the item from the payee in
+      # person, and can validate the item prior to payment.
+      PICKUP_FROM_PERSON = 'PICKUP_FROM_PERSON'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SHIPPING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'shipping' then SHIPPING
+      when 'pickup_in_person' then PICKUP_IN_PERSON
+      when 'pickup_in_store' then PICKUP_IN_STORE
+      when 'pickup_from_person' then PICKUP_FROM_PERSON
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/giropay_payment_object.rb

@@ -0,0 +1,87 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using giropay.
+  class GiropayPaymentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # The [two-character ISO 3166-1
+    # code](https://developer.paypal.com/api/rest/reference/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 business identification code (BIC). In payments systems, a BIC is used
+    # to identify a specific business, most commonly a bank.
+    # @return [String]
+    attr_accessor :bic
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['country_code'] = 'country_code'
+      @_hash['bic'] = 'bic'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        country_code
+        bic
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, country_code: SKIP, bic: SKIP)
+      @name = name unless name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @bic = bic unless bic == 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 = hash.key?('name') ? hash['name'] : SKIP
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      bic = hash.key?('bic') ? hash['bic'] : SKIP
+
+      # Create object from extracted values.
+      GiropayPaymentObject.new(name: name,
+                               country_code: country_code,
+                               bic: bic)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, country_code: #{@country_code}, bic: #{@bic}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, country_code: #{@country_code.inspect}, bic:"\
+      " #{@bic.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/giropay_payment_request.rb

@@ -0,0 +1,87 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using giropay.
+  class GiropayPaymentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # The [two-character ISO 3166-1
+    # code](https://developer.paypal.com/api/rest/reference/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
+
+    # Customizes the payer experience during the approval process for the
+    # payment.
+    # @return [ExperienceContext]
+    attr_accessor :experience_context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['country_code'] = 'country_code'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        experience_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, country_code:, experience_context: SKIP)
+      @name = name
+      @country_code = country_code
+      @experience_context = experience_context unless experience_context == 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 = hash.key?('name') ? hash['name'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      experience_context = ExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      GiropayPaymentRequest.new(name: name,
+                                country_code: country_code,
+                                experience_context: experience_context)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, country_code: #{@country_code}, experience_context:"\
+      " #{@experience_context}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, country_code: #{@country_code.inspect},"\
+      " experience_context: #{@experience_context.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/google_pay_authentication_method.rb

@@ -0,0 +1,42 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Authentication Method which is used for the card transaction.
+  class GooglePayAuthenticationMethod
+    GOOGLE_PAY_AUTHENTICATION_METHOD = [
+      # This authentication method is associated with payment cards stored on
+      # file with the user's Google Account. Returned payment data includes
+      # primary account number (PAN) with the expiration month and the
+      # expiration year.
+      PAN_ONLY = 'PAN_ONLY'.freeze,
+
+      # Returned payment data includes a 3-D Secure (3DS) cryptogram generated
+      # on the device. -> If authentication_method=CRYPTOGRAM, it is required
+      # that 'cryptogram' parameter in the request has a valid 3-D Secure (3DS)
+      # cryptogram generated on the device.
+      CRYPTOGRAM_3DS = 'CRYPTOGRAM_3DS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PAN_ONLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pan_only' then PAN_ONLY
+      when 'cryptogram_3ds' then CRYPTOGRAM_3DS
+      else
+        default_value
+      end
+    end
+  end
+end