qismo 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbb77849305f7812a453eefbea9e5f288ede162774aadb8f638760ae6349b519
-  data.tar.gz: e5f4fd6c8bbae34bc30707cd08f629ac32932b20f10a73307edd8689707ab532
+  metadata.gz: e06efa610df2f136d4775f01ba27d50b6f65576d7cc510024a903eff84547a8b
+  data.tar.gz: 4b3c9685a3c8600a7ea21577648f438fcfa7f76dbd8cf9e6b21a31148f29fd09
 SHA512:
-  metadata.gz: 292760f08f8b16bf5093916564ee4ea0e3f641c7e51ca4c0e65aa6a54bbb3e67a83204a1b087a9e60d7fdcfd5dbced2179e6334b783f87e0570fae5f8f762b1d
-  data.tar.gz: 5af35068e56009c635b0e43af48c2b51517095c610e29ea3d353f5519d4ed29935cee99158cf88a896945607f4c215895037e682c06e39dd45ec90863ef1f234
+  metadata.gz: a374d557e090a13205779073e45bf997922d7f7f874a240f11a2eb74aa7cc39a847c3220e4053b032ec2b97aa6329e522238fa444b1e722d63b6ab5e77283ed6
+  data.tar.gz: '07249fcc6d6d69b4693ac7e20ca6f2aa9909bb9fb5049a3d15b171fbaf2a6cf5b267867b75bf199031ef9ff1c872b7d22bb55c26c1e5ac91247e07ac293c21dc'

data/lib/qismo/api.rb

@@ -1,39 +1,49 @@
 # frozen_string_literal: true
 
 module Qismo
+  # API wrappers
+  #
   module Api
     # @!parse include Qismo::Client
 
     # List customer rooms
     #
-    # @see https://s.id/list-customer-rooms
-    # @param options [Hash]
-    #   List room optional filters
-    # @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
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#704a0c40-56b2-4a94-9c1d-e1529923cbb6
+    # @param channels [Array<Hash>]
+    #   Filter rooms by channels. Example: [{ source: "wa", channel_id: 716171 }]
+    # @param status [String]
+    #   Filter rooms by status. Valid values are "resolved", "unresolved", "expired",or "almost_expired"
+    # @param serve_status [String]
+    #   Filter rooms by serve status. Valid values are "served" or "unserved". By default, we will retrieve all serve_status
+    # @param name [String]
+    #   Filter rooms by customer nam
+    # @param limit [Integer]
+    #   Limit the number of rooms returned in one page. By default, it will return 50 rooms data
+    # @param tag_ids [Array<Integer>]
+    #   Filter rooms by its tag
+    # @param agent_ids [Array<Integer>]
+    #   Filter rooms by the agent who handled the rooms
+    # @param order [String]
+    #   Order returned data by the timestamp. By default, we will return the newest rooms first
+    # @param cursor_after [String]
     #   Next page cursor. If you are on last page, the cursor returned will be nil
-    # @option options [String] :cursor_before
+    # @param cursor_before [String]
     #   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::Collection<Qismo::CustomerRoom>]
-    def rooms(options = {})
-      body = post("/api/v2/customer_rooms", options)
+    def rooms(channels: nil, status: nil, serve_status: nil, name: nil, limit: 50, tag_ids: nil, agent_ids: nil, order: "desc", cursor_after: nil, cursor_before: nil)
+      body = post("/api/v2/customer_rooms", json: {
+        channels: channels,
+        status: status,
+        serve_status: serve_status,
+        name: name,
+        limit: limit,
+        tag_ids: tag_ids,
+        user_ids: agent_ids,
+        order: order,
+        cursor_after: cursor_after,
+        cursor_before: cursor_before
+      }.compact)
+
       Collection.new(
         Qismo::Objects::CustomerRoom.from_array(body.data.customer_rooms),
         next_page: body.meta.cursor_after,
@@ -42,10 +52,10 @@ module Qismo
     end
 
     # Get room by id
-    # @see https://s.id/get-room-by-room-id
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#8c803377-eea2-4879-9d66-8906d9f41275
     # @param room_id [Integer]
-    # @return [Qismo::SingleObject]
-    def room(room_id)
+    # @return [Qismo::Objects::CustomerRoom]
+    def room(room_id:)
       body = get("/api/v2/customer_rooms/#{room_id}")
       if body.data.customer_room.nil?
         raise Qismo::NotFoundError.new("Room not found", status_code: 404, response_body: body.to_json)
@@ -56,10 +66,10 @@ module Qismo
 
     # List tags inside room
     #
-    # @see https://s.id/list-room-tags
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#d40b54a7-2b37-4afc-b474-62593001274e
     # @param room_id [Integer]
     # @return [Qismo::Collection<Qismo::Objects::Tag>]
-    def room_tags(room_id)
+    def room_tags(room_id:)
       Qismo::Collection.new(
         Qismo::Objects::Tag.from_array(
           get("/api/v2/room_tags/#{room_id}").data
@@ -69,33 +79,33 @@ module Qismo
 
     # Add room tag
     #
-    # @see https://s.id/add-room-tag
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#9737d580-d156-4213-85a8-95fb3f1ad964
     # @param room_id [Integer]
     # @param tag_name [String]
     # @return [Qismo::Objects::Tag]
-    def add_room_tag(room_id, tag_name)
+    def add_room_tag(room_id:, tag_name:)
       Qismo::Objects::Tag.new(
-        post("/api/v2/room_tags/#{room_id}", tag: tag_name).data
+        post("/api/v2/room_tags/#{room_id}", tag_name: tag).data
       )
     end
 
     # Delete room tag
     #
-    # @see https://s.id/delete-room-tag
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#f4d173a1-3fb1-4151-87fd-106982bcc4a2
     # @param room_id [Integer]
     # @param tag_id [Integer]
     # @return [TrueClass]
-    def delete_room_tag(room_id, tag_id)
+    def delete_room_tag(room_id:, tag_id:)
       delete("/api/v2/room_tags/#{room_id}/#{tag_id}")
       true
     end
 
     # List room additional info
     #
-    # @see https://s.id/list-room-info
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#88c2287b-21af-4afd-b495-aaaa2818c381
     # @param room_id [Integer]
     # @return [Array<Qismo::Objects::RoomAdditionalInfo>]
-    def room_additional_info(room_id)
+    def room_additional_info(room_id:)
       Qismo::Objects::RoomAdditionalInfo.from_array(
         get("/api/v1/qiscus/room/#{room_id}/user_info").data.extras.user_properties
       )
@@ -107,17 +117,17 @@ module Qismo
 
     # Set room additional info
     #
-    # @see https://s.id/set-room-info
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#2b968e9e-2a76-4569-8763-f883e11dc5a7
     # @note This will replace your current room additional info
     # @param room_id [Integer]
-    # @param additional_info [Array<Hash>]
+    # @param info [Array<Hash>]
     #   Key value pair of additional info. Ex: [{ key: "Ticket Link", value: "https://ticket.com" }]
     # @return [Array<Qismo::Objects::RoomAdditionalInfo>]
-    def set_room_additional_info(room_id, additional_info)
+    def set_room_additional_info(room_id:, info:)
       Qismo::Objects::RoomAdditionalInfo.from_array(
         post(
           "/api/v1/qiscus/room/#{room_id}/user_info",
-          user_properties: additional_info
+          user_properties: info
         ).data.extras.user_properties
       )
     end
@@ -129,31 +139,24 @@ module Qismo
     # Update room additional info
     #
     # @param room_id [Integer]
-    # @param additional_info [Array<Hash>]
+    # @param info [Array<Hash>]
     #   Key value pair of additional info. Ex: [{ key: "Ticket Link", value: "https://ticket.com" }]
     # @return [Array<Qismo::Objects::RoomAdditionalInfo>]
-    def update_room_additional_info(room_id, additional_info)
-      old_additional_info = room_additional_info(room_id).as_json
-      new_additional_info = (additional_info.as_json + old_additional_info).uniq { |h| h.values_at("key") }
-      set_room_additional_info(room_id, new_additional_info)
+    def update_room_additional_info(room_id:, info:)
+      old_info = room_additional_info(room_id).as_json
+      new_info = (info.as_json + old_info).uniq { |h| h.values_at("key") }
+      set_room_additional_info(room_id: room_id, info: new_info)
     end
 
     alias_method :update_room_info, :update_room_additional_info
 
-    # List Whatsapp broadcast history inside room
-    #
-    # @see https://s.id/list-room-broadcast-history
-    # @param room_id [Integer]
-    # @param options [Hash]
-    # @return [Qismo::CollectionObject]
-
     # List broadcast history inside room
     #
     # @param room_id [Integer]
     # @param page [Integer]
     # @param limit [Integer]
     # @return [Qismo::Collection<Qismo::Objects::BroadcastLog>]
-    def room_broadcast_history(room_id, page: 1, limit: 25)
+    def room_broadcast_history(room_id:, page: 1, limit: 25)
       body = get("/api/v2/customer_rooms/#{room_id}/broadcast_history", {
         page: page,
         limit: limit
@@ -180,7 +183,7 @@ module Qismo
     #   param :relpace_agents to true, this param will be forced
     #   to nil, which no be sent on http request
     # @return [Qismo::Objects::User]
-    def assign_agent(room_id, agent_id, replace_agents: false, max_agent: nil)
+    def assign_agent(room_id:, agent_id:, replace_agents: false, max_agent: nil)
       Qismo::Objects::User.new(
         post("/api/v1/admin/service/assign_agent", {
           room_id: room_id.to_s,
@@ -193,11 +196,11 @@ module Qismo
 
     # Remove agent from room
     #
-    # @see https://s.id/remove-agent
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#7a67e214-28e5-47c1-b4ee-7246977dfcff
     # @param room_id [Integer]
     # @param agent_id [Integer]
     # @return [TrueClass]
-    def remove_agent(room_id, agent_id)
+    def remove_agent(room_id:, agent_id:)
       post(
         "/api/v1/admin/service/remove_agent", {
           room_id: room_id.to_s,
@@ -210,7 +213,7 @@ module Qismo
 
     # Resolve room
     #
-    # @see https://s.id/resolve-room
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#a1ff75d0-b637-4b79-a259-fb9d084d1659
     # @param room_id [Integer]
     # @param last_comment_id [Integer]
     #   Id of last message in the room. If you dont specify this param,
@@ -223,8 +226,8 @@ module Qismo
     #   you are using valid email as customer identifier
     # @param extras [Hash]
     #   Room extras in valid hash
-    # @return [Qismo::SingleObject]
-    def resolve_room(room_id, last_comment_id: Time.now.to_i, notes: nil, send_email: false, extras: nil)
+    # @return [Qismo::Objects::AgentService]
+    def resolve_room(room_id:, last_comment_id: Time.now.to_i, notes: nil, send_email: false, extras: nil)
       Qismo::Objects::AgentService.new(
         post("/api/v1/admin/service/mark_as_resolved", {
           room_id: room_id.to_s,
@@ -240,7 +243,7 @@ module Qismo
 
     # Get agent that can be assigned to room
     #
-    # @see https://s.id/allocate-agent
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#a62432c6-1aba-4e2b-be9a-2f7151db9119
     # @param source [String]
     #   Channel source. Available sources are `wa`, `line`, `telegram`,
     #   `qiscus`, `ig`, or `fb`. For custom channel, use that channel's
@@ -251,7 +254,7 @@ module Qismo
     #   Ignore agent availability. If you set this param to true, agent
     #   that are unavailable will be considered as allocatable too
     # @return [Qismo::Objects::User]
-    def allocate_agent(source, channel_id, ignore_availability: false)
+    def allocate_agent(source:, channel_id:, ignore_availability: false)
       Qismo::Objects::User.new(
         post("/api/v1/admin/service/allocate_agent", {
           source: source,
@@ -263,13 +266,13 @@ module Qismo
 
     # Get agent that can be allocated to room and automatically assign them
     #
-    # @see https://s.id/allocate-and-assign-agent
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#f88465ed-379f-4202-a8a4-e0c3bebcfeab
     # @param room_id [Integer]
     # @param ignore_availability [TrueClass,FalseClass]
     #   Ignore agent availability. If you set this param to true, agent
     #   that are unavailable will be considered as allocatable too
-    # @return [Qismo::SingleObject]
-    def allocate_and_assign_agent(room_id, ignore_availability: false)
+    # @return [Qismo::Objects::User]
+    def allocate_and_assign_agent(room_id:, ignore_availability: false)
       Qismo::Objects::User.new(
         post("/api/v1/admin/service/allocate_assign_agent", {
           room_id: room_id.to_s,
@@ -280,14 +283,14 @@ module Qismo
 
     # List agents that are not in room and can be assigned to room
     #
-    # @see https://s.id/list-other-agents
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#10d75d0c-ebd2-44c6-ab19-a0bafe7ad982
     # @param room_id [Integer]
     # @param search [String]
     # @param limit [Integer]
     # @param cursor_after [String]
     # @param cursor_before [String]
     # @return [Qismo::Collection<Qismo::Objects::User>]
-    def other_agents(room_id, search: nil, limit: 15, cursor_after: nil, cursor_before: nil)
+    def other_agents(room_id:, search: nil, limit: 15, cursor_after: nil, cursor_before: nil)
       body = get("/api/v2/admin/service/other_agents", {
         room_id: room_id.to_s,
         search: search,
@@ -305,7 +308,7 @@ module Qismo
 
     # List available agents in room
     #
-    # @see https://s.id/list-available-agents
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#0d5db283-c7f8-42e0-ba02-6cbcbc1d2bb3
     # @param room_id [Integer]
     # @param available_in_room [TrueClass,FalseClass]
     # @param search [String]
@@ -313,7 +316,7 @@ module Qismo
     # @param cursor_after [String]
     # @param cursor_before [String]
     # @return [Qismo::Collection<Qismo::Objects::User>]
-    def available_agents(room_id, available_in_room: true, search: nil, limit: 15, cursor_after: nil, cursor_before: nil)
+    def available_agents(room_id:, available_in_room: true, search: nil, limit: 15, cursor_after: nil, cursor_before: nil)
       body = get("/api/v2/admin/service/available_agents", {
         room_id: room_id.to_s,
         is_available_in_room: available_in_room,
@@ -346,7 +349,7 @@ module Qismo
     # @param url [String]
     # @param enabled [TrueClass,FalseClass]
     # @return [Qismo::Objects::Webhook]
-    def set_new_session_webhook(url, enabled: true)
+    def set_new_session_webhook(url:, enabled: true)
       config = post("/api/v2/app/config/new_session_webhook", url: url, enabled: enabled).data.configs
       Qismo::Objects::Webhook.new(
         enabled: config.is_new_session_webhook_enabled,
@@ -356,7 +359,7 @@ module Qismo
 
     # Get auth webhook config
     #
-    # @return [Qismo::SingleObject]
+    # @return [Qismo::Objects::Webhook]
     def auth_webhook
       config = get("/api/v2/app/config/auth_webhook").data.configs
       Qismo::Objects::Webhook.new(
@@ -369,8 +372,8 @@ module Qismo
     #
     # @param url [String]
     # @param enabled [TrueClass, FalseClass]
-    # @return [Qismo::SingleObject]
-    def set_auth_webhook(url, enabled: true)
+    # @return [Qismo::Objects::Webhook]
+    def set_auth_webhook(url:, enabled: true)
       config = post("/api/v2/app/config/auth_webhook", url: url, enabled: enabled).data.configs
       Qismo::Objects::Webhook.new(
         enabled: config.is_auth_webhook_enabled,
@@ -394,7 +397,7 @@ module Qismo
     # @param url [String]
     # @param options [Hash]
     # @return [Qismo::Objects::Webhook]
-    def set_resolve_webhook(url, enabled: true)
+    def set_resolve_webhook(url:, enabled: true)
       config = post("/api/v1/app/webhook/mark_as_resolved", webhook_url: url, is_webhook_enabled: enabled).data
       Qismo::Objects::Webhook.new(
         enabled: config.is_mark_as_resolved_webhook_enabled,
@@ -429,9 +432,9 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#3db6c8c8-8ffe-4a88-b630-41f9d5b62298
     # @param ids [Array<Integer>]
     # @return [Qismo::Collection<Qismo::Objects::User>]
-    def agents_by_ids(ids)
+    def agents_by_ids(agent_ids:)
       Qismo::Collection.new(
-        Qismo::Objects::User.from_array(get("/api/v1/admin/agents/get_by_ids", {"ids[]": ids}).data)
+        Qismo::Objects::User.from_array(get("/api/v1/admin/agents/get_by_ids", {"ids[]": agent_ids}).data)
       )
     end
 
@@ -462,7 +465,7 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#c6184a6b-ba4d-4f3e-a4da-c6d0fa4597af
     # @param agent_id [Integer]
     # @return [Qismo::Objects::User]
-    def agent(agent_id)
+    def agent(agent_id:)
       Qismo::Objects::User.new(get("/api/v2/admin/agent/#{agent_id}").data.agent)
     end
 
@@ -480,7 +483,7 @@ module Qismo
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#e38d2244-9559-4015-99d5-8c707f6c01bd
     # @param options [Hash]
-    # @return [Qismo::CollectionObject]
+    # @return [Qismo::Collection<Qismo::Objects::HsmTemplate>]
     def wa_broadcast_templates(page: 1, limit: 10, approved: nil)
       body = get("/api/v3/admin/hsm", {
         page: page,
@@ -559,7 +562,7 @@ module Qismo
     # @param file [HTTP::FormData]
     # @param template_detail_id [Integer]
     # @return [Integer]
-    def upload_wa_broadcast_csv(file, template_detail_id, separator: ",")
+    def upload_wa_broadcast_csv(file:, template_detail_id:, separator: ",")
       raise ArgumentError, "Invalid file" unless file.is_a?(HTTP::FormData::File)
 
       body = post_upload("/api/v3/admin/broadcast/upload_csv", {
@@ -580,7 +583,7 @@ module Qismo
     # @param separator [String]
     # @param started_at [Time]
     # @return [Qismo::Objects::BroadcastJob]
-    def send_wa_broadcast(file, template_detail_id, name: nil, separator: ",", started_at: nil)
+    def send_wa_broadcast(file:, template_detail_id:, name: nil, separator: ",", started_at: nil)
       if name.blank?
         name = default_broadcast_name
       end
@@ -614,12 +617,6 @@ module Qismo
 
     alias_method :create_wa_broadcast, :send_wa_broadcast
 
-    # List wa broadcast jobs
-    #
-    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#3a4caa8b-eef4-427f-adcb-d065989899c9
-    # @param options [Hash]
-    # @return [Qismo::CollectionObject]
-
     # List WA broadcast jobs
     #
     # @param page [Integer]
@@ -648,7 +645,7 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#ed0806c8-2e4a-4ea4-8acb-45c84c63c2da
     # @param broadcast_job_id [Integer]
     # @return [Qismo::Objects::BroadcastJob]
-    def wa_broadcast_job(broadcast_job_id)
+    def wa_broadcast_job(broadcast_job_id:)
       Qismo::Objects::BroadcastJob.new(
         get("/api/v2/admin/broadcast_jobs/#{broadcast_job_id}").data.broadcast_job
       )
@@ -659,8 +656,8 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#3f2d8ba8-ab14-43b2-af82-74c8b766216f
     # @param broadcast_job_id [Integer]
     # @param options [Hash]
-    # @return [Qismo::CollectionObject]
-    def wa_broadcast_logs(broadcast_job_id, page: 1, limit: 10)
+    # @return [Qismo::Collection<Qismo::Objects::BroadcastLog>]
+    def wa_broadcast_logs(broadcast_job_id:, page: 1, limit: 10)
       body = get("/api/v2/admin/broadcast_logs/#{broadcast_job_id}", {
         page: page,
         limit: limit
@@ -685,7 +682,7 @@ module Qismo
     # @param payload [Hash]
     # @param extras [Hash]
     # @return [TrueClass]
-    def send_bot_message(room_id, message, type: "text", payload: {}, extras: {})
+    def send_bot_message(room_id:, message:, type: "text", payload: {}, extras: {})
       body = post("/#{app_id}/bot", {
         sender_email: admin_email,
         room_id: room_id.to_s,
@@ -707,7 +704,7 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#494d825f-a49c-4b18-954e-eaaccb738bcd
     # @param room_id [Integer]
     # @return [TrueClass]
-    def enable_bot_in_room(room_id)
+    def enable_bot_in_room(room_id:)
       post("/bot/#{room_id}/activate", is_active: true)
       true
     end
@@ -717,7 +714,7 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#494d825f-a49c-4b18-954e-eaaccb738bcd
     # @param room_id [Integer]
     # @return [TrueClass]
-    def disable_bot_in_room(room_id)
+    def disable_bot_in_room(room_id:)
       post("/bot/#{room_id}/activate", is_active: false)
       true
     end
@@ -727,7 +724,7 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#40867e85-7412-4e0d-84bd-e2506df23df8
     # @param room_id [Integer]
     # @return [TrueClass]
-    def handover_room_from_bot(room_id)
+    def handover_room_from_bot(room_id:)
       request(:post, "/#{app_id}/bot/#{room_id}/hand_over", headers: {
         Authorization: secret_key
       })
@@ -735,31 +732,23 @@ module Qismo
       true
     end
 
-    # Handover room from chatbot to human agent in specific divisions
-    #
-    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#8218db08-9753-4d74-ae5f-0ee62f8579b9
-    # @param room_id [Integer]
-    # @param roles [Array<Integer>]
-    # @param options [Hash]
-    # @return [TrueClass]
-
     # Handover room from chatbot to human agent in specific divisions
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#8218db08-9753-4d74-ae5f-0ee62f8579b9# <Description>
     #
     # @param room_id [Integer]
-    # @param role [Integer,Array<Integer>]
+    # @param roles [Integer,Array<Integer>]
     # @param find_online_agent [TrueClass,FalseClass]
     # @return [TrueClass,FalseClass]
-    def handover_room_from_bot_to_division(room_id, role, find_online_agent: true)
+    def handover_room_from_bot_to_division(room_id:, roles:, find_online_agent: true)
       options = {}
       options[:room_id] = room_id.to_s
       options[:find_online_agent] = find_online_agent
 
-      if role.is_a?(Array)
-        options[:roles] = role
+      if roles.is_a?(Array)
+        options[:roles] = roles
       else
-        options[:role] = role
+        options[:role] = roles
       end
 
       request(
@@ -777,24 +766,44 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#d5a555de-59e0-4705-9582-c216d79e9390
     # @param user_id [String]
     # @param name [String]
-    # @param options [Hash]
-    # @return [Qismo::SingleObject]
-    def initiate_widget_chat(user_id, name, options = {})
-      options = options.merge(app_id: app_id, user_id: user_id, name: name)
+    # @param nonce [String]
+    # @param channel_id [Integer]
+    # @param extras [Hash]
+    # @param reset_extras [TrueClass,FalseClass]
+    # @param room_badge [String]
+    # @param avatar [String]
+    # @param allocate_agent [TrueClass,FalseClass]
+    # @param user_properties [Hash]
+    # @param sdk_user_extras [Hash]
+    # @param timezone_offset [String]
+    # @param notes [String]
+    # @param phone_number [String]
+    # @param email [String]
+    # @return [Qismo::Objects::CustomerRoom]
+    def initiate_widget_chat(user_id:, name:, nonce: nil, channel_id: nil, extras: nil, reset_extras: false, room_badge: nil, avatar: nil, allocate_agent: nil, user_properties: nil, sdk_user_extras: nil, timezone_offset: nil, notes: nil, phone_number: nil, email: nil)
+      options = {
+        user_id: user_id,
+        name: name,
+        nonce: nonce,
+        channel_id: channel_id,
+        extras: extras,
+        reset_extras: reset_extras,
+        room_badge: room_badge,
+        avatar: avatar,
+        allocate_agent: allocate_agent,
+        user_properties: user_properties,
+        sdk_user_extras: sdk_user_extras,
+        timezone_offset: timezone_offset,
+        notes: notes,
+        phone_number: phone_number,
+        email: email
+      }.compact
+
       Qismo::Objects::CustomerRoom.new(post("/api/v2/qiscus/initiate_chat", options).data.customer_room)
     end
 
     alias_method :initiate_chat, :initiate_widget_chat
 
-    # Send message to custom channel
-    #
-    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#aee54b21-68f1-4d31-9d81-d3c73b3e125b
-    # @param identifier_key [String]
-    # @param user_id [String]
-    # @param name [String]
-    # @param options [Hash]
-    # @return [Qismo::SingleObject]
-
     # Send messsage to custom channel
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#aee54b21-68f1-4d31-9d81-d3c73b3e125b
@@ -808,10 +817,10 @@ module Qismo
     # @param extras [Hash]
     # @return [Qismo::Objects::CustomChannelMessageResponse]
     def send_message_to_custom_channel(
-      identifier_key,
-      user_id,
-      name,
-      message,
+      identifier_key:,
+      user_id:,
+      name:,
+      message:,
       avatar: nil,
       type: "text",
       payload: {},
@@ -834,9 +843,11 @@ module Qismo
     # List integrated channels
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#aee54b21-68f1-4d31-9d81-d3c73b3e125b
-    # @return [Qismo::ObjectifiedHash]
+    # @return [Qismo::Objects::ListChannelsResponse]
     def channels
-      get("/api/v2/channels").data
+      Qismo::Objects::ListChannelsResponse.new(
+        get("/api/v2/channels").data
+      )
     end
   end
 end

data/lib/qismo/client.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Qismo
+  # Qismo ruby client
+  #
   class Client
     include Qismo::Api
 
@@ -44,7 +46,6 @@ module Qismo
     # @param body [Hash]
     # @return [Qismo::ObjectifiedHash]
     def post(path, body = {})
-      puts body.to_json
       request(:post, path, json: body.compact)
     end
 
@@ -86,9 +87,6 @@ module Qismo
     def request(method, path, options = {})
       res = connection.request(method, @url + path, options.compact)
 
-      # require "byebug"
-      # byebug
-
       if res.status.success?
         begin
           return JSON.parse(res.to_s, object_class: Qismo::ObjectifiedHash)
@@ -170,6 +168,9 @@ module Qismo
       "#{format[:lib_name]}/#{format[:lib_version]} (#{format[:platform]}; #{format[:lang]}; v#{format[:lang_version]}) app_id:#{@app_id}"
     end
 
+    # Default broadcast name for using in send broadcast api
+    #
+    # @return [String]
     def default_broadcast_name
       Time.current.strftime("%d/%m/%Y, %H:%I %z")
     end

data/lib/qismo/collection.rb

@@ -1,4 +1,6 @@
 module Qismo
+  # Class to handle paginated response from API
+  #
   class Collection < Array
     # Collection object
     #

data/lib/qismo/object.rb

@@ -1,6 +1,8 @@
 require "dry-struct"
 
 module Qismo
+  # Object interface
+  #
   class Object < Dry::Struct
     include Qismo::Types