class Pipedrive::InlineObject33
Attributes
Type of action to receive notifications about. Wildcard will match all supported actions.
Type of object to receive notifications about. Wildcard will match all supported objects.
HTTP basic auth password of the subscription URL endpoint (if required).
HTTP basic auth username of the subscription URL endpoint (if required).
A full, valid, publicly accessible URL. Determines where to send the notifications. Please note that you cannot use Pipedrive
API endpoints as the subscription_url.
The ID of the user this webhook will be authorized with. If not set, current authorized user will be used. Note
that this does not filter only certain user's events — rather, this specifies the user's permissions under which each event is checked. Events about objects the selected user is not entitled to access are not sent. If you want to receive notifications for all events, a top-level admin user should be used.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 58 def self.attribute_map { :'subscription_url' => :'subscription_url', :'event_action' => :'event_action', :'event_object' => :'event_object', :'user_id' => :'user_id', :'http_auth_user' => :'http_auth_user', :'http_auth_password' => :'http_auth_password' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 207 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 89 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Pipedrive::InlineObject33` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Pipedrive::InlineObject33`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'subscription_url') self.subscription_url = attributes[:'subscription_url'] end if attributes.key?(:'event_action') self.event_action = attributes[:'event_action'] end if attributes.key?(:'event_object') self.event_object = attributes[:'event_object'] end if attributes.key?(:'user_id') self.user_id = attributes[:'user_id'] end if attributes.key?(:'http_auth_user') self.http_auth_user = attributes[:'http_auth_user'] end if attributes.key?(:'http_auth_password') self.http_auth_password = attributes[:'http_auth_password'] end end
List of attributes with nullable: true
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 82 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 70 def self.openapi_types { :'subscription_url' => :'String', :'event_action' => :'String', :'event_object' => :'String', :'user_id' => :'Integer', :'http_auth_user' => :'String', :'http_auth_password' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 181 def ==(o) return true if self.equal?(o) self.class == o.class && subscription_url == o.subscription_url && event_action == o.event_action && event_object == o.event_object && user_id == o.user_id && http_auth_user == o.http_auth_user && http_auth_password == o.http_auth_password end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 235 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model Pipedrive.const_get(type).build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 304 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 214 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if 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[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 194 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] event_action
Object to be assigned
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 161 def event_action=(event_action) validator = EnumAttributeValidator.new('String', ["added", "updated", "merged", "deleted", "*"]) unless validator.valid?(event_action) fail ArgumentError, "invalid value for \"event_action\", must be one of #{validator.allowable_values}." end @event_action = event_action end
Custom attribute writer method checking allowed values (enum). @param [Object] event_object
Object to be assigned
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 171 def event_object=(event_object) validator = EnumAttributeValidator.new('String', ["activity", "activityType", "deal", "note", "organization", "person", "pipeline", "product", "stage", "user", "*"]) unless validator.valid?(event_object) fail ArgumentError, "invalid value for \"event_object\", must be one of #{validator.allowable_values}." end @event_object = event_object end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 200 def hash [subscription_url, event_action, event_object, user_id, http_auth_user, http_auth_password].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 129 def list_invalid_properties invalid_properties = Array.new if @subscription_url.nil? invalid_properties.push('invalid value for "subscription_url", subscription_url cannot be nil.') end if @event_action.nil? invalid_properties.push('invalid value for "event_action", event_action cannot be nil.') end if @event_object.nil? invalid_properties.push('invalid value for "event_object", event_object cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 286 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 274 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/pipedrive-openapi-client/models/inline_object33.rb, line 148 def valid? return false if @subscription_url.nil? return false if @event_action.nil? event_action_validator = EnumAttributeValidator.new('String', ["added", "updated", "merged", "deleted", "*"]) return false unless event_action_validator.valid?(@event_action) return false if @event_object.nil? event_object_validator = EnumAttributeValidator.new('String', ["activity", "activityType", "deal", "note", "organization", "person", "pipeline", "product", "stage", "user", "*"]) return false unless event_object_validator.valid?(@event_object) true end