Class: HighLevel::Resources::Users

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

Create User



72
73
74
75
76
77
78
79
 
# File 'lib/high_level/resources/users.rb', line 72

def create_user(body:, **_opts)
  request(
    method: :post,
    path: "/users/",
    security: %w[Agency-Access Location-Access],
    body: body
  )
end

#delete_user(**_opts) ⇒ Object

Delete User



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

def delete_user(**_opts)
  request(
    method: :delete,
    path: "/users/#{user_id}",
    security: %w[Agency-Access Location-Access]
  )
end

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

Filter Users by Email

Filter users by company ID, deleted status, and email array



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

def filter_users_by_email(body:, **_opts)
  request(
    method: :post,
    path: "/users/search/filter-by-email",
    security: ["Agency-Access"],
    body: body
  )
end

#get_user(user_id:, **_opts) ⇒ Object

Get User



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

def get_user(user_id:, **_opts)
  request(
    method: :get,
    path: "/users/#{user_id}",
    security: %w[Agency-Access Location-Access]
  )
end

#get_user_by_location(location_id: nil, **_opts) ⇒ Object

Get User by Location

Deprecated. Use ‘GET /users/search` instead. Pass `locationId` as a query parameter to filter results by location, along with the required `companyId` and other search filters as needed.



62
63
64
65
66
67
68
69
 
# File 'lib/high_level/resources/users.rb', line 62

def get_user_by_location(location_id: nil, **_opts)
  request(
    method: :get,
    path: "/users/",
    security: ["Location-Access"],
    params: { "locationId" => location_id }.compact
  )
end

#search_users(company_id: nil, query: nil, skip: nil, limit: nil, location_id: nil, type: nil, role: nil, ids: nil, sort: nil, sort_direction: nil, enabled2way_sync: nil, **_opts) ⇒ Object

Search Users



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

def search_users(company_id: nil, query: nil, skip: nil, limit: nil, location_id: nil, type: nil, role: nil, ids: nil, sort: nil, sort_direction: nil, enabled2way_sync: nil, **_opts)
  request(
    method: :get,
    path: "/users/search",
    security: %w[Agency-Access Location-Access],
    params: { "companyId" => company_id, "query" => query, "skip" => skip, "limit" => limit, "locationId" => location_id, "type" => type, "role" => role, "ids" => ids, "sort" => sort, "sortDirection" => sort_direction, "enabled2waySync" => enabled2way_sync }.compact
  )
end

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

Update User



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

def update_user(body:, **_opts)
  request(
    method: :put,
    path: "/users/#{user_id}",
    security: %w[Agency-Access Location-Access],
    body: body
  )
end