Class: Projects::Api::EventsAPI

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

Instance Method Summary collapse

Methods inherited from API

#getBaseURL, #getQueryMap

Constructor Details

#initialize(authToken, portalId) ⇒ EventsAPI

  • Construct a new EventsAPI using User’s authToken and portalId.

Parameters

  • authToken

    • User’s authToken.

  • portalId

    • User’s portalId.



36
37
38
 
# File 'lib/projects/api/EventsAPI.rb', line 36

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

Instance Method Details

#add(projectId, event) ⇒ Object 



72
73
74
75
76
 
# File 'lib/projects/api/EventsAPI.rb', line 72

def add(projectId, event)
  url = getBaseURL+"projects/"+String(projectId)+"/events/"    
  response = ZohoHTTPClient.post(url, getQueryMap, event.toParamMAP)   
  return $eventParser.getEvent(response)
end

#delete(projectId, eventId) ⇒ Object

  • Delete an existing event for the project.

Parameters

  • projectId

    • ID of the project.

  • eventId

    • ID of the event.

Returns

  • String object.



108
109
110
111
112
 
# File 'lib/projects/api/EventsAPI.rb', line 108

def delete(projectId, eventId)
  url = getBaseURL+"projects/"+String(projectId)+"/events/"+String(eventId)+"/"    
  response = ZohoHTTPClient.delete(url, getQueryMap)
  return $eventParser.getResult(response)
end

#getEvents(projectId, queryMap) ⇒ Object 



53
54
55
56
57
 
# File 'lib/projects/api/EventsAPI.rb', line 53

def getEvents(projectId, queryMap)
  url = getBaseURL+"projects/"+String(projectId)+"/events/"    
  response = ZohoHTTPClient.get(url, getQueryMap(queryMap))  
  return $eventParser.getEvents(response)
end

#update(projectId, event) ⇒ Object

  • Update the details of an event.

Parameters

  • projectId

    • ID of the project.

  • event

    • Event object.

Returns

  • Event object.



90
91
92
93
94
 
# File 'lib/projects/api/EventsAPI.rb', line 90

def update(projectId, event)
  url = getBaseURL+"projects/"+String(projectId)+"/events/"+String(event.getId)+"/"    
  response = ZohoHTTPClient.post(url, getQueryMap, event.toParamMAP)   
  return $eventParser.getEvent(response)
end