Class: TeamBattlesSdk::Generated::Models::WebhookEndpoint

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/teambattles_sdk/generated/models/webhook_endpoint.rb

Overview

A webhook endpoint (no secret material).

Defined Under Namespace

Classes: WebhookEndpointLabel, WebhookEndpointLastDeliveredAt, WebhookEndpointLastFailedAt

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a webhook_endpoint

Raises:

  • (StandardError) 


71
72
73
74
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 71

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return WebhookEndpoint.new
end

Instance Method Details

#created_at ⇒ Object

Gets the createdAt property value. Creation epoch ms.

Returns:

  • a double



55
56
57
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 55

def created_at
    return @created_at
end

#created_at=(value) ⇒ Object

Sets the createdAt property value. Creation epoch ms.

Parameters:

  • value —

    Value to set for the createdAt property.

Returns:

  • a void



63
64
65
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 63

def created_at=(value)
    @created_at = value
end

#events ⇒ Object

Gets the events property value. Subscribed event tokens.

Returns:

  • a string



79
80
81
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 79

def events
    return @events
end

#events=(value) ⇒ Object

Sets the events property value. Subscribed event tokens.

Parameters:

  • value —

    Value to set for the events property.

Returns:

  • a void



87
88
89
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 87

def events=(value)
    @events = value
end

#failure_count ⇒ Object

Gets the failureCount property value. Consecutive dead-lettered deliveries (auto-disables at 50).

Returns:

  • a integer



94
95
96
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 94

def failure_count
    return @failure_count
end

#failure_count=(value) ⇒ Object

Sets the failureCount property value. Consecutive dead-lettered deliveries (auto-disables at 50).

Parameters:

  • value —

    Value to set for the failureCount property.

Returns:

  • a void



102
103
104
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 102

def failure_count=(value)
    @failure_count = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 109

def get_field_deserializers()
    return {
        "createdAt" => lambda {|n| @created_at = n.get_object_value(lambda {|pn| Double.create_from_discriminator_value(pn) }) },
        "events" => lambda {|n| @events = n.get_collection_of_primitive_values(String) },
        "failureCount" => lambda {|n| @failure_count = n.get_number_value() },
        "id" => lambda {|n| @id = n.get_string_value() },
        "isActive" => lambda {|n| @is_active = n.get_boolean_value() },
        "label" => lambda {|n| @label = n.get_object_value(lambda {|pn| WebhookEndpoint::WebhookEndpointLabel.create_from_discriminator_value(pn) }) },
        "lastDeliveredAt" => lambda {|n| @last_delivered_at = n.get_object_value(lambda {|pn| WebhookEndpoint::WebhookEndpointLastDeliveredAt.create_from_discriminator_value(pn) }) },
        "lastFailedAt" => lambda {|n| @last_failed_at = n.get_object_value(lambda {|pn| WebhookEndpoint::WebhookEndpointLastFailedAt.create_from_discriminator_value(pn) }) },
        "scopeId" => lambda {|n| @scope_id = n.get_string_value() },
        "scopeType" => lambda {|n| @scope_type = n.get_enum_value(TeamBattlesSdk::Generated::Models::WebhookEndpointScopeType) },
        "secretPrefix" => lambda {|n| @secret_prefix = n.get_string_value() },
        "updatedAt" => lambda {|n| @updated_at = n.get_object_value(lambda {|pn| Double.create_from_discriminator_value(pn) }) },
        "url" => lambda {|n| @url = n.get_string_value() },
    }
end

#id ⇒ Object

Gets the id property value. Webhook endpoint id.

Returns:

  • a string



130
131
132
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 130

def id
    return @id
end

#id=(value) ⇒ Object

Sets the id property value. Webhook endpoint id.

Parameters:

  • value —

    Value to set for the id property.

Returns:

  • a void



138
139
140
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 138

def id=(value)
    @id = value
end

#is_active ⇒ Object

Gets the isActive property value. Whether the endpoint receives deliveries.

Returns:

  • a boolean



145
146
147
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 145

def is_active
    return @is_active
end

#is_active=(value) ⇒ Object

Sets the isActive property value. Whether the endpoint receives deliveries.

Parameters:

  • value —

    Value to set for the isActive property.

Returns:

  • a void



153
154
155
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 153

def is_active=(value)
    @is_active = value
end

#label ⇒ Object

Gets the label property value. Human label, or null.

Returns:

  • a webhook_endpoint_label



160
161
162
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 160

def label
    return @label
end

#label=(value) ⇒ Object

Sets the label property value. Human label, or null.

Parameters:

  • value —

    Value to set for the label property.

Returns:

  • a void



168
169
170
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 168

def label=(value)
    @label = value
end

#last_delivered_at ⇒ Object

Gets the lastDeliveredAt property value. Epoch ms of the last successful delivery, or null.

Returns:

  • a webhook_endpoint_last_delivered_at



175
176
177
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 175

def last_delivered_at
    return @last_delivered_at
end

#last_delivered_at=(value) ⇒ Object

Sets the lastDeliveredAt property value. Epoch ms of the last successful delivery, or null.

Parameters:

  • value —

    Value to set for the lastDeliveredAt property.

Returns:

  • a void



183
184
185
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 183

def last_delivered_at=(value)
    @last_delivered_at = value
end

#last_failed_at ⇒ Object

Gets the lastFailedAt property value. Epoch ms of the last failed delivery, or null.

Returns:

  • a webhook_endpoint_last_failed_at



190
191
192
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 190

def last_failed_at
    return @last_failed_at
end

#last_failed_at=(value) ⇒ Object

Sets the lastFailedAt property value. Epoch ms of the last failed delivery, or null.

Parameters:

  • value —

    Value to set for the lastFailedAt property.

Returns:

  • a void



198
199
200
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 198

def last_failed_at=(value)
    @last_failed_at = value
end

#scope_id ⇒ Object

Gets the scopeId property value. Stringified bound scope id.

Returns:

  • a string



205
206
207
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 205

def scope_id
    return @scope_id
end

#scope_id=(value) ⇒ Object

Sets the scopeId property value. Stringified bound scope id.

Parameters:

  • value —

    Value to set for the scopeId property.

Returns:

  • a void



213
214
215
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 213

def scope_id=(value)
    @scope_id = value
end

#scope_type ⇒ Object

Gets the scopeType property value. The single scope dimension an endpoint is bound to.

Returns:

  • a webhook_endpoint_scope_type



220
221
222
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 220

def scope_type
    return @scope_type
end

#scope_type=(value) ⇒ Object

Sets the scopeType property value. The single scope dimension an endpoint is bound to.

Parameters:

  • value —

    Value to set for the scopeType property.

Returns:

  • a void



228
229
230
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 228

def scope_type=(value)
    @scope_type = value
end

#secret_prefix ⇒ Object

Gets the secretPrefix property value. First 8 chars of the current signing secret (display only).

Returns:

  • a string



235
236
237
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 235

def secret_prefix
    return @secret_prefix
end

#secret_prefix=(value) ⇒ Object

Sets the secretPrefix property value. First 8 chars of the current signing secret (display only).

Parameters:

  • value —

    Value to set for the secretPrefix property.

Returns:

  • a void



243
244
245
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 243

def secret_prefix=(value)
    @secret_prefix = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 251

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_object_value("createdAt", @created_at)
    writer.write_collection_of_primitive_values("events", @events)
    writer.write_number_value("failureCount", @failure_count)
    writer.write_string_value("id", @id)
    writer.write_boolean_value("isActive", @is_active)
    writer.write_object_value("label", @label)
    writer.write_object_value("lastDeliveredAt", @last_delivered_at)
    writer.write_object_value("lastFailedAt", @last_failed_at)
    writer.write_string_value("scopeId", @scope_id)
    writer.write_enum_value("scopeType", @scope_type)
    writer.write_string_value("secretPrefix", @secret_prefix)
    writer.write_object_value("updatedAt", @updated_at)
    writer.write_string_value("url", @url)
end

#updated_at ⇒ Object

Gets the updatedAt property value. Last update epoch ms.

Returns:

  • a double



271
272
273
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 271

def updated_at
    return @updated_at
end

#updated_at=(value) ⇒ Object

Sets the updatedAt property value. Last update epoch ms.

Parameters:

  • value —

    Value to set for the updatedAt property.

Returns:

  • a void



279
280
281
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 279

def updated_at=(value)
    @updated_at = value
end

#url ⇒ Object

Gets the url property value. Delivery URL.

Returns:

  • a string



286
287
288
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 286

def url
    return @url
end

#url=(value) ⇒ Object

Sets the url property value. Delivery URL.

Parameters:

  • value —

    Value to set for the url property.

Returns:

  • a void



294
295
296
 
# File 'lib/teambattles_sdk/generated/models/webhook_endpoint.rb', line 294

def url=(value)
    @url = value
end