Class: Smartsheet::Groups

Inherits:
Object
  • Object
show all
Defined in:
lib/smartsheet/endpoints/groups/groups.rb

Overview

Groups Endpoints

See Also:

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Groups

Returns a new instance of Groups.



8
9
10
 
# File 'lib/smartsheet/endpoints/groups/groups.rb', line 8

def initialize(client)
  @client = client
end

Instance Method Details

#add_members(group_id:, body:, params: {}, header_overrides: {}) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/smartsheet/endpoints/groups/groups.rb', line 62

def add_members(group_id:, body:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['groups', :group_id, 'members'], body_type: :json)
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      body: body,
      group_id: group_id
  )
  client.make_request(endpoint_spec, request_spec)
end

#create(body:, params: {}, header_overrides: {}) ⇒ Object 



12
13
14
15
16
17
18
19
20
 
# File 'lib/smartsheet/endpoints/groups/groups.rb', line 12

def create(body:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['groups'], body_type: :json)
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      body: body
  )
  client.make_request(endpoint_spec, request_spec)
end

#delete(group_id:, params: {}, header_overrides: {}) ⇒ Object 



22
23
24
25
26
27
28
29
30
 
# File 'lib/smartsheet/endpoints/groups/groups.rb', line 22

def delete(group_id:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['groups', :group_id])
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      group_id: group_id
  )
  client.make_request(endpoint_spec, request_spec)
end

#get(group_id:, params: {}, header_overrides: {}) ⇒ Object 



32
33
34
35
36
37
38
39
40
 
# File 'lib/smartsheet/endpoints/groups/groups.rb', line 32

def get(group_id:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['groups', :group_id])
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      group_id: group_id
  )
  client.make_request(endpoint_spec, request_spec)
end

#list(params: {}, header_overrides: {}) ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'lib/smartsheet/endpoints/groups/groups.rb', line 42

def list(params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['groups'])
  request_spec = Smartsheet::API::RequestSpec.new(
      header_overrides: header_overrides,
      params: params
  )
  client.make_request(endpoint_spec, request_spec)
end

#remove_member(group_id:, user_id:, params: {}, header_overrides: {}) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/smartsheet/endpoints/groups/groups.rb', line 73

def remove_member(group_id:, user_id:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['groups', :group_id, 'members', :user_id])
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      group_id: group_id,
      user_id: user_id
  )
  client.make_request(endpoint_spec, request_spec)
end

#update(group_id:, body:, params: {}, header_overrides: {}) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/smartsheet/endpoints/groups/groups.rb', line 51

def update(group_id:, body:, params: {}, header_overrides: {})
  endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['groups', :group_id], body_type: :json)
  request_spec = Smartsheet::API::RequestSpec.new(
      params: params,
      header_overrides: header_overrides,
      body: body,
      group_id: group_id
  )
  client.make_request(endpoint_spec, request_spec)
end