Class: Svix::EndpointIn

Inherits:
Object
  • Object
show all
Defined in:
lib/svix/models/endpoint_in.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EndpointIn

Returns a new instance of EndpointIn.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/svix/models/endpoint_in.rb', line 46

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    fail(ArgumentError, "The input argument (attributes) must be a hash in `Svix::EndpointIn` new method")
  end

  attributes.each do |k, v|
    unless ALL_FIELD.include?(k.to_s)
      fail(ArgumentError, "The field #{k} is not part of Svix::EndpointIn")
    end

    instance_variable_set("@#{k}", v)
    instance_variable_set("@__#{k}_is_defined", true)
  end
end

Instance Attribute Details

#channels ⇒ Object

List of message channels this endpoint listens to (omit for all).



8
9
10
 
# File 'lib/svix/models/endpoint_in.rb', line 8

def channels
  @channels
end

#description ⇒ Object

Returns the value of attribute description.



9
10
11
 
# File 'lib/svix/models/endpoint_in.rb', line 9

def description
  @description
end

#disabled ⇒ Object

Returns the value of attribute disabled.



10
11
12
 
# File 'lib/svix/models/endpoint_in.rb', line 10

def disabled
  @disabled
end

#filter_types ⇒ Object

Returns the value of attribute filter_types.



11
12
13
 
# File 'lib/svix/models/endpoint_in.rb', line 11

def filter_types
  @filter_types
end

#headers ⇒ Object

Returns the value of attribute headers.



12
13
14
 
# File 'lib/svix/models/endpoint_in.rb', line 12

def headers
  @headers
end

#metadata ⇒ Object

Returns the value of attribute metadata.



13
14
15
 
# File 'lib/svix/models/endpoint_in.rb', line 13

def metadata
  @metadata
end

#rate_limit ⇒ Object

Deprecated, use ‘throttleRate` instead.



15
16
17
 
# File 'lib/svix/models/endpoint_in.rb', line 15

def rate_limit
  @rate_limit
end

#secret ⇒ Object

The endpoint’s verification secret.

Format: ‘base64` encoded random bytes optionally prefixed with `whsec_`. It is recommended to not set this and let the server generate the secret.



20
21
22
 
# File 'lib/svix/models/endpoint_in.rb', line 20

def secret
  @secret
end

#throttle_rate ⇒ Object

Maximum messages per second to send to this endpoint.

Outgoing messages will be throttled to this rate.



24
25
26
 
# File 'lib/svix/models/endpoint_in.rb', line 24

def throttle_rate
  @throttle_rate
end

#uid ⇒ Object

Optional unique identifier for the endpoint.



26
27
28
 
# File 'lib/svix/models/endpoint_in.rb', line 26

def uid
  @uid
end

#url ⇒ Object

Returns the value of attribute url.



27
28
29
 
# File 'lib/svix/models/endpoint_in.rb', line 27

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



28
29
30
 
# File 'lib/svix/models/endpoint_in.rb', line 28

def version
  @version
end

Class Method Details

.deserialize(attributes = {}) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/svix/models/endpoint_in.rb', line 61

def self.deserialize(attributes = {})
  attributes = attributes.transform_keys(&:to_s)
  attrs = Hash.new
  attrs["channels"] = attributes["channels"]
  attrs["description"] = attributes["description"]
  attrs["disabled"] = attributes["disabled"]
  attrs["filter_types"] = attributes["filterTypes"]
  attrs["headers"] = attributes["headers"]
  attrs["metadata"] = attributes["metadata"]
  attrs["rate_limit"] = attributes["rateLimit"]
  attrs["secret"] = attributes["secret"]
  attrs["throttle_rate"] = attributes["throttleRate"]
  attrs["uid"] = attributes["uid"]
  attrs["url"] = attributes["url"]
  attrs["version"] = attributes["version"]
  new(attrs)
end

Instance Method Details

#serialize ⇒ Object 



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

def serialize
  out = Hash.new
  out["channels"] = Svix::serialize_primitive(@channels) if @channels
  out["description"] = Svix::serialize_primitive(@description) if @description
  out["disabled"] = Svix::serialize_primitive(@disabled) if @disabled
  out["filterTypes"] = Svix::serialize_primitive(@filter_types) if @filter_types
  out["headers"] = Svix::serialize_primitive(@headers) if @headers
  out["metadata"] = Svix::serialize_primitive(@metadata) if @metadata
  out["rateLimit"] = Svix::serialize_primitive(@rate_limit) if @rate_limit
  out["secret"] = Svix::serialize_primitive(@secret) if @secret
  out["throttleRate"] = Svix::serialize_primitive(@throttle_rate) if @throttle_rate
  out["uid"] = Svix::serialize_primitive(@uid) if @uid
  out["url"] = Svix::serialize_primitive(@url) if @url
  out["version"] = Svix::serialize_primitive(@version) if @version
  out
end

#to_json ⇒ Object

Serializes the object to a json string

Returns:

  • String



98
99
100
 
# File 'lib/svix/models/endpoint_in.rb', line 98

def to_json
  JSON.dump(serialize)
end