cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/transactions_list.rb

@@ -0,0 +1,111 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The list transactions for a subscription request details.
+  class TransactionsList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of transactions.
+    # @return [Array[SubscriptionTransactionDetails]]
+    attr_accessor :transactions
+
+    # The total number of items.
+    # @return [Integer]
+    attr_accessor :total_items
+
+    # The total number of pages.
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # An array of request-related [HATEOAS
+    # links](/docs/api/reference/api-responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transactions'] = 'transactions'
+      @_hash['total_items'] = 'total_items'
+      @_hash['total_pages'] = 'total_pages'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transactions
+        total_items
+        total_pages
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transactions: SKIP, total_items: SKIP, total_pages: SKIP,
+                   links: SKIP)
+      @transactions = transactions unless transactions == SKIP
+      @total_items = total_items unless total_items == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @links = links unless links == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (SubscriptionTransactionDetails.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = SKIP unless hash.key?('transactions')
+      total_items = hash.key?('total_items') ? hash['total_items'] : SKIP
+      total_pages = hash.key?('total_pages') ? hash['total_pages'] : 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 object from extracted values.
+      TransactionsList.new(transactions: transactions,
+                           total_items: total_items,
+                           total_pages: total_pages,
+                           links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transactions: #{@transactions}, total_items: #{@total_items}, total_pages:"\
+      " #{@total_pages}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transactions: #{@transactions.inspect}, total_items:"\
+      " #{@total_items.inspect}, total_pages: #{@total_pages.inspect}, links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/trustly_payment_object.rb

@@ -0,0 +1,111 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using Trustly.
+  class TrustlyPaymentObject < 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 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
+
+    # 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
+
+    # The last characters of the IBAN used to pay.
+    # @return [String]
+    attr_accessor :iban_last_chars
+
+    # 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['email'] = 'email'
+      @_hash['bic'] = 'bic'
+      @_hash['iban_last_chars'] = 'iban_last_chars'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        country_code
+        email
+        bic
+        iban_last_chars
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, country_code: SKIP, email: SKIP, bic: SKIP,
+                   iban_last_chars: SKIP)
+      @name = name unless name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @email = email unless email == SKIP
+      @bic = bic unless bic == SKIP
+      @iban_last_chars = iban_last_chars unless iban_last_chars == 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
+      email = hash.key?('email') ? hash['email'] : SKIP
+      bic = hash.key?('bic') ? hash['bic'] : SKIP
+      iban_last_chars =
+        hash.key?('iban_last_chars') ? hash['iban_last_chars'] : SKIP
+
+      # Create object from extracted values.
+      TrustlyPaymentObject.new(name: name,
+                               country_code: country_code,
+                               email: email,
+                               bic: bic,
+                               iban_last_chars: iban_last_chars)
+    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}, email: #{@email}, bic:"\
+      " #{@bic}, iban_last_chars: #{@iban_last_chars}>"
+    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}, email:"\
+      " #{@email.inspect}, bic: #{@bic.inspect}, iban_last_chars: #{@iban_last_chars.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/trustly_payment_request.rb

@@ -0,0 +1,98 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using Trustly.
+  class TrustlyPaymentRequest < 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 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
+
+    # 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['email'] = 'email'
+      @_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:, email:, experience_context: SKIP)
+      @name = name
+      @country_code = country_code
+      @email = email
+      @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
+      email = hash.key?('email') ? hash['email'] : nil
+      experience_context = ExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      TrustlyPaymentRequest.new(name: name,
+                                country_code: country_code,
+                                email: email,
+                                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}, email: #{@email},"\
+      " 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}, email:"\
+      " #{@email.inspect}, experience_context: #{@experience_context.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/universal_product_code.rb

@@ -0,0 +1,68 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The Universal Product Code of the item.
+  class UniversalProductCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Universal Product Code type.
+    # @return [UpcType]
+    attr_accessor :type
+
+    # The UPC product code of the item.
+    # @return [String]
+    attr_accessor :code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['code'] = 'code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, code:)
+      @type = type
+      @code = code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      type = hash.key?('type') ? hash['type'] : nil
+      code = hash.key?('code') ? hash['code'] : nil
+
+      # Create object from extracted values.
+      UniversalProductCode.new(type: type,
+                               code: code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, code: #{@code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, code: #{@code.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/upc_type.rb

@@ -0,0 +1,56 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The Universal Product Code type.
+  class UpcType
+    UPC_TYPE = [
+      # TODO: Write general description for UPC_A
+      UPC_A = 'UPC-A'.freeze,
+
+      # TODO: Write general description for UPC_B
+      UPC_B = 'UPC-B'.freeze,
+
+      # TODO: Write general description for UPC_C
+      UPC_C = 'UPC-C'.freeze,
+
+      # TODO: Write general description for UPC_D
+      UPC_D = 'UPC-D'.freeze,
+
+      # TODO: Write general description for UPC_E
+      UPC_E = 'UPC-E'.freeze,
+
+      # TODO: Write general description for UPC_2
+      UPC_2 = 'UPC-2'.freeze,
+
+      # TODO: Write general description for UPC_5
+      UPC_5 = 'UPC-5'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = UPC_A)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'upc_a' then UPC_A
+      when 'upc_b' then UPC_B
+      when 'upc_c' then UPC_C
+      when 'upc_d' then UPC_D
+      when 'upc_e' then UPC_E
+      when 'upc_2' then UPC_2
+      when 'upc_5' then UPC_5
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/update_pricing_scheme.rb

@@ -0,0 +1,72 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The update pricing scheme request details.
+  class UpdatePricingScheme < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The billing cycle sequence.
+    # @return [Integer]
+    attr_accessor :billing_cycle_sequence
+
+    # The pricing scheme details.
+    # @return [SubscriptionPricingScheme]
+    attr_accessor :pricing_scheme
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['billing_cycle_sequence'] = 'billing_cycle_sequence'
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(billing_cycle_sequence:, pricing_scheme:)
+      @billing_cycle_sequence = billing_cycle_sequence
+      @pricing_scheme = pricing_scheme
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      billing_cycle_sequence =
+        hash.key?('billing_cycle_sequence') ? hash['billing_cycle_sequence'] : nil
+      pricing_scheme = SubscriptionPricingScheme.from_hash(hash['pricing_scheme']) if
+        hash['pricing_scheme']
+
+      # Create object from extracted values.
+      UpdatePricingScheme.new(billing_cycle_sequence: billing_cycle_sequence,
+                              pricing_scheme: pricing_scheme)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} billing_cycle_sequence: #{@billing_cycle_sequence}, pricing_scheme:"\
+      " #{@pricing_scheme}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} billing_cycle_sequence: #{@billing_cycle_sequence.inspect}, pricing_scheme:"\
+      " #{@pricing_scheme.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/update_pricing_schemes_request.rb

@@ -0,0 +1,69 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The update pricing scheme request details.
+  class UpdatePricingSchemesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of pricing schemes.
+    # @return [Array[UpdatePricingScheme]]
+    attr_accessor :pricing_schemes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pricing_schemes'] = 'pricing_schemes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pricing_schemes:)
+      @pricing_schemes = pricing_schemes
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      pricing_schemes = nil
+      unless hash['pricing_schemes'].nil?
+        pricing_schemes = []
+        hash['pricing_schemes'].each do |structure|
+          pricing_schemes << (UpdatePricingScheme.from_hash(structure) if structure)
+        end
+      end
+
+      pricing_schemes = nil unless hash.key?('pricing_schemes')
+
+      # Create object from extracted values.
+      UpdatePricingSchemesRequest.new(pricing_schemes: pricing_schemes)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pricing_schemes: #{@pricing_schemes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pricing_schemes: #{@pricing_schemes.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/usage_pattern.rb

@@ -0,0 +1,95 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Expected business/pricing model for the billing agreement., Expected
+  # business/charge model for the billing agreement.
+  class UsagePattern
+    USAGE_PATTERN = [
+      # On-demand instant payments – non-recurring, pre-paid, variable amount,
+      # variable frequency.
+      IMMEDIATE = 'IMMEDIATE'.freeze,
+
+      # Pay after use, non-recurring post-paid, variable amount, irregular
+      # frequency.
+      DEFERRED = 'DEFERRED'.freeze,
+
+      # Pay upfront fixed or variable amount on a fixed date before the
+      # goods/service is delivered.
+      RECURRING_PREPAID = 'RECURRING_PREPAID'.freeze,
+
+      # Pay on a fixed date based on usage or consumption after the
+      # goods/service is delivered.
+      RECURRING_POSTPAID = 'RECURRING_POSTPAID'.freeze,
+
+      # Charge payer when the set amount is reached or monthly billing cycle,
+      # whichever comes first, before the goods/service is delivered.
+      THRESHOLD_PREPAID = 'THRESHOLD_PREPAID'.freeze,
+
+      # Charge payer when the set amount is reached or monthly billing cycle,
+      # whichever comes first, after the goods/service is delivered.
+      THRESHOLD_POSTPAID = 'THRESHOLD_POSTPAID'.freeze,
+
+      # Subscription plan where the "amount due" and the "billing frequency" are
+      # fixed, and there is no defined duration with the payment due before the
+      # good/service is delivered.
+      SUBSCRIPTION_PREPAID = 'SUBSCRIPTION_PREPAID'.freeze,
+
+      # Subscription plan where the "amount due" and the "billing frequency" are
+      # fixed, and there is no defined duration with the payment due after the
+      # goods/services are delivered.
+      SUBSCRIPTION_POSTPAID = 'SUBSCRIPTION_POSTPAID'.freeze,
+
+      # Unscheduled card on file plan where the merchant can bill buyer upfront
+      # based on an agreed logic, but "amount due" and "frequency" can vary.
+      # Inclusive of automatic reload plans.
+      UNSCHEDULED_PREPAID = 'UNSCHEDULED_PREPAID'.freeze,
+
+      # Unscheduled card on file plan where the merchant can bill buyer based on
+      # an agreed logic, but "amount due" and "frequency" can vary. Inclusive of
+      # automatic reload plans.
+      UNSCHEDULED_POSTPAID = 'UNSCHEDULED_POSTPAID'.freeze,
+
+      # Merchant-managed installment plan when the "amount" to be paid and the
+      # "billing frequency" are fixed, but there is a defined number of payments
+      # with the payment due before the good/service is delivered.
+      INSTALLMENT_PREPAID = 'INSTALLMENT_PREPAID'.freeze,
+
+      # Merchant-managed installment plan when the "amount" to be paid and the
+      # "billing frequency" are fixed, but there is a defined number of payments
+      # with the payment due after the goods/services are delivered.
+      INSTALLMENT_POSTPAID = 'INSTALLMENT_POSTPAID'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = IMMEDIATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'immediate' then IMMEDIATE
+      when 'deferred' then DEFERRED
+      when 'recurring_prepaid' then RECURRING_PREPAID
+      when 'recurring_postpaid' then RECURRING_POSTPAID
+      when 'threshold_prepaid' then THRESHOLD_PREPAID
+      when 'threshold_postpaid' then THRESHOLD_POSTPAID
+      when 'subscription_prepaid' then SUBSCRIPTION_PREPAID
+      when 'subscription_postpaid' then SUBSCRIPTION_POSTPAID
+      when 'unscheduled_prepaid' then UNSCHEDULED_PREPAID
+      when 'unscheduled_postpaid' then UNSCHEDULED_POSTPAID
+      when 'installment_prepaid' then INSTALLMENT_PREPAID
+      when 'installment_postpaid' then INSTALLMENT_POSTPAID
+      else
+        default_value
+      end
+    end
+  end
+end