qismo 0.8.7 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e2ec0fd1f33602149f8bdee9c1f197470c9bac2f381460fd7ade574a3106941
-  data.tar.gz: c08c1226ba080a9b42c114cf4e742efca2dc57c69d629c9402561c0fcb302b9a
+  metadata.gz: dbfbe5dc426f29f2bab1875e42889d559b0fb0936d471343e6dd2088ac1c0cc1
+  data.tar.gz: ca61c1154a98b662dbe05b87d6340a5a423b7665908b7ae7baa1f296ff03b8df
 SHA512:
-  metadata.gz: 0e97d7caa322c1e60ad35316295fb1cf8107c3f9527abed5514e9ce83b20a1d141558356fe4fe825b259b849149402d71910a50d0e558dc358d581a8509c864d
-  data.tar.gz: 795bfb449d7d08bb654bdaee29486a29b654b98c69ad30fa736a3d1d12ecd8139a7776b96de07c651f371497d52f431837d86e010d6afd866a125399cc446172
+  metadata.gz: 58b646f0e706c9193f46f60c6aa31aa1572539bbb098718e75725c6f7b197436a68c52e001b7bc9a46ea4fe04dd258eee8e2fcbe3a656c1364a6375ad231907d
+  data.tar.gz: 3d154d41d5a1a763da397b3b245b6087e8a2456028cfdabe32076471956491ca314931c9fc4d5d4340bbd2bd9c1b39281808310b664ad7e934d36ff4cea1dde8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qismo (0.8.6)
+    qismo (0.8.8)
       activesupport
       http
 

data/lib/qismo/api.rb

@@ -2,7 +2,11 @@
 
 module Qismo
   module Api
-    def rooms(**opt)
+    # List customer rooms
+    #
+    # @param opt [Hash]
+    # @return [Qismo::Collection]
+    def rooms(opt = {})
       body = post("/api/v2/customer_rooms", opt)
       Collection.new(
         body.data.customer_rooms,
@@ -13,6 +17,10 @@ module Qismo
       )
     end
 
+    # Get room by id
+    #
+    # @param room_id [Integer]
+    # @return [Qismo::DataObject]
     def room(room_id)
       body = get("/api/v2/customer_rooms/#{room_id}")
       if body.data.customer_room.nil?
@@ -22,36 +30,70 @@ module Qismo
       body.data.customer_room
     end
 
+    # List tags inside room
+    #
+    # @param room_id [Integer]
+    # @return [Qismo::DataObject]
     def room_tags(room_id)
       get("/api/v2/room_tags/#{room_id}").data
     end
 
+    # Add room tag
+    #
+    # @param room_id [Integer]
+    # @param tag [String]
+    # @return [Qismo::DataObject]
     def add_room_tag(room_id, tag)
       post("/api/v2/room_tags/#{room_id}", tag: tag).data
     end
 
+    # Delete room tag
+    #
+    # @param room_id [Integer]
+    # @param tag_id [Integer]
+    # @return [TrueClass]
     def delete_room_tag(room_id, tag_id)
       delete("/api/v2/room_tags/#{room_id}/#{tag_id}")
       true
     end
 
+    # List room additional info
+    #
+    # @param room_id [Integer]
+    # @return [Qismo::DataObject]
     def room_additional_info(room_id)
       body = get("/api/v1/qiscus/room/#{room_id}/user_info")
       body.data.extras.user_properties
     end
 
+    # Set room additional info
+    #
+    # @note This will replace your current room additional info
+    # @param room_id [Integer]
+    # @param *additional_info [Array<Hash>]
+    # @return [Qismo::DataObject]
     def set_room_additional_info(room_id, *additional_info)
       body = post("/api/v1/qiscus/room/#{room_id}/user_info", user_properties: additional_info)
       body.data.extras.user_properties
     end
 
+    # Update room additional info
+    #
+    # @param room_id [Integer]
+    # @param *additional_info [Array]
+    # @return [Qismo::DataObject]
     def update_room_additional_info(room_id, *additional_info)
       old_additional_info = room_additional_info(room_id)
       new_additional_info = (additional_info + old_additional_info).uniq { |h| h.values_at("key") }
       set_room_additional_info(room_id, *new_additional_info)
     end
 
-    def room_broadcast_history(room_id, **opt)
+    # List Whatsapp broadcast history inside room
+    #
+    # @param room_id [Integer]
+    # @param opt [Hash]
+    # @return [Qismo::Collection]
+    def room_broadcast_history(room_id, opt = {})
       body = get("/api/v2/customer_rooms/#{room_id}/broadcast_history", opt)
 
       next_page = body.meta.page < body.meta.total_page ? (body.meta.page + 1) : nil
@@ -66,35 +108,67 @@ module Qismo
       )
     end
 
-    def assign_agent(room_id, agent_id, **opt)
+    # Assign agent to room
+    #
+    # @param room_id [Integer]
+    # @param agent_id [Integer]
+    # @param opt [Hash]
+    # @return [Qismo::DataObject]
+    def assign_agent(room_id, agent_id, opt = {})
       body = post("/api/v1/admin/service/assign_agent", opt.merge(room_id: room_id.to_s, agent_id: agent_id))
       body.data.added_agent
     end
 
+    # Remove agent from room
+    #
+    # @param room_id [Integer]
+    # @param agent_id [Integer]
+    # @return [TrueClass]
     def remove_agent(room_id, agent_id)
       post("/api/v1/admin/service/remove_agent", room_id: room_id.to_s, agent_id: agent_id)
       true
     end
 
-    def resolve(room_id, last_comment_id, **opt)
+    # Resolve room
+    #
+    # @param room_id [Integer]
+    # @param last_comment_id [Integer]
+    # @param opt [Hash]
+    # @return [Qismo::DataObject]
+    def resolve_room(room_id, last_comment_id, opt = {})
       body = post("/api/v1/admin/service/mark_as_resolved",
         opt.merge(room_id: room_id.to_s, last_comment_id: last_comment_id))
       body.data.service
     end
 
-    alias_method :resolve_room, :resolve
+    alias_method :resolve, :resolve_room
 
-    def allocate_agent(source, **opt)
+    # Get agent that can be assigned to room
+    #
+    # @param source [String]
+    # @param opt [Hash]
+    # @return [Qismo::DataObject]
+    def allocate_agent(source, opt = {})
       body = post("/api/v1/admin/service/allocate_agent", opt.merge(source: source))
       body.data.agent
     end
 
-    def allocate_and_assign_agent(room_id, **opt)
+    # Get agent that can be allocated to room and automatically assign them
+    #
+    # @param room_id [Integer]
+    # @param opt [Hash]
+    # @return [Qismo::DataObject]
+    def allocate_and_assign_agent(room_id, opt = {})
       body = post("/api/v1/admin/service/allocate_assign_agent", opt.merge(room_id: room_id))
       body.data.agent
     end
 
-    def other_agents(room_id, **opt)
+    # List agents that are not in room and can be assigned to room
+    #
+    # @param room_id [Integer]
+    # @param opt [Hash]
+    # @return [Qismo::Collection]
+    def other_agents(room_id, opt = {})
       body = get("/api/v2/admin/service/other_agents", opt.merge(room_id: room_id))
       Collection.new(
         body.data.agents,
@@ -105,7 +179,12 @@ module Qismo
       )
     end
 
-    def available_agents(room_id, **opt)
+    # List available agents in room
+    #
+    # @param room_id [Integer]
+    # @param opt [Hash]
+    # @return [Qismo::Collection]
+    def available_agents(room_id, opt = {})
       body = get("/api/v2/admin/service/available_agents", opt.merge(room_id: room_id))
       Collection.new(
         body.data.agents,
@@ -116,31 +195,59 @@ module Qismo
       )
     end
 
+    # Get new session webhook config
+    #
+    # @return [Qismo::DataObject]
     def new_session_webhook
       get("/api/v2/app/config/new_session_webhook").data.configs
     end
 
-    def set_new_session_webhook(url, **opt)
+    # Set new session webhook
+    #
+    # @param url [String]
+    # @param opt [Hash]
+    # @return [Qismo::DataObject]
+    def set_new_session_webhook(url, opt = {})
       post("/api/v2/app/config/new_session_webhook", opt.merge(url: url)).data.configs
     end
 
+    # Get auth webhook config
+    #
+    # @return [Qismo::DataObject]
     def auth_webhook
       get("/api/v2/app/config/auth_webhook").data.configs
     end
 
-    def set_auth_webhook(url, **opt)
+    # Set auth webhook
+    #
+    # @param url [String]
+    # @param opt [Hash]
+    # @return [Qismo::DataObject]
+    def set_auth_webhook(url, opt = {})
       post("/api/v2/app/config/auth_webhook", opt.merge(url: url)).data.configs
     end
 
+    # Get resolve webhook config
+    #
+    # @return [Qismo::DataObject]
     def resolve_webhook
       get("/api/v1/app/webhook/mark_as_resolved").data
     end
 
-    def set_resolve_webhook(url, **opt)
+    # Set resolve webhook
+    #
+    # @param url [String]
+    # @param opt [Hash]
+    # @return [Qismo::DataObject]
+    def set_resolve_webhook(url, opt = {})
       post("/api/v1/app/webhook/mark_as_resolved", opt.merge(url: url)).data
     end
 
-    def agents(**opt)
+    # List agents
+    #
+    # @param opt [Hash]
+    # @return [Qismo::Collection]
+    def agents(opt = {})
       if opt[:page].nil? || opt[:page].empty?
         opt[:page] = 1
       end
@@ -160,11 +267,20 @@ module Qismo
       )
     end
 
+    # List agents by id
+    #
+    # @param *ids [Array<Integer>]
+    # @return [Qismo::DataObject]
     def agents_by_ids(*ids)
       get("/api/v1/admin/agents/get_by_ids", **{ "ids[]": ids }).data
     end
 
-    def agents_by_divisions(*division_ids, **opt)
+    # List agents by divisions
+    #
+    # @param *division_ids [Array<Integer>]
+    # @param opt [Hash]
+    # @return [Qismo::Collection]
+    def agents_by_divisions(division_ids, opt = {})
       body = get("/api/v2/admin/agents/by_division", opt.merge({ "division_ids[]": division_ids }))
 
       next_page = body.meta.page < body.meta.total_page ? (body.meta.page + 1) : nil
@@ -179,10 +295,17 @@ module Qismo
       )
     end
 
+    # Get agent by id
+    #
+    # @param agent_id [Integer]
+    # @return [Qismo::DataObject]
     def agent(agent_id)
       get("/api/v2/admin/agent/#{agent_id}").data.agent
     end
 
+    # Get office hour config
+    #
+    # @return [Qismo::DataObject]
     def office_hours
       data = get("/api/v1/admin/office_hours").data
       data_hash = data.as_json
@@ -191,7 +314,11 @@ module Qismo
       DataObject.new(data_hash)
     end
 
-    def wa_broadcast_templates(**opt)
+    # List WA broadcast templates
+    #
+    # @param opt [Hash]
+    # @return [Qismo::Collection]
+    def wa_broadcast_templates(opt = {})
       body = get("/api/v3/admin/hsm", opt)
 
       meta = body.meta
@@ -207,63 +334,146 @@ module Qismo
       )
     end
 
-    def send_wa_outbound(**opt)
+    # Send WA outbound message
+    #
+    # @param opt [Hash]
+    # @return [Qismo::DataObject]
+    def send_wa_outbound(opt = {})
       post("/api/v3/admin/broadcast/client", opt).data
     end
 
+    # Upload wa broadcast file that want to be sent in broadcast
+    #
+    # @param file [HTTP::FormData]
+    # @param template_detail_id [Integer]
+    # @return [Qismo::DataObject]
     def upload_wa_broadcast_csv(file, template_detail_id)
       raise ArgumentError, "Invalid file" unless file.is_a?(HTTP::FormData::File)
 
       post_upload("/api/v3/admin/broadcast/upload_csv", file: file, template_detail_id: template_detail_id)
     end
 
-    def send_wa_broadcast(**opt)
+    # Send wa broadcast
+    #
+    # @param opt [Hash]
+    # @return [Qismo::DataObject]
+    def send_wa_broadcast(opt = {})
       post("/api/v3/admin/broadcast/send_broadcast", opt).data.broadcast_job
     end
 
-    def wa_broadcast_jobs(**opt)
-      get("/api/v2/admin/broadcast_jobs", opt).data.broadcast_jobs
+    # List wa broadcast jobs
+    #
+    # @param opt [Hash]
+    # @return [Qismo::Collection]
+    def wa_broadcast_jobs(opt = {})
+      body = get("/api/v2/admin/broadcast_jobs", opt)
+
+      prev_page = body.meta.page > 1 ? (body.meta.meta - 1) : nil
+      next_page = body.meta.page < body.meta.total_page ? (body.meta.page + 1) : nil
+
+      Collection.new(
+        body.data.broadcast_jobs,
+        next_page: next_page,
+        prev_page: prev_page,
+        next_func: -> { wa_broadcast_jobs(opt.merge(page: next_page)) },
+        prev_func: -> { wa_broadcast_jobs(opt.merge(page: prev_page)) },
+      )
     end
 
+    # Get wa broadcast job by id
+    #
+    # @param broadcast_job_id [Integer]
+    # @return [Qismo::DataObject]
     def wa_broadcast_job(broadcast_job_id)
       get("/api/v2/admin/broadcast_jobs/#{broadcast_job_id}").data.broadcast_job
     end
 
-    def wa_broadcast_logs(broadcast_job_id, **opt)
-      get("/api/v2/admin/broadcast_logs/#{broadcast_job_id}", opt).data.broadcast_logs
+    # List wa broadcast logs
+    #
+    # @param broadcast_job_id [Integer]
+    # @param opt [Hash]
+    # @return [Qismo::Collection]
+    def wa_broadcast_logs(broadcast_job_id, opt = {})
+      body = get("/api/v2/admin/broadcast_logs/#{broadcast_job_id}", opt)
+
+      prev_page = body.meta.page > 1 ? (body.meta.meta - 1) : nil
+      next_page = body.meta.page < body.meta.total_page ? (body.meta.page + 1) : nil
+
+      Collection.new(
+        body.data.broadcast_logs,
+        next_page: next_page,
+        prev_page: prev_page,
+        next_func: -> { wa_broadcast_logs(opt.merge(page: next_page)) },
+        prev_func: -> { wa_broadcast_jobs(opt.merge(page: prev_page)) },
+      )
     end
 
-    def send_bot_message(**opt)
+    # Send message as bot
+    #
+    # @param opt [Hash]
+    # @return [TrueClass]
+    def send_bot_message(opt = {})
       post("#{app_id}/bot", opt)
       true
     end
 
+    # Enable chabot in room
+    #
+    # @param room_id [Integer]
+    # @return [TrueClass]
     def enable_chatbot_in_room(room_id)
       post("/bot/#{room_id}/activate", is_active: true)
       true
     end
 
+    # Disable chabot in room
+    #
+    # @param room_id [Integer]
+    # @return [TrueClass]
     def disable_chatbot_in_room(room_id)
       post("/bot/#{room_id}/activate", is_active: false)
       true
     end
 
+    # Handover room from chatbot to human agent
+    #
+    # @param room_id [Integer]
+    # @return [TrueClass]
     def handover_room_from_bot(room_id)
       post("/#{app_id}/bot/#{room_id}/hand_over")
       true
     end
 
-    def handover_room_from_bot_to_division(room_id, *roles, **opt)
+    # Handover room from chatbot to human agent in specific divisions
+    #
+    # @param room_id [Integer]
+    # @param *roles [Array<Integer>]
+    # @param opt [Hash]
+    # @return [TrueClass]
+    def handover_room_from_bot_to_division(room_id, roles, opt = {})
       post("/#{app_id}/bot/#{room_id}/hand_over_to_role", opt.merge(roles: roles))
       true
     end
 
-    def initiate_widget_chat(user_id, name, **opt)
+    # Initiate chat using Qiscus widget channel
+    #
+    # @param user_id [String]
+    # @param name [String]
+    # @param opt [Hash]
+    # @return [Qismo::DataObject]
+    def initiate_widget_chat(user_id, name, opt = {})
       opt = opt.merge(app_id: app_id, user_id: user_id, name: name)
       post("/api/v2/qiscus/initiate_chat", opt).data.customer_room
     end
 
-    def send_message_to_custom_channel(identifier_key, user_id, name, **opt)
+    # Send message to custom channel
+    #
+    # @param identifier_key [String]
+    # @param user_id [String]
+    # @param name [String]
+    # @param opt [Hash]
+    # @return [Qismo::DataObject]
+    def send_message_to_custom_channel(identifier_key, user_id, name, opt = {})
       post("/#{app_id}/api/v2/custom_channel/send",
         opt.merge(identifier_key: identifier_key, user_id: user_id, name: name)).data
     end

data/lib/qismo/client.rb

@@ -4,10 +4,16 @@ module Qismo
   class Client
     include Qismo::Api
 
+    # @return [String, NilClass]
     DEFAULT_APP_ID = ENV["QISCUS_APP_ID"]
+
+    # @return [String, NilClass]
     DEFAULT_SECRET_KEY = ENV["QISCUS_SECRET_KEY"]
+
+    # @return [String]
     DEFAULT_URL = ENV["QISCUS_OMNICHANNEL_URL"] || "https://qismo.qiscus.com"
 
+    # @return [Hash]
     DEFAULT_OPTIONS = {
       app_id: DEFAULT_APP_ID,
       secret_key: DEFAULT_SECRET_KEY,
@@ -20,20 +26,38 @@ module Qismo
 
     attr_accessor(*DEFAULT_OPTIONS.keys)
 
-    def initialize(**opt)
+    # Initialize client
+    #
+    # @param opt [Hash]
+    def initialize(opt = {})
       DEFAULT_OPTIONS.merge(opt).each do |key, value|
         instance_variable_set("@#{key}", value)
       end
     end
 
+    # Send http request with post method
+    #
+    # @param path [String]
+    # @param body [Hash]
+    # @return [Qismo::DataObject]
     def post(path, body = {})
       request(:post, path, json: body)
     end
 
+    # Http request with post method to upload file
+    #
+    # @param path [String]
+    # @param body [Hash]
+    # @return [Qismo::DataObject]
     def post_upload(path, body = {})
       request(:post, form: body)
     end
 
+    # Send http request with get method
+    #
+    # @param path [String]
+    # @param params [Hash]
+    # @return [Qismo::DataObject]
     def get(path, **params)
       request(:get, path, params: params)
     end
@@ -42,7 +66,13 @@ module Qismo
       request(:delete, path)
     end
 
-    def request(method, path, **opt)
+    # Send http request
+    #
+    # @param method [Symbol, String]
+    # @param path [String]
+    # @param body [Hash]
+    # @return [Qismo::DataObject]
+    def request(method, path, opt = {})
       res = connection.request(method, @url + path, opt.compact)
       if res.status.success?
         return DataObject.new(JSON.parse(res.to_s))
@@ -72,6 +102,9 @@ module Qismo
       end
     end
 
+    # Http connection config
+    #
+    # @return [HTTP::Chainable]
     def connection
       http = HTTP
 
@@ -102,6 +135,9 @@ module Qismo
       })
     end
 
+    # Http user agent config
+    #
+    # @return [Hash]
     def user_agent
       {
         lib_version: Qismo::VERSION,

data/lib/qismo/error.rb

@@ -1,19 +1,30 @@
 # frozen_string_literal: true
 
 module Qismo
+  # Qismo ruby base error
+  #
   class Error < StandardError
     attr_reader :message
   end
 
+  # Http timeout error
+  #
   class HTTPTimeoutError < Error
     def initialize(message)
       super(message)
     end
   end
 
+  # Http request error
+  #
   class HTTPRequestError < Error
     attr_reader :message, :status_code, :response_body
 
+    # Initiate error
+    #
+    # @param message [String]
+    # @param status_code [Integer]
+    # @param response_body [String]
     def initialize(message, status_code:, response_body:)
       super(message.to_s)
 
@@ -23,30 +34,38 @@ module Qismo
     end
   end
 
+  # Http internal server error
+  #
   class InternalServerError < HTTPRequestError
   end
 
-  # 400
+  # Http 400 bad request error
+  #
   class BadRequestError < HTTPRequestError
   end
 
-  # 401
+  # Http 401 unauthorized error
+  #
   class UnauthorizedError < HTTPRequestError
   end
 
-  # 402
+  # Http 402 payment required error
+  #
   class PaymentRequiredError < HTTPRequestError
   end
 
-  # 403
+  # Http 403 forbidden error
+  #
   class ForbiddenError < HTTPRequestError
   end
 
-  # 404
+  # Http 404 not found error
+  #
   class NotFoundError < HTTPRequestError
   end
 
-  # 429
+  # Http 429 too many requests error
+  #
   class TooManyRequestError < HTTPRequestError
   end
 end

data/lib/qismo/model.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
 module Qismo
+  # Class to handle http response body
+  #
   class DataObject
-    def initialize(**opt)
+    # Initiate data object
+    #
+    # @param opt [Hash]
+    def initialize(opt = {})
       opt.each do |key, value|
         value = if value.is_a?(Array)
           handle_array(value)
@@ -47,7 +52,16 @@ module Qismo
     end
   end
 
+  # Class to handle response body that contain pagination
+  #
   class Collection < Array
+    # Initiate collection
+    #
+    # @param data [Qismo::DataObject]
+    # @param prev_page [String, Integer]
+    # @param next_page [String, Integer]
+    # @param prev_func [Proc, NilClass]
+    # @param next_func [Proc, NilClass]
     def initialize(data, prev_page: nil, next_page: nil, prev_func: -> { nil }, next_func: -> { nil })
       super(data)
 
@@ -57,22 +71,30 @@ module Qismo
       @next_func = next_func
     end
 
+    # @return [TrueClass, FalseClass]
     def has_next_page?
       @next_page != nil
     end
 
     alias_method :next_page?, :has_next_page?
 
+    # @return [TrueClass, FalseClass]
     def has_prev_page?
       @prev_page != nil
     end
 
     alias_method :prev_page?, :has_prev_page?
 
+    # Call api request for next page
+    #
+    # @return [Qismo::DataObject, Qismo::Collection]
     def next_page
       @next_func.call if has_next_page?
     end
 
+    # Call api request for previous page
+    #
+    # @return [Qismo::DataObject, Qismo::Collection]
     def prev_page
       @prev_func.call if has_prev_page?
     end

data/lib/qismo/util.rb

@@ -3,6 +3,10 @@
 module Qismo
   class Util
     class << self
+      # Check if now is in office hour or not
+      #
+      # @param data [Qismo::DataObject]
+      # @return [TrueClass, FalseClass]
       def in_office_hour?(data)
         return false if data.timezone.blank?
 

data/lib/qismo/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Qismo
-  VERSION = "0.8.7"
+  # @return [String]
+  VERSION = "0.9.0"
 end

data/lib/qismo.rb

@@ -10,8 +10,8 @@ require "qismo/model"
 require "qismo/api"
 require "qismo/client"
 
-# Qismo
 module Qismo
+  # @!method rooms
   class << self
     def configure
       yield client
@@ -19,7 +19,11 @@ module Qismo
       client
     end
 
-    def new(**opt)
+    # Initiate Qismo ruby client
+    #
+    # @param opt [Hash]
+    # @return [Qismo::Client]
+    def new(opt = {})
       @client = Client.new(opt)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qismo
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 0.9.0
 platform: ruby
 authors:
 - Qiscus Integration
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport