Class: HighLevel::Resources::BrandBoards

Inherits:
Base
  • Object
show all
Defined in:
lib/high_level/resources/brand_boards.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_brand_board(body:, **_opts) ⇒ Object

Create a new brand board

Creates a new brand board with logos, colors, and fonts



58
59
60
61
62
63
64
65
 
# File 'lib/high_level/resources/brand_boards.rb', line 58

def create_brand_board(body:, **_opts)
  request(
    method: :post,
    path: "/brand-boards/",
    security: ["Location-Access"],
    body: body
  )
end

#delete_brand_board(location_id:, id:, **_opts) ⇒ Object

Delete a Brand Board

Deletes a Brand Board



47
48
49
50
51
52
53
 
# File 'lib/high_level/resources/brand_boards.rb', line 47

def delete_brand_board(location_id:, id:, **_opts)
  request(
    method: :delete,
    path: "/brand-boards/#{location_id}/#{id}",
    security: ["Location-Access"]
  )
end

#get_brand_board_by_id(location_id:, id:, **_opts) ⇒ Object

Get Brand Board

Retrieves a specific Brand Board by its ID



24
25
26
27
28
29
30
 
# File 'lib/high_level/resources/brand_boards.rb', line 24

def get_brand_board_by_id(location_id:, id:, **_opts)
  request(
    method: :get,
    path: "/brand-boards/#{location_id}/#{id}",
    security: ["Location-Access"]
  )
end

#get_brand_boards_by_location(location_id:, limit: nil, offset: nil, search: nil, deleted: nil, **_opts) ⇒ Object

Get Brand Boards

Retrieves all Brand Boards for a specific location



12
13
14
15
16
17
18
19
 
# File 'lib/high_level/resources/brand_boards.rb', line 12

def get_brand_boards_by_location(location_id:, limit: nil, offset: nil, search: nil, deleted: nil, **_opts)
  request(
    method: :get,
    path: "/brand-boards/#{location_id}",
    security: ["Location-Access"],
    params: { "limit" => limit, "offset" => offset, "search" => search, "deleted" => deleted }.compact
  )
end

#update_brand_board(location_id:, id:, body:, **_opts) ⇒ Object

Update a Brand Board

Updates an existing Brand Board



35
36
37
38
39
40
41
42
 
# File 'lib/high_level/resources/brand_boards.rb', line 35

def update_brand_board(location_id:, id:, body:, **_opts)
  request(
    method: :patch,
    path: "/brand-boards/#{location_id}/#{id}",
    security: ["Location-Access"],
    body: body
  )
end