Module: Paperdrive::Client::GlobalMessages

Includes:

Parameters

Included in:

Paperdrive::Client

Defined in:

lib/paperdrive/client/global_messages.rb

Overview

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

See Also:

• https://developers.pipedrive.com/docs/api/v1/#!/GlobalMessages

Instance Method Summary

• #all_global_messages(**args) ⇒ Paperdrive::Response

  GET

  Get global messages.

• #delete_global_message(id:, **args) ⇒ Paperdrive::Response

  DELETE

  Delete a global message.

Instance Method Details

#all_global_messages(**args) ⇒ Paperdrive::Response

GET

Get global messages

Returns:

• (Paperdrive::Response)

See Also:

• https://developers.pipedrive.com/docs/api/v1/#!/GlobalMessages/get_globalMessages

# File 'lib/paperdrive/client/global_messages.rb', line 18

def all_global_messages(**args)
  params = parameters(args) do
    optional_params :limit
  end
  request(:get, 'globalMessages', params)
end

#delete_global_message(id:, **args) ⇒ Paperdrive::Response

DELETE

Delete a global message

Parameters:

• id: (integer)

Returns:

• (Paperdrive::Response)

See Also:

• https://developers.pipedrive.com/docs/api/v1/#!/GlobalMessages/delete_globalMessages_id

# File 'lib/paperdrive/client/global_messages.rb', line 30

def delete_global_message(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:delete, "globalMessages/#{id}", params)
end