Class: Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/webhook_delivery_retrieve_response.rb

Defined Under Namespace

Modules: Status Classes: HTTP

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(body: nil, headers: nil, status: nil) ⇒ Object

Response details, optional.

Parameters:

  • body (String) (defaults to: nil) —

    Raw response body, limited to 10kB.

  • headers (Array<Array<String>>) (defaults to: nil) —

    List of headers, limited to 10kB.

  • status (Integer) (defaults to: nil) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/telnyx/models/webhook_delivery_retrieve_response.rb', line 90

class Attempt < Telnyx::Internal::Type::BaseModel
  # @!attribute errors
  #   Webhook delivery error codes.
  #
  #   @return [Array<Integer>, nil]
  optional :errors, Telnyx::Internal::Type::ArrayOf[Integer]

  # @!attribute finished_at
  #   ISO 8601 timestamp indicating when the attempt has finished.
  #
  #   @return [Time, nil]
  optional :finished_at, Time

  # @!attribute http
  #   HTTP request and response information.
  #
  #   @return [Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::HTTP, nil]
  optional :http, -> { Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::HTTP }

  # @!attribute started_at
  #   ISO 8601 timestamp indicating when the attempt was initiated.
  #
  #   @return [Time, nil]
  optional :started_at, Time

  # @!attribute status
  #
  #   @return [Symbol, Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::Status, nil]
  optional :status, enum: -> { Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::Status }

  # @!method initialize(errors: nil, finished_at: nil, http: nil, started_at: nil, status: nil)
  #   Webhook delivery attempt details.
  #
  #   @param errors [Array<Integer>] Webhook delivery error codes.
  #
  #   @param finished_at [Time] ISO 8601 timestamp indicating when the attempt has finished.
  #
  #   @param http [Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::HTTP] HTTP request and response information.
  #
  #   @param started_at [Time] ISO 8601 timestamp indicating when the attempt was initiated.
  #
  #   @param status [Symbol, Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::Status]

  # @see Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt#http
  class HTTP < Telnyx::Internal::Type::BaseModel
    # @!attribute request
    #   Request details.
    #
    #   @return [Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::HTTP::Request, nil]
    optional :request, -> { Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::HTTP::Request }

    # @!attribute response
    #   Response details, optional.
    #
    #   @return [Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::HTTP::Response, nil]
    optional :response, -> { Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::HTTP::Response }

    # @!method initialize(request: nil, response: nil)
    #   HTTP request and response information.
    #
    #   @param request [Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::HTTP::Request] Request details.
    #
    #   @param response [Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::HTTP::Response] Response details, optional.

    # @see Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::HTTP#request
    class Request < Telnyx::Internal::Type::BaseModel
      # @!attribute headers
      #   List of headers, limited to 10kB.
      #
      #   @return [Array<Array<String>>, nil]
      optional :headers, Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::ArrayOf[String]]

      # @!attribute url
      #
      #   @return [String, nil]
      optional :url, String

      # @!method initialize(headers: nil, url: nil)
      #   Request details.
      #
      #   @param headers [Array<Array<String>>] List of headers, limited to 10kB.
      #
      #   @param url [String]
    end

    # @see Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::HTTP#response
    class Response < Telnyx::Internal::Type::BaseModel
      # @!attribute body
      #   Raw response body, limited to 10kB.
      #
      #   @return [String, nil]
      optional :body, String

      # @!attribute headers
      #   List of headers, limited to 10kB.
      #
      #   @return [Array<Array<String>>, nil]
      optional :headers, Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::ArrayOf[String]]

      # @!attribute status
      #
      #   @return [Integer, nil]
      optional :status, Integer

      # @!method initialize(body: nil, headers: nil, status: nil)
      #   Response details, optional.
      #
      #   @param body [String] Raw response body, limited to 10kB.
      #
      #   @param headers [Array<Array<String>>] List of headers, limited to 10kB.
      #
      #   @param status [Integer]
    end
  end

  # @see Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt#status
  module Status
    extend Telnyx::Internal::Type::Enum

    DELIVERED = :delivered
    FAILED = :failed

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#errors ⇒ Array<Integer>?

Webhook delivery error codes.

Returns:

  • (Array<Integer>, nil) 


95
 
# File 'lib/telnyx/models/webhook_delivery_retrieve_response.rb', line 95

optional :errors, Telnyx::Internal::Type::ArrayOf[Integer]

#finished_at ⇒ Time?

ISO 8601 timestamp indicating when the attempt has finished.

Returns:

  • (Time, nil) 


101
 
# File 'lib/telnyx/models/webhook_delivery_retrieve_response.rb', line 101

optional :finished_at, Time

#http ⇒ Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::HTTP?

HTTP request and response information.

Returns:



107
 
# File 'lib/telnyx/models/webhook_delivery_retrieve_response.rb', line 107

optional :http, -> { Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::HTTP }

#started_at ⇒ Time?

ISO 8601 timestamp indicating when the attempt was initiated.

Returns:

  • (Time, nil) 


113
 
# File 'lib/telnyx/models/webhook_delivery_retrieve_response.rb', line 113

optional :started_at, Time

#status ⇒ Symbol, ...

Returns:



118
 
# File 'lib/telnyx/models/webhook_delivery_retrieve_response.rb', line 118

optional :status, enum: -> { Telnyx::Models::WebhookDeliveryRetrieveResponse::Data::Attempt::Status }