qismo 0.17.10 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 438e37ba8805d97e8cc2265c11929b274b8fa5387293b2e2f20fe5add2b54c9f
-  data.tar.gz: acb21b8465d43cbadb921578df6f6332ef660d55fd907e03508491074c36cbce
+  metadata.gz: ee4468cc8899fd8ff50f46e1a3b03a486d9535c58e450474624dfa46c9d7888d
+  data.tar.gz: 15d203e201451848742fdbfa7e67e26b2efb434f8ebeb64fc8af48c4dbeda486
 SHA512:
-  metadata.gz: b7ed4f10abe1da26a27ebe6994075e0346abcbbe56175f5d81a465e4514a98095775d21bb508ee46e67f027040b6276104eb3500f6011764507a4905d0122653
-  data.tar.gz: 29e8e66f501de53c1f9264827dd0105b18594c9d183e97476f040666c456ce66347f513150e7db1e46459b312af3da4e79ee2a2d95bd14994dee2702ccf4d4db
+  metadata.gz: 47a01de9e692e3bc0836653702f553049bacada7fb955a9888425dc09dcee79fd99d0f4c3e79da4e32c9c0f8f50919e12ed8b1d2646599a8368cc86bf56e766e
+  data.tar.gz: 856f96e582d66c263c4caef6c71a27d48a894acfa8b51eed4e3279f09bab6c94a9a33219a3c58143359c7009a189bdea9d07f588010b3b162d8f19d9ab8ff9ae

data/README.md

@@ -16,15 +16,14 @@ bundle add qismo
 client = Qismo::Client.new(app_id: "QISCUS_APP_ID", secret_key: "QISCUS_SECRET_KEY")
 
 params = {
-  channel: { channel_id: 12345, source: "wa" },
+  channel: [{ channel_id: 12345, source: "wa" }],
   status: "unresolved",
   serve_status: "served",
   is_handled_by_bot: true,
 }
 
-rooms = client.rooms(params)
+pp client.list_rooms(params)
 
-puts rooms
 # [
 #   #<Qismo::Objects::CustomerRoom
 #     channel_id=126392
@@ -76,11 +75,11 @@ client.logger = Logger.new($stdout)
 For advanced logging, you can also use laverage ActiveSupport instrumentation. If you are using Rails, you can use ActiveSupport without installing the gem by your self.
 
 ```ruby
-ActiveSupport::Notifications.subscribe('start_request.http') d |name, start, finish, id, payload|
-  pp :name => name, :start => start.to_f, :finish => finish.to_f, :id => id, :payload => payload
+ActiveSupport::Notifications.subscribe('start_request.http') do |name, start, finish, id, payload|
+  pp name: name, start: start.to_f, finish: finish.to_f, id: id, payload: payload
 end
 
-client.instrumentation = { instrumenter: ActiveSupport::Notifications.instrumenter }client.instrumentation = { instrumenter: ActiveSupport::Notifications.instrumenter }client.instrumentation = { instrumenter: ActiveSupport::Notifications.instrumenter }
+client.instrumentation = { instrumenter: ActiveSupport::Notifications.instrumenter }
 ```
 
 You can also customize the instrumentation's namespace by using this configuration
@@ -124,12 +123,14 @@ client.proxy = ["proxy-hostname.local", 8080, "username", "password"]
 Some of the Qiscus Omnichannel API will return list of data with pagination. To handle the pagination, you can to that like this example:
 
 ```ruby
+
 all_rooms = []
-rooms = client.rooms
+
+rooms = client.list_rooms
 all_rooms.append(rooms)
 
-while rooms.has_next_page?
-  rooms = rooms.next_page
+while rooms.next_page.present?
+  rooms = client.list_rooms(cursor_after: rooms.next_page)
   all_rooms.append(rooms)
 end
 ```
@@ -140,11 +141,35 @@ Qismo ruby raise error while getting non successful http code from Qiscus Omnich
 
 ```ruby
 begin
-  client.rooms
-rescue Qismo::HTTPRequestError => e
-  e.message
-  e.status_code
-  e.response_body
+  client.list_rooms
+rescue Qismo::BadRequestError => e
+  puts e.message
+  puts e.status_code
+  puts e.response_body
+rescue Qismo::UnauthorizedError => e
+  puts e.message
+  puts e.status_code
+  puts e.response_body
+rescue Qismo::PaymentRequiredError => e
+  puts e.message
+  puts e.status_code
+  puts e.response_body
+rescue Qismo::ForbiddenError => e
+  puts e.message
+  puts e.status_code
+  puts e.response_body
+rescue Qismo::NotFoundError => e
+  puts e.message
+  puts e.status_code
+  puts e.response_body
+rescue Qismo::TooManyRequestError => e
+  puts e.message
+  puts e.status_code
+  puts e.response_body
+rescue Qismo::InternalServerError => e
+  puts e.message
+  puts e.status_code
+  puts e.response_body
 end
 ```
 
@@ -161,9 +186,10 @@ class QiscusWebhooksController < ApplicationController
 
     # Do any action you want using payload that has been objectified
     if webhook.candidate_agent.present?
-      Qismo.assign_agent(
-        webhook.room_id,
-        webhook.candidate_agent.id
+      client = Qismo::Client.new(app_id: "", secret_key: "")
+      client.assign_agent(
+        room_id: webhook.room_id,
+        agent_id: webhook.candidate_agent.id
       )
     end
   end
@@ -199,7 +225,7 @@ class QiscusWebhooksController < ApplicationController
     # Fetch customer from room participants
     customer = webhook.payload.room.participants.find { |participant| participant.email.start_with?("twitter_customer_") }
     if customer.present?
-      twitter_rest_client.create_direct_message(webhook.payload.rooms, webhook.payload.message.text)
+      twitter_rest_client.create_direct_message(customer.email, webhook.payload.message.text)
     end
   end
 
@@ -224,8 +250,9 @@ class QiscusWebhooksController < ApplicationController
     bot_message = response.query_result.fulfillment_text
 
     # Send message to Qismo room
-    Qismo.send_bot_message(
-      webhook.payload.room.id,
+    client = Qismo::Client.new(app_id: "", secret_key: "")
+    client.send_bot_message(
+      room_id: webhook.payload.room.id,
       message: bot_message
     )
   end

data/lib/qismo/api.rb

@@ -32,7 +32,7 @@ module Qismo
     # @param is_handled_by_bot [TrueClass,FalseClass]
     #   Filter rooms by chatbot activation status in room
     # @return [Qismo::Collection<Qismo::CustomerRoom>]
-    def rooms(channels: nil, status: nil, serve_status: nil, name: nil, limit: 50, tag_ids: nil, user_ids: nil, order: "desc", cursor_after: nil, cursor_before: nil, is_handled_by_bot: nil)
+    def list_rooms(channels: nil, status: nil, serve_status: nil, name: nil, limit: 50, tag_ids: nil, user_ids: nil, order: "desc", cursor_after: nil, cursor_before: nil, is_handled_by_bot: nil)
       body = post("/api/v2/customer_rooms", {
         channels: channels,
         status: status,
@@ -58,7 +58,7 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#8c803377-eea2-4879-9d66-8906d9f41275
     # @param room_id [Integer]
     # @return [Qismo::Objects::CustomerRoom]
-    def room(room_id:)
+    def get_room(room_id:)
       body = get("/api/v2/customer_rooms/#{room_id}")
       if body.data.customer_room.nil?
         raise Qismo::NotFoundError.new("Room not found", status_code: 404, response_body: body.to_json)
@@ -72,7 +72,7 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#d40b54a7-2b37-4afc-b474-62593001274e
     # @param room_id [Integer]
     # @return [Qismo::Collection<Qismo::Objects::Tag>]
-    def room_tags(room_id:)
+    def list_room_tags(room_id:)
       Qismo::Collection.new(
         Qismo::Objects::Tag.from_array(
           get("/api/v2/room_tags/#{room_id}").data
@@ -109,7 +109,7 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#88c2287b-21af-4afd-b495-aaaa2818c381
     # @param room_id [Integer]
     # @return [Array<Qismo::Objects::RoomAdditionalInfo>]
-    def room_additional_info(room_id:)
+    def list_room_info(room_id:)
       Qismo::Objects::RoomAdditionalInfo.from_array(
         get("/api/v1/qiscus/room/#{room_id}/user_info").data.extras.user_properties
       )
@@ -117,8 +117,6 @@ module Qismo
       Qismo::Objects::RoomAdditionalInfo.from_array([])
     end
 
-    alias_method :room_info, :room_additional_info
-
     # Set room additional info
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#2b968e9e-2a76-4569-8763-f883e11dc5a7
@@ -127,7 +125,7 @@ module Qismo
     # @param info [Array<Hash>]
     #   Key value pair of additional info. Ex: [{ key: "Ticket Link", value: "https://ticket.com" }]
     # @return [Array<Qismo::Objects::RoomAdditionalInfo>]
-    def set_room_additional_info(room_id:, info:)
+    def create_room_info(room_id:, info:)
       Qismo::Objects::RoomAdditionalInfo.from_array(
         post(
           "/api/v1/qiscus/room/#{room_id}/user_info",
@@ -136,31 +134,25 @@ module Qismo
       )
     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 info [Array<Hash>]
     #   Key value pair of additional info. Ex: [{ key: "Ticket Link", value: "https://ticket.com" }]
     # @return [Array<Qismo::Objects::RoomAdditionalInfo>]
-    def update_room_additional_info(room_id:, info:)
+    def update_room_info(room_id:, info:)
       old_info = room_additional_info(room_id).as_json
       new_info = (info.as_json + old_info).uniq { |h| h.values_at("key") }
       set_room_additional_info(room_id: room_id, info: new_info)
     end
 
-    alias_method :update_room_info, :update_room_additional_info
-
     # List broadcast history inside room
     #
     # @param room_id [Integer]
     # @param page [Integer]
     # @param limit [Integer]
     # @return [Qismo::Collection<Qismo::Objects::BroadcastLog>]
-    def room_broadcast_history(room_id:, page: 1, limit: 25)
+    def list_room_broadcasts(room_id:, page: 1, limit: 25)
       body = get("/api/v2/customer_rooms/#{room_id}/broadcast_history", {
         page: page,
         limit: limit
@@ -243,8 +235,6 @@ module Qismo
       )
     end
 
-    alias_method :resolve, :resolve_room
-
     # Get agent that can be assigned to room
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#a62432c6-1aba-4e2b-be9a-2f7151db9119
@@ -294,7 +284,7 @@ module Qismo
     # @param cursor_after [String]
     # @param cursor_before [String]
     # @return [Qismo::Collection<Qismo::Objects::User>]
-    def other_agents(room_id:, search: nil, limit: 15, cursor_after: nil, cursor_before: nil)
+    def list_other_agents(room_id:, search: nil, limit: 15, cursor_after: nil, cursor_before: nil)
       body = get("/api/v2/admin/service/other_agents", {
         room_id: room_id.to_s,
         search: search,
@@ -320,7 +310,7 @@ module Qismo
     # @param cursor_after [String]
     # @param cursor_before [String]
     # @return [Qismo::Collection<Qismo::Objects::User>]
-    def available_agents(room_id:, is_available_in_room: true, search: nil, limit: 15, cursor_after: nil, cursor_before: nil)
+    def list_available_agents(room_id:, is_available_in_room: true, search: nil, limit: 15, cursor_after: nil, cursor_before: nil)
       body = get("/api/v2/admin/service/available_agents", {
         room_id: room_id.to_s,
         is_available_in_room: is_available_in_room,
@@ -340,7 +330,7 @@ module Qismo
     # Get new session webhook config
     #
     # @return [Qismo::Objects::Webhook]
-    def new_session_webhook
+    def get_new_session_webhook
       config = get("/api/v2/app/config/new_session_webhook").data.configs
       Qismo::Objects::Webhook.new(
         enabled: config.is_new_session_webhook_enabled,
@@ -353,7 +343,7 @@ module Qismo
     # @param url [String]
     # @param enabled [TrueClass,FalseClass]
     # @return [Qismo::Objects::Webhook]
-    def set_new_session_webhook(url:, enabled: true)
+    def create_new_session_webhook(url:, enabled: true)
       config = post("/api/v2/app/config/new_session_webhook", url: url, enabled: enabled).data.configs
       Qismo::Objects::Webhook.new(
         enabled: config.is_new_session_webhook_enabled,
@@ -364,7 +354,7 @@ module Qismo
     # Get auth webhook config
     #
     # @return [Qismo::Objects::Webhook]
-    def auth_webhook
+    def get_auth_webhook
       config = get("/api/v2/app/config/auth_webhook").data.configs
       Qismo::Objects::Webhook.new(
         enabled: config.is_auth_webhook_enabled,
@@ -377,7 +367,7 @@ module Qismo
     # @param url [String]
     # @param enabled [TrueClass, FalseClass]
     # @return [Qismo::Objects::Webhook]
-    def set_auth_webhook(url:, enabled: true)
+    def create_auth_webhook(url:, enabled: true)
       config = post("/api/v2/app/config/auth_webhook", url: url, enabled: enabled).data.configs
       Qismo::Objects::Webhook.new(
         enabled: config.is_auth_webhook_enabled,
@@ -388,7 +378,7 @@ module Qismo
     # Get resolve webhook config
     #
     # @return [Qismo::Objects::Webhook]
-    def resolve_webhook
+    def get_resolve_webhook
       config = get("/api/v1/app/webhook/mark_as_resolved").data
       Qismo::Objects::Webhook.new(
         enabled: config.is_mark_as_resolved_webhook_enabled,
@@ -401,7 +391,7 @@ module Qismo
     # @param url [String]
     # @param options [Hash]
     # @return [Qismo::Objects::Webhook]
-    def set_resolve_webhook(url:, enabled: true)
+    def create_resolve_webhook(url:, enabled: true)
       config = post("/api/v1/app/webhook/mark_as_resolved", webhook_url: url, is_webhook_enabled: enabled).data
       Qismo::Objects::Webhook.new(
         enabled: config.is_mark_as_resolved_webhook_enabled,
@@ -414,7 +404,7 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#849205ca-00d9-4356-9fdd-f05bff777b4e
     # @param options [Hash]
     # @return [Qismo::Collection<Qismo::Objects::User>]
-    def agents(page: 1, limit: 10, search: nil, scope: nil)
+    def list_agents(page: 1, limit: 10, search: nil, scope: nil)
       body = get("/api/v2/admin/agents", {
         page: page,
         limit: limit,
@@ -436,7 +426,7 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#3db6c8c8-8ffe-4a88-b630-41f9d5b62298
     # @param agent_ids [Array<Integer>]
     # @return [Qismo::Collection<Qismo::Objects::User>]
-    def agents_by_ids(agent_ids:)
+    def list_agents_by_ids(agent_ids:)
       Qismo::Collection.new(
         Qismo::Objects::User.from_array(get("/api/v1/admin/agents/get_by_ids", {"ids[]": agent_ids}).data)
       )
@@ -455,7 +445,7 @@ module Qismo
     # @param sort [String]
     #   Sort result by descending or ascending
     # @return [Qismo::Collection<Qismo::Objects::User>]
-    def agents_by_divisions(division_ids, page: 1, limit: 10, is_available: nil, sort: "asc")
+    def list_agents_by_divisions(division_ids, page: 1, limit: 10, is_available: nil, sort: "asc")
       body = get("/api/v2/admin/agents/by_division", {
         "division_ids[]": division_ids,
         page: page,
@@ -476,7 +466,7 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#c6184a6b-ba4d-4f3e-a4da-c6d0fa4597af
     # @param agent_id [Integer]
     # @return [Qismo::Objects::User]
-    def agent(agent_id:)
+    def get_agent(agent_id:)
       Qismo::Objects::User.new(get("/api/v2/admin/agent/#{agent_id}").data.agent)
     end
 
@@ -484,7 +474,7 @@ module Qismo
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#6f3f0cb0-a391-4945-b01a-95ce81138913
     # @return [Qismo::Objects::OfficeHour]
-    def office_hours
+    def get_office_hours
       Qismo::Objects::OfficeHour.new(
         get("/api/v1/admin/office_hours").data
       )
@@ -500,7 +490,7 @@ module Qismo
     # @param approved [TrueClass,FalseClass]
     #   Filter template by approval status
     # @return [Qismo::Collection<Qismo::Objects::HsmTemplate>]
-    def wa_broadcast_templates(page: 1, limit: 10, approved: nil)
+    def list_wa_broadcast_templates(page: 1, limit: 10, approved: nil)
       body = get("/api/v3/admin/hsm", {
         page: page,
         limit: limit,
@@ -514,13 +504,10 @@ module Qismo
       )
     end
 
-    alias_method :wa_message_templates, :wa_broadcast_templates
-    alias_method :wa_outbound_templates, :wa_broadcast_templates
-
     # Get Whatsapp channel credit info
     #
     # @return [Qismo::Objects::WaCreditInfo]
-    def wa_credit
+    def get_wa_credit
       Qismo::Objects::WaCreditInfo.new(
         get("/api/v2/admin/wa_pricing/balance").data
       )
@@ -632,8 +619,6 @@ module Qismo
       )
     end
 
-    alias_method :create_wa_broadcast, :send_wa_broadcast
-
     # List WA broadcast jobs
     #
     # @param page [Integer]
@@ -642,7 +627,7 @@ module Qismo
     # @param cursor_before [Integer]
     # @param name [String]
     # @return [Qismo::Collection<Qismo::Objects::BroadcastJob>]
-    def wa_broadcast_jobs(limit: 10, cursor_after: nil, cursor_before: nil, name: nil)
+    def list_wa_broadcast_jobs(limit: 10, cursor_after: nil, cursor_before: nil, name: nil)
       body = get("/api/v2/admin/broadcast_jobs", {
         limit: limit,
         cursor_after: cursor_after,
@@ -662,7 +647,7 @@ module Qismo
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#ed0806c8-2e4a-4ea4-8acb-45c84c63c2da
     # @param broadcast_job_id [Integer]
     # @return [Qismo::Objects::BroadcastJob]
-    def wa_broadcast_job(broadcast_job_id:)
+    def get_wa_broadcast_job(broadcast_job_id:)
       Qismo::Objects::BroadcastJob.new(
         get("/api/v2/admin/broadcast_jobs/#{broadcast_job_id}").data.broadcast_job
       )
@@ -674,7 +659,7 @@ module Qismo
     # @param broadcast_job_id [Integer]
     # @param options [Hash]
     # @return [Qismo::Collection<Qismo::Objects::BroadcastLog>]
-    def wa_broadcast_logs(broadcast_job_id:, page: 1, limit: 10)
+    def list_wa_broadcast_logs(broadcast_job_id:, page: 1, limit: 10)
       body = get("/api/v2/admin/broadcast_logs/#{broadcast_job_id}", {
         page: page,
         limit: limit
@@ -819,8 +804,6 @@ module Qismo
       Qismo::Objects::CustomerRoom.new(post("/api/v2/qiscus/initiate_chat", options).data.customer_room)
     end
 
-    alias_method :initiate_chat, :initiate_widget_chat
-
     # Send messsage to custom channel
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#aee54b21-68f1-4d31-9d81-d3c73b3e125b
@@ -861,7 +844,7 @@ module Qismo
     #
     # @see https://documenter.getpostman.com/view/8259884/TVsuCSeT#aee54b21-68f1-4d31-9d81-d3c73b3e125b
     # @return [Qismo::Objects::ListChannelsResponse]
-    def channels
+    def list_channels
       Qismo::Objects::ListChannelsResponse.new(
         get("/api/v2/channels").data
       )

data/lib/qismo/version.rb

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

data/qismo.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata = {
     "source_code_uri" => "https://bitbucket.org/qiscus/qismo-rb/src/v#{spec.version}",
-    "documentation_uri" => "https://www.rubydoc.info/gems/qismo/#{spec.version}",
+    "documentation_uri" => "https://www.rubydoc.info/gems/qismo",
     "homepage_uri" => spec.homepage,
     "rubygems_mfa_required" => "true"
   }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qismo
 version: !ruby/object:Gem::Version
-  version: 0.17.10
+  version: 0.18.0
 platform: ruby
 authors:
 - Qiscus Integration
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2022-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -120,8 +120,8 @@ homepage: https://bitbucket.org/qiscus/qismo-rb
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://bitbucket.org/qiscus/qismo-rb/src/v0.17.10
-  documentation_uri: https://www.rubydoc.info/gems/qismo/0.17.10
+  source_code_uri: https://bitbucket.org/qiscus/qismo-rb/src/v0.18.0
+  documentation_uri: https://www.rubydoc.info/gems/qismo
   homepage_uri: https://bitbucket.org/qiscus/qismo-rb
   rubygems_mfa_required: 'true'
 post_install_message: