Class: TeamBattlesSdk::Generated::Models::WebhookDelivery

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

Overview

A single webhook delivery-log row.

Defined Under Namespace

Classes: WebhookDeliveryDeliveredAt, WebhookDeliveryErrorMessage, WebhookDeliveryNextAttemptAt, WebhookDeliveryStatusCode

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_delivery

Raises:

  • (StandardError)


83
84
85
86
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 83

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

Instance Method Details

#attempt_countObject

Gets the attemptCount property value. Number of delivery attempts made.

Returns:

  • a integer



52
53
54
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 52

def attempt_count
    return @attempt_count
end

#attempt_count=(value) ⇒ Object

Sets the attemptCount property value. Number of delivery attempts made.

Parameters:

  • value

    Value to set for the attemptCount property.

Returns:

  • a void



60
61
62
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 60

def attempt_count=(value)
    @attempt_count = value
end

#created_atObject

Gets the createdAt property value. Emit/creation epoch ms (retention key).

Returns:

  • a double



67
68
69
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 67

def created_at
    return @created_at
end

#created_at=(value) ⇒ Object

Sets the createdAt property value. Emit/creation epoch ms (retention key).

Parameters:

  • value

    Value to set for the createdAt property.

Returns:

  • a void



75
76
77
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 75

def created_at=(value)
    @created_at = value
end

#delivered_atObject

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

Returns:

  • a webhook_delivery_delivered_at



91
92
93
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 91

def delivered_at
    return @delivered_at
end

#delivered_at=(value) ⇒ Object

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

Parameters:

  • value

    Value to set for the deliveredAt property.

Returns:

  • a void



99
100
101
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 99

def delivered_at=(value)
    @delivered_at = value
end

#error_messageObject

Gets the errorMessage property value. Last error message, or null.

Returns:

  • a webhook_delivery_error_message



106
107
108
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 106

def error_message
    return @error_message
end

#error_message=(value) ⇒ Object

Sets the errorMessage property value. Last error message, or null.

Parameters:

  • value

    Value to set for the errorMessage property.

Returns:

  • a void



114
115
116
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 114

def error_message=(value)
    @error_message = value
end

#eventObject

Gets the event property value. The delivered event name.

Returns:

  • a string



121
122
123
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 121

def event
    return @event
end

#event=(value) ⇒ Object

Sets the event property value. The delivered event name.

Parameters:

  • value

    Value to set for the event property.

Returns:

  • a void



129
130
131
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 129

def event=(value)
    @event = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 136

def get_field_deserializers()
    return {
        "attemptCount" => lambda {|n| @attempt_count = n.get_number_value() },
        "createdAt" => lambda {|n| @created_at = n.get_object_value(lambda {|pn| Double.create_from_discriminator_value(pn) }) },
        "deliveredAt" => lambda {|n| @delivered_at = n.get_object_value(lambda {|pn| WebhookDelivery::WebhookDeliveryDeliveredAt.create_from_discriminator_value(pn) }) },
        "errorMessage" => lambda {|n| @error_message = n.get_object_value(lambda {|pn| WebhookDelivery::WebhookDeliveryErrorMessage.create_from_discriminator_value(pn) }) },
        "event" => lambda {|n| @event = n.get_string_value() },
        "id" => lambda {|n| @id = n.get_string_value() },
        "idempotencyId" => lambda {|n| @idempotency_id = n.get_string_value() },
        "isTest" => lambda {|n| @is_test = n.get_boolean_value() },
        "nextAttemptAt" => lambda {|n| @next_attempt_at = n.get_object_value(lambda {|pn| WebhookDelivery::WebhookDeliveryNextAttemptAt.create_from_discriminator_value(pn) }) },
        "status" => lambda {|n| @status = n.get_enum_value(TeamBattlesSdk::Generated::Models::WebhookDeliveryStatus) },
        "statusCode" => lambda {|n| @status_code = n.get_object_value(lambda {|pn| WebhookDelivery::WebhookDeliveryStatusCode.create_from_discriminator_value(pn) }) },
        "updatedAt" => lambda {|n| @updated_at = n.get_object_value(lambda {|pn| Double.create_from_discriminator_value(pn) }) },
    }
end

#idObject

Gets the id property value. Delivery-log row id.

Returns:

  • a string



156
157
158
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 156

def id
    return @id
end

#id=(value) ⇒ Object

Sets the id property value. Delivery-log row id.

Parameters:

  • value

    Value to set for the id property.

Returns:

  • a void



164
165
166
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 164

def id=(value)
    @id = value
end

#idempotency_idObject

Gets the idempotencyId property value. Stable evt_ id, reused across retries (idempotency key).

Returns:

  • a string



171
172
173
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 171

def idempotency_id
    return @idempotency_id
end

#idempotency_id=(value) ⇒ Object

Sets the idempotencyId property value. Stable evt_ id, reused across retries (idempotency key).

Parameters:

  • value

    Value to set for the idempotencyId property.

Returns:

  • a void



179
180
181
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 179

def idempotency_id=(value)
    @idempotency_id = value
end

#is_testObject

Gets the isTest property value. True for test.ping deliveries.

Returns:

  • a boolean



186
187
188
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 186

def is_test
    return @is_test
end

#is_test=(value) ⇒ Object

Sets the isTest property value. True for test.ping deliveries.

Parameters:

  • value

    Value to set for the isTest property.

Returns:

  • a void



194
195
196
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 194

def is_test=(value)
    @is_test = value
end

#next_attempt_atObject

Gets the nextAttemptAt property value. Epoch ms of the next scheduled retry, or null.

Returns:

  • a webhook_delivery_next_attempt_at



201
202
203
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 201

def next_attempt_at
    return @next_attempt_at
end

#next_attempt_at=(value) ⇒ Object

Sets the nextAttemptAt property value. Epoch ms of the next scheduled retry, or null.

Parameters:

  • value

    Value to set for the nextAttemptAt property.

Returns:

  • a void



209
210
211
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 209

def next_attempt_at=(value)
    @next_attempt_at = 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)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 217

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_number_value("attemptCount", @attempt_count)
    writer.write_object_value("createdAt", @created_at)
    writer.write_object_value("deliveredAt", @delivered_at)
    writer.write_object_value("errorMessage", @error_message)
    writer.write_string_value("event", @event)
    writer.write_string_value("id", @id)
    writer.write_string_value("idempotencyId", @idempotency_id)
    writer.write_boolean_value("isTest", @is_test)
    writer.write_object_value("nextAttemptAt", @next_attempt_at)
    writer.write_enum_value("status", @status)
    writer.write_object_value("statusCode", @status_code)
    writer.write_object_value("updatedAt", @updated_at)
end

#statusObject

Gets the status property value. Lifecycle status of one logical delivery (endpoint x idempotency id).

Returns:

  • a webhook_delivery_status



236
237
238
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 236

def status
    return @status
end

#status=(value) ⇒ Object

Sets the status property value. Lifecycle status of one logical delivery (endpoint x idempotency id).

Parameters:

  • value

    Value to set for the status property.

Returns:

  • a void



244
245
246
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 244

def status=(value)
    @status = value
end

#status_codeObject

Gets the statusCode property value. Last HTTP response status, or null.

Returns:

  • a webhook_delivery_status_code



251
252
253
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 251

def status_code
    return @status_code
end

#status_code=(value) ⇒ Object

Sets the statusCode property value. Last HTTP response status, or null.

Parameters:

  • value

    Value to set for the statusCode property.

Returns:

  • a void



259
260
261
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 259

def status_code=(value)
    @status_code = value
end

#updated_atObject

Gets the updatedAt property value. Last update epoch ms.

Returns:

  • a double



266
267
268
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 266

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



274
275
276
# File 'lib/teambattles_sdk/generated/models/webhook_delivery.rb', line 274

def updated_at=(value)
    @updated_at = value
end