Class: PlatformAPI::AppWebhookDelivery

Inherits:

Object

• Object
• PlatformAPI::AppWebhookDelivery

Defined in:

lib/platform-api/client.rb

Overview

Represents the delivery of a webhook notification, including its current status.

Instance Method Summary

• #info(app_id_or_app_name, app_webhook_delivery_id) ⇒ Object

  Returns the info for an existing delivery.

• #initialize(client) ⇒ AppWebhookDelivery constructor

  A new instance of AppWebhookDelivery.

• #list(app_id_or_app_name) ⇒ Object

  Lists existing deliveries for an app.

Constructor Details

#initialize(client) ⇒ AppWebhookDelivery

Returns a new instance of AppWebhookDelivery.

# File 'lib/platform-api/client.rb', line 1328

def initialize(client)
  @client = client
end

Instance Method Details

#info(app_id_or_app_name, app_webhook_delivery_id) ⇒ Object

Returns the info for an existing delivery.

Parameters:

• app_id_or_app_name: —

  unique identifier of app or unique name of app

• app_webhook_delivery_id: —

  the delivery's unique identifier

# File 'lib/platform-api/client.rb', line 1336

def info(app_id_or_app_name, app_webhook_delivery_id)
  @client.app_webhook_delivery.info(app_id_or_app_name, app_webhook_delivery_id)
end

#list(app_id_or_app_name) ⇒ Object

Lists existing deliveries for an app.

Parameters:

• app_id_or_app_name: —

  unique identifier of app or unique name of app

# File 'lib/platform-api/client.rb', line 1343

def list(app_id_or_app_name)
  @client.app_webhook_delivery.list(app_id_or_app_name)
end