orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/backfill.rb

@@ -0,0 +1,214 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # A backfill represents an update to historical usage data, adding or
+  # replacing events in a timeframe.
+  class Backfill < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # The status of the backfill.
+    # @return [BackfillStatus]
+    attr_accessor :status
+
+    # The status of the backfill.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # The status of the backfill.
+    # @return [DateTime]
+    attr_accessor :timeframe_start
+
+    # The status of the backfill.
+    # @return [DateTime]
+    attr_accessor :timeframe_end
+
+    # The number of events ingested in this backfill.
+    # @return [Integer]
+    attr_accessor :events_ingested
+
+    # If in the future, the time at which the backfill will automatically close.
+    # If in the past, the time at which the backfill was closed.
+    # @return [DateTime]
+    attr_accessor :close_time
+
+    # The time at which this backfill was reverted.
+    # @return [DateTime]
+    attr_accessor :reverted_at
+
+    # The Orb-generated ID of the customer to which this backfill is scoped. If
+    # `null`, this backfill is scoped to all customers.
+    # @return [String]
+    attr_accessor :customer_id
+
+    # A boolean [computed
+    # property](/extensibility/advanced-metrics#computed-properties) used to
+    # filter the set of events to deprecate
+    # @return [String]
+    attr_accessor :deprecation_filter
+
+    # If `true`, existing events in the backfill's timeframe will be replaced
+    # with the newly ingested events associated with the backfill. If `false`,
+    # newly ingested events will be added to the existing events.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :replace_existing_events
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['status'] = 'status'
+      @_hash['created_at'] = 'created_at'
+      @_hash['timeframe_start'] = 'timeframe_start'
+      @_hash['timeframe_end'] = 'timeframe_end'
+      @_hash['events_ingested'] = 'events_ingested'
+      @_hash['close_time'] = 'close_time'
+      @_hash['reverted_at'] = 'reverted_at'
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['deprecation_filter'] = 'deprecation_filter'
+      @_hash['replace_existing_events'] = 'replace_existing_events'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        deprecation_filter
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        close_time
+        reverted_at
+        customer_id
+        deprecation_filter
+      ]
+    end
+
+    def initialize(id:, status:, created_at:, timeframe_start:, timeframe_end:,
+                   events_ingested:, close_time:, reverted_at:, customer_id:,
+                   replace_existing_events:, deprecation_filter: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @status = status
+      @created_at = created_at
+      @timeframe_start = timeframe_start
+      @timeframe_end = timeframe_end
+      @events_ingested = events_ingested
+      @close_time = close_time
+      @reverted_at = reverted_at
+      @customer_id = customer_id
+      @deprecation_filter = deprecation_filter unless deprecation_filter == SKIP
+      @replace_existing_events = replace_existing_events
+      @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
+      status = hash.key?('status') ? hash['status'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      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
+      events_ingested =
+        hash.key?('events_ingested') ? hash['events_ingested'] : nil
+      close_time = if hash.key?('close_time')
+                     (DateTimeHelper.from_rfc3339(hash['close_time']) if hash['close_time'])
+                   end
+      reverted_at = if hash.key?('reverted_at')
+                      (DateTimeHelper.from_rfc3339(hash['reverted_at']) if hash['reverted_at'])
+                    end
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : nil
+      replace_existing_events =
+        hash.key?('replace_existing_events') ? hash['replace_existing_events'] : nil
+      deprecation_filter =
+        hash.key?('deprecation_filter') ? hash['deprecation_filter'] : 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.
+      Backfill.new(id: id,
+                   status: status,
+                   created_at: created_at,
+                   timeframe_start: timeframe_start,
+                   timeframe_end: timeframe_end,
+                   events_ingested: events_ingested,
+                   close_time: close_time,
+                   reverted_at: reverted_at,
+                   customer_id: customer_id,
+                   replace_existing_events: replace_existing_events,
+                   deprecation_filter: deprecation_filter,
+                   additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_timeframe_start
+      DateTimeHelper.to_rfc3339(timeframe_start)
+    end
+
+    def to_custom_timeframe_end
+      DateTimeHelper.to_rfc3339(timeframe_end)
+    end
+
+    def to_custom_close_time
+      DateTimeHelper.to_rfc3339(close_time)
+    end
+
+    def to_custom_reverted_at
+      DateTimeHelper.to_rfc3339(reverted_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, status: #{@status}, created_at: #{@created_at},"\
+      " timeframe_start: #{@timeframe_start}, timeframe_end: #{@timeframe_end}, events_ingested:"\
+      " #{@events_ingested}, close_time: #{@close_time}, reverted_at: #{@reverted_at},"\
+      " customer_id: #{@customer_id}, deprecation_filter: #{@deprecation_filter},"\
+      " replace_existing_events: #{@replace_existing_events}, 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}, status: #{@status.inspect}, created_at:"\
+      " #{@created_at.inspect}, timeframe_start: #{@timeframe_start.inspect}, timeframe_end:"\
+      " #{@timeframe_end.inspect}, events_ingested: #{@events_ingested.inspect}, close_time:"\
+      " #{@close_time.inspect}, reverted_at: #{@reverted_at.inspect}, customer_id:"\
+      " #{@customer_id.inspect}, deprecation_filter: #{@deprecation_filter.inspect},"\
+      " replace_existing_events: #{@replace_existing_events.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/backfill_status.rb

@@ -0,0 +1,44 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # The status of the backfill.
+  class BackfillStatus
+    BACKFILL_STATUS = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for REFLECTED
+      REFLECTED = 'reflected'.freeze,
+
+      # TODO: Write general description for PENDING_REVERT
+      PENDING_REVERT = 'pending_revert'.freeze,
+
+      # TODO: Write general description for REVERTED
+      REVERTED = 'reverted'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'reflected' then REFLECTED
+      when 'pending_revert' then PENDING_REVERT
+      when 'reverted' then REVERTED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/backfills.rb

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

@@ -0,0 +1,105 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Alert status is used to determine if an alert is currently in-alert or not.
+  class BalanceAlertStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The value of the threshold that defines the alert status.
+    # @return [Float]
+    attr_accessor :threshold_value
+
+    # Whether the alert is currently in-alert or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :in_alert
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['threshold_value'] = 'threshold_value'
+      @_hash['in_alert'] = 'in_alert'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(threshold_value:, in_alert:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @threshold_value = threshold_value
+      @in_alert = in_alert
+      @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.
+      threshold_value =
+        hash.key?('threshold_value') ? hash['threshold_value'] : nil
+      in_alert = hash.key?('in_alert') ? hash['in_alert'] : 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.
+      BalanceAlertStatus.new(threshold_value: threshold_value,
+                             in_alert: in_alert,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [BalanceAlertStatus | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.threshold_value,
+                                ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.in_alert,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['threshold_value'],
+                              ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['in_alert'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} threshold_value: #{@threshold_value}, in_alert: #{@in_alert},"\
+      " 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} threshold_value: #{@threshold_value.inspect}, in_alert:"\
+      " #{@in_alert.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/base_model.rb

@@ -0,0 +1,110 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end