orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/dimensional_price_group.rb

@@ -0,0 +1,134 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # A dimensional price group is used to partition the result of a billable
+  # metric by a set of dimensions. Prices in a price group must specify the
+  # partition used to derive their usage.
+  class DimensionalPriceGroup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [String]
+    attr_accessor :id
+
+    # The name of the dimensional price group
+    # @return [String]
+    attr_accessor :name
+
+    # An alias for the dimensional price group
+    # @return [String]
+    attr_accessor :external_dimensional_price_group_id
+
+    # The dimensions that this dimensional price group is defined over
+    # @return [Array[String]]
+    attr_accessor :dimensions
+
+    # The billable metric associated with this dimensional price group. All
+    # prices associated with this dimensional price group will be computed using
+    # this billable metric.
+    # @return [String]
+    attr_accessor :billable_metric_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['external_dimensional_price_group_id'] =
+        'external_dimensional_price_group_id'
+      @_hash['dimensions'] = 'dimensions'
+      @_hash['billable_metric_id'] = 'billable_metric_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        external_dimensional_price_group_id
+      ]
+    end
+
+    def initialize(metadata:, id:, name:, external_dimensional_price_group_id:,
+                   dimensions:, billable_metric_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @id = id
+      @name = name
+      @external_dimensional_price_group_id = external_dimensional_price_group_id
+      @dimensions = dimensions
+      @billable_metric_id = billable_metric_id
+      @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.
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      external_dimensional_price_group_id =
+        hash.key?('external_dimensional_price_group_id') ? hash['external_dimensional_price_group_id'] : nil
+      dimensions = hash.key?('dimensions') ? hash['dimensions'] : nil
+      billable_metric_id =
+        hash.key?('billable_metric_id') ? hash['billable_metric_id'] : 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.
+      DimensionalPriceGroup.new(metadata: metadata,
+                                id: id,
+                                name: name,
+                                external_dimensional_price_group_id: external_dimensional_price_group_id,
+                                dimensions: dimensions,
+                                billable_metric_id: billable_metric_id,
+                                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} metadata: #{@metadata}, id: #{@id}, name: #{@name},"\
+      " external_dimensional_price_group_id: #{@external_dimensional_price_group_id}, dimensions:"\
+      " #{@dimensions}, billable_metric_id: #{@billable_metric_id}, 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} metadata: #{@metadata.inspect}, id: #{@id.inspect}, name: #{@name.inspect},"\
+      " external_dimensional_price_group_id: #{@external_dimensional_price_group_id.inspect},"\
+      " dimensions: #{@dimensions.inspect}, billable_metric_id: #{@billable_metric_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/dimensional_price_groups.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # DimensionalPriceGroups Model.
+  class DimensionalPriceGroups < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[DimensionalPriceGroup]]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [PaginationMetadata]
+    attr_accessor :pagination_metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['pagination_metadata'] = 'pagination_metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, pagination_metadata:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @pagination_metadata = pagination_metadata
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (DimensionalPriceGroup.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+      pagination_metadata = PaginationMetadata.from_hash(hash['pagination_metadata']) if
+        hash['pagination_metadata']
+
+      # 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.
+      DimensionalPriceGroups.new(data: data,
+                                 pagination_metadata: pagination_metadata,
+                                 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} data: #{@data}, pagination_metadata: #{@pagination_metadata},"\
+      " 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} data: #{@data.inspect}, pagination_metadata:"\
+      " #{@pagination_metadata.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/discount_override.rb

@@ -0,0 +1,116 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # DiscountOverride Model.
+  class DiscountOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DiscountType]
+    attr_accessor :discount_type
+
+    # Only available if discount_type is `percentage`. This is a number between
+    # 0 and 1.
+    # @return [Float]
+    attr_accessor :percentage_discount
+
+    # Only available if discount_type is `usage`. Number of usage units that
+    # this discount is for
+    # @return [Float]
+    attr_accessor :usage_discount
+
+    # Only available if discount_type is `amount`.
+    # @return [String]
+    attr_accessor :amount_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['usage_discount'] = 'usage_discount'
+      @_hash['amount_discount'] = 'amount_discount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        percentage_discount
+        usage_discount
+        amount_discount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        percentage_discount
+        usage_discount
+        amount_discount
+      ]
+    end
+
+    def initialize(discount_type:, percentage_discount: SKIP,
+                   usage_discount: SKIP, amount_discount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @discount_type = discount_type
+      @percentage_discount = percentage_discount unless percentage_discount == SKIP
+      @usage_discount = usage_discount unless usage_discount == SKIP
+      @amount_discount = amount_discount unless amount_discount == 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.
+      discount_type = hash.key?('discount_type') ? hash['discount_type'] : nil
+      percentage_discount =
+        hash.key?('percentage_discount') ? hash['percentage_discount'] : SKIP
+      usage_discount =
+        hash.key?('usage_discount') ? hash['usage_discount'] : SKIP
+      amount_discount =
+        hash.key?('amount_discount') ? hash['amount_discount'] : 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.
+      DiscountOverride.new(discount_type: discount_type,
+                           percentage_discount: percentage_discount,
+                           usage_discount: usage_discount,
+                           amount_discount: amount_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}, percentage_discount:"\
+      " #{@percentage_discount}, usage_discount: #{@usage_discount}, amount_discount:"\
+      " #{@amount_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}, usage_discount: #{@usage_discount.inspect},"\
+      " amount_discount: #{@amount_discount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/discount_type.rb

@@ -0,0 +1,40 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Discount Type.
+  class DiscountType
+    DISCOUNT_TYPE = [
+      # TODO: Write general description for PERCENTAGE
+      PERCENTAGE = 'percentage'.freeze,
+
+      # TODO: Write general description for USAGE
+      USAGE = 'usage'.freeze,
+
+      # TODO: Write general description for AMOUNT
+      AMOUNT = 'amount'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PERCENTAGE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'percentage' then PERCENTAGE
+      when 'usage' then USAGE
+      when 'amount' then AMOUNT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/discount_type1.rb

@@ -0,0 +1,36 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Discount Type1.
+  class DiscountType1
+    DISCOUNT_TYPE1 = [
+      # TODO: Write general description for PERCENTAGE
+      PERCENTAGE = 'percentage'.freeze,
+
+      # TODO: Write general description for AMOUNT
+      AMOUNT = 'amount'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PERCENTAGE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'percentage' then PERCENTAGE
+      when 'amount' then AMOUNT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/duplicate_resource_creation_error.rb

@@ -0,0 +1,101 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # DuplicateResourceCreationError Model.
+  class DuplicateResourceCreationError < 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#400-duplicate-resource-creation'
+      @status = 400
+      @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.
+      DuplicateResourceCreationError.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/duration_unit.rb

@@ -0,0 +1,36 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # The unit of billing period duration.
+  class DurationUnit
+    DURATION_UNIT = [
+      # TODO: Write general description for DAY
+      DAY = 'day'.freeze,
+
+      # TODO: Write general description for MONTH
+      MONTH = 'month'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'day' then DAY
+      when 'month' then MONTH
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/duration_unit1.rb

@@ -0,0 +1,36 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Duration Unit1.
+  class DurationUnit1
+    DURATION_UNIT1 = [
+      # TODO: Write general description for DAY
+      DAY = 'day'.freeze,
+
+      # TODO: Write general description for MONTH
+      MONTH = 'month'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'day' then DAY
+      when 'month' then MONTH
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/duration_unit3.rb

@@ -0,0 +1,48 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Duration Unit3.
+  class DurationUnit3
+    DURATION_UNIT3 = [
+      # TODO: Write general description for DAILY
+      DAILY = 'daily'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'monthly'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'quarterly'.freeze,
+
+      # TODO: Write general description for SEMI_ANNUAL
+      SEMI_ANNUAL = 'semi_annual'.freeze,
+
+      # TODO: Write general description for ANNUAL
+      ANNUAL = 'annual'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DAILY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'daily' then DAILY
+      when 'monthly' then MONTHLY
+      when 'quarterly' then QUARTERLY
+      when 'semi_annual' then SEMI_ANNUAL
+      when 'annual' then ANNUAL
+      else
+        default_value
+      end
+    end
+  end
+end