module Nearmiss::Client::Companies
Methods for the Companies
API
Public Instance Methods
List companies
@note Shows a list of companies for the users organization aka account
@return [Array<Sawyer::Resource>] List of companys
# File lib/nearmiss-ruby/client/companies.rb, line 13 def companies(options = {}) paginate "companies", options end
Get a single company
@param company [String] UUID of company to fetch @return [Sawyer::Resource] Project
information
# File lib/nearmiss-ruby/client/companies.rb, line 23 def company(company, options = {}) get "#{company_path(company)}", options end
Create a company
@param options [Hash] Project
information. @option options [String] :name e.g. Berkeley Art Museum @option options [String] :company_id e.g. 10611.70 @return [Sawyer::Resource] Newly created company info
# File lib/nearmiss-ruby/client/companies.rb, line 33 def create_company(options = {}) post 'companies', options end
Delete a company
@param company [String] Project
ID @return [Boolean] Indicating success of deletion
# File lib/nearmiss-ruby/client/companies.rb, line 60 def delete_company(company, options = {}) boolean_from_response :delete, "companies/#{company}", options end
Edit a company
@param options [Hash] Project
information. @option options [String] :name e.g. Berkeley Art Museum @option options [String] :company_id e.g. 10611.70
@return
[Sawyer::Resource] Newly created company info
@example Update a company
@client.edit_company('some_id', { name: "New name of company", company_id: "1043.32" })
# File lib/nearmiss-ruby/client/companies.rb, line 51 def edit_company(company, options = {}) patch "#{company_path(company)}", options end
Private Instance Methods
# File lib/nearmiss-ruby/client/companies.rb, line 67 def company_path(id) if uuid?(id) "companies/#{id}" else "company/#{id}" end end