qismo 0.10.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1b4c93e50732069adea997b37a9377cff4444c8785971e1a194eac896b4e18d
-  data.tar.gz: 2afff6846d7d8e981dbc8242bee37bdfe32d37845029ba11614365c898bd5f89
+  metadata.gz: b73024f4c815c21256b3012449f511b2878d33a47a7e1c2ef3eb33bb452696ee
+  data.tar.gz: ecdd9b38f3d9f4c2b3015089607aead4128e9d1a14fbe8f3a721252361f011aa
 SHA512:
-  metadata.gz: 7a12795cfc80d51487a8c5242f11b5796e2292e6fc440f1fab7a05ad32bc616ffb5c129d43679f622397a19001cc56fa4fb229f0f20473c40dec4961593f4d4b
-  data.tar.gz: c6bb012dc5209dd55409c4cdcad760f4bc7a2686ee3265cd758bc9228be0ca0643a9d40cb54932815d9095d3722ee934a5d6ecaea1f9fbba2a5711bbb9f6de45
+  metadata.gz: '08efe305bc37790d1b91964dd3beb29226b25f7d8f071423a89d84571adf160471d2af5ab012c7e6323bc055183741be198d264a0575a0f8ed2a65b9d7d05351'
+  data.tar.gz: 4541a245aa4d783cf5f1a1a760f497cba47f731e22b62056d2be660b8096fad531db470829a82b822fdc2fca9b009ed4b2df585730b9b0fe32c749352266ae5e

data/Gemfile.lock

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

data/lib/qismo/api.rb

@@ -2,23 +2,27 @@
 
 module Qismo
   module Api
+    # @!parse include Qismo::Client
+
     # List customer rooms
     #
-    # @param opt [Hash]
+    # @see https://s.id/list-customer-rooms
+    # @param options [Hash]
     # @return [Qismo::CollectionObject]
-    def rooms(opt = {})
-      body = post("/api/v2/customer_rooms", opt)
+    def rooms(options = {})
+      body = post("/api/v2/customer_rooms", options)
       CollectionObject.new(
         body.data.customer_rooms,
         prev_page: body.meta&.cursor_before,
         next_page: body.meta&.cursor_after,
-        prev_func: -> { rooms(opt.merge(cursor_before: body.meta&.cursor_before)) },
-        next_func: -> { rooms(opt.merge(cursor_after: body.meta&.cursor_after)) },
+        prev_func: -> { rooms(options.merge(cursor_before: body.meta&.cursor_before)) },
+        next_func: -> { rooms(options.merge(cursor_after: body.meta&.cursor_after)) },
       )
     end
 
     # Get room by id
     #
+    # @see https://s.id/get-room-by-room-id
     # @param room_id [Integer]
     # @return [Qismo::SingleObject]
     def room(room_id)
@@ -32,6 +36,7 @@ module Qismo
 
     # List tags inside room
     #
+    # @see https://s.id/list-room-tags
     # @param room_id [Integer]
     # @return [Qismo::CollectionObject]
     def room_tags(room_id)
@@ -40,6 +45,7 @@ module Qismo
 
     # Add room tag
     #
+    # @see https://s.id/add-room-tag
     # @param room_id [Integer]
     # @param tag_name [String]
     # @return [Qismo::SingleObject]
@@ -49,6 +55,7 @@ module Qismo
 
     # Delete room tag
     #
+    # @see https://s.id/delete-room-tag
     # @param room_id [Integer]
     # @param tag_id [Integer]
     # @return [TrueClass]
@@ -59,6 +66,7 @@ module Qismo
 
     # List room additional info
     #
+    # @see https://s.id/list-room-info
     # @param room_id [Integer]
     # @return [Qismo::CollectionObject]
     def room_additional_info(room_id)
@@ -69,8 +77,11 @@ module Qismo
       ) || CollectionObject.new
     end
 
+    alias_method :room_info, :room_additional_info
+
     # Set room additional info
     #
+    # @see https://s.id/set-room-info
     # @note This will replace your current room additional info
     # @param room_id [Integer]
     # @param additional_info [Array<Hash>]
@@ -84,6 +95,10 @@ module Qismo
       ) || CollectionObject.new
     end
 
+    alias_method :set_room_info, :set_room_additional_info
+    alias_method :create_room_info, :set_room_additional_info
+    alias_method :create_room_additional_info, :set_room_additional_info
+
     # Update room additional info
     #
     # @param room_id [Integer]
@@ -95,13 +110,16 @@ module Qismo
       set_room_additional_info(room_id, new_additional_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 opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::CollectionObject]
-    def room_broadcast_history(room_id, opt = {})
-      body = get("/api/v2/customer_rooms/#{room_id}/broadcast_history", opt)
+    def room_broadcast_history(room_id, options = {})
+      body = get("/api/v2/customer_rooms/#{room_id}/broadcast_history", options)
 
       next_page = body.meta.page < body.meta.total_page ? (body.meta.page + 1) : nil
       prev_page = body.meta.page > 1 ? (body.meta.page - 1) : nil
@@ -110,24 +128,26 @@ module Qismo
         body.data.broadcast_logs,
         next_page: next_page,
         prev_page: prev_page,
-        next_func: -> { room_broadcast_history(opt.merge(page: next_page)) },
-        prev_func: -> { room_broadcast_history(opt.merge(page: prev_page)) },
+        next_func: -> { room_broadcast_history(options.merge(page: next_page)) },
+        prev_func: -> { room_broadcast_history(options.merge(page: prev_page)) },
       )
     end
 
     # Assign agent to room
     #
+    # @see https://s.id/assign-agent
     # @param room_id [Integer]
     # @param agent_id [Integer]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::SingleObject]
-    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))
+    def assign_agent(room_id, agent_id, options = {})
+      body = post("/api/v1/admin/service/assign_agent", options.merge(room_id: room_id.to_s, agent_id: agent_id))
       body.data.added_agent
     end
 
     # Remove agent from room
     #
+    # @see https://s.id/remove-agent
     # @param room_id [Integer]
     # @param agent_id [Integer]
     # @return [TrueClass]
@@ -138,13 +158,14 @@ module Qismo
 
     # Resolve room
     #
+    # @see https://s.id/resolve-room
     # @param room_id [Integer]
     # @param last_comment_id [Integer]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::SingleObject]
-    def resolve_room(room_id, last_comment_id, opt = {})
+    def resolve_room(room_id, last_comment_id, options = {})
       body = post("/api/v1/admin/service/mark_as_resolved",
-        opt.merge(room_id: room_id.to_s, last_comment_id: last_comment_id))
+        options.merge(room_id: room_id.to_s, last_comment_id: last_comment_id))
       body.data.service
     end
 
@@ -152,53 +173,57 @@ module Qismo
 
     # Get agent that can be assigned to room
     #
+    # @see https://s.id/allocate-agent
     # @param source [String]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::SingleObject]
-    def allocate_agent(source, opt = {})
-      body = post("/api/v1/admin/service/allocate_agent", opt.merge(source: source))
+    def allocate_agent(source, options = {})
+      body = post("/api/v1/admin/service/allocate_agent", options.merge(source: source))
       body.data.agent
     end
 
     # Get agent that can be allocated to room and automatically assign them
     #
+    # @see https://s.id/allocate-and-assign-agent
     # @param room_id [Integer]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::SingleObject]
-    def allocate_and_assign_agent(room_id, opt = {})
-      body = post("/api/v1/admin/service/allocate_assign_agent", opt.merge(room_id: room_id))
+    def allocate_and_assign_agent(room_id, options = {})
+      body = post("/api/v1/admin/service/allocate_assign_agent", options.merge(room_id: room_id))
       body.data.agent
     end
 
     # List agents that are not in room and can be assigned to room
     #
+    # @see https://s.id/list-other-agents
     # @param room_id [Integer]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::CollectionObject]
-    def other_agents(room_id, opt = {})
-      body = get("/api/v2/admin/service/other_agents", opt.merge(room_id: room_id))
+    def other_agents(room_id, options = {})
+      body = get("/api/v2/admin/service/other_agents", options.merge(room_id: room_id))
       CollectionObject.new(
         body.data.agents,
         prev_page: body.meta&.cursor_before,
         next_page: body.meta&.cursor_after,
-        prev_func: -> { other_agents(opt.merge(cursor_before: body.meta&.cursor_before)) },
-        next_func: -> { other_agents(opt.merge(cursor_after: body.meta&.cursor_after)) },
+        prev_func: -> { other_agents(options.merge(cursor_before: body.meta&.cursor_before)) },
+        next_func: -> { other_agents(options.merge(cursor_after: body.meta&.cursor_after)) },
       )
     end
 
     # List available agents in room
     #
+    # @see https://s.id/list-available-agents
     # @param room_id [Integer]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::CollectionObject]
-    def available_agents(room_id, opt = {})
-      body = get("/api/v2/admin/service/available_agents", opt.merge(room_id: room_id))
+    def available_agents(room_id, options = {})
+      body = get("/api/v2/admin/service/available_agents", options.merge(room_id: room_id))
       CollectionObject.new(
         body.data.agents,
         prev_page: body.meta&.cursor_before,
         next_page: body.meta&.cursor_after,
-        prev_func: -> { available_agents(opt.merge(cursor_before: body.meta&.cursor_before)) },
-        next_func: -> { available_agents(opt.merge(cursor_after: body.meta&.cursor_after)) },
+        prev_func: -> { available_agents(options.merge(cursor_before: body.meta&.cursor_before)) },
+        next_func: -> { available_agents(options.merge(cursor_after: body.meta&.cursor_after)) },
       )
     end
 
@@ -212,10 +237,10 @@ module Qismo
     # Set new session webhook
     #
     # @param url [String]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::SingleObject]
-    def set_new_session_webhook(url, opt = {})
-      post("/api/v2/app/config/new_session_webhook", opt.merge(url: url)).data.configs
+    def set_new_session_webhook(url, options = {})
+      post("/api/v2/app/config/new_session_webhook", options.merge(url: url)).data.configs
     end
 
     # Get auth webhook config
@@ -228,10 +253,10 @@ module Qismo
     # Set auth webhook
     #
     # @param url [String]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::SingleObject]
-    def set_auth_webhook(url, opt = {})
-      post("/api/v2/app/config/auth_webhook", opt.merge(url: url)).data.configs
+    def set_auth_webhook(url, options = {})
+      post("/api/v2/app/config/auth_webhook", options.merge(url: url)).data.configs
     end
 
     # Get resolve webhook config
@@ -244,38 +269,40 @@ module Qismo
     # Set resolve webhook
     #
     # @param url [String]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::SingleObject]
-    def set_resolve_webhook(url, opt = {})
-      post("/api/v1/app/webhook/mark_as_resolved", opt.merge(url: url)).data
+    def set_resolve_webhook(url, options = {})
+      post("/api/v1/app/webhook/mark_as_resolved", options.merge(url: url)).data
     end
 
     # List agents
     #
-    # @param opt [Hash]
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#849205ca-00d9-4356-9fdd-f05bff777b4e
+    # @param options [Hash]
     # @return [Qismo::CollectionObject]
-    def agents(opt = {})
-      if opt[:page].nil? || opt[:page].empty?
-        opt[:page] = 1
+    def agents(options = {})
+      if options[:page].nil? || options[:page].empty?
+        options[:page] = 1
       end
 
-      body = get("/api/v2/admin/agents", opt)
+      body = get("/api/v2/admin/agents", options)
 
       total_page = (body.meta.total_count.to_f / body.meta.per_page.to_f).ceil
-      next_page = opt[:page] < total_page ? (opt[:page] + 1) : nil
-      prev_page = opt[:page] > 1 ? (opt[:page] - 1) : nil
+      next_page = options[:page] < total_page ? (options[:page] + 1) : nil
+      prev_page = options[:page] > 1 ? (options[:page] - 1) : nil
 
       CollectionObject.new(
         body.data.agents,
         next_page: next_page,
         prev_page: prev_page,
-        next_func: -> { agents(opt.merge(page: next_page)) },
-        prev_func: -> { agents(opt.merge(page: prev_page)) },
+        next_func: -> { agents(options.merge(page: next_page)) },
+        prev_func: -> { agents(options.merge(page: prev_page)) },
       )
     end
 
     # List agents by id
     #
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#3db6c8c8-8ffe-4a88-b630-41f9d5b62298
     # @param ids [Array<Integer>]
     # @return [Qismo::CollectionObject]
     def agents_by_ids(ids)
@@ -284,11 +311,12 @@ module Qismo
 
     # List agents by divisions
     #
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#94eeb9cb-dd70-4baf-9f63-361e7922299a
     # @param division_ids [Array<Integer>]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::CollectionObject]
-    def agents_by_divisions(division_ids, opt = {})
-      body = get("/api/v2/admin/agents/by_division", opt.merge({ "division_ids[]": division_ids }))
+    def agents_by_divisions(division_ids, options = {})
+      body = get("/api/v2/admin/agents/by_division", options.merge({ "division_ids[]": division_ids }))
 
       next_page = body.meta.page < body.meta.total_page ? (body.meta.page + 1) : nil
       prev_page = body.meta.page > 1 ? (body.meta.page - 1) : nil
@@ -297,13 +325,14 @@ module Qismo
         body.data,
         next_page: next_page,
         prev_page: prev_page,
-        next_func: -> { agents_by_divisions(opt.merge(page: next_page)) },
-        prev_func: -> { agents_by_divisions(opt.merge(page: prev_page)) },
+        next_func: -> { agents_by_divisions(options.merge(page: next_page)) },
+        prev_func: -> { agents_by_divisions(options.merge(page: prev_page)) },
       )
     end
 
     # Get agent by id
     #
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#c6184a6b-ba4d-4f3e-a4da-c6d0fa4597af
     # @param agent_id [Integer]
     # @return [Qismo::SingleObject]
     def agent(agent_id)
@@ -312,6 +341,7 @@ module Qismo
 
     # Get office hour config
     #
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#6f3f0cb0-a391-4945-b01a-95ce81138913
     # @return [Qismo::SingleObject]
     def office_hours
       data = get("/api/v1/admin/office_hours").data
@@ -323,10 +353,11 @@ module Qismo
 
     # List WA broadcast templates
     #
-    # @param opt [Hash]
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#e38d2244-9559-4015-99d5-8c707f6c01bd
+    # @param options [Hash]
     # @return [Qismo::CollectionObject]
-    def wa_broadcast_templates(opt = {})
-      body = get("/api/v3/admin/hsm", opt)
+    def wa_broadcast_templates(options = {})
+      body = get("/api/v3/admin/hsm", options)
 
       meta = body.meta
       next_page = meta.page < meta.total_page ? (meta.page + 1) : nil
@@ -336,21 +367,26 @@ module Qismo
         body.data.hsm_templates,
         next_page: next_page,
         prev_page: prev_page,
-        next_func: -> { wa_broadcast_templates(opt.merge(page: next_page)) },
-        prev_func: -> { wa_broadcast_templates(opt.merge(page: prev_page)) },
+        next_func: -> { wa_broadcast_templates(options.merge(page: next_page)) },
+        prev_func: -> { wa_broadcast_templates(options.merge(page: prev_page)) },
       )
     end
 
+    alias_method :wa_message_templates, :wa_broadcast_templates
+    alias_method :wa_outbound_templates, :wa_broadcast_templates
+
     # Send WA outbound message
     #
-    # @param opt [Hash]
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#d0183cf6-deca-439b-aff3-2e2f007c15a9
+    # @param options [Hash]
     # @return [Qismo::SingleObject]
-    def send_wa_outbound(opt = {})
-      post("/api/v3/admin/broadcast/client", opt).data
+    def send_wa_outbound(options = {})
+      post("/api/v3/admin/broadcast/client", options).data
     end
 
     # Upload wa broadcast file that want to be sent in broadcast
     #
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#030acde2-21cf-4373-8d11-075206053c1d
     # @param file [HTTP::FormData]
     # @param template_detail_id [Integer]
     # @return [Qismo::SingleObject]
@@ -362,18 +398,22 @@ module Qismo
 
     # Send wa broadcast
     #
-    # @param opt [Hash]
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#717c1a12-facb-4945-aed5-04557696b873
+    # @param options [Hash]
     # @return [Qismo::SingleObject]
-    def send_wa_broadcast(opt = {})
-      post("/api/v3/admin/broadcast/send_broadcast", opt).data.broadcast_job
+    def send_wa_broadcast(options = {})
+      post("/api/v3/admin/broadcast/send_broadcast", options).data.broadcast_job
     end
 
+    alias_method :create_wa_broadcast, :send_wa_broadcast
+
     # List wa broadcast jobs
     #
-    # @param opt [Hash]
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#3a4caa8b-eef4-427f-adcb-d065989899c9
+    # @param options [Hash]
     # @return [Qismo::CollectionObject]
-    def wa_broadcast_jobs(opt = {})
-      body = get("/api/v2/admin/broadcast_jobs", opt)
+    def wa_broadcast_jobs(options = {})
+      body = get("/api/v2/admin/broadcast_jobs", options)
 
       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
@@ -382,13 +422,14 @@ module Qismo
         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)) },
+        next_func: -> { wa_broadcast_jobs(options.merge(page: next_page)) },
+        prev_func: -> { wa_broadcast_jobs(options.merge(page: prev_page)) },
       )
     end
 
     # Get wa broadcast job by id
     #
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#ed0806c8-2e4a-4ea4-8acb-45c84c63c2da
     # @param broadcast_job_id [Integer]
     # @return [Qismo::SingleObject]
     def wa_broadcast_job(broadcast_job_id)
@@ -397,11 +438,12 @@ module Qismo
 
     # List wa broadcast logs
     #
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#3f2d8ba8-ab14-43b2-af82-74c8b766216f
     # @param broadcast_job_id [Integer]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::CollectionObject]
-    def wa_broadcast_logs(broadcast_job_id, opt = {})
-      body = get("/api/v2/admin/broadcast_logs/#{broadcast_job_id}", opt)
+    def wa_broadcast_logs(broadcast_job_id, options = {})
+      body = get("/api/v2/admin/broadcast_logs/#{broadcast_job_id}", options)
 
       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
@@ -410,22 +452,24 @@ module Qismo
         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)) },
+        next_func: -> { wa_broadcast_logs(options.merge(page: next_page)) },
+        prev_func: -> { wa_broadcast_jobs(options.merge(page: prev_page)) },
       )
     end
 
     # Send message as bot
     #
-    # @param opt [Hash]
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#bb77c653-5daa-4e1c-a866-43bca7c494fc
+    # @param options [Hash]
     # @return [TrueClass]
-    def send_bot_message(opt = {})
-      post("#{app_id}/bot", opt)
+    def send_bot_message(options = {})
+      post("#{app_id}/bot", options)
       true
     end
 
     # Enable chabot in room
     #
+    # @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)
@@ -435,6 +479,7 @@ module Qismo
 
     # Disable chatbot in room
     #
+    # @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)
@@ -444,6 +489,7 @@ module Qismo
 
     # Handover room from chatbot to human agent
     #
+    # @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)
@@ -453,38 +499,47 @@ module Qismo
 
     # 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 opt [Hash]
+    # @param options [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))
+    def handover_room_from_bot_to_division(room_id, roles, options = {})
+      post("/#{app_id}/bot/#{room_id}/hand_over_to_role", options.merge(roles: roles))
       true
     end
 
     # Initiate chat using Qiscus widget channel
     #
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#d5a555de-59e0-4705-9582-c216d79e9390
     # @param user_id [String]
     # @param name [String]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::SingleObject]
-    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
+    def initiate_widget_chat(user_id, name, options = {})
+      options = options.merge(app_id: app_id, user_id: user_id, name: name)
+      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 opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::SingleObject]
-    def send_message_to_custom_channel(identifier_key, user_id, name, opt = {})
+    def send_message_to_custom_channel(identifier_key, user_id, name, options = {})
       post("/#{app_id}/api/v2/custom_channel/send",
-        opt.merge(identifier_key: identifier_key, user_id: user_id, name: name)).data
+        options.merge(identifier_key: identifier_key, user_id: user_id, name: name)).data
     end
 
+    # List integrated channels
+    #
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#aee54b21-68f1-4d31-9d81-d3c73b3e125b
+    # @return [Qismo::SingleObject]
     def channels
       get("/api/v2/channels").data
     end
@@ -494,33 +549,33 @@ module Qismo
     # @param identifier_key [String]
     # @param name [String]
     # @param webhook_url [String]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::SingleObject]
-    def create_custom_channel(identifier_key, name, webhook_url, opt = {})
-      opt = opt.merge(
+    def create_custom_channel(identifier_key, name, webhook_url, options = {})
+      options = options.merge(
         identifier_key: identifier_key,
         name: name,
         webhook_url: webhook_url,
       )
 
-      opt[:is_active] = true unless opt[:is_active].nil?
+      options[:is_active] = true unless options[:is_active].nil?
 
-      post("/api/v1/custom_channel/connect", opt.merge).data
+      post("/api/v1/custom_channel/connect", options.merge).data
     end
 
     # Update custom channel
     #
     # @param id [Integer]
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::SingleObject]
-    def update_custom_channel(id, opt = {})
+    def update_custom_channel(id, options = {})
       channel = channels.custom_channels.find { |cc| cc.id == id }
       if channel.nil?
         raise Qismo::NotFoundError.new("Channel not found", status_code: 404, response_body: nil)
       end
 
       channel_hash = JSON.parse(channel.to_json, symbolize_names: true)
-      new_channel_config = channel_hash.merge(opt)
+      new_channel_config = channel_hash.merge(options)
 
       post("/api/v1/custom_channel/connect/update", new_channel_config).data
     end
@@ -541,6 +596,10 @@ module Qismo
       update_custom_channel(id, is_active: false)
     end
 
+    # Delete custom channel
+    #
+    # @param id [Integer]
+    # @return [TrueClass]
     def delete_custom_channel(id)
       post("/api/v2/custom_channel/connect/#{id}/delete")
       true

data/lib/qismo/client.rb

@@ -28,9 +28,9 @@ module Qismo
 
     # Initialize client
     #
-    # @param opt [Hash]
-    def initialize(opt = {})
-      DEFAULT_OPTIONS.merge(opt).each do |key, value|
+    # @param options [Hash]
+    def initialize(options = {})
+      DEFAULT_OPTIONS.merge(options).each do |key, value|
         instance_variable_set("@#{key}", value)
       end
     end
@@ -44,7 +44,7 @@ module Qismo
       request(:post, path, json: body)
     end
 
-    # Http request with post method to upload file
+    # Send HTTP request with post method to upload file
     #
     # @param path [String]
     # @param body [Hash]
@@ -53,27 +53,39 @@ module Qismo
       request(:post, form: body)
     end
 
-    # Send http request with get method
+    # Send HTTP request with get method
     #
     # @param path [String]
     # @param params [Hash]
     # @return [Qismo::SingleObject]
-    def get(path, **params)
+    def get(path, params = {})
       request(:get, path, params: params)
     end
 
-    def delete(path)
-      request(:delete, path)
+    # Send HTTP request with delete method
+    #
+    # @param path [String]
+    # @param params [Hash]
+    # @return [Qismo::SingleObject]
+    def delete(path, params = {})
+      request(:delete, path, params: params)
     end
 
-    # Send http request
+    # Send HTTP request
     #
     # @param method [Symbol, String]
     # @param path [String]
-    # @param body [Hash]
+    # @param headers [Hash]
+    # @param params [Hash]
+    # @param json [Hash]
     # @return [Qismo::SingleObject]
-    def request(method, path, opt = {})
-      res = connection.request(method, @url + path, opt.compact)
+    def request(method, path, headers: {}, params: {}, json: {})
+      res = connection.request(method, @url + path, {
+        headers: headers,
+        params: params,
+        json: json,
+      })
+
       if res.status.success?
         return SingleObject.new(JSON.parse(res.to_s))
       end

data/lib/qismo/model.rb

@@ -6,9 +6,9 @@ module Qismo
   class SingleObject
     # Initiate data object
     #
-    # @param opt [Hash]
-    def initialize(opt = {})
-      opt.each do |key, value|
+    # @param options [Hash]
+    def initialize(options = {})
+      options.each do |key, value|
         value = if value.is_a?(Array)
           CollectionObject.new(handle_array(value))
         elsif value.is_a?(Hash)

data/lib/qismo/version.rb

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

data/lib/qismo.rb

@@ -11,7 +11,8 @@ require "qismo/api"
 require "qismo/client"
 
 module Qismo
-  # @!method rooms
+  # @!parse extend Qismo::Api
+
   class << self
     def configure
       yield client
@@ -21,34 +22,31 @@ module Qismo
 
     # Initiate Qismo ruby client
     #
-    # @param opt [Hash]
+    # @param options [Hash]
     # @return [Qismo::Client]
-    def new(opt = {})
-      @client = Client.new(opt)
+    def new(options = {})
+      @client = Client.new(options)
     end
 
-    if Gem::Version.new(RUBY_VERSION).release >= Gem::Version.new("3.0.0")
-      def method_missing(method, *args, **kwargs, &block)
-        return super unless client.respond_to?(method)
+    # @return [Qismo::Client]
+    def client
+      @client ||= Client.new
+    end
 
-        client.send(method, *args, **kwargs, &block)
-      end
-    else
-      def method_missing(method, *args, &block)
-        return super unless client.respond_to?(method)
+    private
 
-        client.send(method, *args, &block)
-      end
-    end
+    def method_missing(method, *args, &block)
+      return super unless client.respond_to?(method)
 
-    def respond_to_missing?(method_name, *args)
-      Qismo::Client.instance_methods.include?(method_name)
+      client.send(method * args, &block)
     end
 
-    private
+    def respond_to?(method_name, include_private = false)
+      client.respond_to?(method_name, include_private) || super(method_name, include_private)
+    end
 
-    def client
-      @client ||= Client.new
+    def respond_to_missing?(method_name, include_private = false)
+      client.respond_to?(method_name, include_private) || super(method_name, include_private)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qismo
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Qiscus Integration
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-06 00:00:00.000000000 Z
+date: 2022-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -129,12 +129,14 @@ files:
 - lib/qismo/model.rb
 - lib/qismo/util.rb
 - lib/qismo/version.rb
-homepage: https://qiscus.com
+homepage: https://bitbucket.org/qiscus/qismo-rb
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
   source_code_uri: https://bitbucket.org/qiscus/qismo-rb
+  homepage_uri: https://bitbucket.org/qiscus/qismo-rb
+  documentation_uri: https://www.rubydoc.info/gems/qismo
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -153,5 +155,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Qiscus Omnichannel Ruby Gem
+summary: Ruby wrapper for Qiscus Omnichannel public API
 test_files: []