class EbanqApi::Messages

Declares an client instance.

# File lib/ebanq_api/blocks/messages.rb, line 13
def initialize(client)
  @client = client
end

Delete messages thread /api/v1/messages/{id}

Attributes¶ ↑

• id (required) - Thread ID. (Number)

Examples¶ ↑

client.messages.delete(4)

# File lib/ebanq_api/blocks/messages.rb, line 163
def delete_thread(id)
  @client.make_request :delete, messages_path(id)
end

List of all incoming messages /api/v1/messages

Attributes¶ ↑

• options - hash of options for request,

e.g. {page: 1, per_page: 2, order: 'last_update'}

• • page - Number of page with messages. (Number)

• • per_page - Count messages per page. (Number)

• • order - Sorting for messages list.

Allowed values: last_update, subject. (String)

• • sort - Order of sorting for messages list.

Allowed values: asc, desc.

• • search - Part of subject of text of messages for search. (String)

Examples¶ ↑

options = {page: 1, per_page: 3, order: 'subject', sort: 'asc'}
client.messages.list

# File lib/ebanq_api/blocks/messages.rb, line 36
def list(options = {})
  @client.make_request :get, messages_path, options
end

Retrieve all outgoing messages /api/v1/messages/outgoing

Attributes¶ ↑

• options - hash of options for request,

e.g. {page: 1, per_page: 2, order: 'last_update'}

• • page - Number of page with messages. (Number)

• • per_page - Count messages per page. (Number)

• • order - Sorting for messages list.

Allowed values: last_update, subject. (String)

• • sort - Order of sorting for messages list.

Allowed values: asc, desc.

• • search - Part of subject of text of messages for search. (String)

Examples¶ ↑

client.messages.outgoing(page: 1, per_page: 2)

# File lib/ebanq_api/blocks/messages.rb, line 73
def outgoing(options = {})
  @client.make_request :get, messages_path('outgoing'), options
end

Send message to a group /api/v1/messages/send/groups/

Attributes¶ ↑

• subject (required) - (String)

• body (required) - (String)

• recipient - (String)

• thread_id - (Number)

Examples¶ ↑

client.messages.send_to_a_group('subject', 'body')

# File lib/ebanq_api/blocks/messages.rb, line 143
def send_to_a_group(subject, body, recipient = '', thread_id = '')
  values = {
    recipient: recipient,
    subject: subject,
    body: body,
    thread_id: thread_id
  }

  @client.make_request :post, messages_path('send/groups'), values
end

Send message to administrator /api/v1/messages/send

Attributes¶ ↑

• subject (required) - (String)

• body (required) - (String)

• recipient - (String)

• thread_id - (Number)

Examples¶ ↑

client.messages.send_to_administrator('test subject', 'test body')

# File lib/ebanq_api/blocks/messages.rb, line 99
def send_to_administrator(subject, body, recipient = '', thread_id = '')
  values = {
    recipient: recipient,
    subject: subject,
    body: body,
    thread_id: thread_id
  }

  @client.make_request :post, messages_path('send'), values
end

Send message to all users api/v1/messages/send/all

Attributes¶ ↑

• subject (required) - (String)

• body (required) - (String)

• thread_id - (Number)

Examples¶ ↑

client.messages.send_to_all('subject', 'body')

# File lib/ebanq_api/blocks/messages.rb, line 121
def send_to_all(subject, body, thread_id = '')
  values = {
    subject: subject,
    body: body,
    thread_id: thread_id
  }

  @client.make_request :post, messages_path('send/all'), values
end

Retrieve a message /api/v1/messages/{id}

Attributes¶ ↑

• id (required) - Message id (Number)

Examples¶ ↑

client.messages.show(4)

@return Array

# File lib/ebanq_api/blocks/messages.rb, line 51
def show(id)
  @client.make_request :get, messages_path(id)
end

Get unread messages count /api/v1/messages/unread-count

Examples¶ ↑

client.messages.unread_count

# File lib/ebanq_api/blocks/messages.rb, line 83
def unread_count
  @client.make_request :get, messages_path('unread-count')
end