appnigma-sdk 0.1.0

data/lib/appnigma/generated/models/crm_deal.rb

@@ -0,0 +1,479 @@
+=begin
+#Appnigma SDK API
+
+#The routes a customer's product calls through an Appnigma SDK. Every answer carries a request id in X-Request-Id; quote it when you write to support.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Appnigma::Generated
+  class CrmDeal < ApiModelBase
+    # The record's id in the CRM
+    attr_accessor :id
+
+    attr_accessor :platform
+
+    # ISO 8601, in UTC
+    attr_accessor :created_at
+
+    # ISO 8601, in UTC
+    attr_accessor :updated_at
+
+    # The CRM's custom properties, by their internal name
+    attr_accessor :custom_fields
+
+    # The record exactly as the CRM sent it
+    attr_accessor :raw
+
+    attr_accessor :name
+
+    attr_accessor :amount
+
+    # ISO 4217, such as USD
+    attr_accessor :currency
+
+    attr_accessor :status
+
+    attr_accessor :stage
+
+    attr_accessor :pipeline
+
+    attr_accessor :probability
+
+    # YYYY-MM-DD
+    attr_accessor :close_date
+
+    # ISO 8601, in UTC
+    attr_accessor :closed_at
+
+    attr_accessor :company_id
+
+    attr_accessor :owner_id
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'platform' => :'platform',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt',
+        :'custom_fields' => :'customFields',
+        :'raw' => :'raw',
+        :'name' => :'name',
+        :'amount' => :'amount',
+        :'currency' => :'currency',
+        :'status' => :'status',
+        :'stage' => :'stage',
+        :'pipeline' => :'pipeline',
+        :'probability' => :'probability',
+        :'close_date' => :'closeDate',
+        :'closed_at' => :'closedAt',
+        :'company_id' => :'companyId',
+        :'owner_id' => :'ownerId'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'platform' => :'String',
+        :'created_at' => :'String',
+        :'updated_at' => :'String',
+        :'custom_fields' => :'Hash<String, CrmCustomField>',
+        :'raw' => :'Object',
+        :'name' => :'String',
+        :'amount' => :'Float',
+        :'currency' => :'String',
+        :'status' => :'String',
+        :'stage' => :'CrmLabelled',
+        :'pipeline' => :'CrmLabelled',
+        :'probability' => :'Float',
+        :'close_date' => :'String',
+        :'closed_at' => :'String',
+        :'company_id' => :'String',
+        :'owner_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'created_at',
+        :'updated_at',
+        :'name',
+        :'amount',
+        :'currency',
+        :'status',
+        :'stage',
+        :'pipeline',
+        :'probability',
+        :'close_date',
+        :'closed_at',
+        :'company_id',
+        :'owner_id'
+      ])
+    end
+
+    # Returns attribute type mapping
+    def self.acceptable_openapi_types
+      openapi_types
+    end
+
+    # Returns the nullable attributes
+    def self.acceptable_openapi_nullable
+      openapi_nullable
+    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 `Appnigma::Generated::CrmDeal` 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 `Appnigma::Generated::CrmDeal`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'platform')
+        self.platform = attributes[:'platform']
+      else
+        self.platform = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
+      end
+
+      if attributes.key?(:'custom_fields')
+        if (value = attributes[:'custom_fields']).is_a?(Hash)
+          self.custom_fields = value
+        end
+      else
+        self.custom_fields = nil
+      end
+
+      if attributes.key?(:'raw')
+        self.raw = attributes[:'raw']
+      else
+        self.raw = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      else
+        self.amount = nil
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'stage')
+        self.stage = attributes[:'stage']
+      else
+        self.stage = nil
+      end
+
+      if attributes.key?(:'pipeline')
+        self.pipeline = attributes[:'pipeline']
+      else
+        self.pipeline = nil
+      end
+
+      if attributes.key?(:'probability')
+        self.probability = attributes[:'probability']
+      else
+        self.probability = nil
+      end
+
+      if attributes.key?(:'close_date')
+        self.close_date = attributes[:'close_date']
+      else
+        self.close_date = nil
+      end
+
+      if attributes.key?(:'closed_at')
+        self.closed_at = attributes[:'closed_at']
+      else
+        self.closed_at = nil
+      end
+
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      else
+        self.company_id = nil
+      end
+
+      if attributes.key?(:'owner_id')
+        self.owner_id = attributes[:'owner_id']
+      else
+        self.owner_id = nil
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @platform.nil?
+        invalid_properties.push('invalid value for "platform", platform cannot be nil.')
+      end
+
+      if @custom_fields.nil?
+        invalid_properties.push('invalid value for "custom_fields", custom_fields cannot be nil.')
+      end
+
+      if @raw.nil?
+        invalid_properties.push('invalid value for "raw", raw cannot be nil.')
+      end
+
+      if @probability > 100
+        invalid_properties.push('invalid value for "probability", must be smaller than or equal to 100.')
+      end
+
+      if @probability < 0
+        invalid_properties.push('invalid value for "probability", must be greater than or equal to 0.')
+      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 @id.nil?
+      return false if @platform.nil?
+      return false if @custom_fields.nil?
+      return false if @raw.nil?
+      status_validator = EnumAttributeValidator.new('String', ["open", "won", "lost"])
+      return false unless status_validator.valid?(@status)
+      return false if @probability > 100
+      return false if @probability < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] platform Value to be assigned
+    def platform=(platform)
+      if platform.nil?
+        fail ArgumentError, 'platform cannot be nil'
+      end
+
+      @platform = platform
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] custom_fields Value to be assigned
+    def custom_fields=(custom_fields)
+      if custom_fields.nil?
+        fail ArgumentError, 'custom_fields cannot be nil'
+      end
+
+      @custom_fields = custom_fields
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] raw Value to be assigned
+    def raw=(raw)
+      if raw.nil?
+        fail ArgumentError, 'raw cannot be nil'
+      end
+
+      @raw = raw
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["open", "won", "lost"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] probability Value to be assigned
+    def probability=(probability)
+      if !probability.nil? && probability > 100
+        fail ArgumentError, 'invalid value for "probability", must be smaller than or equal to 100.'
+      end
+
+      if !probability.nil? && probability < 0
+        fail ArgumentError, 'invalid value for "probability", must be greater than or equal to 0.'
+      end
+
+      @probability = probability
+    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 &&
+          id == o.id &&
+          platform == o.platform &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          custom_fields == o.custom_fields &&
+          raw == o.raw &&
+          name == o.name &&
+          amount == o.amount &&
+          currency == o.currency &&
+          status == o.status &&
+          stage == o.stage &&
+          pipeline == o.pipeline &&
+          probability == o.probability &&
+          close_date == o.close_date &&
+          closed_at == o.closed_at &&
+          company_id == o.company_id &&
+          owner_id == o.owner_id
+    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
+      [id, platform, created_at, updated_at, custom_fields, raw, name, amount, currency, status, stage, pipeline, probability, close_date, closed_at, company_id, owner_id].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)
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      map = acceptable_attribute_map
+      transformed_hash = {}
+      acceptable_openapi_types.each_pair do |key, type|
+        if attributes.key?(map[key]) && attributes[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[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[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 = {}
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      self.class.acceptable_attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.acceptable_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/appnigma/generated/models/crm_deal_get_output.rb

@@ -0,0 +1,177 @@
+=begin
+#Appnigma SDK API
+
+#The routes a customer's product calls through an Appnigma SDK. Every answer carries a request id in X-Request-Id; quote it when you write to support.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Appnigma::Generated
+  class CrmDealGetOutput < ApiModelBase
+    attr_accessor :record
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'record' => :'record'
+      }
+    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
+      {
+        :'record' => :'CrmDeal'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Returns attribute type mapping
+    def self.acceptable_openapi_types
+      openapi_types
+    end
+
+    # Returns the nullable attributes
+    def self.acceptable_openapi_nullable
+      openapi_nullable
+    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 `Appnigma::Generated::CrmDealGetOutput` 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 `Appnigma::Generated::CrmDealGetOutput`. 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?(:'record')
+        self.record = attributes[:'record']
+      else
+        self.record = nil
+      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 @record.nil?
+        invalid_properties.push('invalid value for "record", record cannot be nil.')
+      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 @record.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] record Value to be assigned
+    def record=(record)
+      if record.nil?
+        fail ArgumentError, 'record cannot be nil'
+      end
+
+      @record = record
+    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 &&
+          record == o.record
+    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
+      [record].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)
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      map = acceptable_attribute_map
+      transformed_hash = {}
+      acceptable_openapi_types.each_pair do |key, type|
+        if attributes.key?(map[key]) && attributes[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[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[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 = {}
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      self.class.acceptable_attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.acceptable_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