Module: Insightly2::DSL::Events

Included in:
Insightly2::DSL
Defined in:
lib/insightly2/dsl/events.rb

Instance Method Summary collapse

Instance Method Details

#create_event(event: nil) ⇒ Insightly2::Resources::Event?

POST /v2.1/Events Create an event.

Parameters:

  • event (Hash) (defaults to: nil) —

    The event to create.

Returns:

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



27
28
29
30
 
# File 'lib/insightly2/dsl/events.rb', line 27

def create_event(event: nil)
  raise ArgumentError, "Event cannot be blank" if event.blank?
  Resources::Event.parse(request(:post, "Events", event))
end

#delete_event(id: nil) ⇒ Faraday::Response

DELETE /v2.1/Events/id Delete an event.

Parameters:

  • id (String, Fixnum) (defaults to: nil) —

    An event’s ID.

Returns:

  • (Faraday::Response) —

    .

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



47
48
49
50
 
# File 'lib/insightly2/dsl/events.rb', line 47

def delete_event(id: nil)
  raise ArgumentError, "ID cannot be blank" if id.blank?
  request(:delete, "Events/#{id}")
end

#get_event(id: nil) ⇒ Insightly2::Resources::Event?

GET /v2.1/Events/id Get an event.

Parameters:

  • id (String, Fixnum) (defaults to: nil) —

    An event’s ID.

Returns:

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



10
11
12
13
 
# File 'lib/insightly2/dsl/events.rb', line 10

def get_event(id: nil)
  raise ArgumentError, "ID cannot be blank" if id.blank?
  Resources::Event.parse(request(:get, "Events/#{id}"))
end

#get_events ⇒ Insightly2::Resources::Event?

GET /v2.1/Events Get a list of events.

Returns:



18
19
20
 
# File 'lib/insightly2/dsl/events.rb', line 18

def get_events
  Resources::Event.parse(request(:get, "Events"))
end

#update_event(event: nil) ⇒ Insightly2::Resources::Event?

PUT /v2.1/Events Update an event.

Parameters:

  • event (Hash) (defaults to: nil) —

    The event to update.

Returns:

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



37
38
39
40
 
# File 'lib/insightly2/dsl/events.rb', line 37

def update_event(event: nil)
  raise ArgumentError, "Event cannot be blank" if event.blank?
  Resources::Event.parse(request(:put, "Events", event))
end