Class: Invoicetronic_Sdk::WebHook

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

Overview

A webhook subscription.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/invoicetronic_sdk/models/web_hook.rb', line 109

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

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

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

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

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

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

  if attributes.key?(:'events')
    if (value = attributes[:'events']).is_a?(Array)
      self.events = value
    end
  end

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

Instance Attribute Details

#company_id ⇒ Object

Optional company id. If set, the webhook is restricted to events for that company; if omitted, it fires for all companies on the account.



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

def company_id
  @company_id
end

#created ⇒ Object

Creation date. It is set automatically.



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

def created
  @created
end

#description ⇒ Object

An optional description.



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

def description
  @description
end

#enabled ⇒ Object

Whether the webhook is enabled. On creation, this is set to ‘true`.



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

def enabled
  @enabled
end

#events ⇒ Object

List of events that trigger the webhook. See Invoicetronic.SupportedEvents.Available for a list of valid event names.



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

def events
  @events
end

#failure_notified_at ⇒ Object

Timestamp of the last failure notification email sent for this webhook. Set by the notifier service; reset to null on successful delivery.



50
51
52
 
# File 'lib/invoicetronic_sdk/models/web_hook.rb', line 50

def failure_notified_at
  @failure_notified_at
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.rb', line 20

def id
  @id
end

#secret ⇒ Object

The secret used to generate webhook signatures, only returned on creation. You should store this value securely and validate it on every call, to ensure that the caller is InvoicetronicApi.



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

def secret
  @secret
end

#url ⇒ Object

The url of your application’s endpoint that will receive a POST request when the webhook is fired.



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

def url
  @url
end

#user_id ⇒ Object

User id. It is set automatically based on the authenticated user.



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

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.rb', line 26

def version
  @version
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/invoicetronic_sdk/models/web_hook.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/invoicetronic_sdk/models/web_hook.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/invoicetronic_sdk/models/web_hook.rb', line 53

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'version' => :'version',
    :'user_id' => :'user_id',
    :'company_id' => :'company_id',
    :'url' => :'url',
    :'enabled' => :'enabled',
    :'secret' => :'secret',
    :'description' => :'description',
    :'events' => :'events',
    :'failure_notified_at' => :'failure_notified_at'
  }
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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/invoicetronic_sdk/models/web_hook.rb', line 244

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



97
98
99
100
101
102
103
104
105
 
# File 'lib/invoicetronic_sdk/models/web_hook.rb', line 97

def self.openapi_nullable
  Set.new([
    :'company_id',
    :'secret',
    :'description',
    :'events',
    :'failure_notified_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/invoicetronic_sdk/models/web_hook.rb', line 80

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'Time',
    :'version' => :'Integer',
    :'user_id' => :'Integer',
    :'company_id' => :'Integer',
    :'url' => :'String',
    :'enabled' => :'Boolean',
    :'secret' => :'String',
    :'description' => :'String',
    :'events' => :'Array<String>',
    :'failure_notified_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/invoicetronic_sdk/models/web_hook.rb', line 213

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      version == o.version &&
      user_id == o.user_id &&
      company_id == o.company_id &&
      url == o.url &&
      enabled == o.enabled &&
      secret == o.secret &&
      description == o.description &&
      events == o.events &&
      failure_notified_at == o.failure_notified_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


231
232
233
 
# File 'lib/invoicetronic_sdk/models/web_hook.rb', line 231

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



237
238
239
 
# File 'lib/invoicetronic_sdk/models/web_hook.rb', line 237

def hash
  [id, created, version, user_id, company_id, url, enabled, secret, description, events, failure_notified_at].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @url.nil?
    invalid_properties.push('invalid value for "url", url cannot be nil.')
  end

  if @url.to_s.length < 1
    invalid_properties.push('invalid value for "url", the character length must be greater than or equal to 1.')
  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



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/invoicetronic_sdk/models/web_hook.rb', line 266

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



190
191
192
193
194
195
 
# File 'lib/invoicetronic_sdk/models/web_hook.rb', line 190

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @url.nil?
  return false if @url.to_s.length < 1
  true
end