agent_push_kit 0.1.0

data/lib/agent_push_kit/models/search_events_input.rb

@@ -0,0 +1,212 @@
+=begin
+#Agent Push Kit API
+
+#The complete Agent Push Kit REST API. Application event ingestion uses an organization key beginning with `apk_`. Authenticated user operations accept either an Agent Push Kit login JWT or an agent access token beginning with `apt_`.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module AgentPushKit
+  class SearchEventsInput < ApiModelBase
+    attr_accessor :filter
+
+    attr_accessor :cursor
+
+    attr_accessor :limit
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'filter' => :'filter',
+        :'cursor' => :'cursor',
+        :'limit' => :'limit'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'filter' => :'EventFilter',
+        :'cursor' => :'String',
+        :'limit' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AgentPushKit::SearchEventsInput` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AgentPushKit::SearchEventsInput`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'filter')
+        self.filter = attributes[:'filter']
+      else
+        self.filter = nil
+      end
+
+      if attributes.key?(:'cursor')
+        self.cursor = attributes[:'cursor']
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      else
+        self.limit = 50
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @filter.nil?
+        invalid_properties.push('invalid value for "filter", filter cannot be nil.')
+      end
+
+      if !@limit.nil? && @limit > 100
+        invalid_properties.push('invalid value for "limit", must be smaller than or equal to 100.')
+      end
+
+      if !@limit.nil? && @limit < 1
+        invalid_properties.push('invalid value for "limit", must be greater than or equal to 1.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @filter.nil?
+      return false if !@limit.nil? && @limit > 100
+      return false if !@limit.nil? && @limit < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] filter Value to be assigned
+    def filter=(filter)
+      if filter.nil?
+        fail ArgumentError, 'filter cannot be nil'
+      end
+
+      @filter = filter
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] limit Value to be assigned
+    def limit=(limit)
+      if limit.nil?
+        fail ArgumentError, 'limit cannot be nil'
+      end
+
+      if limit > 100
+        fail ArgumentError, 'invalid value for "limit", must be smaller than or equal to 100.'
+      end
+
+      if limit < 1
+        fail ArgumentError, 'invalid value for "limit", must be greater than or equal to 1.'
+      end
+
+      @limit = limit
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          filter == o.filter &&
+          cursor == o.cursor &&
+          limit == o.limit
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [filter, cursor, limit].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/agent_push_kit/models/send_event_input.rb

@@ -0,0 +1,427 @@
+=begin
+#Agent Push Kit API
+
+#The complete Agent Push Kit REST API. Application event ingestion uses an organization key beginning with `apk_`. Authenticated user operations accept either an Agent Push Kit login JWT or an agent access token beginning with `apt_`.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module AgentPushKit
+  class SendEventInput < ApiModelBase
+    attr_accessor :service
+
+    attr_accessor :service_display_name
+
+    attr_accessor :type
+
+    attr_accessor :title
+
+    attr_accessor :body
+
+    attr_accessor :metadata
+
+    attr_accessor :external_id
+
+    attr_accessor :action_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'service' => :'service',
+        :'service_display_name' => :'serviceDisplayName',
+        :'type' => :'type',
+        :'title' => :'title',
+        :'body' => :'body',
+        :'metadata' => :'metadata',
+        :'external_id' => :'externalId',
+        :'action_url' => :'actionUrl'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'service' => :'String',
+        :'service_display_name' => :'String',
+        :'type' => :'String',
+        :'title' => :'String',
+        :'body' => :'String',
+        :'metadata' => :'Hash<String, Object>',
+        :'external_id' => :'String',
+        :'action_url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AgentPushKit::SendEventInput` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AgentPushKit::SendEventInput`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'service')
+        self.service = attributes[:'service']
+      else
+        self.service = nil
+      end
+
+      if attributes.key?(:'service_display_name')
+        self.service_display_name = attributes[:'service_display_name']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+
+      if attributes.key?(:'body')
+        self.body = attributes[:'body']
+      else
+        self.body = nil
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      end
+
+      if attributes.key?(:'action_url')
+        self.action_url = attributes[:'action_url']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @service.nil?
+        invalid_properties.push('invalid value for "service", service cannot be nil.')
+      end
+
+      if @service.to_s.length > 120
+        invalid_properties.push('invalid value for "service", the character length must be smaller than or equal to 120.')
+      end
+
+      if @service.to_s.length < 1
+        invalid_properties.push('invalid value for "service", the character length must be greater than or equal to 1.')
+      end
+
+      if !@service_display_name.nil? && @service_display_name.to_s.length > 120
+        invalid_properties.push('invalid value for "service_display_name", the character length must be smaller than or equal to 120.')
+      end
+
+      if !@service_display_name.nil? && @service_display_name.to_s.length < 1
+        invalid_properties.push('invalid value for "service_display_name", the character length must be greater than or equal to 1.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @type.to_s.length > 120
+        invalid_properties.push('invalid value for "type", the character length must be smaller than or equal to 120.')
+      end
+
+      if @type.to_s.length < 1
+        invalid_properties.push('invalid value for "type", the character length must be greater than or equal to 1.')
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @title.to_s.length > 200
+        invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 200.')
+      end
+
+      if @title.to_s.length < 1
+        invalid_properties.push('invalid value for "title", the character length must be greater than or equal to 1.')
+      end
+
+      if @body.nil?
+        invalid_properties.push('invalid value for "body", body cannot be nil.')
+      end
+
+      if @body.to_s.length > 10000
+        invalid_properties.push('invalid value for "body", the character length must be smaller than or equal to 10000.')
+      end
+
+      if @body.to_s.length < 1
+        invalid_properties.push('invalid value for "body", the character length must be greater than or equal to 1.')
+      end
+
+      if !@external_id.nil? && @external_id.to_s.length > 300
+        invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 300.')
+      end
+
+      if !@external_id.nil? && @external_id.to_s.length < 1
+        invalid_properties.push('invalid value for "external_id", the character length must be greater than or equal to 1.')
+      end
+
+      if !@action_url.nil? && @action_url.to_s.length > 2000
+        invalid_properties.push('invalid value for "action_url", the character length must be smaller than or equal to 2000.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @service.nil?
+      return false if @service.to_s.length > 120
+      return false if @service.to_s.length < 1
+      return false if !@service_display_name.nil? && @service_display_name.to_s.length > 120
+      return false if !@service_display_name.nil? && @service_display_name.to_s.length < 1
+      return false if @type.nil?
+      return false if @type.to_s.length > 120
+      return false if @type.to_s.length < 1
+      return false if @title.nil?
+      return false if @title.to_s.length > 200
+      return false if @title.to_s.length < 1
+      return false if @body.nil?
+      return false if @body.to_s.length > 10000
+      return false if @body.to_s.length < 1
+      return false if !@external_id.nil? && @external_id.to_s.length > 300
+      return false if !@external_id.nil? && @external_id.to_s.length < 1
+      return false if !@action_url.nil? && @action_url.to_s.length > 2000
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] service Value to be assigned
+    def service=(service)
+      if service.nil?
+        fail ArgumentError, 'service cannot be nil'
+      end
+
+      if service.to_s.length > 120
+        fail ArgumentError, 'invalid value for "service", the character length must be smaller than or equal to 120.'
+      end
+
+      if service.to_s.length < 1
+        fail ArgumentError, 'invalid value for "service", the character length must be greater than or equal to 1.'
+      end
+
+      @service = service
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] service_display_name Value to be assigned
+    def service_display_name=(service_display_name)
+      if service_display_name.nil?
+        fail ArgumentError, 'service_display_name cannot be nil'
+      end
+
+      if service_display_name.to_s.length > 120
+        fail ArgumentError, 'invalid value for "service_display_name", the character length must be smaller than or equal to 120.'
+      end
+
+      if service_display_name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "service_display_name", the character length must be greater than or equal to 1.'
+      end
+
+      @service_display_name = service_display_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type Value to be assigned
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'type cannot be nil'
+      end
+
+      if type.to_s.length > 120
+        fail ArgumentError, 'invalid value for "type", the character length must be smaller than or equal to 120.'
+      end
+
+      if type.to_s.length < 1
+        fail ArgumentError, 'invalid value for "type", the character length must be greater than or equal to 1.'
+      end
+
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      if title.to_s.length > 200
+        fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 200.'
+      end
+
+      if title.to_s.length < 1
+        fail ArgumentError, 'invalid value for "title", the character length must be greater than or equal to 1.'
+      end
+
+      @title = title
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] body Value to be assigned
+    def body=(body)
+      if body.nil?
+        fail ArgumentError, 'body cannot be nil'
+      end
+
+      if body.to_s.length > 10000
+        fail ArgumentError, 'invalid value for "body", the character length must be smaller than or equal to 10000.'
+      end
+
+      if body.to_s.length < 1
+        fail ArgumentError, 'invalid value for "body", the character length must be greater than or equal to 1.'
+      end
+
+      @body = body
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] external_id Value to be assigned
+    def external_id=(external_id)
+      if external_id.nil?
+        fail ArgumentError, 'external_id cannot be nil'
+      end
+
+      if external_id.to_s.length > 300
+        fail ArgumentError, 'invalid value for "external_id", the character length must be smaller than or equal to 300.'
+      end
+
+      if external_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "external_id", the character length must be greater than or equal to 1.'
+      end
+
+      @external_id = external_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] action_url Value to be assigned
+    def action_url=(action_url)
+      if action_url.nil?
+        fail ArgumentError, 'action_url cannot be nil'
+      end
+
+      if action_url.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "action_url", the character length must be smaller than or equal to 2000.'
+      end
+
+      @action_url = action_url
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          service == o.service &&
+          service_display_name == o.service_display_name &&
+          type == o.type &&
+          title == o.title &&
+          body == o.body &&
+          metadata == o.metadata &&
+          external_id == o.external_id &&
+          action_url == o.action_url
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [service, service_display_name, type, title, body, metadata, external_id, action_url].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end