orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/url_not_found.rb

@@ -0,0 +1,101 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # UrlNotFound Model.
+  class UrlNotFound < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_reader :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :detail
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['status'] = 'status'
+      @_hash['detail'] = 'detail'
+      @_hash['title'] = 'title'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        detail
+        title
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        detail
+        title
+      ]
+    end
+
+    def initialize(detail: SKIP, title: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'https://docs.withorb.com/reference/error-responses#404-url-not-found'
+      @status = 404
+      @detail = detail unless detail == SKIP
+      @title = title unless title == SKIP
+      @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.
+      detail = hash.key?('detail') ? hash['detail'] : SKIP
+      title = hash.key?('title') ? hash['title'] : 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.
+      UrlNotFound.new(detail: detail,
+                      title: title,
+                      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} type: #{@type}, status: #{@status}, detail: #{@detail}, title: #{@title},"\
+      " 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} type: #{@type.inspect}, status: #{@status.inspect}, detail:"\
+      " #{@detail.inspect}, title: #{@title.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/usage.rb

@@ -0,0 +1,131 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # Usage Model.
+  class Usage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :quantity
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :timeframe_start
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :timeframe_end
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['quantity'] = 'quantity'
+      @_hash['timeframe_start'] = 'timeframe_start'
+      @_hash['timeframe_end'] = 'timeframe_end'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(quantity:, timeframe_start:, timeframe_end:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @quantity = quantity
+      @timeframe_start = timeframe_start
+      @timeframe_end = timeframe_end
+      @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.
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      timeframe_start = if hash.key?('timeframe_start')
+                          (DateTimeHelper.from_rfc3339(hash['timeframe_start']) if hash['timeframe_start'])
+                        end
+      timeframe_end = if hash.key?('timeframe_end')
+                        (DateTimeHelper.from_rfc3339(hash['timeframe_end']) if hash['timeframe_end'])
+                      end
+
+      # 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.
+      Usage.new(quantity: quantity,
+                timeframe_start: timeframe_start,
+                timeframe_end: timeframe_end,
+                additional_properties: additional_properties)
+    end
+
+    def to_custom_timeframe_start
+      DateTimeHelper.to_rfc3339(timeframe_start)
+    end
+
+    def to_custom_timeframe_end
+      DateTimeHelper.to_rfc3339(timeframe_end)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Usage | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.quantity,
+                                ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.timeframe_start,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.timeframe_end,
+                                  ->(val) { val.instance_of? DateTime })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['quantity'],
+                              ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['timeframe_start'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['timeframe_end'],
+                                ->(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} quantity: #{@quantity}, timeframe_start: #{@timeframe_start},"\
+      " timeframe_end: #{@timeframe_end}, 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} quantity: #{@quantity.inspect}, timeframe_start:"\
+      " #{@timeframe_start.inspect}, timeframe_end: #{@timeframe_end.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/usage_discount.rb

@@ -0,0 +1,129 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # UsageDiscount Model.
+  class UsageDiscount < 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 `usage`. Number of usage units that
+    # this discount is for
+    # @return [Float]
+    attr_accessor :usage_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['usage_discount'] = 'usage_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(usage_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 = 'usage'
+      @applies_to_price_ids = applies_to_price_ids unless applies_to_price_ids == SKIP
+      @filters = filters unless filters == SKIP
+      @reason = reason unless reason == SKIP
+      @usage_discount = usage_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.
+      usage_discount =
+        hash.key?('usage_discount') ? hash['usage_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.
+      UsageDiscount.new(usage_discount: usage_discount,
+                        applies_to_price_ids: applies_to_price_ids,
+                        filters: filters,
+                        reason: reason,
+                        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} discount_type: #{@discount_type}, applies_to_price_ids:"\
+      " #{@applies_to_price_ids}, filters: #{@filters}, reason: #{@reason}, usage_discount:"\
+      " #{@usage_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}, usage_discount: #{@usage_discount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/usage_discount_creation_params.rb

@@ -0,0 +1,82 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # UsageDiscountCreationParams Model.
+  class UsageDiscountCreationParams < 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 `usage`. Number of usage units that
+    # this discount is for.
+    # @return [Float]
+    attr_accessor :usage_discount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['discount_type'] = 'discount_type'
+      @_hash['usage_discount'] = 'usage_discount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(usage_discount:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @discount_type = 'usage'
+      @usage_discount = usage_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.
+      usage_discount =
+        hash.key?('usage_discount') ? hash['usage_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.
+      UsageDiscountCreationParams.new(usage_discount: usage_discount,
+                                      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} discount_type: #{@discount_type}, usage_discount: #{@usage_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}, usage_discount:"\
+      " #{@usage_discount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/usage_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
+  # UsageDiscountInterval Model.
+  class UsageDiscountInterval < 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 `usage`. Number of usage units that
+    # this discount is for
+    # @return [Float]
+    attr_accessor :usage_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['usage_discount'] = 'usage_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(usage_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 = 'usage'
+      @usage_discount = usage_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.
+      usage_discount =
+        hash.key?('usage_discount') ? hash['usage_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.
+      UsageDiscountInterval.new(usage_discount: usage_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 [UsageDiscountInterval | 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.usage_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['usage_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}, usage_discount: #{@usage_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}, usage_discount:"\
+      " #{@usage_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