orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/percentage_discount.rb

@@ -0,0 +1,151 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PercentageDiscount Model.
+  class PercentageDiscount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :discount_type
+
+    # List of price_ids that this discount applies to. For plan/plan phase
+    # discounts, this can be a subset of prices.
+    # @return [Array[String]]
+    attr_accessor :applies_to_price_ids
+
+    # The filters that determine which prices to apply this discount to.
+    # @return [Array[PriceFilter]]
+    attr_accessor :filters
+
+    # The filters that determine which prices to apply this discount to.
+    # @return [String]
+    attr_accessor :reason
+
+    # Only available if discount_type is `percentage`. This is a number between
+    # 0 and 1.
+    # @return [Float]
+    attr_accessor :percentage_discount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['discount_type'] = 'discount_type'
+      @_hash['applies_to_price_ids'] = 'applies_to_price_ids'
+      @_hash['filters'] = 'filters'
+      @_hash['reason'] = 'reason'
+      @_hash['percentage_discount'] = 'percentage_discount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        applies_to_price_ids
+        filters
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        applies_to_price_ids
+        filters
+        reason
+      ]
+    end
+
+    def initialize(percentage_discount:, applies_to_price_ids: SKIP,
+                   filters: SKIP, reason: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @discount_type = 'percentage'
+      @applies_to_price_ids = applies_to_price_ids unless applies_to_price_ids == SKIP
+      @filters = filters unless filters == SKIP
+      @reason = reason unless reason == SKIP
+      @percentage_discount = percentage_discount
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      percentage_discount =
+        hash.key?('percentage_discount') ? hash['percentage_discount'] : nil
+      applies_to_price_ids =
+        hash.key?('applies_to_price_ids') ? hash['applies_to_price_ids'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      filters = nil
+      unless hash['filters'].nil?
+        filters = []
+        hash['filters'].each do |structure|
+          filters << (PriceFilter.from_hash(structure) if structure)
+        end
+      end
+
+      filters = SKIP unless hash.key?('filters')
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PercentageDiscount.new(percentage_discount: percentage_discount,
+                             applies_to_price_ids: applies_to_price_ids,
+                             filters: filters,
+                             reason: reason,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PercentageDiscount | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.discount_type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.percentage_discount,
+                                  ->(val) { val.instance_of? Float })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['discount_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['percentage_discount'],
+                                ->(val) { val.instance_of? Float })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} discount_type: #{@discount_type}, applies_to_price_ids:"\
+      " #{@applies_to_price_ids}, filters: #{@filters}, reason: #{@reason}, percentage_discount:"\
+      " #{@percentage_discount}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} discount_type: #{@discount_type.inspect}, applies_to_price_ids:"\
+      " #{@applies_to_price_ids.inspect}, filters: #{@filters.inspect}, reason:"\
+      " #{@reason.inspect}, percentage_discount: #{@percentage_discount.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/percentage_discount_creation_params.rb

@@ -0,0 +1,104 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PercentageDiscountCreationParams Model.
+  class PercentageDiscountCreationParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :discount_type
+
+    # Only available if discount_type is `percentage`. This is a number between
+    # 0 and 1.
+    # @return [Float]
+    attr_accessor :percentage_discount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['discount_type'] = 'discount_type'
+      @_hash['percentage_discount'] = 'percentage_discount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(percentage_discount:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @discount_type = 'percentage'
+      @percentage_discount = percentage_discount
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      percentage_discount =
+        hash.key?('percentage_discount') ? hash['percentage_discount'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PercentageDiscountCreationParams.new(percentage_discount: percentage_discount,
+                                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PercentageDiscountCreationParams | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.discount_type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.percentage_discount,
+                                  ->(val) { val.instance_of? Float })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['discount_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['percentage_discount'],
+                                ->(val) { val.instance_of? Float })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} discount_type: #{@discount_type}, percentage_discount:"\
+      " #{@percentage_discount}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} discount_type: #{@discount_type.inspect}, percentage_discount:"\
+      " #{@percentage_discount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/percentage_discount_interval.rb

@@ -0,0 +1,188 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # PercentageDiscountInterval Model.
+  class PercentageDiscountInterval < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :discount_type
+
+    # Only available if discount_type is `percentage`.This is a number between 0
+    # and 1.
+    # @return [Float]
+    attr_accessor :percentage_discount
+
+    # The start date of the discount interval.
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The end date of the discount interval.
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # The filters that determine which prices this discount interval applies to.
+    # @return [Array[PriceFilter]]
+    attr_accessor :filters
+
+    # The price interval ids that this discount interval applies to.
+    # @return [Array[String]]
+    attr_accessor :applies_to_price_interval_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['discount_type'] = 'discount_type'
+      @_hash['percentage_discount'] = 'percentage_discount'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['filters'] = 'filters'
+      @_hash['applies_to_price_interval_ids'] =
+        'applies_to_price_interval_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        end_date
+      ]
+    end
+
+    def initialize(percentage_discount:, start_date:, end_date:, filters:,
+                   applies_to_price_interval_ids:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @discount_type = 'percentage'
+      @percentage_discount = percentage_discount
+      @start_date = start_date
+      @end_date = end_date
+      @filters = filters
+      @applies_to_price_interval_ids = applies_to_price_interval_ids
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      percentage_discount =
+        hash.key?('percentage_discount') ? hash['percentage_discount'] : nil
+      start_date = if hash.key?('start_date')
+                     (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
+                   end
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 end
+      # Parameter is an array, so we need to iterate through it
+      filters = nil
+      unless hash['filters'].nil?
+        filters = []
+        hash['filters'].each do |structure|
+          filters << (PriceFilter.from_hash(structure) if structure)
+        end
+      end
+
+      filters = nil unless hash.key?('filters')
+      applies_to_price_interval_ids =
+        hash.key?('applies_to_price_interval_ids') ? hash['applies_to_price_interval_ids'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PercentageDiscountInterval.new(percentage_discount: percentage_discount,
+                                     start_date: start_date,
+                                     end_date: end_date,
+                                     filters: filters,
+                                     applies_to_price_interval_ids: applies_to_price_interval_ids,
+                                     additional_properties: additional_properties)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PercentageDiscountInterval | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.discount_type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.percentage_discount,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.start_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.end_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.filters,
+                                  ->(val) { PriceFilter.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.applies_to_price_interval_ids,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['discount_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['percentage_discount'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['start_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['end_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['filters'],
+                                ->(val) { PriceFilter.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['applies_to_price_interval_ids'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} discount_type: #{@discount_type}, percentage_discount:"\
+      " #{@percentage_discount}, start_date: #{@start_date}, end_date: #{@end_date}, filters:"\
+      " #{@filters}, applies_to_price_interval_ids: #{@applies_to_price_interval_ids},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} discount_type: #{@discount_type.inspect}, percentage_discount:"\
+      " #{@percentage_discount.inspect}, start_date: #{@start_date.inspect}, end_date:"\
+      " #{@end_date.inspect}, filters: #{@filters.inspect}, applies_to_price_interval_ids:"\
+      " #{@applies_to_price_interval_ids.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/percentage_tier.rb

@@ -0,0 +1,122 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # One band of a tiered percentage discount. Bounds are denominated in the
+  # discount's currency. `lower_bound` is the exclusive start of the band and
+  # `upper_bound` is the inclusive end; `upper_bound` is null only for the
+  # open-ended final tier.
+  class PercentageTier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Exclusive lower bound of cumulative spend for this tier.
+    # @return [Float]
+    attr_accessor :lower_bound
+
+    # Inclusive upper bound of cumulative spend for this tier; null for the
+    # final open-ended tier.
+    # @return [Float]
+    attr_accessor :upper_bound
+
+    # The percentage (between 0 and 1) discounted from spend that falls within
+    # this tier.
+    # @return [Float]
+    attr_accessor :percentage
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['lower_bound'] = 'lower_bound'
+      @_hash['upper_bound'] = 'upper_bound'
+      @_hash['percentage'] = 'percentage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        upper_bound
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        upper_bound
+      ]
+    end
+
+    def initialize(lower_bound:, percentage:, upper_bound: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @lower_bound = lower_bound
+      @upper_bound = upper_bound unless upper_bound == SKIP
+      @percentage = percentage
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      lower_bound = hash.key?('lower_bound') ? hash['lower_bound'] : nil
+      percentage = hash.key?('percentage') ? hash['percentage'] : nil
+      upper_bound = hash.key?('upper_bound') ? hash['upper_bound'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PercentageTier.new(lower_bound: lower_bound,
+                         percentage: percentage,
+                         upper_bound: upper_bound,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PercentageTier | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.lower_bound,
+                                ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.percentage,
+                                  ->(val) { val.instance_of? Float })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['lower_bound'],
+                              ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['percentage'],
+                                ->(val) { val.instance_of? Float })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} lower_bound: #{@lower_bound}, upper_bound: #{@upper_bound}, percentage:"\
+      " #{@percentage}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} lower_bound: #{@lower_bound.inspect}, upper_bound: #{@upper_bound.inspect},"\
+      " percentage: #{@percentage.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/ping_response.rb

@@ -0,0 +1,73 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PingResponse Model.
+  class PingResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :response
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['response'] = 'response'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(response:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @response = response
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      response = hash.key?('response') ? hash['response'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PingResponse.new(response: response,
+                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response: #{@response}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response: #{@response.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end