Class: Tenk::Projects

Inherits:
Resource show all
Defined in:
lib/projects.rb

Overview

API methods for Project resources

Defined Under Namespace

Classes: Assignments, BillRates, CreateRequest, GetRequest, ListRequest, Phases, ProjectResource, Tags, TimeEntries, UpdateRequest, Users

Instance Method Summary collapse

Methods inherited from Resource

#initialize, #resource_root

Constructor Details

This class inherits a constructor from Tenk::Resource

Instance Method Details

#assignments ⇒ Projects::Assignments

An Assignments subresource of Projects

Returns:



76
77
78
 
# File 'lib/projects.rb', line 76

def assignments
  @_assignments ||= Projects::Assignments.new(@_client)
end

#bill_rates ⇒ Projects::BillRates

A BillRate subresource of Projects

Returns:



82
83
84
 
# File 'lib/projects.rb', line 82

def bill_rates
  @_bill_rates ||= Projects::BillRates.new(@_client)
end

#create(opts = {}) ⇒ Hashie::Mash

Create a new project in this 10k account

Parameters:

  • opts (Hash) (defaults to: {}) —

    the parameters for this create request

Returns:

  • (Hashie::Mash) —

    the API response wrapped in a Hashie::Mash

See Also:



107
108
109
 
# File 'lib/projects.rb', line 107

def create(opts = {})
  super(CreateRequest.new(opts))
end

#get(id, opts = {}) ⇒ Hashie::Mash

Get a single project for this 10k account

Parameters:

  • id (Integer) —

    the id of this project

  • opts (Hash) (defaults to: {}) —

    the query parameters for the list request

Returns:

  • (Hashie::Mash) —

    the API response wrapped in a Hashie::Mash

See Also:



99
100
101
 
# File 'lib/projects.rb', line 99

def get(id, opts = {})
  super(id, GetRequest.new(opts))
end

#list(opts = {}) ⇒ Hashie::Mash

List projects for this 10k account

Parameters:

  • opts (Hash) (defaults to: {}) —

    the query parameters for the list request

Returns:

  • (Hashie::Mash) —

    the API response wrapped in a Hashie::Mash

See Also:



90
91
92
 
# File 'lib/projects.rb', line 90

def list(opts = {})
  super(ListRequest.new(opts))
end

#phases ⇒ Projects::Phases

A Phase subresource of Projects

Returns:



64
65
66
 
# File 'lib/projects.rb', line 64

def phases
  @_phases ||= Projects::Phases.new(@_client)
end

#tags ⇒ Projects::Tags

A Tag subresource of Projects

Returns:



58
59
60
 
# File 'lib/projects.rb', line 58

def tags
  @_tags ||= Projects::Tags.new(@_client)
end

#time_entries ⇒ Projects::TimeEntries

A TimeEntry subresource of Projects

Returns:



70
71
72
 
# File 'lib/projects.rb', line 70

def time_entries
  @_time_entries ||= Projects::TimeEntries.new(@_client)
end

#update(id, opts = {}) ⇒ Hashie::Mash

Update a project in this 10k account

Parameters:

  • id (Integer) —

    the id of this project

  • opts (Hash) (defaults to: {}) —

    the parameters for this update request

Returns:

  • (Hashie::Mash) —

    the API response wrapped in a Hashie::Mash

See Also:



116
117
118
 
# File 'lib/projects.rb', line 116

def update(id, opts = {})
  super(id, UpdateRequest.new(opts))
end

#users ⇒ Projects::Users

A User subresource of Projects

Returns:



52
53
54
 
# File 'lib/projects.rb', line 52

def users
  @_users ||= Projects::Users.new(@_client)
end