Cubscout

require 'cubscout'

Cubscout::Config.client_id = 'YOUR_APP_ID'
Cubscout::Config.client_secret = 'YOUR_APP_SECRET'

# all possible conversations available
# WARNING: this will create a lot of HTTP requests. You probably want some filtering.
conversations = Cubscout::Conversation.all

# conversations with filters
conversations = Cubscout::Conversation.all(tag: 'red,blue', status: 'active')

# Cubscout::Conversation.all returns a Cubscout::List object. You can iterate
# over it's Cubscout::Conversation items like this:
conversations.each { |conversation| puts conversation.mailbox_id }

# or you can also get some metadata information. For example if you only care
# about the number of items, you can query the first page only and find out how
# many elements exist in total:
Cubscout::Conversation.all(page: 1, tag: 'red,blue', status: 'active').total_size

conversations = Cubscout::Conversation.all(page: 1,
                                           assigned_to: 1234,
                                           sortField: "customerName",
                                           modifiedSince: (DateTime.now - 4).to_time.utc.iso8601,
                                           tag: "red,blue")

# find conversation by id:
conversation = Cubscout::Conversation.find(12345)

# Cubscout::Conversation.find returns one Cubscout::Conversation object, from
# which attributes can be read. attributes can be read as snake case or camel case.
puts conversation.mailbox_id
puts conversation.mailboxId

# By default, the threads are not embedded in the conversations payload. They can
# optionally be returned with the `embed` option:
Cubscout::Conversation.find(12345, embed: "threads")

conversation = Cubscout::Conversation.find(12345)
conversation.update(op: "replace", path: "/subject", value: "New conversation subject")

# or
Cubscout::Conversation.update(12345, op: "replace", path: "/subject", value: "New conversation subject")

# by conversation id, will make a request to Helpscout:
threads = Cubscout::Conversation.threads(conversation_id)

# from a conversation object, either by embedding threads on conversation request:
also_threads = Cubscout::Conversation.find(id, embed: 'threads').threads
# or making the threads request with explicit `fetch` option, will make a request
# to Helpscout:
another_way_to_get_threads = Cubscout::Conversation.find(id).threads(fetch: true)

# By default, the threads are not embedded in the conversations payload. They can
# optionally be returned with the `embed` option:
conversations = Cubscout::Conversation.all(page: 1, tag: 'red,blue', embed: 'threads')
threads = conversations.first.threads

# by conversation id:
Cubscout::Conversation.create_note(conversation_id, attributes)

# from a conversation object:
Cubscout::Conversation.find(id).create_note(attributes)

# of the attributes hash, :text is the only attribute required
Cubscout::Conversation.create_note(12345, text: "A new note by me")

# this endpoint doesn't return any body

# all possible users available
# WARNING: this will create multiple HTTP requests. You may want some filtering.
users = Cubscout::User.all

# users with filters
users = Cubscout::User.all(mailbox: 12345)

# Cubscout::User.all returns a Cubscout::List object. You can iterate over
# it's Cubscout::User items like this:
users.each { |user| puts user.first_name }

# or you can also get some metadata information. For example if you only care
# about the number of items, you can query the first page only and find out how
# many elements exist in total:
Cubscout::User.all(page: 1, mailbox: 12345).total_size

# find user by id:
user = Cubscout::User.find(12345)

# Cubscout::User.find returns one Cubscout::User object, from
# which attributes can be read. attributes can be read as snake case or camel case.
puts user.firstName
puts user.first_name

# With limited attributes returned in conversation payload. Small gotcha here:
# - "first" attributes is renamed to "firstName"
# - "last" attributes is renamed to "lastName"
# to keep consistency with the attribute names returned from the /users endpoint
user = Cubscout::Conversation.find(conversation_id).assignee

# All attributes, will make a request to Helpscout:
user = Cubscout::Conversation.find(conversation_id).assignee(fetch: true)