Class: TalkboxApi::EmailSenderDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/talkbox_api/email_sender_details.rb

Overview

EmailSenderDetails resource class This class provides methods for interacting with the Talkbox API email sender details resource.

Instance Method Summary collapse

Constructor Details

#initialize(conn) ⇒ EmailSenderDetails

Returns a new instance of EmailSenderDetails.



7
8
9
 
# File 'lib/talkbox_api/email_sender_details.rb', line 7

def initialize(conn)
  @conn = conn
end

Instance Method Details

#all ⇒ Array

Retrieves all email sender details

Returns:

  • (Array) —

    The list of email sender details



13
14
15
 
# File 'lib/talkbox_api/email_sender_details.rb', line 13

def all
  @conn.get("#{PATH_PREFIX}/email_sender_details").body
end

#create(params) ⇒ Hash

Creates a new email sender detail

Parameters:

  • params (Hash) —

    The parameters for the new email sender detail

Returns:

  • (Hash) —

    The created email sender detail



20
21
22
 
# File 'lib/talkbox_api/email_sender_details.rb', line 20

def create(params)
  @conn.post("#{PATH_PREFIX}/email_sender_details", params.to_json, { "Content-Type" => "application/json" }).body
end

#delete(id) ⇒ Hash

Deletes an email sender detail

Parameters:

  • id (String) —

    The ID of the email sender detail to delete

Returns:

  • (Hash) —

    The deleted email sender detail



36
37
38
 
# File 'lib/talkbox_api/email_sender_details.rb', line 36

def delete(id)
  @conn.delete("#{PATH_PREFIX}/email_sender_details/#{id}").body
end

#update(id, params) ⇒ Hash

Updates an existing email sender detail

Parameters:

  • id (String) —

    The ID of the email sender detail to update

  • params (Hash) —

    The parameters for the updated email sender detail

Returns:

  • (Hash) —

    The updated email sender detail



28
29
30
31
 
# File 'lib/talkbox_api/email_sender_details.rb', line 28

def update(id, params)
  @conn.put("#{PATH_PREFIX}/email_sender_details/#{id}", params.to_json, { "Content-Type" => "application/json" })
       .body
end