cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/billing_cycle_override.rb

@@ -0,0 +1,91 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The billing cycle details to override at subscription level. The
+  # subscription billing cycle definition has to adhere to the plan billing
+  # cycle definition.
+  class BillingCycleOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The pricing scheme details.
+    # @return [SubscriptionPricingScheme]
+    attr_accessor :pricing_scheme
+
+    # The order in which this cycle is to run among other billing cycles. For
+    # example, a trial billing cycle has a `sequence` of `1` while a regular
+    # billing cycle has a `sequence` of `2`, so that trial cycle runs before the
+    # regular cycle.
+    # @return [Integer]
+    attr_accessor :sequence
+
+    # The number of times this billing cycle gets executed. Trial billing cycles
+    # can only be executed a finite number of times (value between 1 and 999 for
+    # total_cycles). Regular billing cycles can be executed infinite times
+    # (value of 0 for total_cycles) or a finite number of times (value between 1
+    # and 999 for total_cycles).
+    # @return [Integer]
+    attr_accessor :total_cycles
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['sequence'] = 'sequence'
+      @_hash['total_cycles'] = 'total_cycles'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pricing_scheme
+        total_cycles
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(sequence:, pricing_scheme: SKIP, total_cycles: SKIP)
+      @pricing_scheme = pricing_scheme unless pricing_scheme == SKIP
+      @sequence = sequence
+      @total_cycles = total_cycles unless total_cycles == 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.
+      sequence = hash.key?('sequence') ? hash['sequence'] : nil
+      pricing_scheme = SubscriptionPricingScheme.from_hash(hash['pricing_scheme']) if
+        hash['pricing_scheme']
+      total_cycles = hash.key?('total_cycles') ? hash['total_cycles'] : SKIP
+
+      # Create object from extracted values.
+      BillingCycleOverride.new(sequence: sequence,
+                               pricing_scheme: pricing_scheme,
+                               total_cycles: total_cycles)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pricing_scheme: #{@pricing_scheme}, sequence: #{@sequence}, total_cycles:"\
+      " #{@total_cycles}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pricing_scheme: #{@pricing_scheme.inspect}, sequence: #{@sequence.inspect},"\
+      " total_cycles: #{@total_cycles.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/billing_plan.rb

@@ -0,0 +1,212 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The plan details.
+  class BillingPlan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique PayPal-generated ID for the plan.
+    # @return [String]
+    attr_accessor :id
+
+    # The ID for the product.
+    # @return [String]
+    attr_accessor :product_id
+
+    # The plan name.
+    # @return [String]
+    attr_accessor :name
+
+    # The plan status.
+    # @return [SubscriptionPlanStatus]
+    attr_accessor :status
+
+    # The detailed description of the plan.
+    # @return [String]
+    attr_accessor :description
+
+    # An array of billing cycles for trial billing and regular billing. A plan
+    # can have at most two trial cycles and only one regular cycle.
+    # @return [Array[SubscriptionBillingCycle]]
+    attr_accessor :billing_cycles
+
+    # The payment preferences for a subscription.
+    # @return [PaymentPreferences]
+    attr_accessor :payment_preferences
+
+    # The merchant preferences for a subscription.
+    # @return [MerchantPreferences]
+    attr_accessor :merchant_preferences
+
+    # The tax details.
+    # @return [Taxes]
+    attr_accessor :taxes
+
+    # Indicates whether you can subscribe to this plan by providing a quantity
+    # for the goods or service.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :quantity_supported
+
+    # 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
+
+    # 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['id'] = 'id'
+      @_hash['product_id'] = 'product_id'
+      @_hash['name'] = 'name'
+      @_hash['status'] = 'status'
+      @_hash['description'] = 'description'
+      @_hash['billing_cycles'] = 'billing_cycles'
+      @_hash['payment_preferences'] = 'payment_preferences'
+      @_hash['merchant_preferences'] = 'merchant_preferences'
+      @_hash['taxes'] = 'taxes'
+      @_hash['quantity_supported'] = 'quantity_supported'
+      @_hash['create_time'] = 'create_time'
+      @_hash['update_time'] = 'update_time'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        product_id
+        name
+        status
+        description
+        billing_cycles
+        payment_preferences
+        merchant_preferences
+        taxes
+        quantity_supported
+        create_time
+        update_time
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, product_id: SKIP, name: SKIP, status: SKIP,
+                   description: SKIP, billing_cycles: SKIP,
+                   payment_preferences: SKIP, merchant_preferences: SKIP,
+                   taxes: SKIP, quantity_supported: false, create_time: SKIP,
+                   update_time: SKIP, links: SKIP)
+      @id = id unless id == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @name = name unless name == SKIP
+      @status = status unless status == SKIP
+      @description = description unless description == SKIP
+      @billing_cycles = billing_cycles unless billing_cycles == SKIP
+      @payment_preferences = payment_preferences unless payment_preferences == SKIP
+      @merchant_preferences = merchant_preferences unless merchant_preferences == SKIP
+      @taxes = taxes unless taxes == SKIP
+      @quantity_supported = quantity_supported unless quantity_supported == SKIP
+      @create_time = create_time unless create_time == SKIP
+      @update_time = update_time unless update_time == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      billing_cycles = nil
+      unless hash['billing_cycles'].nil?
+        billing_cycles = []
+        hash['billing_cycles'].each do |structure|
+          billing_cycles << (SubscriptionBillingCycle.from_hash(structure) if structure)
+        end
+      end
+
+      billing_cycles = SKIP unless hash.key?('billing_cycles')
+      payment_preferences = PaymentPreferences.from_hash(hash['payment_preferences']) if
+        hash['payment_preferences']
+      merchant_preferences = MerchantPreferences.from_hash(hash['merchant_preferences']) if
+        hash['merchant_preferences']
+      taxes = Taxes.from_hash(hash['taxes']) if hash['taxes']
+      quantity_supported = hash['quantity_supported'] ||= false
+      create_time = hash.key?('create_time') ? hash['create_time'] : SKIP
+      update_time = hash.key?('update_time') ? hash['update_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 object from extracted values.
+      BillingPlan.new(id: id,
+                      product_id: product_id,
+                      name: name,
+                      status: status,
+                      description: description,
+                      billing_cycles: billing_cycles,
+                      payment_preferences: payment_preferences,
+                      merchant_preferences: merchant_preferences,
+                      taxes: taxes,
+                      quantity_supported: quantity_supported,
+                      create_time: create_time,
+                      update_time: update_time,
+                      links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, product_id: #{@product_id}, name: #{@name}, status: #{@status},"\
+      " description: #{@description}, billing_cycles: #{@billing_cycles}, payment_preferences:"\
+      " #{@payment_preferences}, merchant_preferences: #{@merchant_preferences}, taxes: #{@taxes},"\
+      " quantity_supported: #{@quantity_supported}, create_time: #{@create_time}, update_time:"\
+      " #{@update_time}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, product_id: #{@product_id.inspect}, name:"\
+      " #{@name.inspect}, status: #{@status.inspect}, description: #{@description.inspect},"\
+      " billing_cycles: #{@billing_cycles.inspect}, payment_preferences:"\
+      " #{@payment_preferences.inspect}, merchant_preferences: #{@merchant_preferences.inspect},"\
+      " taxes: #{@taxes.inspect}, quantity_supported: #{@quantity_supported.inspect}, create_time:"\
+      " #{@create_time.inspect}, update_time: #{@update_time.inspect}, links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/bin_details.rb

@@ -0,0 +1,102 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Bank Identification Number (BIN) details used to fund a payment.
+  class BinDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Bank Identification Number (BIN) signifies the number that is being
+    # used to identify the granular level details (except the PII information)
+    # of the card.
+    # @return [String]
+    attr_accessor :bin
+
+    # The issuer of the card instrument.
+    # @return [String]
+    attr_accessor :issuing_bank
+
+    # 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 :bin_country_code
+
+    # The type of card product assigned to the BIN by the issuer. These values
+    # are defined by the issuer and may change over time. Some examples include:
+    # PREPAID_GIFT, CONSUMER, CORPORATE.
+    # @return [Array[String]]
+    attr_accessor :products
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bin'] = 'bin'
+      @_hash['issuing_bank'] = 'issuing_bank'
+      @_hash['bin_country_code'] = 'bin_country_code'
+      @_hash['products'] = 'products'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bin
+        issuing_bank
+        bin_country_code
+        products
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bin: SKIP, issuing_bank: SKIP, bin_country_code: SKIP,
+                   products: SKIP)
+      @bin = bin unless bin == SKIP
+      @issuing_bank = issuing_bank unless issuing_bank == SKIP
+      @bin_country_code = bin_country_code unless bin_country_code == SKIP
+      @products = products unless products == 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.
+      bin = hash.key?('bin') ? hash['bin'] : SKIP
+      issuing_bank = hash.key?('issuing_bank') ? hash['issuing_bank'] : SKIP
+      bin_country_code =
+        hash.key?('bin_country_code') ? hash['bin_country_code'] : SKIP
+      products = hash.key?('products') ? hash['products'] : SKIP
+
+      # Create object from extracted values.
+      BinDetails.new(bin: bin,
+                     issuing_bank: issuing_bank,
+                     bin_country_code: bin_country_code,
+                     products: products)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} bin: #{@bin}, issuing_bank: #{@issuing_bank}, bin_country_code:"\
+      " #{@bin_country_code}, products: #{@products}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} bin: #{@bin.inspect}, issuing_bank: #{@issuing_bank.inspect},"\
+      " bin_country_code: #{@bin_country_code.inspect}, products: #{@products.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/blik_experience_context.rb

@@ -0,0 +1,142 @@
+# 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 BLIK
+  # payment.
+  class BlikExperienceContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The label that overrides the business name in the PayPal account on the
+    # PayPal site. The pattern is defined by an external party and supports
+    # Unicode.
+    # @return [String]
+    attr_accessor :brand_name
+
+    # The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the
+    # language in which to localize the error-related strings, such as messages,
+    # issues, and suggested actions. The tag is made up of the [ISO 639-2
+    # language code](https://www.loc.gov/standards/iso639-2/php/code_list.php),
+    # the optional [ISO-15924 script
+    # tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166
+    # alpha-2 country
+    # code](https://developer.paypal.com/api/rest/reference/country-codes/) or
+    # [M49 region code](https://unstats.un.org/unsd/methodology/m49/).
+    # @return [String]
+    attr_accessor :locale
+
+    # The location from which the shipping address is derived.
+    # @return [ExperienceContextShippingPreference]
+    attr_accessor :shipping_preference
+
+    # Describes the URL.
+    # @return [String]
+    attr_accessor :return_url
+
+    # Describes the URL.
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # An Internet Protocol address (IP address). This address assigns a
+    # numerical label to each device that is connected to a computer network
+    # through the Internet Protocol. Supports IPv4 and IPv6 addresses.
+    # @return [String]
+    attr_accessor :consumer_ip
+
+    # The payer's User Agent. For example, Mozilla/5.0 (Macintosh; Intel Mac OS
+    # X x.y; rv:42.0).
+    # @return [String]
+    attr_accessor :consumer_user_agent
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['brand_name'] = 'brand_name'
+      @_hash['locale'] = 'locale'
+      @_hash['shipping_preference'] = 'shipping_preference'
+      @_hash['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash['consumer_ip'] = 'consumer_ip'
+      @_hash['consumer_user_agent'] = 'consumer_user_agent'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        shipping_preference
+        return_url
+        cancel_url
+        consumer_ip
+        consumer_user_agent
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      brand_name: SKIP, locale: SKIP,
+      shipping_preference: ExperienceContextShippingPreference::GET_FROM_FILE,
+      return_url: SKIP, cancel_url: SKIP, consumer_ip: SKIP,
+      consumer_user_agent: SKIP
+    )
+      @brand_name = brand_name unless brand_name == SKIP
+      @locale = locale unless locale == SKIP
+      @shipping_preference = shipping_preference unless shipping_preference == SKIP
+      @return_url = return_url unless return_url == SKIP
+      @cancel_url = cancel_url unless cancel_url == SKIP
+      @consumer_ip = consumer_ip unless consumer_ip == SKIP
+      @consumer_user_agent = consumer_user_agent unless consumer_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.
+      brand_name = hash.key?('brand_name') ? hash['brand_name'] : SKIP
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+      shipping_preference =
+        hash['shipping_preference'] ||= ExperienceContextShippingPreference::GET_FROM_FILE
+      return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
+      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
+      consumer_ip = hash.key?('consumer_ip') ? hash['consumer_ip'] : SKIP
+      consumer_user_agent =
+        hash.key?('consumer_user_agent') ? hash['consumer_user_agent'] : SKIP
+
+      # Create object from extracted values.
+      BlikExperienceContext.new(brand_name: brand_name,
+                                locale: locale,
+                                shipping_preference: shipping_preference,
+                                return_url: return_url,
+                                cancel_url: cancel_url,
+                                consumer_ip: consumer_ip,
+                                consumer_user_agent: consumer_user_agent)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name}, locale: #{@locale}, shipping_preference:"\
+      " #{@shipping_preference}, return_url: #{@return_url}, cancel_url: #{@cancel_url},"\
+      " consumer_ip: #{@consumer_ip}, consumer_user_agent: #{@consumer_user_agent}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name.inspect}, locale: #{@locale.inspect},"\
+      " shipping_preference: #{@shipping_preference.inspect}, return_url: #{@return_url.inspect},"\
+      " cancel_url: #{@cancel_url.inspect}, consumer_ip: #{@consumer_ip.inspect},"\
+      " consumer_user_agent: #{@consumer_user_agent.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/blik_level0_payment_object.rb

@@ -0,0 +1,60 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using BLIK level_0 flow.
+  class BlikLevel0PaymentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The 6-digit code used to authenticate a consumer within BLIK.
+    # @return [String]
+    attr_accessor :auth_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auth_code'] = 'auth_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(auth_code:)
+      @auth_code = auth_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.
+      auth_code = hash.key?('auth_code') ? hash['auth_code'] : nil
+
+      # Create object from extracted values.
+      BlikLevel0PaymentObject.new(auth_code: auth_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auth_code: #{@auth_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auth_code: #{@auth_code.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/blik_one_click_payment_object.rb

@@ -0,0 +1,64 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using BLIK one-click flow.
+  class BlikOneClickPaymentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The merchant generated, unique reference serving as a primary identifier
+    # for accounts connected between Blik and a merchant.
+    # @return [String]
+    attr_accessor :consumer_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['consumer_reference'] = 'consumer_reference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        consumer_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(consumer_reference: SKIP)
+      @consumer_reference = consumer_reference unless consumer_reference == 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.
+      consumer_reference =
+        hash.key?('consumer_reference') ? hash['consumer_reference'] : SKIP
+
+      # Create object from extracted values.
+      BlikOneClickPaymentObject.new(consumer_reference: consumer_reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} consumer_reference: #{@consumer_reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} consumer_reference: #{@consumer_reference.inspect}>"
+    end
+  end
+end