Module: Calendars

Included in:
Config
Defined in:
lib/user/config/calendars.rb

Instance Method Summary collapse

Instance Method Details

#create_calendar(data) ⇒ Object

Create calendar.

Create a calendar with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New Calendar',
  object_type: 'contacts',
  object_id: 1
}
@data = @mints_user.create_calendar(data)


58
59
60
 
# File 'lib/user/config/calendars.rb', line 58

def create_calendar(data)
  @client.raw('post', '/config/calendars', nil, data_transform(data))
end

#delete_calendar(id) ⇒ Object

Delete calendar.

Delete a calendar.

Parameters

id

(Integer) – Calendar id.

Example

@data = @mints_user.delete_calendar(4)


88
89
90
 
# File 'lib/user/config/calendars.rb', line 88

def delete_calendar(id)
  @client.raw('delete', "/config/calendars/#{id}")
end

#get_calendar(id, options = nil) ⇒ Object

Get calendar.

Get a calendar info.

Parameters

id

(Integer) – Calendar id.

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @mints_user.get_calendar(1)

Second Example

options = {
  fields: 'title'
}
@data = @mints_user.get_calendar(1, options)


41
42
43
 
# File 'lib/user/config/calendars.rb', line 41

def get_calendar(id, options = nil)
  @client.raw('get', "/config/calendars/#{id}", options)
end

#get_calendars(options = nil) ⇒ Object

Get calendars.

Get a collection of calendars.

Parameters

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @mints_user.get_calendars

Second Example

options = {
  fields: 'title'
}
@data = @mints_user.get_calendars(options)


22
23
24
 
# File 'lib/user/config/calendars.rb', line 22

def get_calendars(options = nil)
  @client.raw('get', '/config/calendars', options)
end

#update_calendar(id, data) ⇒ Object

Update calendar.

Update a calendar info.

Parameters

id

(Integer) – Calendar id.

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New Calendar Modified',
  object_type: 'contacts',
  object_id: 1
}
@data = @mints_user.update_calendar(4, data)


76
77
78
 
# File 'lib/user/config/calendars.rb', line 76

def update_calendar(id, data)
  @client.raw('put', "/config/calendars/#{id}", nil, data_transform(data))
end