qismo 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbfbe5dc426f29f2bab1875e42889d559b0fb0936d471343e6dd2088ac1c0cc1
-  data.tar.gz: ca61c1154a98b662dbe05b87d6340a5a423b7665908b7ae7baa1f296ff03b8df
+  metadata.gz: 23e999cca8b986d2783ea662573e0fab71db0c0bb1e6bf0a1603b4442eea6acc
+  data.tar.gz: fc35ba076ba1c6597e1fb8f13b26c2a4319a92dc8c0a6215529c4f5aff2b9a09
 SHA512:
-  metadata.gz: 58b646f0e706c9193f46f60c6aa31aa1572539bbb098718e75725c6f7b197436a68c52e001b7bc9a46ea4fe04dd258eee8e2fcbe3a656c1364a6375ad231907d
-  data.tar.gz: 3d154d41d5a1a763da397b3b245b6087e8a2456028cfdabe32076471956491ca314931c9fc4d5d4340bbd2bd9c1b39281808310b664ad7e934d36ff4cea1dde8
+  metadata.gz: d45397820b9bdf5214ff8e45d164f2253824d20c4e8d2017d3c4cec9993c1e550e51754f4743be566b5296edb90d6eb7b1c6b82f098f25ce67b74db87422ee31
+  data.tar.gz: 40b3d89d5d06bce5e7460d7d36b3c0010da9fd583f0e7d66574a052be6b61bfda33688751380b32c1b6e436553f79f0661a739941e742aaf876800707fbb19cf

data/.rubocop.yml

@@ -5,15 +5,4 @@ AllCops:
   TargetRubyVersion: 2.6
   Exclude:
     - "bin/**/*"
-    - "examples/*"
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
+    - "examples/*"

data/Gemfile.lock

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

data/lib/qismo/api.rb

@@ -2,25 +2,29 @@
 
 module Qismo
   module Api
+    # @!parse include Qismo::Client
+
     # List customer rooms
     #
-    # @param opt [Hash]
-    # @return [Qismo::Collection]
-    def rooms(opt = {})
-      body = post("/api/v2/customer_rooms", opt)
-      Collection.new(
+    # @see https://s.id/list-customer-rooms
+    # @param options [Hash]
+    # @return [Qismo::CollectionObject]
+    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::DataObject]
+    # @return [Qismo::SingleObject]
     def room(room_id)
       body = get("/api/v2/customer_rooms/#{room_id}")
       if body.data.customer_room.nil?
@@ -32,23 +36,26 @@ module Qismo
 
     # List tags inside room
     #
+    # @see https://s.id/list-room-tags
     # @param room_id [Integer]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::CollectionObject]
     def room_tags(room_id)
-      get("/api/v2/room_tags/#{room_id}").data
+      CollectionObject.new(get("/api/v2/room_tags/#{room_id}").data)
     end
 
     # Add room tag
     #
+    # @see https://s.id/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
+    # @param tag_name [String]
+    # @return [Qismo::SingleObject]
+    def add_room_tag(room_id, tag_name)
+      post("/api/v2/room_tags/#{room_id}", tag: tag_name).data
     end
 
     # Delete room tag
     #
+    # @see https://s.id/delete-room-tag
     # @param room_id [Integer]
     # @param tag_id [Integer]
     # @return [TrueClass]
@@ -59,68 +66,88 @@ module Qismo
 
     # List room additional info
     #
+    # @see https://s.id/list-room-info
     # @param room_id [Integer]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::CollectionObject]
     def room_additional_info(room_id)
-      body = get("/api/v1/qiscus/room/#{room_id}/user_info")
-      body.data.extras.user_properties
+      CollectionObject.new(
+        get(
+          "/api/v1/qiscus/room/#{room_id}/user_info",
+        ).data&.extras&.user_properties,
+      ) || 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>]
-    # @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
+    # @param additional_info [Array<Hash>]
+    # @return [Qismo::CollectionObject]
+    def set_room_additional_info(room_id, additional_info)
+      CollectionObject.new(
+        post(
+          "/api/v1/qiscus/room/#{room_id}/user_info",
+          user_properties: additional_info,
+        ).data&.extras&.user_properties,
+      ) || 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]
-    # @param *additional_info [Array]
-    # @return [Qismo::DataObject]
-    def update_room_additional_info(room_id, *additional_info)
+    # @param additional_info [Array]
+    # @return [Qismo::CollectionObject]
+    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)
+      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]
-    # @return [Qismo::Collection]
-    def room_broadcast_history(room_id, opt = {})
-      body = get("/api/v2/customer_rooms/#{room_id}/broadcast_history", opt)
+    # @param options [Hash]
+    # @return [Qismo::CollectionObject]
+    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
 
-      Collection.new(
+      CollectionObject.new(
         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]
-    # @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))
+    # @param options [Hash]
+    # @return [Qismo::SingleObject]
+    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]
@@ -131,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]
-    # @return [Qismo::DataObject]
-    def resolve_room(room_id, last_comment_id, opt = {})
+    # @param options [Hash]
+    # @return [Qismo::SingleObject]
+    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
 
@@ -145,59 +173,63 @@ module Qismo
 
     # Get agent that can be assigned to room
     #
+    # @see https://s.id/allocate-agent
     # @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))
+    # @param options [Hash]
+    # @return [Qismo::SingleObject]
+    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]
-    # @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))
+    # @param options [Hash]
+    # @return [Qismo::SingleObject]
+    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]
-    # @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(
+    # @param options [Hash]
+    # @return [Qismo::CollectionObject]
+    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]
-    # @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(
+    # @param options [Hash]
+    # @return [Qismo::CollectionObject]
+    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
 
     # Get new session webhook config
     #
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     def new_session_webhook
       get("/api/v2/app/config/new_session_webhook").data.configs
     end
@@ -205,15 +237,15 @@ module Qismo
     # 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
+    # @param options [Hash]
+    # @return [Qismo::SingleObject]
+    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
     #
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     def auth_webhook
       get("/api/v2/app/config/auth_webhook").data.configs
     end
@@ -221,15 +253,15 @@ module Qismo
     # 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
+    # @param options [Hash]
+    # @return [Qismo::SingleObject]
+    def set_auth_webhook(url, options = {})
+      post("/api/v2/app/config/auth_webhook", options.merge(url: url)).data.configs
     end
 
     # Get resolve webhook config
     #
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     def resolve_webhook
       get("/api/v1/app/webhook/mark_as_resolved").data
     end
@@ -237,116 +269,127 @@ module Qismo
     # 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
+    # @param options [Hash]
+    # @return [Qismo::SingleObject]
+    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]
-    # @return [Qismo::Collection]
-    def agents(opt = {})
-      if opt[:page].nil? || opt[:page].empty?
-        opt[:page] = 1
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#849205ca-00d9-4356-9fdd-f05bff777b4e
+    # @param options [Hash]
+    # @return [Qismo::CollectionObject]
+    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
 
-      Collection.new(
+      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
     #
-    # @param *ids [Array<Integer>]
-    # @return [Qismo::DataObject]
-    def agents_by_ids(*ids)
-      get("/api/v1/admin/agents/get_by_ids", **{ "ids[]": ids }).data
+    # @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)
+      CollectionObject.new(get("/api/v1/admin/agents/get_by_ids", { "ids[]": ids }).data) || CollectionObject.new
     end
 
     # 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 }))
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#94eeb9cb-dd70-4baf-9f63-361e7922299a
+    # @param division_ids [Array<Integer>]
+    # @param options [Hash]
+    # @return [Qismo::CollectionObject]
+    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
 
-      Collection.new(
+      CollectionObject.new(
         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::DataObject]
+    # @return [Qismo::SingleObject]
     def agent(agent_id)
       get("/api/v2/admin/agent/#{agent_id}").data.agent
     end
 
     # Get office hour config
     #
-    # @return [Qismo::DataObject]
+    # @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
       data_hash = data.as_json
       data_hash["is_in_office_hour"] = Util.in_office_hour?(data)
 
-      DataObject.new(data_hash)
+      SingleObject.new(data_hash)
     end
 
     # List WA broadcast templates
     #
-    # @param opt [Hash]
-    # @return [Qismo::Collection]
-    def wa_broadcast_templates(opt = {})
-      body = get("/api/v3/admin/hsm", opt)
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#e38d2244-9559-4015-99d5-8c707f6c01bd
+    # @param options [Hash]
+    # @return [Qismo::CollectionObject]
+    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
       prev_page = meta.page > 1 ? (meta.page - 1) : nil
 
-      Collection.new(
+      CollectionObject.new(
         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]
-    # @return [Qismo::DataObject]
-    def send_wa_outbound(opt = {})
-      post("/api/v3/admin/broadcast/client", opt).data
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#d0183cf6-deca-439b-aff3-2e2f007c15a9
+    # @param options [Hash]
+    # @return [Qismo::SingleObject]
+    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::DataObject]
+    # @return [Qismo::SingleObject]
     def upload_wa_broadcast_csv(file, template_detail_id)
       raise ArgumentError, "Invalid file" unless file.is_a?(HTTP::FormData::File)
 
@@ -355,88 +398,98 @@ module Qismo
 
     # 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
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#717c1a12-facb-4945-aed5-04557696b873
+    # @param options [Hash]
+    # @return [Qismo::SingleObject]
+    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]
-    # @return [Qismo::Collection]
-    def wa_broadcast_jobs(opt = {})
-      body = get("/api/v2/admin/broadcast_jobs", opt)
+    # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#3a4caa8b-eef4-427f-adcb-d065989899c9
+    # @param options [Hash]
+    # @return [Qismo::CollectionObject]
+    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
 
-      Collection.new(
+      CollectionObject.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)) },
+        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::DataObject]
+    # @return [Qismo::SingleObject]
     def wa_broadcast_job(broadcast_job_id)
       get("/api/v2/admin/broadcast_jobs/#{broadcast_job_id}").data.broadcast_job
     end
 
     # 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]
-    # @return [Qismo::Collection]
-    def wa_broadcast_logs(broadcast_job_id, opt = {})
-      body = get("/api/v2/admin/broadcast_logs/#{broadcast_job_id}", opt)
+    # @param options [Hash]
+    # @return [Qismo::CollectionObject]
+    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
 
-      Collection.new(
+      CollectionObject.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)) },
+        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_chatbot_in_room(room_id)
+    def enable_bot_in_room(room_id)
       post("/bot/#{room_id}/activate", is_active: true)
       true
     end
 
-    # Disable chabot in room
+    # 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_chatbot_in_room(room_id)
+    def disable_bot_in_room(room_id)
       post("/bot/#{room_id}/activate", is_active: false)
       true
     end
 
     # 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)
@@ -446,36 +499,110 @@ 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 roles [Array<Integer>]
+    # @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]
-    # @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
+    # @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)
+      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]
-    # @return [Qismo::DataObject]
-    def send_message_to_custom_channel(identifier_key, user_id, name, opt = {})
+    # @param options [Hash]
+    # @return [Qismo::SingleObject]
+    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
+
+    # Create customchannel
+    #
+    # @param identifier_key [String]
+    # @param name [String]
+    # @param webhook_url [String]
+    # @param options [Hash]
+    # @return [Qismo::SingleObject]
+    def create_custom_channel(identifier_key, name, webhook_url, options = {})
+      options = options.merge(
+        identifier_key: identifier_key,
+        name: name,
+        webhook_url: webhook_url,
+      )
+
+      options[:is_active] = true unless options[:is_active].nil?
+
+      post("/api/v1/custom_channel/connect", options.merge).data
+    end
+
+    # Update custom channel
+    #
+    # @param id [Integer]
+    # @param options [Hash]
+    # @return [Qismo::SingleObject]
+    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(options)
+
+      post("/api/v1/custom_channel/connect/update", new_channel_config).data
+    end
+
+    # Activate custom channel
+    #
+    # @param id [Integer]
+    # @return [Qismo::SingleObject]
+    def activate_custom_channel(id)
+      update_custom_channel(id, is_active: true)
+    end
+
+    # Deactivate custom channel
+    #
+    # @param id [Integer]
+    # @return [Qismo::SingleObject]
+    def deactivate_custom_channel(id)
+      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
     end
   end
 end

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
@@ -39,43 +39,55 @@ module Qismo
     #
     # @param path [String]
     # @param body [Hash]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     def post(path, body = {})
       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]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     def post_upload(path, body = {})
       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::DataObject]
-    def get(path, **params)
+    # @return [Qismo::SingleObject]
+    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]
-    # @return [Qismo::DataObject]
-    def request(method, path, opt = {})
-      res = connection.request(method, @url + path, opt.compact)
+    # @param headers [Hash]
+    # @param params [Hash]
+    # @param json [Hash]
+    # @return [Qismo::SingleObject]
+    def request(method, path, headers: {}, params: {}, json: {})
+      res = connection.request(method, @url + path, {
+        headers: headers,
+        params: params,
+        json: json,
+      })
+
       if res.status.success?
-        return DataObject.new(JSON.parse(res.to_s))
+        return SingleObject.new(JSON.parse(res.to_s))
       end
 
       if res.status.server_error?
@@ -83,10 +95,10 @@ module Qismo
       end
 
       if res.status.client_error?
-        body = DataObject.new(JSON.parse(res.to_s))
+        body = SingleObject.new(JSON.parse(res.to_s))
 
         error = body.errors
-        error = error.message if error.is_a?(DataObject)
+        error = error.message if error.is_a?(SingleObject)
 
         error_klass_map = {
           400 => BadRequestError,

data/lib/qismo/model.rb

@@ -3,14 +3,14 @@
 module Qismo
   # Class to handle http response body
   #
-  class DataObject
+  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)
-          handle_array(value)
+          CollectionObject.new(handle_array(value))
         elsif value.is_a?(Hash)
           self.class.new(value)
         elsif value.is_a?(TrueClass) || value.is_a?(FalseClass)
@@ -54,15 +54,15 @@ module Qismo
 
   # Class to handle response body that contain pagination
   #
-  class Collection < Array
+  class CollectionObject < Array
     # Initiate collection
     #
-    # @param data [Qismo::DataObject]
+    # @param data [Qismo::SingleObject]
     # @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 })
+    def initialize(data = [], prev_page: nil, next_page: nil, prev_func: -> { nil }, next_func: -> { nil })
       super(data)
 
       @prev_page = prev_page
@@ -87,14 +87,14 @@ module Qismo
 
     # Call api request for next page
     #
-    # @return [Qismo::DataObject, Qismo::Collection]
+    # @return [Qismo::SingleObject, Qismo::CollectionObject]
     def next_page
       @next_func.call if has_next_page?
     end
 
     # Call api request for previous page
     #
-    # @return [Qismo::DataObject, Qismo::Collection]
+    # @return [Qismo::SingleObject, Qismo::CollectionObject]
     def prev_page
       @prev_func.call if has_prev_page?
     end

data/lib/qismo/util.rb

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

data/lib/qismo/version.rb

@@ -2,5 +2,5 @@
 
 module Qismo
   # @return [String]
-  VERSION = "0.9.0"
+  VERSION = "0.11.0"
 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.9.0
+  version: 0.11.0
 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: []