module Paperdrive::Client::Notes

Instance methods related to Notes to embed into Paperdrive::Client
arguments are compatible with the Pipedribe API.

@see developers.pipedrive.com/docs/api/v1/#!/Notes

Public Instance Methods

all_notes(**args) click to toggle source
GET

fetch Notes list

@see developers.pipedrive.com/docs/api/v1/#!/Notes/get_notes @return [Paperdrive::Response]

# File lib/paperdrive/client/notes.rb, line 18
def all_notes(**args)
  params = parameters(args) do
    optional_params :user_id, :deal_id, :person_id, :org_id, :start, :limit, :sort, :start_date, :end_date, :pinned_to_deal_flag, :pinned_to_organization_flag, :pinned_to_person_flag
  end
  request(:get, 'notes', params)
end
create_note(**args) click to toggle source
POST

create a single Note

@see developers.pipedrive.com/docs/api/v1/#!/Notes/post_notes @return [Paperdrive::Response]

# File lib/paperdrive/client/notes.rb, line 41
def create_note(**args)
  params = parameters(args) do
    required_params :content
    optional_params :content, :deal_id, :person_id, :org_id, :add_time, :pinned_to_deal_flag, :pinned_to_organization_flag, :pinned_to_person_flag
  end
  request(:post, 'notes', params)
end
delete_note(id:, **args) click to toggle source
DELETE

delete a single note

@see developers.pipedrive.com/docs/api/v1/#!/Notes/delete_notes_id @return [Paperdrive::Response]

# File lib/paperdrive/client/notes.rb, line 68
def delete_note(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:delete, "notes/#{id}", params)
end
edit_note(id:, **args)
Alias for: update_note
note_detail(id:, **args) click to toggle source
GET

fetch a single note whose ID specified

@param [integer] id: ID of the note to fetch @see developers.pipedrive.com/docs/api/v1/#!/Notes/get_notes_id @return [Paperdrive::Response]

# File lib/paperdrive/client/notes.rb, line 30
def note_detail(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "notes/#{id}", params)
end
update_note(id:, **args) click to toggle source
PUT

update a single note

@param [integer] id: ID of the note to update @see developers.pipedrive.com/docs/api/v1/#!/Notes/put_notes_id @return [Paperdrive::Response]

# File lib/paperdrive/client/notes.rb, line 54
def update_note(id:, **args)
  params = parameters(args) do
    required_params :content
    optional_params :content, :deal_id, :person_id, :org_id, :add_time, :pinned_to_deal_flag, :pinned_to_organization_flag, :pinned_to_person_flag
  end
  request(:put, "notes/#{id}", params)
end
Also aliased as: edit_note