orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/billable_metric.rb

@@ -0,0 +1,155 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # The Metric resource represents a calculation of a quantity based on events.
+  # Metrics are defined by the query that transforms raw usage events into
+  # meaningful values for your customers.
+  class BillableMetric < 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
+
+    # 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 :name
+
+    # 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 :description
+
+    # 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 [Status]
+    attr_accessor :status
+
+    # The Item resource represents a sellable product or good. Items are
+    # associated with all line items, billable metrics,
+    # and prices and are used for defining external sync behavior for invoices
+    # and tax calculation purposes.
+    # @return [Item]
+    attr_accessor :item
+
+    # The Item resource represents a sellable product or good. Items are
+    # associated with all line items, billable metrics,
+    # and prices and are used for defining external sync behavior for invoices
+    # and tax calculation purposes.
+    # @return [Array[Object]]
+    attr_accessor :parameter_definitions
+
+    # 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['description'] = 'description'
+      @_hash['status'] = 'status'
+      @_hash['item'] = 'item'
+      @_hash['parameter_definitions'] = 'parameter_definitions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        parameter_definitions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        parameter_definitions
+      ]
+    end
+
+    def initialize(metadata:, id:, name:, description:, status:, item:,
+                   parameter_definitions: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @id = id
+      @name = name
+      @description = description
+      @status = status
+      @item = item
+      @parameter_definitions = parameter_definitions unless parameter_definitions == 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.
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      item = Item.from_hash(hash['item']) if hash['item']
+      parameter_definitions =
+        hash.key?('parameter_definitions') ? hash['parameter_definitions'] : 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.
+      BillableMetric.new(metadata: metadata,
+                         id: id,
+                         name: name,
+                         description: description,
+                         status: status,
+                         item: item,
+                         parameter_definitions: parameter_definitions,
+                         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}, description:"\
+      " #{@description}, status: #{@status}, item: #{@item}, parameter_definitions:"\
+      " #{@parameter_definitions}, 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},"\
+      " description: #{@description.inspect}, status: #{@status.inspect}, item: #{@item.inspect},"\
+      " parameter_definitions: #{@parameter_definitions.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/billable_metric_minified.rb

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

data/lib/api_reference/models/billable_metric_simple.rb

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

data/lib/api_reference/models/billable_metric_tiny.rb

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

data/lib/api_reference/models/billable_metrics.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # BillableMetrics Model.
+  class BillableMetrics < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[BillableMetric]]
+    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 << (BillableMetric.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.
+      BillableMetrics.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/billing_cycle_alignment.rb

@@ -0,0 +1,40 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Billing Cycle Alignment.
+  class BillingCycleAlignment
+    BILLING_CYCLE_ALIGNMENT = [
+      # TODO: Write general description for UNCHANGED
+      UNCHANGED = 'unchanged'.freeze,
+
+      # TODO: Write general description for PLAN_CHANGE_DATE
+      PLAN_CHANGE_DATE = 'plan_change_date'.freeze,
+
+      # TODO: Write general description for START_OF_MONTH
+      START_OF_MONTH = 'start_of_month'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = UNCHANGED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'unchanged' then UNCHANGED
+      when 'plan_change_date' then PLAN_CHANGE_DATE
+      when 'start_of_month' then START_OF_MONTH
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/billing_cycle_anchor_configuration.rb

@@ -0,0 +1,117 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # BillingCycleAnchorConfiguration Model.
+  class BillingCycleAnchorConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The day of the month on which the billing cycle is anchored. If the
+    # maximum number of days in a month is greater than this value, the last day
+    # of the month is the billing cycle day (e.g. billing_cycle_day=31 for April
+    # means the billing period begins on the 30th.
+    # @return [Integer]
+    attr_accessor :day
+
+    # The month on which the billing cycle is anchored (e.g. a quarterly price
+    # anchored in February would have cycles starting February, May, August, and
+    # November).
+    # @return [Integer]
+    attr_accessor :month
+
+    # The year on which the billing cycle is anchored (e.g. a 2 year billing
+    # cycle anchored on 2021 would have cycles starting on 2021, 2023, 2025,
+    # etc.).
+    # @return [Integer]
+    attr_accessor :year
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['day'] = 'day'
+      @_hash['month'] = 'month'
+      @_hash['year'] = 'year'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        month
+        year
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        month
+        year
+      ]
+    end
+
+    def initialize(day:, month: SKIP, year: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @day = day
+      @month = month unless month == SKIP
+      @year = year unless year == 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.
+      day = hash.key?('day') ? hash['day'] : nil
+      month = hash.key?('month') ? hash['month'] : SKIP
+      year = hash.key?('year') ? hash['year'] : 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.
+      BillingCycleAnchorConfiguration.new(day: day,
+                                          month: month,
+                                          year: year,
+                                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [BillingCycleAnchorConfiguration | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.day,
+                                     ->(val) { val.instance_of? Integer })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['day'],
+                            ->(val) { val.instance_of? Integer })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} day: #{@day}, month: #{@month}, year: #{@year}, 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} day: #{@day.inspect}, month: #{@month.inspect}, year: #{@year.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end