orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/event_search_criteria.rb

@@ -0,0 +1,106 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # EventSearchCriteria Model.
+  class EventSearchCriteria < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This is an explicit array of IDs to filter by. Note that an event's ID is
+    # the idempotency_key that was originally used for ingestion, and this only
+    # supports events that have not been amended. Values in this array will be
+    # treated case sensitively.
+    # @return [Array[String]]
+    attr_accessor :event_ids
+
+    # The start of the timeframe, inclusive, in which to search events. If not
+    # specified, the one week ago is used.
+    # @return [DateTime]
+    attr_accessor :timeframe_start
+
+    # The end of the timeframe, exclusive, in which to search events. If not
+    # specified, the current time is used.
+    # @return [DateTime]
+    attr_accessor :timeframe_end
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event_ids'] = 'event_ids'
+      @_hash['timeframe_start'] = 'timeframe_start'
+      @_hash['timeframe_end'] = 'timeframe_end'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timeframe_start
+        timeframe_end
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        timeframe_start
+        timeframe_end
+      ]
+    end
+
+    def initialize(event_ids:, timeframe_start: SKIP, timeframe_end: SKIP)
+      @event_ids = event_ids
+      @timeframe_start = timeframe_start unless timeframe_start == SKIP
+      @timeframe_end = timeframe_end unless timeframe_end == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      event_ids = hash.key?('event_ids') ? hash['event_ids'] : nil
+      timeframe_start = if hash.key?('timeframe_start')
+                          (DateTimeHelper.from_rfc3339(hash['timeframe_start']) if hash['timeframe_start'])
+                        else
+                          SKIP
+                        end
+      timeframe_end = if hash.key?('timeframe_end')
+                        (DateTimeHelper.from_rfc3339(hash['timeframe_end']) if hash['timeframe_end'])
+                      else
+                        SKIP
+                      end
+
+      # Create object from extracted values.
+      EventSearchCriteria.new(event_ids: event_ids,
+                              timeframe_start: timeframe_start,
+                              timeframe_end: timeframe_end)
+    end
+
+    def to_custom_timeframe_start
+      DateTimeHelper.to_rfc3339(timeframe_start)
+    end
+
+    def to_custom_timeframe_end
+      DateTimeHelper.to_rfc3339(timeframe_end)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} event_ids: #{@event_ids}, timeframe_start: #{@timeframe_start},"\
+      " timeframe_end: #{@timeframe_end}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} event_ids: #{@event_ids.inspect}, timeframe_start:"\
+      " #{@timeframe_start.inspect}, timeframe_end: #{@timeframe_end.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/event_volume.rb

@@ -0,0 +1,107 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # An EventVolume contains the event volume ingested in an hourly window. The
+  # timestamp used for the aggregation is the `timestamp` datetime field on
+  # events.
+  class EventVolume < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # The number of events ingested with a timestamp between the timeframe
+    # @return [Integer]
+    attr_accessor :count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['timeframe_start'] = 'timeframe_start'
+      @_hash['timeframe_end'] = 'timeframe_end'
+      @_hash['count'] = 'count'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timeframe_start:, timeframe_end:, count:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @timeframe_start = timeframe_start
+      @timeframe_end = timeframe_end
+      @count = count
+      @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.
+      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
+      count = hash.key?('count') ? hash['count'] : 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.
+      EventVolume.new(timeframe_start: timeframe_start,
+                      timeframe_end: timeframe_end,
+                      count: count,
+                      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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} timeframe_start: #{@timeframe_start}, timeframe_end: #{@timeframe_end},"\
+      " count: #{@count}, 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} timeframe_start: #{@timeframe_start.inspect}, timeframe_end:"\
+      " #{@timeframe_end.inspect}, count: #{@count.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/event_volume_params.rb

@@ -0,0 +1,115 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # EventVolumeParams Model.
+  class EventVolumeParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number of items to fetch. Defaults to 20.
+    # @return [Integer]
+    attr_accessor :limit
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [String]
+    attr_accessor :cursor
+
+    # The start of the timeframe, inclusive, in which to return event volume.
+    # All datetime values are converted to UTC time. If the specified time isn't
+    # hour-aligned, the response includes the event volume count for the hour
+    # the time falls in.
+    # @return [DateTime]
+    attr_accessor :timeframe_start
+
+    # The end of the timeframe, exclusive, in which to return event volume. If
+    # not specified, the current time is used. All datetime values are converted
+    # to UTC time.If the specified time isn't hour-aligned, the response
+    # includes the event volumecount for the hour the time falls in.
+    # @return [DateTime]
+    attr_accessor :timeframe_end
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['limit'] = 'limit'
+      @_hash['cursor'] = 'cursor'
+      @_hash['timeframe_start'] = 'timeframe_start'
+      @_hash['timeframe_end'] = 'timeframe_end'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        limit
+        cursor
+        timeframe_end
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cursor
+      ]
+    end
+
+    def initialize(timeframe_start:, limit: 20, cursor: SKIP,
+                   timeframe_end: SKIP)
+      @limit = limit unless limit == SKIP
+      @cursor = cursor unless cursor == SKIP
+      @timeframe_start = timeframe_start
+      @timeframe_end = timeframe_end unless timeframe_end == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      timeframe_start = if hash.key?('timeframe_start')
+                          (DateTimeHelper.from_rfc3339(hash['timeframe_start']) if hash['timeframe_start'])
+                        end
+      limit = hash['limit'] ||= 20
+      cursor = hash.key?('cursor') ? hash['cursor'] : SKIP
+      timeframe_end = if hash.key?('timeframe_end')
+                        (DateTimeHelper.from_rfc3339(hash['timeframe_end']) if hash['timeframe_end'])
+                      else
+                        SKIP
+                      end
+
+      # Create object from extracted values.
+      EventVolumeParams.new(timeframe_start: timeframe_start,
+                            limit: limit,
+                            cursor: cursor,
+                            timeframe_end: timeframe_end)
+    end
+
+    def to_custom_timeframe_start
+      DateTimeHelper.to_rfc3339(timeframe_start)
+    end
+
+    def to_custom_timeframe_end
+      DateTimeHelper.to_rfc3339(timeframe_end)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} limit: #{@limit}, cursor: #{@cursor}, timeframe_start: #{@timeframe_start},"\
+      " timeframe_end: #{@timeframe_end}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} limit: #{@limit.inspect}, cursor: #{@cursor.inspect}, timeframe_start:"\
+      " #{@timeframe_start.inspect}, timeframe_end: #{@timeframe_end.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/event_volumes.rb

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

data/lib/api_reference/models/events.rb

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