Class: Invoicetronic_Sdk::WebHookHistory

Inherits:
ApiModelBase show all
Defined in:
lib/invoicetronic_sdk/models/web_hook_history.rb

Overview

Webhook history.

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 = {}) ⇒ WebHookHistory

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 101

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created ⇒ Object

Creation date. It is set automatically.



23
24
25
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 23

def created
  @created
end

#date_time ⇒ Object

Date and time of the request.



44
45
46
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 44

def date_time
  @date_time
end

#error ⇒ Object

Error description, if any. Null when the delivery is successful (2xx). Contains the exception message for network errors (status code 0) or the response body for non-2xx HTTP responses.



41
42
43
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 41

def error
  @error
end

#event ⇒ Object

Event name.



35
36
37
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 35

def event
  @event
end

#id ⇒ Object

Unique identifier. For POST requests, leave it at ‘0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update.



20
21
22
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 20

def id
  @id
end

#status_code ⇒ Object

HTTP status code returned by the webhook endpoint. A value of 0 means the request could not be completed due to a network error (e.g., DNS resolution failure, connection refused, or timeout). This typically indicates that the endpoint URL is misconfigured or no longer exists.



38
39
40
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 38

def status_code
  @status_code
end

#success ⇒ Object

Whether the request was successful.



47
48
49
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 47

def success
  @success
end

#user_id ⇒ Object

User id.



32
33
34
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 32

def user_id
  @user_id
end

#version ⇒ Object

Row version, for optimistic concurrency. It is set automatically.



26
27
28
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 26

def version
  @version
end

#web_hook_id ⇒ Object

Webhook id.



29
30
31
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 29

def web_hook_id
  @web_hook_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 50

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'version' => :'version',
    :'web_hook_id' => :'web_hook_id',
    :'user_id' => :'user_id',
    :'event' => :'event',
    :'status_code' => :'status_code',
    :'error' => :'error',
    :'date_time' => :'date_time',
    :'success' => :'success'
  }
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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 203

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



92
93
94
95
96
97
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 92

def self.openapi_nullable
  Set.new([
    :'event',
    :'error',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 76

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'Time',
    :'version' => :'Integer',
    :'web_hook_id' => :'Integer',
    :'user_id' => :'Integer',
    :'event' => :'String',
    :'status_code' => :'Integer',
    :'error' => :'String',
    :'date_time' => :'Time',
    :'success' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      version == o.version &&
      web_hook_id == o.web_hook_id &&
      user_id == o.user_id &&
      event == o.event &&
      status_code == o.status_code &&
      error == o.error &&
      date_time == o.date_time &&
      success == o.success
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


190
191
192
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 190

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



196
197
198
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 196

def hash
  [id, created, version, web_hook_id, user_id, event, status_code, error, date_time, success].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



158
159
160
161
162
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 158

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 225

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



166
167
168
169
 
# File 'lib/invoicetronic_sdk/models/web_hook_history.rb', line 166

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end