Class: SevenApi::Resources::Groups

Inherits:
SevenApi::Resource show all
Defined in:
lib/seven_api/resources/groups.rb

Constant Summary

Constants inherited from SevenApi::Resource

SevenApi::Resource::BASE_PATH

Instance Attribute Summary

Attributes inherited from SevenApi::Resource

#api_key, #builder, #conn, #endpoint, #http_methods, #request_methods, #sent_with

Instance Method Summary collapse

Methods inherited from SevenApi::Resource

get_endpoint, get_http_methods, #initialize

Constructor Details

This class inherits a constructor from SevenApi::Resource

Instance Method Details

#all(params = {}) ⇒ Hash

Retrieve groups associated with the API key read more: docs.seven.io/en/rest-api/endpoints/groups#list-all-groups

Parameters:

  • params (Hash) (defaults to: {})

Returns:

  • (Hash) 


21
22
23
 
# File 'lib/seven_api/resources/groups.rb', line 21

def all(params = {})
  request(:get, params)
end

#create(params) ⇒ Hash

Create a group read more: docs.seven.io/en/rest-api/endpoints/groups#create-group

Parameters:

  • params (Hash)

Returns:

  • (Hash) 


45
46
47
 
# File 'lib/seven_api/resources/groups.rb', line 45

def create(params)
  request(:post, params)
end

#delete(id) ⇒ Hash

Delete a group with given ID read more: docs.seven.io/en/rest-api/endpoints/groups#delete-group

Parameters:

  • id (Integer)

Returns:

  • (Hash) 


37
38
39
 
# File 'lib/seven_api/resources/groups.rb', line 37

def delete(id)
  request(:delete,{}, {}, "/#{id}")
end

#one(id) ⇒ Hash

Retrieve a group associated with the API key read more: docs.seven.io/en/rest-api/endpoints/groups#retrieve-a-group

Parameters:

  • id (Int)

Returns:

  • (Hash) 


29
30
31
 
# File 'lib/seven_api/resources/groups.rb', line 29

def one(id)
  request(:get,{}, {}, "/#{id}")
end

#update(contact) ⇒ Hash

Update a group read more: docs.seven.io/en/rest-api/endpoints/groups#update-a-group

Parameters:

  • contact (Hash)

Returns:

  • (Hash) 


53
54
55
 
# File 'lib/seven_api/resources/groups.rb', line 53

def update(contact)
  request(:patch, contact, {}, "/#{contact['id']}")
end