cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/merchant_preferences.rb

@@ -0,0 +1,73 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The merchant preferences for a subscription.
+  class MerchantPreferences < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The URL where the customer is redirected after the customer approves the
+    # payment.
+    # @return [String]
+    attr_accessor :return_url
+
+    # The URL where the customer is redirected after the customer cancels the
+    # payment.
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        return_url
+        cancel_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(return_url: SKIP, cancel_url: 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.
+      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.
+      MerchantPreferences.new(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} 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} return_url: #{@return_url.inspect}, cancel_url: #{@cancel_url.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/mobile_return_flow.rb

@@ -0,0 +1,41 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Merchant preference on how the buyer can navigate back to merchant website
+  # post approving the transaction on the PayPal App.
+  class MobileReturnFlow
+    MOBILE_RETURN_FLOW = [
+      # After payment approval in the PayPal App, buyer will automatically be
+      # redirected to the merchant website.
+      AUTO = 'AUTO'.freeze,
+
+      # After payment approval in the PayPal App, buyer will be asked to
+      # manually navigate back to the merchant website where they started the
+      # transaction from. The buyer is shown a message like 'Return to Merchant'
+      # to return to the source where the transaction actually started.
+      MANUAL = 'MANUAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = AUTO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'auto' then AUTO
+      when 'manual' then MANUAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/mobile_web_context.rb

@@ -0,0 +1,76 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Buyer's mobile web browser context to app switch to the PayPal consumer app.
+  class MobileWebContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant preference on how the buyer can navigate back to merchant website
+    # post approving the transaction on the PayPal App.
+    # @return [MobileReturnFlow]
+    attr_accessor :return_flow
+
+    # User agent from the request originating from the buyer's device. This will
+    # be used to identify the buyer's operating system and browser versions.
+    # NOTE: Merchants must not alter or modify the buyer's device user agent.
+    # @return [String]
+    attr_accessor :buyer_user_agent
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['return_flow'] = 'return_flow'
+      @_hash['buyer_user_agent'] = 'buyer_user_agent'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        return_flow
+        buyer_user_agent
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(return_flow: MobileReturnFlow::AUTO, buyer_user_agent: SKIP)
+      @return_flow = return_flow unless return_flow == SKIP
+      @buyer_user_agent = buyer_user_agent unless buyer_user_agent == 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.
+      return_flow = hash['return_flow'] ||= MobileReturnFlow::AUTO
+      buyer_user_agent =
+        hash.key?('buyer_user_agent') ? hash['buyer_user_agent'] : SKIP
+
+      # Create object from extracted values.
+      MobileWebContext.new(return_flow: return_flow,
+                           buyer_user_agent: buyer_user_agent)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} return_flow: #{@return_flow}, buyer_user_agent: #{@buyer_user_agent}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} return_flow: #{@return_flow.inspect}, buyer_user_agent:"\
+      " #{@buyer_user_agent.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/modify_subscription_request.rb

@@ -0,0 +1,124 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The request to update the quantity of the product or service in a
+  # subscription. You can also use this method to switch the plan and update the
+  # `shipping_amount` and `shipping_address` values for the subscription. This
+  # type of update requires the buyer's consent.
+  class ModifySubscriptionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique PayPal-generated ID for the plan.
+    # @return [String]
+    attr_accessor :plan_id
+
+    # The quantity of the product or service in the subscription.
+    # @return [String]
+    attr_accessor :quantity
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :shipping_amount
+
+    # The shipping details.
+    # @return [ShippingDetails]
+    attr_accessor :shipping_address
+
+    # The application context, which customizes the payer experience during the
+    # subscription approval process with PayPal.
+    # @return [SubscriptionPatchApplicationContext]
+    attr_accessor :application_context
+
+    # An inline plan object to customise the subscription. You can override plan
+    # level default attributes by providing customised values for the
+    # subscription in this object.
+    # @return [PlanOverride]
+    attr_accessor :plan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['plan_id'] = 'plan_id'
+      @_hash['quantity'] = 'quantity'
+      @_hash['shipping_amount'] = 'shipping_amount'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['application_context'] = 'application_context'
+      @_hash['plan'] = 'plan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        plan_id
+        quantity
+        shipping_amount
+        shipping_address
+        application_context
+        plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(plan_id: SKIP, quantity: SKIP, shipping_amount: SKIP,
+                   shipping_address: SKIP, application_context: SKIP,
+                   plan: SKIP)
+      @plan_id = plan_id unless plan_id == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @shipping_amount = shipping_amount unless shipping_amount == SKIP
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @application_context = application_context unless application_context == SKIP
+      @plan = plan unless plan == 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.
+      plan_id = hash.key?('plan_id') ? hash['plan_id'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      shipping_amount = Money.from_hash(hash['shipping_amount']) if hash['shipping_amount']
+      shipping_address = ShippingDetails.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      if hash['application_context']
+        application_context = SubscriptionPatchApplicationContext.from_hash(hash['application_context'])
+      end
+      plan = PlanOverride.from_hash(hash['plan']) if hash['plan']
+
+      # Create object from extracted values.
+      ModifySubscriptionRequest.new(plan_id: plan_id,
+                                    quantity: quantity,
+                                    shipping_amount: shipping_amount,
+                                    shipping_address: shipping_address,
+                                    application_context: application_context,
+                                    plan: plan)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plan_id: #{@plan_id}, quantity: #{@quantity}, shipping_amount:"\
+      " #{@shipping_amount}, shipping_address: #{@shipping_address}, application_context:"\
+      " #{@application_context}, plan: #{@plan}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plan_id: #{@plan_id.inspect}, quantity: #{@quantity.inspect},"\
+      " shipping_amount: #{@shipping_amount.inspect}, shipping_address:"\
+      " #{@shipping_address.inspect}, application_context: #{@application_context.inspect}, plan:"\
+      " #{@plan.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/modify_subscription_response.rb

@@ -0,0 +1,141 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The response to a request to update the quantity of the product or service
+  # in a subscription. You can also use this method to switch the plan and
+  # update the `shipping_amount` and `shipping_address` values for the
+  # subscription. This type of update requires the buyer's consent.
+  class ModifySubscriptionResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique PayPal-generated ID for the plan.
+    # @return [String]
+    attr_accessor :plan_id
+
+    # The quantity of the product or service in the subscription.
+    # @return [String]
+    attr_accessor :quantity
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :shipping_amount
+
+    # The shipping details.
+    # @return [ShippingDetails]
+    attr_accessor :shipping_address
+
+    # An inline plan object to customise the subscription. You can override plan
+    # level default attributes by providing customised values for the
+    # subscription in this object.
+    # @return [PlanOverride]
+    attr_accessor :plan
+
+    # Indicates whether the subscription has overridden any plan attributes.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :plan_overridden
+
+    # 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['plan_id'] = 'plan_id'
+      @_hash['quantity'] = 'quantity'
+      @_hash['shipping_amount'] = 'shipping_amount'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['plan'] = 'plan'
+      @_hash['plan_overridden'] = 'plan_overridden'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        plan_id
+        quantity
+        shipping_amount
+        shipping_address
+        plan
+        plan_overridden
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(plan_id: SKIP, quantity: SKIP, shipping_amount: SKIP,
+                   shipping_address: SKIP, plan: SKIP, plan_overridden: SKIP,
+                   links: SKIP)
+      @plan_id = plan_id unless plan_id == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @shipping_amount = shipping_amount unless shipping_amount == SKIP
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @plan = plan unless plan == SKIP
+      @plan_overridden = plan_overridden unless plan_overridden == 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.
+      plan_id = hash.key?('plan_id') ? hash['plan_id'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      shipping_amount = Money.from_hash(hash['shipping_amount']) if hash['shipping_amount']
+      shipping_address = ShippingDetails.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      plan = PlanOverride.from_hash(hash['plan']) if hash['plan']
+      plan_overridden =
+        hash.key?('plan_overridden') ? hash['plan_overridden'] : 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.
+      ModifySubscriptionResponse.new(plan_id: plan_id,
+                                     quantity: quantity,
+                                     shipping_amount: shipping_amount,
+                                     shipping_address: shipping_address,
+                                     plan: plan,
+                                     plan_overridden: plan_overridden,
+                                     links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plan_id: #{@plan_id}, quantity: #{@quantity}, shipping_amount:"\
+      " #{@shipping_amount}, shipping_address: #{@shipping_address}, plan: #{@plan},"\
+      " plan_overridden: #{@plan_overridden}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plan_id: #{@plan_id.inspect}, quantity: #{@quantity.inspect},"\
+      " shipping_amount: #{@shipping_amount.inspect}, shipping_address:"\
+      " #{@shipping_address.inspect}, plan: #{@plan.inspect}, plan_overridden:"\
+      " #{@plan_overridden.inspect}, links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/money.rb

@@ -0,0 +1,75 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The currency and amount for a financial transaction, such as a balance or
+  # payment due.
+  class Money < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The [three-character ISO-4217 currency
+    # code](https://developer.paypal.com/api/rest/reference/currency-codes/)
+    # that identifies the currency.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # The value, which might be: An integer for currencies like `JPY` that are
+    # not typically fractional. A decimal fraction for currencies like `TND`
+    # that are subdivided into thousandths. For the required number of decimal
+    # places for a currency code, see [Currency
+    # Codes](https://developer.paypal.com/api/rest/reference/currency-codes/).
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency_code'] = 'currency_code'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency_code:, value:)
+      @currency_code = currency_code
+      @value = value
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      currency_code = hash.key?('currency_code') ? hash['currency_code'] : nil
+      value = hash.key?('value') ? hash['value'] : nil
+
+      # Create object from extracted values.
+      Money.new(currency_code: currency_code,
+                value: value)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency_code: #{@currency_code}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency_code: #{@currency_code.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/mybank_payment_object.rb

@@ -0,0 +1,99 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using MyBank.
+  class MybankPaymentObject < 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
+
+    # 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['bic'] = 'bic'
+      @_hash['iban_last_chars'] = 'iban_last_chars'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        country_code
+        bic
+        iban_last_chars
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, country_code: SKIP, bic: SKIP,
+                   iban_last_chars: SKIP)
+      @name = name unless name == SKIP
+      @country_code = country_code unless country_code == 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
+      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.
+      MybankPaymentObject.new(name: name,
+                              country_code: country_code,
+                              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}, 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}, bic:"\
+      " #{@bic.inspect}, iban_last_chars: #{@iban_last_chars.inspect}>"
+    end
+  end
+end