Class: Telnyx::Resources::WebhookDeliveries

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/webhook_deliveries.rb

Overview

Webhooks operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ WebhookDeliveries

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of WebhookDeliveries.

Parameters:



62
63
64
 
# File 'lib/telnyx/resources/webhook_deliveries.rb', line 62

def initialize(client:)
  @client = client
end

Instance Method Details

#list(filter: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::WebhookDeliveryListResponse>

Some parameter documentations has been truncated, see Models::WebhookDeliveryListParams for more details.

Lists webhook_deliveries for the authenticated user

Parameters:

Returns:

See Also:



46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/telnyx/resources/webhook_deliveries.rb', line 46

def list(params = {})
  parsed, options = Telnyx::WebhookDeliveryListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "webhook_deliveries",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Models::WebhookDeliveryListResponse,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ Telnyx::Models::WebhookDeliveryRetrieveResponse

Provides webhook_delivery debug data, such as timestamps, delivery status and attempts.

Parameters:

  • id (String) —

    Uniquely identifies the webhook_delivery.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



19
20
21
22
23
24
25
26
 
# File 'lib/telnyx/resources/webhook_deliveries.rb', line 19

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["webhook_deliveries/%1$s", id],
    model: Telnyx::Models::WebhookDeliveryRetrieveResponse,
    options: params[:request_options]
  )
end