cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/plan_details.rb

@@ -0,0 +1,147 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The plan details.
+  class PlanDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID for the product.
+    # @return [String]
+    attr_accessor :product_id
+
+    # The plan name.
+    # @return [String]
+    attr_accessor :name
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'product_id'
+      @_hash['name'] = 'name'
+      @_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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_id
+        name
+        description
+        billing_cycles
+        payment_preferences
+        merchant_preferences
+        taxes
+        quantity_supported
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_id: SKIP, name: SKIP, description: SKIP,
+                   billing_cycles: SKIP, payment_preferences: SKIP,
+                   merchant_preferences: SKIP, taxes: SKIP,
+                   quantity_supported: false)
+      @product_id = product_id unless product_id == SKIP
+      @name = name unless name == 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
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : 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 object from extracted values.
+      PlanDetails.new(product_id: product_id,
+                      name: name,
+                      description: description,
+                      billing_cycles: billing_cycles,
+                      payment_preferences: payment_preferences,
+                      merchant_preferences: merchant_preferences,
+                      taxes: taxes,
+                      quantity_supported: quantity_supported)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id}, name: #{@name}, description: #{@description},"\
+      " billing_cycles: #{@billing_cycles}, payment_preferences: #{@payment_preferences},"\
+      " merchant_preferences: #{@merchant_preferences}, taxes: #{@taxes}, quantity_supported:"\
+      " #{@quantity_supported}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id.inspect}, name: #{@name.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}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/plan_override.rb

@@ -0,0 +1,96 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # 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.
+  class PlanOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of billing cycles for trial billing and regular billing. The
+    # subscription billing cycle definition has to adhere to the plan billing
+    # cycle definition.
+    # @return [Array[BillingCycleOverride]]
+    attr_accessor :billing_cycles
+
+    # The payment preferences to override at subscription level.
+    # @return [PaymentPreferencesOverride]
+    attr_accessor :payment_preferences
+
+    # The tax details.
+    # @return [TaxesOverride]
+    attr_accessor :taxes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['billing_cycles'] = 'billing_cycles'
+      @_hash['payment_preferences'] = 'payment_preferences'
+      @_hash['taxes'] = 'taxes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        billing_cycles
+        payment_preferences
+        taxes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(billing_cycles: SKIP, payment_preferences: SKIP, taxes: SKIP)
+      @billing_cycles = billing_cycles unless billing_cycles == SKIP
+      @payment_preferences = payment_preferences unless payment_preferences == SKIP
+      @taxes = taxes unless taxes == 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
+      billing_cycles = nil
+      unless hash['billing_cycles'].nil?
+        billing_cycles = []
+        hash['billing_cycles'].each do |structure|
+          billing_cycles << (BillingCycleOverride.from_hash(structure) if structure)
+        end
+      end
+
+      billing_cycles = SKIP unless hash.key?('billing_cycles')
+      payment_preferences = PaymentPreferencesOverride.from_hash(hash['payment_preferences']) if
+        hash['payment_preferences']
+      taxes = TaxesOverride.from_hash(hash['taxes']) if hash['taxes']
+
+      # Create object from extracted values.
+      PlanOverride.new(billing_cycles: billing_cycles,
+                       payment_preferences: payment_preferences,
+                       taxes: taxes)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} billing_cycles: #{@billing_cycles}, payment_preferences:"\
+      " #{@payment_preferences}, taxes: #{@taxes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} billing_cycles: #{@billing_cycles.inspect}, payment_preferences:"\
+      " #{@payment_preferences.inspect}, taxes: #{@taxes.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/plan_request.rb

@@ -0,0 +1,154 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The create plan request details.
+  class PlanRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the product created through Catalog Products API.
+    # @return [String]
+    attr_accessor :product_id
+
+    # The plan name.
+    # @return [String]
+    attr_accessor :name
+
+    # The initial state of the plan. Allowed input values are CREATED and
+    # ACTIVE.
+    # @return [PlanRequestStatus]
+    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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        description
+        merchant_preferences
+        taxes
+        quantity_supported
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_id:, name:, billing_cycles:, payment_preferences:,
+                   status: PlanRequestStatus::ACTIVE, description: SKIP,
+                   merchant_preferences: SKIP, taxes: SKIP,
+                   quantity_supported: false)
+      @product_id = product_id
+      @name = name
+      @status = status unless status == SKIP
+      @description = description unless description == SKIP
+      @billing_cycles = billing_cycles
+      @payment_preferences = payment_preferences
+      @merchant_preferences = merchant_preferences unless merchant_preferences == SKIP
+      @taxes = taxes unless taxes == SKIP
+      @quantity_supported = quantity_supported unless quantity_supported == 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.
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      # 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 = nil unless hash.key?('billing_cycles')
+      payment_preferences = PaymentPreferences.from_hash(hash['payment_preferences']) if
+        hash['payment_preferences']
+      status = hash['status'] ||= PlanRequestStatus::ACTIVE
+      description = hash.key?('description') ? hash['description'] : SKIP
+      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 object from extracted values.
+      PlanRequest.new(product_id: product_id,
+                      name: name,
+                      billing_cycles: billing_cycles,
+                      payment_preferences: payment_preferences,
+                      status: status,
+                      description: description,
+                      merchant_preferences: merchant_preferences,
+                      taxes: taxes,
+                      quantity_supported: quantity_supported)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} 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}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} 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}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/plan_request_status.rb

@@ -0,0 +1,42 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The initial state of the plan. Allowed input values are CREATED and ACTIVE.
+  class PlanRequestStatus
+    PLAN_REQUEST_STATUS = [
+      # The plan was created. You cannot create subscriptions for a plan in this
+      # state.
+      CREATED = 'CREATED'.freeze,
+
+      # The plan is inactive.
+      INACTIVE = 'INACTIVE'.freeze,
+
+      # The plan is active. You can only create subscriptions for a plan in this
+      # state.
+      ACTIVE = 'ACTIVE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CREATED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'created' then CREATED
+      when 'inactive' then INACTIVE
+      when 'active' then ACTIVE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/platform_fee.rb

@@ -0,0 +1,75 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The platform or partner fee, commission, or brokerage fee that is associated
+  # with the transaction. Not a separate or isolated transaction leg from the
+  # external perspective. The platform fee is limited in scope and is always
+  # associated with the original payment for the purchase unit.
+  class PlatformFee < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # 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['amount'] = 'amount'
+      @_hash['payee'] = 'payee'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payee
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, payee: SKIP)
+      @amount = amount
+      @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.
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      payee = PayeeBase.from_hash(hash['payee']) if hash['payee']
+
+      # Create object from extracted values.
+      PlatformFee.new(amount: amount,
+                      payee: payee)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, payee: #{@payee}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, payee: #{@payee.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pricing_model.rb

@@ -0,0 +1,42 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The pricing model for the billing cycle.
+  class PricingModel
+    PRICING_MODEL = [
+      # A fixed pricing scheme where the customer is charged a fixed amount.
+      FIXED = 'FIXED'.freeze,
+
+      # A variable pricing scheme where the customer is charged a variable
+      # amount.
+      VARIABLE = 'VARIABLE'.freeze,
+
+      # A auto-reload pricing scheme where the customer is charged a fixed
+      # amount for reload.
+      AUTO_RELOAD = 'AUTO_RELOAD'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = FIXED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fixed' then FIXED
+      when 'variable' then VARIABLE
+      when 'auto_reload' then AUTO_RELOAD
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pricing_scheme.rb

@@ -0,0 +1,84 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The pricing scheme details.
+  class PricingScheme < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :price
+
+    # The pricing model for the billing cycle.
+    # @return [PricingModel]
+    attr_accessor :pricing_model
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :reload_threshold_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['price'] = 'price'
+      @_hash['pricing_model'] = 'pricing_model'
+      @_hash['reload_threshold_amount'] = 'reload_threshold_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        price
+        reload_threshold_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pricing_model:, price: SKIP, reload_threshold_amount: SKIP)
+      @price = price unless price == SKIP
+      @pricing_model = pricing_model
+      @reload_threshold_amount = reload_threshold_amount unless reload_threshold_amount == 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.
+      pricing_model = hash.key?('pricing_model') ? hash['pricing_model'] : nil
+      price = Money.from_hash(hash['price']) if hash['price']
+      reload_threshold_amount = Money.from_hash(hash['reload_threshold_amount']) if
+        hash['reload_threshold_amount']
+
+      # Create object from extracted values.
+      PricingScheme.new(pricing_model: pricing_model,
+                        price: price,
+                        reload_threshold_amount: reload_threshold_amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price: #{@price}, pricing_model: #{@pricing_model},"\
+      " reload_threshold_amount: #{@reload_threshold_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price: #{@price.inspect}, pricing_model: #{@pricing_model.inspect},"\
+      " reload_threshold_amount: #{@reload_threshold_amount.inspect}>"
+    end
+  end
+end