qismo 0.17.4 → 0.17.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32a1f3d54408a3ec4ac13282946090480b5e684537d8c37e8deca21ee37dab51
-  data.tar.gz: c5c9c893cb57b4b33f17fa384b24947888a26335418ee6b1841fcbd74ca5af2b
+  metadata.gz: 7a44082e18e6a2a83f52495239286434f94929f70ed04169719d54b31e3d222f
+  data.tar.gz: b4539c710a2172b0bdb7049d140d3cf197aa7e081507d6c1c12422e38eb7c8db
 SHA512:
-  metadata.gz: 6ae312acbe3a8805c115e4656e8f1d1385ec0ed891ee8637fa92ee625e0a765536d13f2409af429064f3ddd8b8f48dc7ab063ccde014daf5255dca0128340fe5
-  data.tar.gz: 9be35658b3ef3804a70ec74c67c4f99a1582a4e956fd1e9497e694fdf585c121879b79d0a8a586af8241a6b5fe84308ebbc2b7102daad8556879072db2fd6c78
+  metadata.gz: d53cfb2641b87854f7dd6dc5c96b228679e8c5fa96266b90085fb97e1bbe4a794cd12452d9f37123888c3cac07e30fc7915059eb362c269d46ec16468bb5b22f
+  data.tar.gz: 0a4550b86a6dd7e520bae304b3f59042fe3c4dee1b4ce315a25223f3d5f5635c3e55ed06a40ca94ca6f96ec698363611c57c696c11b80315b1c4540c06541f71

data/README.md

@@ -13,17 +13,8 @@ bundle add qismo
 ## Usage
 
 ```ruby
-# config/initializers/qismo.rb
-
-Qismo.configure do |client|
-  client.app_id           = ENV["QISCUS_APP_ID"]
-  client.secret_key       = ENV["QISCUS_SECRET_KEY"]
-end
-```
-
-Then, start requesting to available endpoint
+client = Qismo::Client.new(app_id: "QISCUS_APP_ID", secret_key: "QISCUS_SECRET_KEY")
 
-```ruby
 params = {
   channel: { channel_id: 12345, source: "wa" },
   status: "unresolved",
@@ -31,51 +22,33 @@ params = {
   is_handled_by_bot: true,
 }
 
-# List rooms
-rooms = Qismo.rooms(params)
+rooms = client.rooms(params)
 
 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"
-#   >
+#   #<Qismo::Objects::CustomerRoom
+#     channel_id=126392
+#     contact_id=21608346
+#     id=68303333
+#     is_handled_by_bot=true
+#     is_resolved=false
+#     is_waiting=false
+#     last_comment_sender="karm-gzu41e4e4dv9fu3f_admin@qismo.com"
+#     last_comment_sender_type="system"
+#     last_comment_text="bayu joined this conversation"
+#     last_comment_timestamp="2022-12-22T06:37:58Z"
+#     last_customer_comment_text=nil
+#     last_customer_timestamp="2022-12-19T13:32:51Z"
+#     name="Oyis"
+#     room_badge="https://d1edrlpyc25xu0.cloudfront.net/ods-cc6rmwouax2thbow3/image/upload/5sYxRCGJl_/qiscus_badge.svg"
+#     room_id=103513607
+#     room_type="individual"
+#     source="qiscus"
+#     user_avatar_url="https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png"
+#     user_id="nurcholisart@gmail.com">
 # ]
 ```
 
-## Multiple app id client initialization
-
-```ruby
-client = Qismo::Client.new(app_id: "QISCUS_APP_ID", secret_key: "QISCUS_SECRET_KEY")
-
-params = {
-  channel: { channel_id: 12345, source: "wa" },
-  status: "unresolved",
-  serve_status: "served",
-  is_handled_by_bot: true,
-}
-
-# This will produce same result as explained before
-client.rooms(params)
-```
-
 ## Client optional configuration
 
 Qismo ruby also provide some optional configuration that you can pass, they are:
@@ -182,10 +155,10 @@ Qiscus Omnichannel provide webhooks that triggered from various action on your a
 ```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(

data/lib/qismo/api.rb

@@ -21,7 +21,7 @@ module Qismo
     #   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>]
+    # @param user_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
@@ -29,8 +29,10 @@ module Qismo
     #   Next page cursor. If you are on last page, the cursor returned will be nil
     # @param cursor_before [String]
     #   Previous page cursor. If you are on first page, the cursor returned will be nil
+    # @param is_handled_by_bot [TrueClass,FalseClass]
+    #   Filter rooms by chatbot activation status in room
     # @return [Qismo::Collection<Qismo::CustomerRoom>]
-    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)
+    def rooms(channels: nil, status: nil, serve_status: nil, name: nil, limit: 50, tag_ids: nil, user_ids: nil, order: "desc", cursor_after: nil, cursor_before: nil, is_handled_by_bot: nil)
       body = post("/api/v2/customer_rooms", {
         channels: channels,
         status: status,
@@ -38,11 +40,12 @@ module Qismo
         name: name,
         limit: limit,
         tag_ids: tag_ids,
-        user_ids: agent_ids,
+        user_ids: user_ids,
         order: order,
         cursor_after: cursor_after,
-        cursor_before: cursor_before
-      }.compact)
+        cursor_before: cursor_before,
+        is_handled_by_bot: is_handled_by_bot
+      })
 
       Collection.new(
         Qismo::Objects::CustomerRoom.from_array(body.data.customer_rooms),
@@ -81,11 +84,12 @@ module Qismo
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#9737d580-d156-4213-85a8-95fb3f1ad964
     # @param room_id [Integer]
-    # @param tag_name [String]
+    # @param tag [String]
+    #   Tag name
     # @return [Qismo::Objects::Tag]
-    def add_room_tag(room_id:, tag_name:)
+    def add_room_tag(room_id:, tag:)
       Qismo::Objects::Tag.new(
-        post("/api/v2/room_tags/#{room_id}", tag: tag_name).data
+        post("/api/v2/room_tags/#{room_id}", tag: tag).data
       )
     end
 
@@ -173,23 +177,23 @@ module Qismo
     #
     # @param room_id [Integer]
     # @param agent_id [Integer]
-    # @param replace_agents [TrueClass,FalseClass]
+    # @param replace_latest_agent [TrueClass,FalseClass]
     #   Replace agents in room or not. Don't combine this param
     #   with :max_agent param
     # @param max_agent [Integer]
     #   Specify max agent that can be assigned to a room. For
     #   example, if there are 1 agent in a room and you specific
     #   max_agent to 1, you will get bad request error. If you set
-    #   param :relpace_agents to true, this param will be forced
+    #   param :replace_latest_agent 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_latest_agent: false, max_agent: nil)
       Qismo::Objects::User.new(
         post("/api/v1/admin/service/assign_agent", {
           room_id: room_id.to_s,
           agent_id: agent_id,
-          replace_latest_agent: replace_agents,
-          max_agent: (replace_agents == true) ? nil : max_agent
+          replace_latest_agent: replace_latest_agent,
+          max_agent: (replace_latest_agent == true) ? nil : max_agent
         }).data.assign_agent
       )
     end
@@ -221,19 +225,19 @@ module Qismo
     # @param notes [String]
     #   Specify room notes. You can also use simple markdown markup
     #   for this param
-    # @param send_email [TrueClass,FalseClass]
+    # @param is_send_email [TrueClass,FalseClass]
     #   Send email to customer or no. This param will only worked if
     #   you are using valid email as customer identifier
     # @param extras [Hash]
     #   Room extras in valid hash
     # @return [Qismo::Objects::AgentService]
-    def resolve_room(room_id:, last_comment_id: Time.now.to_i, notes: nil, send_email: false, extras: nil)
+    def resolve_room(room_id:, last_comment_id: Time.now.to_i, notes: nil, is_send_email: false, extras: nil)
       Qismo::Objects::AgentService.new(
         post("/api/v1/admin/service/mark_as_resolved", {
           room_id: room_id.to_s,
           last_comment_id: last_comment_id,
           notes: notes,
-          is_send_email: send_email,
+          is_send_email: is_send_email,
           extras: extras
         }).data.service
       )
@@ -310,16 +314,16 @@ module Qismo
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#0d5db283-c7f8-42e0-ba02-6cbcbc1d2bb3
     # @param room_id [Integer]
-    # @param available_in_room [TrueClass,FalseClass]
+    # @param is_available_in_room [TrueClass,FalseClass]
     # @param search [String]
     # @param limit [Integer]
     # @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:, is_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,
+        is_available_in_room: is_available_in_room,
         search: search,
         limit: limit,
         cursor_after: cursor_after,
@@ -430,7 +434,7 @@ module Qismo
     # List agents by ids
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#3db6c8c8-8ffe-4a88-b630-41f9d5b62298
-    # @param ids [Array<Integer>]
+    # @param agent_ids [Array<Integer>]
     # @return [Qismo::Collection<Qismo::Objects::User>]
     def agents_by_ids(agent_ids:)
       Qismo::Collection.new(
@@ -442,14 +446,21 @@ module Qismo
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#94eeb9cb-dd70-4baf-9f63-361e7922299a
     # @param division_ids [Array<Integer>]
-    # @param options [Hash]
+    # @param page [Integer]
+    #   Page number
+    # @param limit [Integer]
+    #   Number of data returned in one page
+    # @param is_available [TrueClass,FalseClass]
+    #   Filter only available or unavailable agents
+    # @param sort [String]
+    #   Sort result by descending or ascending
     # @return [Qismo::Collection<Qismo::Objects::User>]
-    def agents_by_divisions(division_ids, page: 1, limit: 10, available: nil, sort: "asc")
+    def agents_by_divisions(division_ids, page: 1, limit: 10, is_available: nil, sort: "asc")
       body = get("/api/v2/admin/agents/by_division", {
         "division_ids[]": division_ids,
         page: page,
         limit: limit,
-        is_available: available,
+        is_available: is_available,
         sort: sort
       })
 
@@ -482,7 +493,12 @@ module Qismo
     # List WA broadcast templates
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#e38d2244-9559-4015-99d5-8c707f6c01bd
-    # @param options [Hash]
+    # @param page [Integer]
+    #   Page number
+    # @param limit [Integer]
+    #   Number of data returned in one page
+    # @param approved [TrueClass,FalseClass]
+    #   Filter template by approval status
     # @return [Qismo::Collection<Qismo::Objects::HsmTemplate>]
     def wa_broadcast_templates(page: 1, limit: 10, approved: nil)
       body = get("/api/v3/admin/hsm", {
@@ -561,6 +577,7 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#030acde2-21cf-4373-8d11-075206053c1d
     # @param file [HTTP::FormData]
     # @param template_detail_id [Integer]
+    # @param separator [String]
     # @return [Integer]
     def upload_wa_broadcast_csv(file:, template_detail_id:, separator: ",")
       raise ArgumentError, "Invalid file" unless file.is_a?(HTTP::FormData::File)

data/lib/qismo/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qismo
 version: !ruby/object:Gem::Version
-  version: 0.17.4
+  version: 0.17.6
 platform: ruby
 authors:
 - Qiscus Integration