Class: Structurely::Clients::ConversationWebhooks

Inherits:

ApiStruct::Client

• Object
• ApiStruct::Client
• Structurely::Clients::ConversationWebhooks

Defined in:

lib/structurely/clients/conversation_webhooks.rb

Instance Method Summary

• #create(post_data) ⇒ Object

  Calls POST /conversationWebhooks.

• #destroy(id) ⇒ Object

  Calls DELETE /conversationWebhooks/:id.

• #index ⇒ Object

  Calls GET /conversationWebooks.

• #show(id) ⇒ Object

  Calls GET /conversationWebhooks/:id.

• #update(id, post_data) ⇒ Object

  Calls PATCH /conversationWebhooks/:id.

Instance Method Details

#create(post_data) ⇒ Object

Calls POST /conversationWebhooks

Examples:

Structurely::Clients::ConversationWebhooks.new.create({ foo: "bar" })

See Also:

• https://docs.structurely.com/#conversation-webhooks-create-conversation-webhook

# File 'lib/structurely/clients/conversation_webhooks.rb', line 29

def create(post_data)
  post(json: post_data, path: "conversationWebhooks")
end

#destroy(id) ⇒ Object

Calls DELETE /conversationWebhooks/:id

Examples:

Structurely::Clients::ConversationWebhooks.new.delete("abcde")

See Also:

• https://docs.structurely.com/#conversation-webhooks-delete-conversation-webhook

# File 'lib/structurely/clients/conversation_webhooks.rb', line 47

def destroy(id)
  delete(id, path: "conversationWebhooks")
end

#index ⇒ Object

Calls GET /conversationWebooks

Examples:

Structurely::Clients::ConversationWebhooks.new.index

See Also:

• https://docs.structurely.com/#conversation-webhooks-list-conversation-webhooks

# File 'lib/structurely/clients/conversation_webhooks.rb', line 11

def index
  get(path: "conversationWebhooks")
end

#show(id) ⇒ Object

Calls GET /conversationWebhooks/:id

Examples:

Structurely::Clients::ConversationWebhooks.new.show('test-conversation-webhook-id')

See Also:

• https://docs.structurely.com/#conversation-webhooks-get-conversation-webhook

# File 'lib/structurely/clients/conversation_webhooks.rb', line 20

def show(id)
  get(id, path: "conversationWebhooks")
end

#update(id, post_data) ⇒ Object

Calls PATCH /conversationWebhooks/:id

Examples:

Structurely::Clients::ConversationWebhooks.new.update("abcde", { foo: "bar" })

See Also:

• https://docs.structurely.com/#conversation-webhooks-update-conversation-webhook

# File 'lib/structurely/clients/conversation_webhooks.rb', line 38

def update(id, post_data)
  patch(id, json: post_data, path: "conversationWebhooks")
end