Class: LetMeSendEmail::Resources::ContactCategories

Inherits:
Base
  • Object
show all
Defined in:
lib/letmesendemail/resources/contact_categories.rb

Overview

Contact Categories API operations.

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from LetMeSendEmail::Resources::Base

Instance Method Details

#create(name:, slug: nil) ⇒ Models::Model

Creates a contact category.

Returns:



9
10
11
12
13
 
# File 'lib/letmesendemail/resources/contact_categories.rb', line 9

def create(name:, slug: nil)
  body = { name: name }
  body[:slug] = slug if slug
  @client.request(:post, '/contact-categories', body: body)
end

#delete(id) ⇒ Models::Model

Deletes a contact category.

Parameters:

  • id (String)

Returns:



40
41
42
 
# File 'lib/letmesendemail/resources/contact_categories.rb', line 40

def delete(id)
  @client.request(:delete, path_for('contact-categories', id))
end

#get(id) ⇒ Models::Model

Retrieves a contact category.

Parameters:

  • id (String)

Returns:



24
25
26
 
# File 'lib/letmesendemail/resources/contact_categories.rb', line 24

def get(id)
  @client.request(:get, path_for('contact-categories', id))
end

#list(per_page: nil, after: nil, before: nil) ⇒ Models::Model

Lists one cursor page of contact categories.

Returns:



17
18
19
 
# File 'lib/letmesendemail/resources/contact_categories.rb', line 17

def list(per_page: nil, after: nil, before: nil)
  @client.request(:get, list_path('contact-categories', per_page: per_page, after: after, before: before))
end

#update(id, name:, slug: nil) ⇒ Models::Model

Updates a contact category.

Parameters:

  • id (String)

Returns:



31
32
33
34
35
 
# File 'lib/letmesendemail/resources/contact_categories.rb', line 31

def update(id, name:, slug: nil)
  body = { name: name }
  body[:slug] = slug if slug
  @client.request(:put, path_for('contact-categories', id), body: body)
end