Class: Comet::WebhookOption

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/webhook_option.rb

Overview

WebhookOption is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ WebhookOption

Returns a new instance of WebhookOption.



29
30
31
 
# File 'lib/comet/models/webhook_option.rb', line 29

def initialize
  clear
end

Instance Attribute Details

#custom_headers ⇒ Object

Returns the value of attribute custom_headers.



24
25
26
 
# File 'lib/comet/models/webhook_option.rb', line 24

def custom_headers
  @custom_headers
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



27
28
29
 
# File 'lib/comet/models/webhook_option.rb', line 27

def unknown_json_fields
  @unknown_json_fields
end

#url ⇒ Object

Returns the value of attribute url.



18
19
20
 
# File 'lib/comet/models/webhook_option.rb', line 18

def url
  @url
end

#white_listed_event_types ⇒ Object

Returns the value of attribute white_listed_event_types.



21
22
23
 
# File 'lib/comet/models/webhook_option.rb', line 21

def white_listed_event_types
  @white_listed_event_types
end

Instance Method Details

#clear ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/comet/models/webhook_option.rb', line 33

def clear
  @url = ''
  @white_listed_event_types = []
  @custom_headers = {}
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/comet/models/webhook_option.rb', line 48

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'URL'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @url = v
    when 'WhiteListedEventTypes'
      if v.nil?
        @white_listed_event_types = []
      else
        @white_listed_event_types = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric

          @white_listed_event_types[i1] = v1
        end
      end
    when 'CustomHeaders'
      @custom_headers = {}
      if v.nil?
        @custom_headers = {}
      else
        v.each do |k1, v1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @custom_headers[k1] = v1
        end
      end
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


41
42
43
44
45
 
# File 'lib/comet/models/webhook_option.rb', line 41

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



98
99
100
 
# File 'lib/comet/models/webhook_option.rb', line 98

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/comet/models/webhook_option.rb', line 86

def to_hash
  ret = {}
  ret['URL'] = @url
  ret['WhiteListedEventTypes'] = @white_listed_event_types
  ret['CustomHeaders'] = @custom_headers
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



103
104
105
 
# File 'lib/comet/models/webhook_option.rb', line 103

def to_json(options = {})
  to_hash.to_json(options)
end