qismo 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb55e3c23efa55080a8c65449b619f5d1016d9f3ef72b0692413654687e98e38
-  data.tar.gz: 610b16a6507bd54a017602146ce5866111e0bb89a0c36f491ec1898057ffb51d
+  metadata.gz: 3a661003cb31406d91ff9af0717d796b4bf4e425d395fa16304fb871f6174c3f
+  data.tar.gz: d46b28c74af1561c93f12d23e291fcc8d1e8a865f072f10ffacbc608a7eda1fa
 SHA512:
-  metadata.gz: 522f77e9e507001a0e6f07834c0e048c88716a93f810a8cdff7dafb38bb31d8faa50d4d2165878468fdbe3ab13bbc7916a63509293e798da99bd4c73582115ae
-  data.tar.gz: 76e9cead4064ad7f28c3b04144976356c1f46d62f11ec71029820d1043c9e728f71980c389e52be4d215cdd36916652de43544bc56f23ca62ce6362d36866e48
+  metadata.gz: b74ceea740b566d0e24c61929af9f2697ca8a1c961625853a6ee999f53d67cc6ddf4e0334e0b5f39e4856a243167ca1b39e94abf2347fa6ef242a7c399ffc21e
+  data.tar.gz: 55035df4c8ca13362e43b82e434c88389bc62d5aa7263fb5cb45031569a897b6d2dac2709bf29d9743061c52acd9ad95d1abcb85491f17a143f4235cd2d50835

data/Gemfile

@@ -10,6 +10,5 @@ group :development do
   gem "byebug", "~> 11.1"
   gem "rake", "~> 13.0"
   gem "rspec", "~> 3.0"
-  gem "solargraph", "~> 0.47.2"
   gem "standard", ">= 1"
 end

data/README.md

@@ -12,57 +12,73 @@ bundle add qismo
 
 ## Usage
 
-### Initialize and make request
-
-To start using Qismo ruby, you must get your account's `App ID` and `Qiscus Secret Key` which can be checked in your admin dashboard's [settings page](https://omnichannel.qiscus.com/settings). After getting these data, you can start initialize the client.
-
 ```ruby
+# config/initializers/qismo.rb
+
 Qismo.configure do |client|
-  client.app_id           = "YOU_ACCOUNT_APP_ID"
-  client.secret_key       = "YOUR_ACCOUNT_SECRET_KEY"
-
-  ## Optional
-  client.url              = "https://qismo.qiscus.com"
-  client.logger           = { logger: Logger.new($stdout) }
-  client.instrumentation  = { instrumenter: ActiveSupport::Notifications.instrumenter }
-  client.timeout          = { connect: 5, write: 2, read: 5 }
-  client.proxy            = ["proxy-hostname.local", 8080, "username", "password"]
+  client.app_id           = ENV["QISCUS_APP_ID"]
+  client.secret_key       = ENV["QISCUS_SECRET_KEY"]
 end
 ```
 
-Then, start requesting to any endpoint yg want
+Then, start requesting to available endpoint
 
 ```ruby
 params = {
-  channel: { id: 12345, source: "wa" },
+  channel: { channel_id: 12345, source: "wa" },
   status: "unresolved",
   serve_status: "served",
-  is_handled_by_bot: false,
+  is_handled_by_bot: true,
 }
 
+# List rooms
 rooms = Qismo.rooms(params)
-```
 
-If your app manage multiple app id, you initialize the client like below
-
-```ruby
-client = Qismo::Client.new(app_id: "YOUR_ACCOUNT_APP_ID", secret_key: "YOUR_ACCOUNT_SECRET_KEY")
+puts rooms
+# [
+#   #<Qismo::SingleObject
+#     channel_id=6171,
+#     contact_id=71716,
+#     id=181917,
+#     is_handled_by_bot=true,
+#     is_resolved=false,
+#     is_waiting=false,
+#     last_comment_sender="admin@qismo.com",
+#     last_comment_sender_type="system",
+#     last_comment_text="Agent joined this conversation",
+#     last_comment_timestamp="2022-12-09T04:25:55Z",
+#     last_customer_comment_text=nil,
+#     last_customer_timestamp="2022-11-28T09:03:08Z",
+#     name="Customer - Yogyakarta",
+#     room_badge="https://multichannel.qiscus.com/img/whatsapp_badge.svg",
+#     room_id="8191816171",
+#     room_type="individual",
+#     source="wa",
+#     user_avatar_url="https://multichannel.qiscus.com/img/default_avatar.svg",
+#     user_id="628155555711"
+#   >
+# ]
 ```
 
-Then, start requesting to an endpoint using that `client` variable
+## Multiple app id client initialization
 
 ```ruby
+client = Qismo::Client.new(app_id: "QISCUS_APP_ID", secret_key: "QISCUS_SECRET_KEY")
+
 params = {
-  channel: { id: 12345, source: "wa" },
+  channel: { channel_id: 12345, source: "wa" },
   status: "unresolved",
   serve_status: "served",
-  is_handled_by_bot: false,
+  is_handled_by_bot: true,
 }
 
-rooms = client.rooms(params)
+# This will produce same result as explained before
+client.rooms(params)
 ```
 
-### Client configuration
+## Client optional configuration
+
+Qismo ruby also provide some optional configuration that you can pass, they are:
 
 **url**
 
@@ -130,7 +146,7 @@ Proxy needs authentication?
 client.proxy = ["proxy-hostname.local", 8080, "username", "password"]
 ```
 
-### Handling pagination
+## Handling pagination
 
 Some of the Qiscus Omnichannel API will return list of data with pagination. To handle the pagination, you can to that like this example:
 
@@ -145,7 +161,7 @@ while rooms.has_next_page?
 end
 ```
 
-### Handling error
+## Handling error
 
 Qismo ruby raise error while getting non successful http code from Qiscus Omnichannel API. To handle it, you follow this example:
 
@@ -158,3 +174,87 @@ rescue Qismo::HTTPRequestError => e
   e.response_body
 end
 ```
+
+## Handle incoming webhook request
+
+Qiscus Omnichannel provide webhooks that triggered from various action on your account. Qismo ruby gem provide convenient way to handle the request.
+
+```ruby
+class QiscusWebhooksController < ApplicationController
+  skip_before_action :verify_authenticity_token
+  
+  def handle_agent_allocation_webhook
+    webhook = Qismo::WebhookRequests::OnAgentAllocationNeeded.new(JSON.parse(request.raw_body))
+    
+    # Do any action you want using payload that has been objectified
+    if webhook.candidate_agent.present?
+      Qismo.assign_agent(
+        webhook.room_id,
+        webhook.candidate_agent.id
+      )
+    end
+  end
+
+  def handle_custom_button_webhook
+    webhook = Qismo::WebhookRequests::OnCustomButtonClicked.new(JSON.parse(request.raw_body))
+
+    # Do any action you want using payload that has been objectified. The
+    # following example assuming you want to create Zendesk ticket
+    # everytime your agent click custom button "Create Ticket". We are
+    # assuming, you have setup Zendesk ruby client
+    zendesk_ticket_subject = webhook.additional_info.find do |info|
+      info.key == "Zendesk Ticket Subject"
+    end
+
+    if zendesk_ticket_subject.present?
+      ZendeskAPI::Ticket.create!(
+        zendesk_client,
+        subject: zendesk_ticket_subject.value,
+        submitter_id: webhook.agent.email,
+        priority: "urgent"
+      )
+    end
+  end
+
+  def handle_custom_channel_webhook
+    webhook = Qismo::WebhookRequests::OnCustomChannelMessageSent.new(JSON.parse(request.raw_body))
+
+    # Do any action you want
+    # The following example assuming you want to reply customer's message from Twitter
+    # Assuming that you have installed and setup twitter ruby client
+
+    # Fetch customer from room participants
+    customer = webhook.payload.room.participants.find { |participant| participant.email.start_with?("twitter_customer_") }
+    if customer.present?
+      twitter_rest_client.create_direct_message(webhook.payload.rooms, webhook.payload.message.text)
+    end
+  end
+
+  def handle_bot_webhook
+    webhook = Qismo::WebhookRequests::OnMessageForBotSent.new(JSON.parse(request.raw_body))
+
+    # Do any action you want. The following example assuming you want to use
+    # Dialogflow as bot engine
+
+    # Detect intent for customer's message
+    response = dialogflow_client.detect_intent(
+      session: "session_#{webhook.payload.room.id}",
+      query_input: {
+        text: {
+          text: webhook.payload.message.text,
+          language_code: "en-US"
+        }
+      }
+    )
+
+    # Parse bot message which will be sent back to customer
+    bot_message = response.query_result.fulfillment_text
+
+    # Send message to Qismo room
+    Qismo.send_bot_message(
+      webhook.payload.room.id,
+      message: bot_message
+    )
+  end
+end
+```

data/lib/qismo/api.rb

@@ -7,7 +7,18 @@ module Qismo
     # List customer rooms
     #
     # @see https://s.id/list-customer-rooms
-    # @param options [Hash]
+    # @param [Hash] options
+    # @option options [String] :status Filter by room status. Valid values are "resolved", "unresolved", "expired", or "almost_expired"
+    # @option options [String] :serve_status Filter by room serve status. Valid values are "served" or "unserved"
+    # @option options [Array<Hash>] :channels Filter by channels. Example: [{ source: "wa", channel_id: 716171 }]
+    # @option options [TrueClass,FalseClass] :is_handled_by_bot Filter by bot handling status
+    # @option options [String] :name Filter by customer name
+    # @option options [Integer] :limit Number of data returned in one page. Default is 50
+    # @option options [String] :order Order data by timestamp. Can be ordered "asc" or "desc". Default is "desc"
+    # @option options [String] :cursor_after Next page cursor. If you are on last page, the cursor returned will be nil
+    # @option options [String] :cursor_before Previous page cursor. If you are on first page, the cursor returned will be nil
+    # @option options [Array<Integer>] :tag_ids Filter by tags
+    # @option options [Array<Integer>] :user_ids Filter by agent who handled or assigned to the room
     # @return [Qismo::CollectionObject]
     def rooms(options = {})
       body = post("/api/v2/customer_rooms", options)
@@ -463,7 +474,8 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#bb77c653-5daa-4e1c-a866-43bca7c494fc
     # @param options [Hash]
     # @return [TrueClass]
-    def send_bot_message(options = {})
+    def send_bot_message(room_id, options = {})
+      options = options.merge(room_id: room_id.to_s, sender_email: admin_email)
       post("#{app_id}/bot", options)
       true
     end

data/lib/qismo/client.rb

@@ -25,6 +25,7 @@ module Qismo
     }
 
     attr_accessor(*DEFAULT_OPTIONS.keys)
+    attr_reader :admin_email
 
     # Initialize client
     #
@@ -33,6 +34,8 @@ module Qismo
       DEFAULT_OPTIONS.merge(options).each do |key, value|
         instance_variable_set("@#{key}", value)
       end
+
+      @admin_email = "#{@app_id}_admin@qismo.com"
     end
 
     # Send http request with post method

data/lib/qismo/models/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+
+module Qismo
+  module Models
+    include Qismo::Types
+
+    class Base < Dry::Struct
+      transform_keys(&:to_sym)
+    end
+  end
+end

data/lib/qismo/models/customer_room.rb

@@ -0,0 +1,6 @@
+module Qismo
+  module Models
+    class CustomerRoom < Base
+    end
+  end
+end

data/lib/qismo/types.rb

@@ -0,0 +1,10 @@
+module Qismo
+  module Types
+    include Dry.Types()
+
+    Int = Params::Integer
+    String = Params::String
+    Bool = Params::Bool
+    Hash = Params::Hash
+  end
+end

data/lib/qismo/version.rb

@@ -2,5 +2,5 @@
 
 module Qismo
   # @return [String]
-  VERSION = "0.12.1"
+  VERSION = "0.13.0"
 end

data/lib/qismo/webhook_requests/on_agent_allocation_needed.rb

@@ -0,0 +1,75 @@
+module Qismo
+  module WebhookRequests
+    class OnAgentAllocationNeeded < Qismo::Models::Base
+      # @!attribute [r] avatar_url
+      #   @return [String]
+      # @!attribute [r] created_at
+      #   @return [String]
+      # @!attribute [r] email
+      #   @return [String]
+      # @!attribute [r] force_offline
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] is_available
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] is_verified
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] last_login
+      #   @return [String]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] sdk_email
+      #   @return [String]
+      # @!attribute [r] sdk_key
+      #   @return [String]
+      # @!attribute [r] updated_at
+      #   @return [String]
+      class CandidateAgent < Qismo::Models::Base
+        attribute? :avatar_url, Types::String.optional
+        attribute? :created_at, Types::String.optional
+        attribute? :email, Types::String.optional
+        attribute? :force_offline, Types::Bool.optional
+        attribute? :id, Types::Int.optional
+        attribute? :is_available, Types::Bool.optional
+        attribute? :is_verified, Types::Bool.optional
+        attribute? :last_login, Types::String.optional
+        attribute? :name, Types::String.optional
+        attribute? :sdk_email, Types::String.optional
+        attribute? :sdk_key, Types::String.optional
+        attribute? :updated_at, Types::String.optional
+      end
+
+      # @!attribute [r] app_id
+      #   @return [String]
+      # @!attribute [r] avatar_url
+      #   @return [String]
+      # @!attribute [r] candidate_agent
+      #   @return [CandidateAgent]
+      # @!attribute [r] email
+      #   @return [String]
+      # @!attribute [r] extras
+      #   @return [String]
+      # @!attribute [r] is_new_session
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] is_resolved
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] room_id
+      #   @return [String]
+      # @!attribute [r] source
+      #   @return [String]
+      attribute? :app_id, Types::String.optional
+      attribute? :avatar_url, Types::String.optional
+      attribute? :candidate_agent, CandidateAgent
+      attribute? :email, Types::String.optional
+      attribute? :extras, Types::String.optional
+      attribute? :is_new_session, Types::Bool.optional
+      attribute? :is_resolved, Types::Bool.optional
+      attribute? :name, Types::String.optional
+      attribute? :room_id, Types::String.optional
+      attribute? :source, Types::String.optional
+    end
+  end
+end

data/lib/qismo/webhook_requests/on_custom_button_clicked.rb

@@ -0,0 +1,86 @@
+module Qismo
+  module WebhookRequests
+    # @!attribute [r] additional_info
+    #   @return [Array<AdditionalInfo>]
+    # @!attribute [r] agent
+    #   @return [Agent]
+    # @!attribute [r] channel_id
+    #   @return [Integer]
+    # @!attribute [r] channel_name
+    #   @return [String]
+    # @!attribute [r] channel_type
+    #   @return [String]
+    # @!attribute [r] customer
+    #   @return [Customer]
+    # @!attribute [r] notes
+    #   @return [String]
+    # @!attribute [r] room_id
+    #   @return [Integer]
+    # @!attribute [r] tag
+    #   @return [Array<Tag>]
+    class OnCustomButtonClicked < Qismo::Models::Base
+      # @!parse include Qismo::Models
+
+      # @!attribute [r] key
+      #   @return [String]
+      # @!attribute [r] value
+      #   @return [String,Integer,TrueClass,FalseClass]
+      class AdditionalInfo < Qismo::Models::Base
+        attribute? :key, Types::String.optional
+        attribute? :value, (Types::String.optional | Types::Int.optional | Types::Params::Bool.optional)
+      end
+
+      # @!attribute [r] email
+      #   @return [String]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] type
+      #   @return [String]
+      class Agent < Qismo::Models::Base
+        attribute? :email, Types::String.optional
+        attribute? :name, Types::String.optional
+        attribute? :type, Types::String.optional
+      end
+
+      # @!attribute [r] avatar
+      #   @return [String]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] user_id
+      #   @return [String]
+      class Customer < Qismo::Models::Base
+        attribute? :avatar, Types::String.optional
+        attribute? :name, Types::String.optional
+        attribute? :user_id, Types::String.optional
+      end
+
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] created_at
+      #   @return [String]
+      # @!attribute [r] updated_at
+      #   @return [String]
+      # @!attribute [r] room_tag_created_at
+      #   @return [String]
+      class Tag < Qismo::Models::Base
+        attribute? :id, Types::Int.optional
+        attribute? :name, Types::String.optional
+        attribute? :created_at, Types::String.optional
+        attribute? :updated_at, Types::String.optional
+        attribute? :room_tag_created, Types::String.optional
+      end
+
+      attribute? :additional_info, Types.Array(AdditionalInfo.optional).optional
+      attribute? :agent, Agent.optional
+      attribute? :channel_id, Types::Int.optional
+      attribute? :channel_name, Types::String.optional
+      attribute? :channel_type, Types::String.optional
+      attribute? :customer, Customer.optional
+      attribute? :notes, Types::String.optional
+      attribute? :room_id, Types::Int.optional
+      attribute? :tag, Types.Array(Tag.optional).optional
+    end
+  end
+end

data/lib/qismo/webhook_requests/on_custom_channel_message_sent.rb

@@ -0,0 +1,95 @@
+module Qismo
+  module WebhookRequests
+    # @!attribute [r] payload
+    #   @return [Payload]
+    class OnCustomChannelMessageSent < Qismo::Models::Base
+      # @!attribute [r] avatar_url
+      #   @return [String]
+      # @!attribute [r] email
+      #   @return [String]
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] name
+      #   @return [String]
+      class From < Qismo::Models::Base
+        attribute? :avatar_url, Types::String.optional
+        attribute? :email, Types::String.optional
+        attribute? :id, Types::Int.optional
+        attribute? :name, Types::String.optional
+      end
+
+      # @!attribute [r] comment_before_id
+      #   @return [Integer]
+      # @!attribute [r] created_at
+      #   @return [String]
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] payload
+      #   @return [Hash]
+      # @!attribute [r] text
+      #   @return [String]
+      # @!attribute [r] timestamp
+      #   @return [String]
+      # @!attribute [r] type
+      #   @return [String]
+      # @!attribute [r] unique_temp_id
+      #   @return [String]
+      # @!attribute [r] unix_nano_timestamp
+      #   @return [String]
+      # @!attribute [r] unix_timestamp
+      #   @return [String]
+      class Message < Qismo::Models::Base
+        attribute? :comment_before_id, Types::Int.optional
+        attribute? :created_at, Types::String.optional
+        attribute? :id, Types::Int.optional
+        attribute? :payload, Types::Hash.optional
+        attribute? :text, Types::String.optional
+        attribute? :timestamp, Types::String.optional
+        attribute? :type, Types::String.optional
+        attribute? :unique_temp_id, Types::String.optional
+        attribute? :unix_nano_timestamp, Types::String.optional
+        attribute? :unix_timestamp, Types::String.optional
+      end
+
+      # @!attribute [r] email
+      #   @return [String]
+      class Participant < Qismo::Models::Base
+        attribute? :email, Types::String.optional
+      end
+
+      # @!attribute [r] id
+      #   @return [String]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] options
+      #   @return [String]
+      # @!attribute [r] participants
+      #   @return [Array<Participant>]
+      # @!attribute [r] room_avatar
+      #   @return [String]
+      class Room < Qismo::Models::Base
+        attribute? :id, Types::String.optional
+        attribute? :name, Types::String.optional
+        attribute? :options, Types::String.optional
+        attribute? :participants, Types.Array(Participant.optional).optional
+        attribute? :room_avatar, Types::String.optional
+      end
+
+      # @!attribute [r] from
+      #   @return [From]
+      # @!attribute [r] message
+      #   @return [Message]
+      # @!attribute [r] room
+      #   @return [Room]
+      # @!attribute [r] type
+      #   @return [String]
+      class Payload < Qismo::Models::Base
+        attribute? :from, From.optional
+        attribute? :message, Message.optional
+        attribute? :room, Room.optional
+      end
+
+      attribute? :payload, Payload.optional
+    end
+  end
+end

data/lib/qismo/webhook_requests/on_message_for_bot_sent.rb

@@ -0,0 +1,95 @@
+module Qismo
+  module WebhookRequests
+    class OnMessageForBotSent < Qismo::Models::Base
+      # @!attribute [r] avatar_url
+      #   @return [String]
+      # @!attribute [r] email
+      #   @return [String]
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] name
+      #   @return [String]
+      class From < Qismo::Models::Base
+        attribute? :avatar_url, Types::String.optional
+        attribute? :email, Types::String.optional
+        attribute? :id, Types::Int.optional
+        attribute? :name, Types::String.optional
+      end
+
+      # @!attribute [r] comment_before_id
+      #   @return [Integer]
+      # @!attribute [r] created_at
+      #   @return [String]
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] payload
+      #   @return [Hash]
+      # @!attribute [r] text
+      #   @return [String]
+      # @!attribute [r] timestamp
+      #   @return [String]
+      # @!attribute [r] type
+      #   @return [String]
+      # @!attribute [r] unique_temp_id
+      #   @return [String]
+      # @!attribute [r] unix_nano_timestamp
+      #   @return [String]
+      # @!attribute [r] unix_timestamp
+      #   @return [String]
+      class Message < Qismo::Models::Base
+        attribute? :comment_before_id, Types::Int.optional
+        attribute? :created_at, Types::String.optional
+        attribute? :id, Types::Int.optional
+        attribute? :payload, Types::Hash.optional
+        attribute? :text, Types::String.optional
+        attribute? :timestamp, Types::String.optional
+        attribute? :type, Types::String.optional
+        attribute? :unique_temp_id, Types::String.optional
+        attribute? :unix_nano_timestamp, Types::String.optional
+        attribute? :unix_timestamp, Types::String.optional
+      end
+
+      # @!attribute [r] email
+      #   @return [String]
+      class Participant < Qismo::Models::Base
+        attribute? :email, Types::String.optional
+      end
+
+      # @!attribute [r] id
+      #   @return [String]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] options
+      #   @return [String]
+      # @!attribute [r] participants
+      #   @return [Array<Participant>]
+      # @!attribute [r] room_avatar
+      #   @return [String]
+      class Room < Qismo::Models::Base
+        attribute? :id, Types::String.optional
+        attribute? :name, Types::String.optional
+        attribute? :options, Types::String.optional
+        attribute? :participants, Types.Array(Participant.optional).optional
+        attribute? :room_avatar, Types::String.optional
+      end
+
+      # @!attribute [r] from
+      #   @return [From]
+      # @!attribute [r] message
+      #   @return [Message]
+      # @!attribute [r] room
+      #   @return [Room]
+      # @!attribute [r] type
+      #   @return [String]
+      class Payload < Qismo::Models::Base
+        attribute? :from, From.optional
+        attribute? :message, Message.optional
+        attribute? :room, Room.optional
+      end
+
+      # @!attribute [r] payload
+      #   @return [Payload]
+      attribute? :payload, Payload.optional
+    end
+  end
+end

data/lib/qismo/webhook_requests/on_new_session_initiated.rb

@@ -0,0 +1,170 @@
+module Qismo
+  module WebhookRequests
+    # @!attribute [r] is_new_session
+    #   @return [TrueClass,FalseClass]
+    # @!attribute [r] payload
+    #   @return [Payload]
+    # @!attribute [r] room_log
+    #   @return [RoomLog]
+    class OnNewSessionInitiated < Qismo::Models::Base
+      # @!attribute [r] avatar_url
+      #   @return [String]
+      # @!attribute [r] email
+      #   @return [String]
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] name
+      #   @return [String]
+      class From < Qismo::Models::Base
+        attribute? :avatar_url, Types::String.optional
+        attribute? :email, Types::String.optional
+        attribute? :id, Types::Int.optional
+        attribute? :name, Types::String.optional
+      end
+
+      # @!attribute [r] comment_before_id
+      #   @return [Integer]
+      # @!attribute [r] created_at
+      #   @return [String]
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] payload
+      #   @return [Hash]
+      # @!attribute [r] text
+      #   @return [String]
+      # @!attribute [r] timestamp
+      #   @return [String]
+      # @!attribute [r] type
+      #   @return [String]
+      # @!attribute [r] unique_temp_id
+      #   @return [String]
+      # @!attribute [r] unix_nano_timestamp
+      #   @return [String]
+      # @!attribute [r] unix_timestamp
+      #   @return [String]
+      class Message < Qismo::Models::Base
+        attribute? :comment_before_id, Types::Int.optional
+        attribute? :created_at, Types::String.optional
+        attribute? :id, Types::Int.optional
+        attribute? :payload, Types::Hash.optional
+        attribute? :text, Types::String.optional
+        attribute? :timestamp, Types::String.optional
+        attribute? :type, Types::String.optional
+        attribute? :unique_temp_id, Types::String.optional
+        attribute? :unix_nano_timestamp, Types::String.optional
+        attribute? :unix_timestamp, Types::String.optional
+      end
+
+      # @!attribute [r] email
+      #   @return [String]
+      class Participant < Qismo::Models::Base
+        attribute? :email, Types::String.optional
+      end
+
+      # @!attribute [r] id
+      #   @return [String]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] options
+      #   @return [String]
+      # @!attribute [r] participants
+      #   @return [Array<Participant>]
+      # @!attribute [r] room_avatar
+      #   @return [String]
+      class Room < Qismo::Models::Base
+        attribute? :id, Types::String.optional
+        attribute? :name, Types::String.optional
+        attribute? :options, Types::String.optional
+        attribute? :participants, Types.Array(Participant.optional).optional
+        attribute? :room_avatar, Types::String.optional
+      end
+
+      # @!attribute [r] from
+      #   @return [From]
+      # @!attribute [r] message
+      #   @return [Message]
+      # @!attribute [r] room
+      #   @return [Room]
+      # @!attribute [r] type
+      #   @return [String]
+      class Payload < Qismo::Models::Base
+        attribute? :from, From.optional
+        attribute? :message, Message.optional
+        attribute? :room, Room.optional
+      end
+
+      # @!attribute [r] key
+      #   @return [String]
+      # @!attribute [r] value
+      #   @return [String,Integer,TrueClass,FalseClass]
+      class UserProperty < Qismo::Models::Base
+        attribute? :key, Types::String.optional
+        attribute? :value, (Types::String.optional | Types::Int.optional | Types::Params::Bool.optional)
+      end
+
+      # @!attribute [r] timezone_offset
+      #   @return [String]
+      class AdditionalExtras < Qismo::Models::Base
+        attribute? :timezone_offset, Types::String
+      end
+
+      # @!attribute [r] additional_extras
+      #   @return [AdditionalExtras]
+      # @!attribute [r] notes
+      #   @return [String]
+      # @!attribute [r] timezone_offset
+      #   @return [String]
+      # @!attribute [r] user_properties
+      #   @return [Array<UserProperty>]
+      class Extras < Qismo::Models::Base
+        attribute? :additional_extras, AdditionalExtras.optional
+        attribute? :notes, Types::String
+        attribute? :timezone_offset, Types::String
+        attribute? :user_properties, Types.Array(UserProperty.optional).optional
+      end
+
+      # @!attribute [r] channel_id
+      #   @return [Integer]
+      # @!attribute [r] created_at
+      #   @return [String]
+      # @!attribute [r] extras
+      #   @return [String]
+      # @!attribute [r] has_no_message
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] is_waiting
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] resolved
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] room_badge
+      #   @return [String]
+      # @!attribute [r] room_id
+      #   @return [String]
+      # @!attribute [r] source
+      #   @return [String]
+      # @!attribute [r] user_avatar_url
+      #   @return [String]
+      # @!attribute [r] user_id
+      #   @return [String]
+      class RoomLog < Qismo::Models::Base
+        attribute? :channel_id, Types::Int
+        attribute? :created_at, Types::String
+        attribute? :extras, Extras
+        attribute? :has_no_message, Types::Bool
+        attribute? :is_waiting, Types::Nil
+        attribute? :name, Types::String
+        attribute? :resolved, Types::Bool
+        attribute? :room_badge, Types::String
+        attribute? :room_id, Types::String
+        attribute? :source, Types::String
+        attribute? :user_avatar_url, Types::String
+        attribute? :user_id, Types::String
+      end
+
+      attribute? :is_new_session, Types::Bool
+      attribute? :payload, Payload
+      attribute? :room_log, RoomLog
+    end
+  end
+end

data/lib/qismo/webhook_requests/on_room_resolved.rb

@@ -0,0 +1,81 @@
+module Qismo
+  module WebhookRequests
+    # @!attribute [r] customer
+    #   @return [Customer]
+    # @!attribute [r] resolved_by
+    #   @return [ResolvedBy]
+    # @!attribute [r] service
+    #   @return [Service]
+    class OnRoomResolved < Qismo::Models::Base
+      # @!attribute [r] key
+      #   @return [String]
+      # @!attribute [r] value
+      #   @return [String,Integer,TrueClass,FalseClass]
+      class AdditionalInfo < Qismo::Models::Base
+        attribute? :key, Types::String.optional
+        attribute? :value, (Types::String.optional | Types::Int.optional | Types::Params::Bool.optional)
+      end
+
+      # @!attribute [r] additional_info
+      #   @return [Array<AdditionalInfo>]
+      # @!attribute [r] avatar
+      #   @return [String]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] user_id
+      #   @return [String]
+      class Customer < Qismo::Models::Base
+        attribute? :additional_info, Types.Array(AdditionalInfo.optional).optional
+        attribute? :avatar, Types::String.optional
+        attribute? :name, Types::String.optional
+        attribute? :user_id, Types::String.optional
+      end
+
+      # @!attribute [r] email
+      #   @return [String]
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] is_available
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] type
+      #   @return [String]
+      class ResolvedBy < Qismo::Models::Base
+        attribute? :email, Types::String.optional
+        attribute? :id, Types::Int.optional
+        attribute? :is_available, Types::Bool.optional
+        attribute? :name, Types::String.optional
+        attribute? :type, Types::String.optional
+      end
+
+      # @!attribute [r] first_comment_id
+      #   @return [String]
+      # @!attribute [r] last_comment_id
+      #   @return [String]
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] is_resolved
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] notes
+      #   @return [String]
+      # @!attribute [r] room_id
+      #   @return [String]
+      # @!attribute [r] source
+      #   @return [String]
+      class Service < Qismo::Models::Base
+        attribute? :first_comment_id, Types::String.optional
+        attribute? :last_comment_id, Types::String.optional
+        attribute? :id, Types::Int.optional
+        attribute? :is_resolved, Types::Bool.optional
+        attribute? :notes, Types::String.optional
+        attribute? :room_id, Types::String.optional
+        attribute? :source, Types::String.optional
+      end
+
+      attribute? :customer, Customer
+      attribute? :resolved_by, ResolvedBy
+      attribute? :service, Service
+    end
+  end
+end

data/lib/qismo.rb

@@ -1,19 +1,31 @@
 # frozen_string_literal: true
 
 require "active_support/all"
+require "dry-struct"
 require "http"
 
-require "qismo/util"
 require "qismo/version"
+require "qismo/types"
+require "qismo/util"
+
+require "qismo/models/base"
+
+require "qismo/webhook_requests/on_agent_allocation_needed"
+require "qismo/webhook_requests/on_custom_button_clicked"
+require "qismo/webhook_requests/on_custom_channel_message_sent"
+require "qismo/webhook_requests/on_message_for_bot_sent"
+require "qismo/webhook_requests/on_new_session_initiated"
+require "qismo/webhook_requests/on_room_resolved"
+
 require "qismo/error"
 require "qismo/model"
 require "qismo/api"
 require "qismo/client"
 
 module Qismo
-  # @!parse extend Qismo::Api
-
   class << self
+    # @!parse extend Qismo::Api
+
     def configure
       yield client
 

data/qismo.gemspec

@@ -43,4 +43,5 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency("activesupport")
   spec.add_runtime_dependency("http")
+  spec.add_runtime_dependency("dry-struct", "~> 1.6")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qismo
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Qiscus Integration
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-08 00:00:00.000000000 Z
+date: 2022-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: Ruby wrapper for Qiscus Omnichannel public API
 email:
 - developer@qiscus.net
@@ -53,8 +67,17 @@ files:
 - lib/qismo/client.rb
 - lib/qismo/error.rb
 - lib/qismo/model.rb
+- lib/qismo/models/base.rb
+- lib/qismo/models/customer_room.rb
+- lib/qismo/types.rb
 - lib/qismo/util.rb
 - lib/qismo/version.rb
+- lib/qismo/webhook_requests/on_agent_allocation_needed.rb
+- lib/qismo/webhook_requests/on_custom_button_clicked.rb
+- lib/qismo/webhook_requests/on_custom_channel_message_sent.rb
+- lib/qismo/webhook_requests/on_message_for_bot_sent.rb
+- lib/qismo/webhook_requests/on_new_session_initiated.rb
+- lib/qismo/webhook_requests/on_room_resolved.rb
 - qismo.gemspec
 homepage: https://bitbucket.org/qiscus/qismo-rb
 licenses: