Class: HighLevel::Resources::Emails

Inherits:
Base
  • Object
show all
Defined in:
lib/high_level/resources/emails.rb

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

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

Instance Method Details

#create_template(body:, **_opts) ⇒ Object

Create a new template



32
33
34
35
36
37
38
39
 
# File 'lib/high_level/resources/emails.rb', line 32

def create_template(body:, **_opts)
  request(
    method: :post,
    path: "/emails/builder",
    security: ["Location-Access"],
    body: body
  )
end

#delete_template(location_id:, template_id:, **_opts) ⇒ Object

Delete a template



42
43
44
45
46
47
48
 
# File 'lib/high_level/resources/emails.rb', line 42

def delete_template(location_id:, template_id:, **_opts)
  request(
    method: :delete,
    path: "/emails/builder/#{location_id}/#{template_id}",
    security: ["Location-Access"]
  )
end

#fetch_campaigns(location_id: nil, limit: nil, offset: nil, status: nil, email_status: nil, name: nil, parent_id: nil, limited_fields: nil, archived: nil, campaigns_only: nil, show_stats: nil, **_opts) ⇒ Object

Get Campaigns



10
11
12
13
14
15
16
17
 
# File 'lib/high_level/resources/emails.rb', line 10

def fetch_campaigns(location_id: nil, limit: nil, offset: nil, status: nil, email_status: nil, name: nil, parent_id: nil, limited_fields: nil, archived: nil, campaigns_only: nil, show_stats: nil, **_opts)
  request(
    method: :get,
    path: "/emails/schedule",
    security: ["Location-Access"],
    params: { "locationId" => location_id, "limit" => limit, "offset" => offset, "status" => status, "emailStatus" => email_status, "name" => name, "parentId" => parent_id, "limitedFields" => limited_fields, "archived" => archived, "campaignsOnly" => campaigns_only, "showStats" => show_stats }.compact
  )
end

#fetch_template(location_id: nil, limit: nil, offset: nil, search: nil, sort_by_date: nil, archived: nil, builder_version: nil, name: nil, parent_id: nil, origin_id: nil, templates_only: nil, **_opts) ⇒ Object

Fetch email templates

Fetch email templates by location id



22
23
24
25
26
27
28
29
 
# File 'lib/high_level/resources/emails.rb', line 22

def fetch_template(location_id: nil, limit: nil, offset: nil, search: nil, sort_by_date: nil, archived: nil, builder_version: nil, name: nil, parent_id: nil, origin_id: nil, templates_only: nil, **_opts)
  request(
    method: :get,
    path: "/emails/builder",
    security: ["Location-Access"],
    params: { "locationId" => location_id, "limit" => limit, "offset" => offset, "search" => search, "sortByDate" => sort_by_date, "archived" => archived, "builderVersion" => builder_version, "name" => name, "parentId" => parent_id, "originId" => origin_id, "templatesOnly" => templates_only }.compact
  )
end

#update_template(body:, **_opts) ⇒ Object

Update a template



51
52
53
54
55
56
57
58
 
# File 'lib/high_level/resources/emails.rb', line 51

def update_template(body:, **_opts)
  request(
    method: :post,
    path: "/emails/builder/data",
    security: ["Location-Access"],
    body: body
  )
end