cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/payer_information.rb

@@ -0,0 +1,146 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payer information.
+  class PayerInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The PayPal` customer account ID.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The internationalized email address. Note: Up to 64 characters are allowed
+    # before and 255 characters are allowed after the @ sign. However, the
+    # generally accepted maximum length for an email address is 254 characters.
+    # The pattern verifies that an unquoted @ sign exists.
+    # @return [String]
+    attr_accessor :email_address
+
+    # The phone number, in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [Phone]
+    attr_accessor :phone_number
+
+    # The address status of the payer. Value is either: Y. Verified. N. Not
+    # verified.
+    # @return [String]
+    attr_accessor :address_status
+
+    # The status of the payer. Value is `Y` or `N`.
+    # @return [String]
+    attr_accessor :payer_status
+
+    # The name of the party.
+    # @return [PayerName]
+    attr_accessor :payer_name
+
+    # The [two-character ISO 3166-1
+    # code](/docs/integration/direct/rest/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
+
+    # A simple postal address with coarse-grained fields. Do not use for an
+    # international address. Use for backward compatibility only. Does not
+    # contain phone.
+    # @return [SimplePostalAddressCoarseGrained]
+    attr_accessor :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'account_id'
+      @_hash['email_address'] = 'email_address'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['address_status'] = 'address_status'
+      @_hash['payer_status'] = 'payer_status'
+      @_hash['payer_name'] = 'payer_name'
+      @_hash['country_code'] = 'country_code'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        email_address
+        phone_number
+        address_status
+        payer_status
+        payer_name
+        country_code
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id: SKIP, email_address: SKIP, phone_number: SKIP,
+                   address_status: SKIP, payer_status: SKIP, payer_name: SKIP,
+                   country_code: SKIP, address: SKIP)
+      @account_id = account_id unless account_id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @address_status = address_status unless address_status == SKIP
+      @payer_status = payer_status unless payer_status == SKIP
+      @payer_name = payer_name unless payer_name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @address = address unless address == 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.
+      account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      phone_number = Phone.from_hash(hash['phone_number']) if hash['phone_number']
+      address_status =
+        hash.key?('address_status') ? hash['address_status'] : SKIP
+      payer_status = hash.key?('payer_status') ? hash['payer_status'] : SKIP
+      payer_name = PayerName.from_hash(hash['payer_name']) if hash['payer_name']
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      address = SimplePostalAddressCoarseGrained.from_hash(hash['address']) if hash['address']
+
+      # Create object from extracted values.
+      PayerInformation.new(account_id: account_id,
+                           email_address: email_address,
+                           phone_number: phone_number,
+                           address_status: address_status,
+                           payer_status: payer_status,
+                           payer_name: payer_name,
+                           country_code: country_code,
+                           address: address)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id}, email_address: #{@email_address}, phone_number:"\
+      " #{@phone_number}, address_status: #{@address_status}, payer_status: #{@payer_status},"\
+      " payer_name: #{@payer_name}, country_code: #{@country_code}, address: #{@address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id.inspect}, email_address:"\
+      " #{@email_address.inspect}, phone_number: #{@phone_number.inspect}, address_status:"\
+      " #{@address_status.inspect}, payer_status: #{@payer_status.inspect}, payer_name:"\
+      " #{@payer_name.inspect}, country_code: #{@country_code.inspect}, address:"\
+      " #{@address.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payer_name.rb

@@ -0,0 +1,128 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The name of the party.
+  class PayerName < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The prefix, or title, to the party's name.
+    # @return [String]
+    attr_accessor :prefix
+
+    # When the party is a person, the party's given, or first, name.
+    # @return [String]
+    attr_accessor :given_name
+
+    # When the party is a person, the party's surname or family name. Also known
+    # as the last name. Required when the party is a person. Use also to store
+    # multiple surnames including the matronymic, or mother's, surname.
+    # @return [String]
+    attr_accessor :surname
+
+    # When the party is a person, the party's middle name. Use also to store
+    # multiple middle names including the patronymic, or father's, middle name.
+    # @return [String]
+    attr_accessor :middle_name
+
+    # The suffix for the party's name.
+    # @return [String]
+    attr_accessor :suffix
+
+    # DEPRECATED. The party's alternate name. Can be a business name, nickname,
+    # or any other name that cannot be split into first, last name. Required
+    # when the party is a business.
+    # @return [String]
+    attr_accessor :alternate_full_name
+
+    # When the party is a person, the party's full name.
+    # @return [String]
+    attr_accessor :full_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['prefix'] = 'prefix'
+      @_hash['given_name'] = 'given_name'
+      @_hash['surname'] = 'surname'
+      @_hash['middle_name'] = 'middle_name'
+      @_hash['suffix'] = 'suffix'
+      @_hash['alternate_full_name'] = 'alternate_full_name'
+      @_hash['full_name'] = 'full_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        prefix
+        given_name
+        surname
+        middle_name
+        suffix
+        alternate_full_name
+        full_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(prefix: SKIP, given_name: SKIP, surname: SKIP,
+                   middle_name: SKIP, suffix: SKIP, alternate_full_name: SKIP,
+                   full_name: SKIP)
+      @prefix = prefix unless prefix == SKIP
+      @given_name = given_name unless given_name == SKIP
+      @surname = surname unless surname == SKIP
+      @middle_name = middle_name unless middle_name == SKIP
+      @suffix = suffix unless suffix == SKIP
+      @alternate_full_name = alternate_full_name unless alternate_full_name == SKIP
+      @full_name = full_name unless full_name == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      prefix = hash.key?('prefix') ? hash['prefix'] : SKIP
+      given_name = hash.key?('given_name') ? hash['given_name'] : SKIP
+      surname = hash.key?('surname') ? hash['surname'] : SKIP
+      middle_name = hash.key?('middle_name') ? hash['middle_name'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
+      alternate_full_name =
+        hash.key?('alternate_full_name') ? hash['alternate_full_name'] : SKIP
+      full_name = hash.key?('full_name') ? hash['full_name'] : SKIP
+
+      # Create object from extracted values.
+      PayerName.new(prefix: prefix,
+                    given_name: given_name,
+                    surname: surname,
+                    middle_name: middle_name,
+                    suffix: suffix,
+                    alternate_full_name: alternate_full_name,
+                    full_name: full_name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} prefix: #{@prefix}, given_name: #{@given_name}, surname: #{@surname},"\
+      " middle_name: #{@middle_name}, suffix: #{@suffix}, alternate_full_name:"\
+      " #{@alternate_full_name}, full_name: #{@full_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} prefix: #{@prefix.inspect}, given_name: #{@given_name.inspect}, surname:"\
+      " #{@surname.inspect}, middle_name: #{@middle_name.inspect}, suffix: #{@suffix.inspect},"\
+      " alternate_full_name: #{@alternate_full_name.inspect}, full_name: #{@full_name.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_advice_code.rb

@@ -0,0 +1,101 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The declined payment transactions might have payment advice codes. The card
+  # networks, like Visa and Mastercard, return payment advice codes.
+  class PaymentAdviceCode
+    PAYMENT_ADVICE_CODE = [
+      # For Mastercard, expired card account upgrade or portfolio sale
+      # conversion. Obtain new account information before next billing cycle.
+      PAYMENTADVICE_01 = '01'.freeze,
+
+      # For Mastercard, over credit limit or insufficient funds. Retry the
+      # transaction 72 hours later. For Visa, the card holder wants to stop only
+      # one specific payment in the recurring payment relationship. The merchant
+      # must NOT resubmit the same transaction. The merchant can continue the
+      # billing process in the subsequent billing period.
+      PAYMENTADVICE_02 = '02'.freeze,
+
+      # For Mastercard, account closed as fraudulent. Obtain another type of
+      # payment from customer due to account being closed or fraud. Possible
+      # reason: Account closed as fraudulent. For Visa, the card holder wants to
+      # stop all recurring payment transactions for a specific merchant. Stop
+      # recurring payment requests.
+      PAYMENTADVICE_03 = '03'.freeze,
+
+      # For Mastercard, token requirements not fulfilled for this token type.
+      PAYMENTADVICE_04 = '04'.freeze,
+
+      # For Mastercard, the card holder has been unsuccessful at canceling
+      # recurring payment through merchant. Stop recurring payment requests. For
+      # Visa, all recurring payments were canceled for the card number
+      # requested. Stop recurring payment requests.
+      PAYMENTADVICE_21 = '21'.freeze,
+
+      # For Mastercard, merchant does not qualify for product code.
+      PAYMENTADVICE_22 = '22'.freeze,
+
+      # For Mastercard, retry after 1 hour.
+      PAYMENTADVICE_24 = '24'.freeze,
+
+      # For Mastercard, retry after 24 hours.
+      PAYMENTADVICE_25 = '25'.freeze,
+
+      # For Mastercard, retry after 2 days.
+      PAYMENTADVICE_26 = '26'.freeze,
+
+      # For Mastercard, retry after 4 days.
+      PAYMENTADVICE_27 = '27'.freeze,
+
+      # For Mastercard, retry after 6 days.
+      PAYMENTADVICE_28 = '28'.freeze,
+
+      # For Mastercard, retry after 8 days.
+      PAYMENTADVICE_29 = '29'.freeze,
+
+      # For Mastercard, retry after 10 days .
+      PAYMENTADVICE_30 = '30'.freeze,
+
+      # For Mastercard, consumer non-reloadable prepaid card.
+      PAYMENTADVICE_40 = '40'.freeze,
+
+      # For Mastercard, consumer multi-use virtual card number.
+      PAYMENTADVICE_43 = '43'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PAYMENTADVICE_01)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'paymentadvice_01' then PAYMENTADVICE_01
+      when 'paymentadvice_02' then PAYMENTADVICE_02
+      when 'paymentadvice_03' then PAYMENTADVICE_03
+      when 'paymentadvice_04' then PAYMENTADVICE_04
+      when 'paymentadvice_21' then PAYMENTADVICE_21
+      when 'paymentadvice_22' then PAYMENTADVICE_22
+      when 'paymentadvice_24' then PAYMENTADVICE_24
+      when 'paymentadvice_25' then PAYMENTADVICE_25
+      when 'paymentadvice_26' then PAYMENTADVICE_26
+      when 'paymentadvice_27' then PAYMENTADVICE_27
+      when 'paymentadvice_28' then PAYMENTADVICE_28
+      when 'paymentadvice_29' then PAYMENTADVICE_29
+      when 'paymentadvice_30' then PAYMENTADVICE_30
+      when 'paymentadvice_40' then PAYMENTADVICE_40
+      when 'paymentadvice_43' then PAYMENTADVICE_43
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_authorization.rb

@@ -0,0 +1,233 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The authorized payment transaction.
+  class PaymentAuthorization < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status for the authorized payment.
+    # @return [AuthorizationStatus]
+    attr_accessor :status
+
+    # The details of the authorized payment status.
+    # @return [AuthorizationStatusDetails]
+    attr_accessor :status_details
+
+    # The PayPal-generated ID for the authorized payment.
+    # @return [String]
+    attr_accessor :id
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # The API caller-provided external invoice number for this order. Appears in
+    # both the payer's transaction history and the emails that the payer
+    # receives.
+    # @return [String]
+    attr_accessor :invoice_id
+
+    # The API caller-provided external ID. Used to reconcile API
+    # caller-initiated transactions with PayPal transactions. Appears in
+    # transaction and settlement reports.
+    # @return [String]
+    attr_accessor :custom_id
+
+    # Reference values used by the card network to identify a transaction.
+    # @return [NetworkTransaction]
+    attr_accessor :network_transaction_reference
+
+    # The level of protection offered as defined by [PayPal Seller Protection
+    # for
+    # Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protectio
+    # n).
+    # @return [SellerProtection]
+    attr_accessor :seller_protection
+
+    # 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 :expiration_time
+
+    # An array of related [HATEOAS
+    # links](/docs/api/reference/api-responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # 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 :create_time
+
+    # 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 :update_time
+
+    # The supplementary data.
+    # @return [PaymentSupplementaryData]
+    attr_accessor :supplementary_data
+
+    # The details for the merchant who receives the funds and fulfills the
+    # order. The merchant is also known as the payee.
+    # @return [PayeeBase]
+    attr_accessor :payee
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['status_details'] = 'status_details'
+      @_hash['id'] = 'id'
+      @_hash['amount'] = 'amount'
+      @_hash['invoice_id'] = 'invoice_id'
+      @_hash['custom_id'] = 'custom_id'
+      @_hash['network_transaction_reference'] =
+        'network_transaction_reference'
+      @_hash['seller_protection'] = 'seller_protection'
+      @_hash['expiration_time'] = 'expiration_time'
+      @_hash['links'] = 'links'
+      @_hash['create_time'] = 'create_time'
+      @_hash['update_time'] = 'update_time'
+      @_hash['supplementary_data'] = 'supplementary_data'
+      @_hash['payee'] = 'payee'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        status_details
+        id
+        amount
+        invoice_id
+        custom_id
+        network_transaction_reference
+        seller_protection
+        expiration_time
+        links
+        create_time
+        update_time
+        supplementary_data
+        payee
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, status_details: SKIP, id: SKIP, amount: SKIP,
+                   invoice_id: SKIP, custom_id: SKIP,
+                   network_transaction_reference: SKIP, seller_protection: SKIP,
+                   expiration_time: SKIP, links: SKIP, create_time: SKIP,
+                   update_time: SKIP, supplementary_data: SKIP, payee: SKIP)
+      @status = status unless status == SKIP
+      @status_details = status_details unless status_details == SKIP
+      @id = id unless id == SKIP
+      @amount = amount unless amount == SKIP
+      @invoice_id = invoice_id unless invoice_id == SKIP
+      @custom_id = custom_id unless custom_id == SKIP
+      unless network_transaction_reference == SKIP
+        @network_transaction_reference =
+          network_transaction_reference
+      end
+      @seller_protection = seller_protection unless seller_protection == SKIP
+      @expiration_time = expiration_time unless expiration_time == SKIP
+      @links = links unless links == SKIP
+      @create_time = create_time unless create_time == SKIP
+      @update_time = update_time unless update_time == SKIP
+      @supplementary_data = supplementary_data unless supplementary_data == SKIP
+      @payee = payee unless payee == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_details = AuthorizationStatusDetails.from_hash(hash['status_details']) if
+        hash['status_details']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
+      custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
+      if hash['network_transaction_reference']
+        network_transaction_reference = NetworkTransaction.from_hash(hash['network_transaction_reference'])
+      end
+      seller_protection = SellerProtection.from_hash(hash['seller_protection']) if
+        hash['seller_protection']
+      expiration_time =
+        hash.key?('expiration_time') ? hash['expiration_time'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (LinkDescription.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+      create_time = hash.key?('create_time') ? hash['create_time'] : SKIP
+      update_time = hash.key?('update_time') ? hash['update_time'] : SKIP
+      supplementary_data = PaymentSupplementaryData.from_hash(hash['supplementary_data']) if
+        hash['supplementary_data']
+      payee = PayeeBase.from_hash(hash['payee']) if hash['payee']
+
+      # Create object from extracted values.
+      PaymentAuthorization.new(status: status,
+                               status_details: status_details,
+                               id: id,
+                               amount: amount,
+                               invoice_id: invoice_id,
+                               custom_id: custom_id,
+                               network_transaction_reference: network_transaction_reference,
+                               seller_protection: seller_protection,
+                               expiration_time: expiration_time,
+                               links: links,
+                               create_time: create_time,
+                               update_time: update_time,
+                               supplementary_data: supplementary_data,
+                               payee: payee)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, status_details: #{@status_details}, id: #{@id}, amount:"\
+      " #{@amount}, invoice_id: #{@invoice_id}, custom_id: #{@custom_id},"\
+      " network_transaction_reference: #{@network_transaction_reference}, seller_protection:"\
+      " #{@seller_protection}, expiration_time: #{@expiration_time}, links: #{@links},"\
+      " create_time: #{@create_time}, update_time: #{@update_time}, supplementary_data:"\
+      " #{@supplementary_data}, payee: #{@payee}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, status_details: #{@status_details.inspect}, id:"\
+      " #{@id.inspect}, amount: #{@amount.inspect}, invoice_id: #{@invoice_id.inspect}, custom_id:"\
+      " #{@custom_id.inspect}, network_transaction_reference:"\
+      " #{@network_transaction_reference.inspect}, seller_protection:"\
+      " #{@seller_protection.inspect}, expiration_time: #{@expiration_time.inspect}, links:"\
+      " #{@links.inspect}, create_time: #{@create_time.inspect}, update_time:"\
+      " #{@update_time.inspect}, supplementary_data: #{@supplementary_data.inspect}, payee:"\
+      " #{@payee.inspect}>"
+    end
+  end
+end