Class: Projects::Api::MilestonesAPI

Inherits:
API
  • Object
show all
Includes:
Parser, Util
Defined in:
lib/projects/api/MilestonesAPI.rb

Instance Method Summary collapse

Methods inherited from API

#getBaseURL, #getQueryMap

Constructor Details

#initialize(authToken, portalId) ⇒ MilestonesAPI

  • portalId

    • User’s portalId.



40
41
42
 
# File 'lib/projects/api/MilestonesAPI.rb', line 40

def initialize(authToken,portalId)
	super(authToken,portalId)
end

Instance Method Details

#create(projectId, milestone) ⇒ Object

  • Create a milestone for the project.

Parameters

  • projectId

    • ID of the project.

  • milestone

    • Milestone object.

Returns

  • Milestone object.



95
96
97
98
99
 
# File 'lib/projects/api/MilestonesAPI.rb', line 95

def create(projectId,milestone)
	url = getBaseURL+"projects/"+String(projectId)+"/milestones/"
	response = ZohoHTTPClient.post(url, getQueryMap, milestone.toParamMAP())
	return $milestonesParser.getMilestone(response)
end

#delete(projectId, milestoneId) ⇒ Object

  • Delete an existing milestone for the project.

Parameters

  • projectId

    • ID of the project.

  • milestoneId

    • ID of the milestone.

Returns

  • String object.



152
153
154
155
156
 
# File 'lib/projects/api/MilestonesAPI.rb', line 152

def delete(projectId,milestoneId)
	url = getBaseURL+"projects/"+String(projectId)+"/milestones/"+String(milestoneId)+"/"
	response = ZohoHTTPClient.delete(url, getQueryMap)
	return $milestonesParser.getResult(response)
end

#get(projectId, milestoneId) ⇒ Object

  • Get the details of a milestone.

Parameters

  • projectId

    • ID of the project.

  • milestoneId

    • ID of the milestone.

==== Returns

  • Milestone object.



78
79
80
81
82
 
# File 'lib/projects/api/MilestonesAPI.rb', line 78

def get(projectId,milestoneId)
	url = getBaseURL+"projects/"+String(projectId)+"/milestones/"+String(milestoneId)+"/"
	response = ZohoHTTPClient.get(url, getQueryMap)
	return $milestonesParser.getMilestone(response)
end

#getMilestones(projectId, *queryMap) ⇒ Object

  • List of Milestone object.



56
57
58
59
60
61
62
63
64
 
# File 'lib/projects/api/MilestonesAPI.rb', line 56

def getMilestones(projectId, * queryMap)
	url = getBaseURL+"projects/"+String(projectId)+"/milestones/"
	if queryMap.length == 0
		response = ZohoHTTPClient.get(url, getQueryMap)
	else
		response = ZohoHTTPClient.get(url, getQueryMap(queryMap))
	end
	return $milestonesParser.getMilestones(response)
end

#update(projectId, milestone) ⇒ Object

  • Update the details of a milestone.

Parameters

  • projectId

    • ID of the project.

  • milestone

    • Milestone object.

Returns

  • Milestone object.



112
113
114
115
116
 
# File 'lib/projects/api/MilestonesAPI.rb', line 112

def update(projectId,milestone)
	url = getBaseURL+"projects/"+String(projectId)+"/milestones/"+String(milestone.getId)+"/"
	response = ZohoHTTPClient.post(url, getQueryMap, milestone.toParamMAP())
	return $milestonesParser.getMilestone(response)
end

#updateStatus(projectId, milestoneId, status) ⇒ Object

  • Update the status of a milestone.

Parameters

  • projectId

    • ID of the project.

  • milestoneId

    • ID of the milestone.

  • status

    • Status of the milestone.

Returns

  • Milestone object.



132
133
134
135
136
137
138
 
# File 'lib/projects/api/MilestonesAPI.rb', line 132

def updateStatus(projectId,milestoneId,status)
	url = getBaseURL+"projects/"+String(projectId)+"/milestones/"+String(milestoneId)+"/status/"
	requestBody = Hash.new()
	requestBody["status"] = status
	response = ZohoHTTPClient.post(url, getQueryMap, requestBody)
	return $milestonesParser.getMilestone(response)
end