qismo 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbfbe5dc426f29f2bab1875e42889d559b0fb0936d471343e6dd2088ac1c0cc1
-  data.tar.gz: ca61c1154a98b662dbe05b87d6340a5a423b7665908b7ae7baa1f296ff03b8df
+  metadata.gz: e1b4c93e50732069adea997b37a9377cff4444c8785971e1a194eac896b4e18d
+  data.tar.gz: 2afff6846d7d8e981dbc8242bee37bdfe32d37845029ba11614365c898bd5f89
 SHA512:
-  metadata.gz: 58b646f0e706c9193f46f60c6aa31aa1572539bbb098718e75725c6f7b197436a68c52e001b7bc9a46ea4fe04dd258eee8e2fcbe3a656c1364a6375ad231907d
-  data.tar.gz: 3d154d41d5a1a763da397b3b245b6087e8a2456028cfdabe32076471956491ca314931c9fc4d5d4340bbd2bd9c1b39281808310b664ad7e934d36ff4cea1dde8
+  metadata.gz: 7a12795cfc80d51487a8c5242f11b5796e2292e6fc440f1fab7a05ad32bc616ffb5c129d43679f622397a19001cc56fa4fb229f0f20473c40dec4961593f4d4b
+  data.tar.gz: c6bb012dc5209dd55409c4cdcad760f4bc7a2686ee3265cd758bc9228be0ca0643a9d40cb54932815d9095d3722ee934a5d6ecaea1f9fbba2a5711bbb9f6de45

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

@@ -5,10 +5,10 @@ module Qismo
     # List customer rooms
     #
     # @param opt [Hash]
-    # @return [Qismo::Collection]
+    # @return [Qismo::CollectionObject]
     def rooms(opt = {})
       body = post("/api/v2/customer_rooms", opt)
-      Collection.new(
+      CollectionObject.new(
         body.data.customer_rooms,
         prev_page: body.meta&.cursor_before,
         next_page: body.meta&.cursor_after,
@@ -20,7 +20,7 @@ module Qismo
     # Get room by 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?
@@ -33,18 +33,18 @@ module Qismo
     # List tags inside room
     #
     # @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
     #
     # @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
@@ -60,46 +60,53 @@ module Qismo
     # List room additional 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
 
     # 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
+    # @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
 
     # 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
 
     # List Whatsapp broadcast history inside room
     #
     # @param room_id [Integer]
     # @param opt [Hash]
-    # @return [Qismo::Collection]
+    # @return [Qismo::CollectionObject]
     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
       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,
@@ -113,7 +120,7 @@ module Qismo
     # @param room_id [Integer]
     # @param agent_id [Integer]
     # @param opt [Hash]
-    # @return [Qismo::DataObject]
+    # @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))
       body.data.added_agent
@@ -134,7 +141,7 @@ module Qismo
     # @param room_id [Integer]
     # @param last_comment_id [Integer]
     # @param opt [Hash]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     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))
@@ -147,7 +154,7 @@ module Qismo
     #
     # @param source [String]
     # @param opt [Hash]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     def allocate_agent(source, opt = {})
       body = post("/api/v1/admin/service/allocate_agent", opt.merge(source: source))
       body.data.agent
@@ -157,7 +164,7 @@ module Qismo
     #
     # @param room_id [Integer]
     # @param opt [Hash]
-    # @return [Qismo::DataObject]
+    # @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))
       body.data.agent
@@ -167,10 +174,10 @@ module Qismo
     #
     # @param room_id [Integer]
     # @param opt [Hash]
-    # @return [Qismo::Collection]
+    # @return [Qismo::CollectionObject]
     def other_agents(room_id, opt = {})
       body = get("/api/v2/admin/service/other_agents", opt.merge(room_id: room_id))
-      Collection.new(
+      CollectionObject.new(
         body.data.agents,
         prev_page: body.meta&.cursor_before,
         next_page: body.meta&.cursor_after,
@@ -183,10 +190,10 @@ module Qismo
     #
     # @param room_id [Integer]
     # @param opt [Hash]
-    # @return [Qismo::Collection]
+    # @return [Qismo::CollectionObject]
     def available_agents(room_id, opt = {})
       body = get("/api/v2/admin/service/available_agents", opt.merge(room_id: room_id))
-      Collection.new(
+      CollectionObject.new(
         body.data.agents,
         prev_page: body.meta&.cursor_before,
         next_page: body.meta&.cursor_after,
@@ -197,7 +204,7 @@ module Qismo
 
     # 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
@@ -206,14 +213,14 @@ module Qismo
     #
     # @param url [String]
     # @param opt [Hash]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     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]
+    # @return [Qismo::SingleObject]
     def auth_webhook
       get("/api/v2/app/config/auth_webhook").data.configs
     end
@@ -222,14 +229,14 @@ module Qismo
     #
     # @param url [String]
     # @param opt [Hash]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     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]
+    # @return [Qismo::SingleObject]
     def resolve_webhook
       get("/api/v1/app/webhook/mark_as_resolved").data
     end
@@ -238,7 +245,7 @@ module Qismo
     #
     # @param url [String]
     # @param opt [Hash]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     def set_resolve_webhook(url, opt = {})
       post("/api/v1/app/webhook/mark_as_resolved", opt.merge(url: url)).data
     end
@@ -246,7 +253,7 @@ module Qismo
     # List agents
     #
     # @param opt [Hash]
-    # @return [Qismo::Collection]
+    # @return [Qismo::CollectionObject]
     def agents(opt = {})
       if opt[:page].nil? || opt[:page].empty?
         opt[:page] = 1
@@ -258,7 +265,7 @@ module Qismo
       next_page = opt[:page] < total_page ? (opt[:page] + 1) : nil
       prev_page = opt[:page] > 1 ? (opt[:page] - 1) : nil
 
-      Collection.new(
+      CollectionObject.new(
         body.data.agents,
         next_page: next_page,
         prev_page: prev_page,
@@ -269,24 +276,24 @@ module Qismo
 
     # 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
+    # @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 division_ids [Array<Integer>]
     # @param opt [Hash]
-    # @return [Qismo::Collection]
+    # @return [Qismo::CollectionObject]
     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
       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,
@@ -298,26 +305,26 @@ module Qismo
     # Get agent by id
     #
     # @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]
+    # @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]
+    # @return [Qismo::CollectionObject]
     def wa_broadcast_templates(opt = {})
       body = get("/api/v3/admin/hsm", opt)
 
@@ -325,7 +332,7 @@ module Qismo
       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,
@@ -337,7 +344,7 @@ module Qismo
     # Send WA outbound message
     #
     # @param opt [Hash]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     def send_wa_outbound(opt = {})
       post("/api/v3/admin/broadcast/client", opt).data
     end
@@ -346,7 +353,7 @@ module Qismo
     #
     # @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)
 
@@ -356,7 +363,7 @@ module Qismo
     # Send wa broadcast
     #
     # @param opt [Hash]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     def send_wa_broadcast(opt = {})
       post("/api/v3/admin/broadcast/send_broadcast", opt).data.broadcast_job
     end
@@ -364,14 +371,14 @@ module Qismo
     # List wa broadcast jobs
     #
     # @param opt [Hash]
-    # @return [Qismo::Collection]
+    # @return [Qismo::CollectionObject]
     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(
+      CollectionObject.new(
         body.data.broadcast_jobs,
         next_page: next_page,
         prev_page: prev_page,
@@ -383,7 +390,7 @@ module Qismo
     # Get wa broadcast job by id
     #
     # @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
@@ -392,14 +399,14 @@ module Qismo
     #
     # @param broadcast_job_id [Integer]
     # @param opt [Hash]
-    # @return [Qismo::Collection]
+    # @return [Qismo::CollectionObject]
     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(
+      CollectionObject.new(
         body.data.broadcast_logs,
         next_page: next_page,
         prev_page: prev_page,
@@ -421,16 +428,16 @@ module Qismo
     #
     # @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
     #
     # @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
@@ -447,7 +454,7 @@ module Qismo
     # Handover room from chatbot to human agent in specific divisions
     #
     # @param room_id [Integer]
-    # @param *roles [Array<Integer>]
+    # @param roles [Array<Integer>]
     # @param opt [Hash]
     # @return [TrueClass]
     def handover_room_from_bot_to_division(room_id, roles, opt = {})
@@ -460,7 +467,7 @@ module Qismo
     # @param user_id [String]
     # @param name [String]
     # @param opt [Hash]
-    # @return [Qismo::DataObject]
+    # @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
@@ -472,10 +479,71 @@ module Qismo
     # @param user_id [String]
     # @param name [String]
     # @param opt [Hash]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     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
+
+    def channels
+      get("/api/v2/channels").data
+    end
+
+    # Create customchannel
+    #
+    # @param identifier_key [String]
+    # @param name [String]
+    # @param webhook_url [String]
+    # @param opt [Hash]
+    # @return [Qismo::SingleObject]
+    def create_custom_channel(identifier_key, name, webhook_url, opt = {})
+      opt = opt.merge(
+        identifier_key: identifier_key,
+        name: name,
+        webhook_url: webhook_url,
+      )
+
+      opt[:is_active] = true unless opt[:is_active].nil?
+
+      post("/api/v1/custom_channel/connect", opt.merge).data
+    end
+
+    # Update custom channel
+    #
+    # @param id [Integer]
+    # @param opt [Hash]
+    # @return [Qismo::SingleObject]
+    def update_custom_channel(id, opt = {})
+      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)
+
+      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
+
+    def delete_custom_channel(id)
+      post("/api/v2/custom_channel/connect/#{id}/delete")
+      true
+    end
   end
 end

data/lib/qismo/client.rb

@@ -39,7 +39,7 @@ module Qismo
     #
     # @param path [String]
     # @param body [Hash]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     def post(path, body = {})
       request(:post, path, json: body)
     end
@@ -48,7 +48,7 @@ module Qismo
     #
     # @param path [String]
     # @param body [Hash]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     def post_upload(path, body = {})
       request(:post, form: body)
     end
@@ -57,7 +57,7 @@ module Qismo
     #
     # @param path [String]
     # @param params [Hash]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     def get(path, **params)
       request(:get, path, params: params)
     end
@@ -71,11 +71,11 @@ module Qismo
     # @param method [Symbol, String]
     # @param path [String]
     # @param body [Hash]
-    # @return [Qismo::DataObject]
+    # @return [Qismo::SingleObject]
     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))
+        return SingleObject.new(JSON.parse(res.to_s))
       end
 
       if res.status.server_error?
@@ -83,10 +83,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|
         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.10.0"
 end

metadata

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