Class: Devdraft::UpdateWebhookDto

Inherits:
ApiModelBase show all
Defined in:
lib/devdraft/models/update_webhook_dto.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ UpdateWebhookDto

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 73

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Devdraft::UpdateWebhookDto` 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 `Devdraft::UpdateWebhookDto`. 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?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.key?(:'is_active')
    self.is_active = attributes[:'is_active']
  else
    self.is_active = true
  end

  if attributes.key?(:'signing_secret')
    self.signing_secret = attributes[:'signing_secret']
  end

  if attributes.key?(:'encrypted')
    self.encrypted = attributes[:'encrypted']
  else
    self.encrypted = false
  end
end

Instance Attribute Details

#encrypted ⇒ Object

Whether webhook payloads should be encrypted



31
32
33
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 31

def encrypted
  @encrypted
end

#is_active ⇒ Object

Whether the webhook is active and will receive events



25
26
27
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 25

def is_active
  @is_active
end

#name ⇒ Object

Name of the webhook for identification purposes



19
20
21
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 19

def name
  @name
end

#signing_secret ⇒ Object

Secret key used to sign webhook payloads for verification



28
29
30
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 28

def signing_secret
  @signing_secret
end

#url ⇒ Object

URL where webhook events will be sent



22
23
24
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 22

def url
  @url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



45
46
47
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 45

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 50

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



34
35
36
37
38
39
40
41
42
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 34

def self.attribute_map
  {
    :'name' => :'name',
    :'url' => :'url',
    :'is_active' => :'isActive',
    :'signing_secret' => :'signing_secret',
    :'encrypted' => :'encrypted'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 182

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



66
67
68
69
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 66

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 55

def self.openapi_types
  {
    :'name' => :'String',
    :'url' => :'String',
    :'is_active' => :'Boolean',
    :'signing_secret' => :'String',
    :'encrypted' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



157
158
159
160
161
162
163
164
165
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 157

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      url == o.url &&
      is_active == o.is_active &&
      signing_secret == o.signing_secret &&
      encrypted == o.encrypted
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


169
170
171
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 169

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



175
176
177
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 175

def hash
  [name, url, is_active, signing_secret, encrypted].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 114

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  end

  if !@name.nil? && @name.to_s.length < 3
    invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 3.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 204

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



130
131
132
133
134
135
 
# File 'lib/devdraft/models/update_webhook_dto.rb', line 130

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@name.nil? && @name.to_s.length > 100
  return false if !@name.nil? && @name.to_s.length < 3
  true
end