cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/seller_receivable_breakdown.rb

@@ -0,0 +1,147 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The detailed breakdown of the capture activity. This is not available for
+  # transactions that are in pending state.
+  class SellerReceivableBreakdown < 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 :gross_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :paypal_fee
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :paypal_fee_in_receivable_currency
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :net_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :receivable_amount
+
+    # The exchange rate that determines the amount to convert from one currency
+    # to another currency.
+    # @return [ExchangeRate]
+    attr_accessor :exchange_rate
+
+    # An array of platform or partner fees, commissions, or brokerage fees that
+    # associated with the captured payment.
+    # @return [Array[PlatformFee]]
+    attr_accessor :platform_fees
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['gross_amount'] = 'gross_amount'
+      @_hash['paypal_fee'] = 'paypal_fee'
+      @_hash['paypal_fee_in_receivable_currency'] =
+        'paypal_fee_in_receivable_currency'
+      @_hash['net_amount'] = 'net_amount'
+      @_hash['receivable_amount'] = 'receivable_amount'
+      @_hash['exchange_rate'] = 'exchange_rate'
+      @_hash['platform_fees'] = 'platform_fees'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        paypal_fee
+        paypal_fee_in_receivable_currency
+        net_amount
+        receivable_amount
+        exchange_rate
+        platform_fees
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(gross_amount:, paypal_fee: SKIP,
+                   paypal_fee_in_receivable_currency: SKIP, net_amount: SKIP,
+                   receivable_amount: SKIP, exchange_rate: SKIP,
+                   platform_fees: SKIP)
+      @gross_amount = gross_amount
+      @paypal_fee = paypal_fee unless paypal_fee == SKIP
+      unless paypal_fee_in_receivable_currency == SKIP
+        @paypal_fee_in_receivable_currency =
+          paypal_fee_in_receivable_currency
+      end
+      @net_amount = net_amount unless net_amount == SKIP
+      @receivable_amount = receivable_amount unless receivable_amount == SKIP
+      @exchange_rate = exchange_rate unless exchange_rate == SKIP
+      @platform_fees = platform_fees unless platform_fees == 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.
+      gross_amount = Money.from_hash(hash['gross_amount']) if hash['gross_amount']
+      paypal_fee = Money.from_hash(hash['paypal_fee']) if hash['paypal_fee']
+      if hash['paypal_fee_in_receivable_currency']
+        paypal_fee_in_receivable_currency = Money.from_hash(hash['paypal_fee_in_receivable_currency'])
+      end
+      net_amount = Money.from_hash(hash['net_amount']) if hash['net_amount']
+      receivable_amount = Money.from_hash(hash['receivable_amount']) if hash['receivable_amount']
+      exchange_rate = ExchangeRate.from_hash(hash['exchange_rate']) if hash['exchange_rate']
+      # Parameter is an array, so we need to iterate through it
+      platform_fees = nil
+      unless hash['platform_fees'].nil?
+        platform_fees = []
+        hash['platform_fees'].each do |structure|
+          platform_fees << (PlatformFee.from_hash(structure) if structure)
+        end
+      end
+
+      platform_fees = SKIP unless hash.key?('platform_fees')
+
+      # Create object from extracted values.
+      SellerReceivableBreakdown.new(gross_amount: gross_amount,
+                                    paypal_fee: paypal_fee,
+                                    paypal_fee_in_receivable_currency: paypal_fee_in_receivable_currency,
+                                    net_amount: net_amount,
+                                    receivable_amount: receivable_amount,
+                                    exchange_rate: exchange_rate,
+                                    platform_fees: platform_fees)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} gross_amount: #{@gross_amount}, paypal_fee: #{@paypal_fee},"\
+      " paypal_fee_in_receivable_currency: #{@paypal_fee_in_receivable_currency}, net_amount:"\
+      " #{@net_amount}, receivable_amount: #{@receivable_amount}, exchange_rate:"\
+      " #{@exchange_rate}, platform_fees: #{@platform_fees}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} gross_amount: #{@gross_amount.inspect}, paypal_fee: #{@paypal_fee.inspect},"\
+      " paypal_fee_in_receivable_currency: #{@paypal_fee_in_receivable_currency.inspect},"\
+      " net_amount: #{@net_amount.inspect}, receivable_amount: #{@receivable_amount.inspect},"\
+      " exchange_rate: #{@exchange_rate.inspect}, platform_fees: #{@platform_fees.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/sepa_debit_experience_context.rb

@@ -0,0 +1,89 @@
+# 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 SEPA
+  # Debit payment.
+  class SepaDebitExperienceContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # 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['locale'] = 'locale'
+      @_hash['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        locale
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(return_url:, cancel_url:, locale: SKIP)
+      @locale = locale unless locale == SKIP
+      @return_url = return_url
+      @cancel_url = cancel_url
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      return_url = hash.key?('return_url') ? hash['return_url'] : nil
+      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : nil
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+
+      # Create object from extracted values.
+      SepaDebitExperienceContext.new(return_url: return_url,
+                                     cancel_url: cancel_url,
+                                     locale: locale)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} locale: #{@locale}, 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} locale: #{@locale.inspect}, return_url: #{@return_url.inspect}, cancel_url:"\
+      " #{@cancel_url.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/sepa_debit_request.rb

@@ -0,0 +1,64 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # An API resource denoting a request to securely store a SEPA Debit.
+  class SepaDebitRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Customizes the payer experience during the approval process for the SEPA
+    # Debit payment.
+    # @return [SepaDebitExperienceContext]
+    attr_accessor :experience_context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_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(experience_context: SKIP)
+      @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.
+      experience_context = SepaDebitExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      SepaDebitRequest.new(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} 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} experience_context: #{@experience_context.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/setup_fee_failure_action.rb

@@ -0,0 +1,37 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The action to take on the subscription if the initial payment for the setup
+  # fails.
+  class SetupFeeFailureAction
+    SETUP_FEE_FAILURE_ACTION = [
+      # Continues the subscription if the initial payment for the setup fails.
+      CONTINUE = 'CONTINUE'.freeze,
+
+      # Cancels the subscription if the initial payment for the setup fails.
+      CANCEL = 'CANCEL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CONTINUE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'continue' then CONTINUE
+      when 'cancel' then CANCEL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/setup_token_request.rb

@@ -0,0 +1,74 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Setup Token Request where the `source` defines the type of instrument to be
+  # stored.
+  class SetupTokenRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This object defines a customer in your system. Use it to manage customer
+    # profiles, save payment methods and contact details.
+    # @return [Customer]
+    attr_accessor :customer
+
+    # The payment method to vault with the instrument details.
+    # @return [SetupTokenRequestPaymentSource]
+    attr_accessor :payment_source
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer'] = 'customer'
+      @_hash['payment_source'] = 'payment_source'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_source:, customer: SKIP)
+      @customer = customer unless customer == SKIP
+      @payment_source = payment_source
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      payment_source = SetupTokenRequestPaymentSource.from_hash(hash['payment_source']) if
+        hash['payment_source']
+      customer = Customer.from_hash(hash['customer']) if hash['customer']
+
+      # Create object from extracted values.
+      SetupTokenRequest.new(payment_source: payment_source,
+                            customer: customer)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer}, payment_source: #{@payment_source}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer.inspect}, payment_source:"\
+      " #{@payment_source.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/setup_token_request_card.rb

@@ -0,0 +1,143 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A Resource representing a request to vault a Card.
+  class SetupTokenRequestCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The card holder's name as it appears on the card.
+    # @return [String]
+    attr_accessor :name
+
+    # The primary account number (PAN) for the payment card.
+    # @return [String]
+    attr_accessor :number
+
+    # The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date
+    # and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
+    # @return [String]
+    attr_accessor :expiry
+
+    # The three- or four-digit security code of the card. Also known as the CVV,
+    # CVC, CVN, CVE, or CID. This parameter cannot be present in the request
+    # when `payment_initiator=MERCHANT`.
+    # @return [String]
+    attr_accessor :security_code
+
+    # The card network or brand. Applies to credit, debit, gift, and payment
+    # cards.
+    # @return [CardBrand]
+    attr_accessor :brand
+
+    # The portable international postal address. Maps to
+    # [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/
+    # wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls:
+    # the autocomplete
+    # attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-co
+    # ntrols-the-autocomplete-attribute).
+    # @return [Address]
+    attr_accessor :billing_address
+
+    # The verification method of the card.
+    # @return [VaultCardVerificationMethod]
+    attr_accessor :verification_method
+
+    # A resource representing an experience context of vault a card.
+    # @return [VaultCardExperienceContext]
+    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['number'] = 'number'
+      @_hash['expiry'] = 'expiry'
+      @_hash['security_code'] = 'security_code'
+      @_hash['brand'] = 'brand'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['verification_method'] = 'verification_method'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        number
+        expiry
+        security_code
+        brand
+        billing_address
+        verification_method
+        experience_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, number: SKIP, expiry: SKIP, security_code: SKIP,
+                   brand: SKIP, billing_address: SKIP,
+                   verification_method: SKIP, experience_context: SKIP)
+      @name = name unless name == SKIP
+      @number = number unless number == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @security_code = security_code unless security_code == SKIP
+      @brand = brand unless brand == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @verification_method = verification_method unless verification_method == SKIP
+      @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'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      security_code = hash.key?('security_code') ? hash['security_code'] : SKIP
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+      billing_address = Address.from_hash(hash['billing_address']) if hash['billing_address']
+      verification_method =
+        hash.key?('verification_method') ? hash['verification_method'] : SKIP
+      experience_context = VaultCardExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      SetupTokenRequestCard.new(name: name,
+                                number: number,
+                                expiry: expiry,
+                                security_code: security_code,
+                                brand: brand,
+                                billing_address: billing_address,
+                                verification_method: verification_method,
+                                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}, number: #{@number}, expiry: #{@expiry}, security_code:"\
+      " #{@security_code}, brand: #{@brand}, billing_address: #{@billing_address},"\
+      " verification_method: #{@verification_method}, 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}, number: #{@number.inspect}, expiry:"\
+      " #{@expiry.inspect}, security_code: #{@security_code.inspect}, brand: #{@brand.inspect},"\
+      " billing_address: #{@billing_address.inspect}, verification_method:"\
+      " #{@verification_method.inspect}, experience_context: #{@experience_context.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/setup_token_request_payment_source.rb

@@ -0,0 +1,111 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment method to vault with the instrument details.
+  class SetupTokenRequestPaymentSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A Resource representing a request to vault a Card.
+    # @return [SetupTokenRequestCard]
+    attr_accessor :card
+
+    # A resource representing a request to vault PayPal Wallet.
+    # @return [VaultPaypalWalletRequest]
+    attr_accessor :paypal
+
+    # A resource representing a request to vault Venmo.
+    # @return [VaultVenmoRequest]
+    attr_accessor :venmo
+
+    # A resource representing a request to vault Apple Pay.
+    # @return [VaultApplePayRequest]
+    attr_accessor :apple_pay
+
+    # The Tokenized Payment Source representing a Request to Vault a Token.
+    # @return [VaultTokenRequest]
+    attr_accessor :token
+
+    # A Resource representing a request to vault a Bank used for ACH Debit.
+    # @return [BankRequest]
+    attr_accessor :bank
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash['paypal'] = 'paypal'
+      @_hash['venmo'] = 'venmo'
+      @_hash['apple_pay'] = 'apple_pay'
+      @_hash['token'] = 'token'
+      @_hash['bank'] = 'bank'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+        paypal
+        venmo
+        apple_pay
+        token
+        bank
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP, paypal: SKIP, venmo: SKIP, apple_pay: SKIP,
+                   token: SKIP, bank: SKIP)
+      @card = card unless card == SKIP
+      @paypal = paypal unless paypal == SKIP
+      @venmo = venmo unless venmo == SKIP
+      @apple_pay = apple_pay unless apple_pay == SKIP
+      @token = token unless token == SKIP
+      @bank = bank unless bank == 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 = SetupTokenRequestCard.from_hash(hash['card']) if hash['card']
+      paypal = VaultPaypalWalletRequest.from_hash(hash['paypal']) if hash['paypal']
+      venmo = VaultVenmoRequest.from_hash(hash['venmo']) if hash['venmo']
+      apple_pay = VaultApplePayRequest.from_hash(hash['apple_pay']) if hash['apple_pay']
+      token = VaultTokenRequest.from_hash(hash['token']) if hash['token']
+      bank = BankRequest.from_hash(hash['bank']) if hash['bank']
+
+      # Create object from extracted values.
+      SetupTokenRequestPaymentSource.new(card: card,
+                                         paypal: paypal,
+                                         venmo: venmo,
+                                         apple_pay: apple_pay,
+                                         token: token,
+                                         bank: bank)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card}, paypal: #{@paypal}, venmo: #{@venmo}, apple_pay:"\
+      " #{@apple_pay}, token: #{@token}, bank: #{@bank}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card.inspect}, paypal: #{@paypal.inspect}, venmo:"\
+      " #{@venmo.inspect}, apple_pay: #{@apple_pay.inspect}, token: #{@token.inspect}, bank:"\
+      " #{@bank.inspect}>"
+    end
+  end
+end