qismo 0.14.0 → 0.17.0

data/lib/qismo/objectified_hash.rb

@@ -1,11 +1,15 @@
 module Qismo
+  # Objectified hash interface for accesing hash using dot notation
+  #
   class ObjectifiedHash < Hash
+    # method missing patch
     def method_missing(method, *args, &block)
       return super unless respond_to?(method)
 
       fetch(method.to_s)
     end
 
+    # respond to patch
     def respond_to?(method_name, include_private = false)
       fetch(method_name.to_s)
 
@@ -14,6 +18,7 @@ module Qismo
       super(method_name, include_private)
     end
 
+    # respond to missing patch
     def respond_to_missing?(method_name, include_private = false)
       fetch(method_name.to_s)
 

data/lib/qismo/objects/agent_service.rb

@@ -1,5 +1,9 @@
 module Qismo
+  # Objects module to handle schema for API response
+  #
   module Objects
+    # Agent service object
+    #
     class AgentService < Qismo::Object
       # @!attribute [r] created_at
       #   @return [String]

data/lib/qismo/objects/broadcast_job.rb

@@ -1,6 +1,10 @@
 module Qismo
   module Objects
+    # Broadcast job object
+    #
     class BroadcastJob < Qismo::Object
+      # Broadcast job user object
+      #
       class User < Qismo::Object
         # @!attribute [r] name
         #   @return [String]

data/lib/qismo/objects/broadcast_log.rb

@@ -1,5 +1,7 @@
 module Qismo
   module Objects
+    # Broadcast log object
+    #
     class BroadcastLog < Qismo::Object
       # @!attribute [r] button_params
       #   @return [String]

data/lib/qismo/objects/custom_channel.rb

@@ -0,0 +1,35 @@
+module Qismo
+  module Objects
+    # Custom channel object
+    #
+    class CustomChannel < Qismo::Object
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int.optional
+
+      # @!attribute [r] webhook_url
+      #   @return [String]
+      attribute? :webhook_url, Types::String.optional
+
+      # @!attribute [r] logo_url
+      #   @return [String]
+      attribute? :logo_url, Types::String.optional
+
+      # @!attribute [r] identifier_key
+      #   @return [String]
+      attribute? :identifier_key, Types::String.optional
+
+      # @!attribute [r] name
+      #   @return [String]
+      attribute? :name, Types::String.optional
+
+      # @!attribute [r] is_active
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_active, Types::Bool.optional
+
+      # @!attribute [r] use_channel_responder
+      #   @return [TrueClass,FalseClass]
+      attribute? :use_channel_responder, Types::Bool.optional
+    end
+  end
+end

data/lib/qismo/objects/custom_channel_message_response.rb

@@ -1,5 +1,7 @@
 module Qismo
   module Objects
+    # Custom channel message response object
+    #
     class CustomChannelMessageResponse < Qismo::Object
       # @!attribute [r] agent
       #   @return [Qismo::Objects::User]

data/lib/qismo/objects/customer_room.rb

@@ -2,6 +2,8 @@ require "qismo/object"
 
 module Qismo
   module Objects
+    # Customer room object
+    #
     class CustomerRoom < Qismo::Object
       # @!attribute [r] channel_id
       #   @return [Integer]

data/lib/qismo/objects/fb_channel.rb

@@ -0,0 +1,31 @@
+module Qismo
+  module Objects
+    # Fb channel object
+    #
+    class FbChannel < Qismo::Object
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int.optional
+
+      # @!attribute [r] is_active
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_active, Types::Bool.optional
+
+      # @!attribute [r] profile_name
+      #   @return [String]
+      attribute? :profile_name, Types::String.optional
+
+      # @!attribute [r] page_id
+      #   @return [String]
+      attribute? :page_id, Types::String.optional
+
+      # @!attribute [r] badge_url
+      #   @return [String]
+      attribute? :badge_url, Types::String.optional
+
+      # @!attribute [r] use_channel_responder
+      #   @return [TrueClass,FalseClass]
+      attribute :use_channel_responder, Types::Bool.optional
+    end
+  end
+end

data/lib/qismo/objects/hsm_template.rb

@@ -1,7 +1,13 @@
 module Qismo
   module Objects
+    # HSM template object
+    #
     class HsmTemplate < Qismo::Object
+      # Hsm detail object
+      #
       class HsmDetail < Qismo::Object
+        # Hsm detail button object
+        #
         class Button < Qismo::Object
           # @!attribute [r] text
           #   @return [String]

data/lib/qismo/objects/ig_channel.rb

@@ -0,0 +1,43 @@
+module Qismo
+  module Objects
+    # IG channel object
+    #
+    class IgChannel < Qismo::Object
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int.optional
+
+      # @!attribute [r] is_active
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_active, Types::Bool.optional
+
+      # @!attribute [r] name
+      #   @return [String]
+      attribute? :name, Types::String.optional
+
+      # @!attribute [r] page_id
+      #   @return [String]
+      attribute? :page_id, Types::String.optional
+
+      # @!attribute [r] badge_url
+      #   @return [String]
+      attribute? :badge_url, Types::String.optional
+
+      # @!attribute [r] use_channel_responder
+      #   @return [TrueClass,FalseClass]
+      attribute? :use_channel_responder, Types::Bool.optional
+
+      # @!attribute [r] ig_id
+      #   @return [String]
+      attribute? :ig_id, Types::String.optional
+
+      # @!attribute [r] private_replies_enabled
+      #   @return [TrueClass,FalseClass]
+      attribute? :private_replies_enabled, Types::Bool.optional
+
+      # @!attribute [r] private_replies_text
+      #   @return [String]
+      attribute? :private_replies_text, Types::String.optional
+    end
+  end
+end

data/lib/qismo/objects/line_channel.rb

@@ -0,0 +1,27 @@
+module Qismo
+  module Objects
+    # Line channel object
+    #
+    class LineChannel < Qismo::Object
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int.optional
+
+      # @!attribute [r] is_active
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_active, Types::Bool.optional
+
+      # @!attribute [r] badge_url
+      #   @return [String]
+      attribute? :badge_url, Types::String.optional
+
+      # @!attribute [r] name
+      #   @return [String]
+      attribute? :name, Types::String.optional
+
+      # @!attribute [r] use_channel_responder
+      #   @return [TrueClass,FalseClass]
+      attribute? :use_channel_responder, Types::Bool.optional
+    end
+  end
+end

data/lib/qismo/objects/list_channels_response.rb

@@ -0,0 +1,39 @@
+module Qismo
+  module Objects
+    # List channels response object
+    #
+    class ListChannelsResponse < Qismo::Object
+      # @!attribute [r] custom_channels
+      #   @return [Array<Qismo::Objects::CustomChannel>]
+      attribute? :custom_channels, Types.Array(Qismo::Objects::CustomChannel.optional).optional
+
+      # @!attribute [r] fb_channels
+      #   @return [Array<Qismo::Objects::FbChannel>]
+      attribute? :fb_channels, Types.Array(Qismo::Objects::FbChannel.optional).optional
+
+      # @!attribute [r] ig_channels
+      #   @return [Array<Qismo::Objects::IgChannel>]
+      attribute? :ig_channels, Types.Array(Qismo::Objects::IgChannel.optional).optional
+
+      # @!attribute [r] line_channels
+      #   @return [Array<Qismo::Objects::LineChannel>]
+      attribute? :line_channels, Types.Array(Qismo::Objects::LineChannel.optional).optional
+
+      # @!attribute [r] qiscus_channels
+      #   @return [Array<Qismo::Objects::QiscusChannel>]
+      attribute? :qiscus_channels, Types.Array(Qismo::Objects::QiscusChannel.optional).optional
+
+      # @!attribute [r] telegram_channels
+      #   @return [Array<Qismo::Objects::TelegramChannel>]
+      attribute? :telegram_channels, Types.Array(Qismo::Objects::TelegramChannel.optional).optional
+
+      # @!attribute [r] wa_channels
+      #   @return [Array<Qismo::Objects::WaChannel>]
+      attribute? :wa_channels, Types.Array(Qismo::Objects::WaChannel.optional).optional
+
+      # @!attribute [r] waca_channels
+      #   @return [Array<Qismo::Objects::WacaChannel>]
+      attribute? :waca_channels, Types.Array(Qismo::Objects::WacaChannel.optional).optional
+    end
+  end
+end

data/lib/qismo/objects/office_hour.rb

@@ -1,6 +1,10 @@
 module Qismo
   module Objects
+    # Office hour object
+    #
     class OfficeHour < Qismo::Object
+      # Office hour element object
+      #
       class OfficeHourElement < Qismo::Object
         # @!attribute [r] day
         #   @return [Integer]

data/lib/qismo/objects/qiscus_channel.rb

@@ -0,0 +1,27 @@
+module Qismo
+  module Objects
+    # Qiscus channel object
+    #
+    class QiscusChannel < Qismo::Object
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int.optional
+
+      # @!attribute [r] is_active
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_active, Types::Bool.optional
+
+      # @!attribute [r] name
+      #   @return [String]
+      attribute? :name, Types::String.optional
+
+      # @!attribute [r] badge_url
+      #   @return [String]
+      attribute? :badge_url, Types::String.optional
+
+      # @!attribute [r] use_channel_responder
+      #   @return [TrueClass,FalseClass]
+      attribute? :use_channel_responder, Types::Bool.optional
+    end
+  end
+end

data/lib/qismo/objects/room_additional_info.rb

@@ -1,5 +1,7 @@
 module Qismo
   module Objects
+    # Room additional info object
+    #
     class RoomAdditionalInfo < Qismo::Object
       # @!attribute [r] key
       #   @return [String]

data/lib/qismo/objects/tag.rb

@@ -1,5 +1,7 @@
 module Qismo
   module Objects
+    # Tag object
+    #
     class Tag < Qismo::Object
       # @!attribute [r] created_at
       #   @return [String]
@@ -15,11 +17,11 @@ module Qismo
 
       # @!attribute [r] room_tag_created_at
       #   @return [String]
-      attribute? :room_tag_created, Types::DateTime.optional
+      attribute? :room_tag_created, Types::String.optional
 
       # @!attribute [r] updated_at
       #   @return [String]
-      attribute? :updated_at, Types::DateTime.optional
+      attribute? :updated_at, Types::String.optional
     end
   end
 end

data/lib/qismo/objects/telegram_channel.rb

@@ -0,0 +1,31 @@
+module Qismo
+  module Objects
+    # Telegram channel object
+    #
+    class TelegramChannel < Qismo::Object
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int.optional
+
+      # @!attribute [r] is_active
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_active, Types::Bool.optional
+
+      # @!attribute [r] name
+      #   @return [String]
+      attribute? :name, Types::String.optional
+
+      # @!attribute [r] username
+      #   @return [String]
+      attribute? :username, Types::String.optional
+
+      # @!attribute [r] badge_url
+      #   @return [String]
+      attribute? :badge_url, Types::String.optional
+
+      # @!attribute [r] use_channel_responder
+      #   @return [TrueClass,FalseClass]
+      attribute? :use_channel_responder, Types::Bool.optional
+    end
+  end
+end

data/lib/qismo/objects/user.rb

@@ -1,6 +1,10 @@
 module Qismo
   module Objects
+    # User object
+    #
     class User < Qismo::Object
+      # User channel object
+      #
       class Channel < Qismo::Object
         # @!attribute [r] id
         #   @return [Integer]
@@ -11,6 +15,8 @@ module Qismo
         attribute? :name, Types::String.optional
       end
 
+      # User role object
+      #
       class Role < Qismo::Object
         # @!attribute [r] id
         #   @return [Integer]

data/lib/qismo/objects/wa_channel.rb

@@ -0,0 +1,111 @@
+module Qismo
+  module Objects
+    # WA channel object
+    #
+    class WaChannel < Qismo::Object
+      # @!attribute [r] allow_intl_hsm
+      #   @return [TrueClass,FalseClass]
+      attribute? :allow_intl_hsm, Types::Bool.optional
+
+      # @!attribute [r] alter_app_id
+      #   @return [TrueClass,FalseClass]
+      attribute? :alter_app_id, Types::Bool.optional
+
+      # @!attribute [r] badge_url
+      #   @return [String]
+      attribute? :badge_url, Types::String.optional
+
+      # @!attribute [r] base_url
+      #   @return [String]
+      attribute? :base_url, Types::String.optional
+
+      # @!attribute [r] business_id
+      #   @return [String]
+      attribute? :business_id, Types::String.optional
+
+      # @!attribute [r] business_verification_status
+      #   @return [String]
+      attribute? :business_verification_status, Types::String.optional
+
+      # @!attribute [r] created_at
+      #   @return [String]
+      attribute? :created_at, Types::String.optional
+
+      # @!attribute [r] forward_enabled
+      #   @return [TrueClass,FalseClass]
+      attribute? :forward_enabled, Types::Bool.optional
+
+      # @!attribute [r] forward_url
+      #   @return [String]
+      attribute? :forward_url, Types::String.optional
+
+      # @!attribute [r] hsm_24_enabled
+      #   @return [TrueClass,FalseClass]
+      attribute? :hsm_24_enabled, Types::Bool.optional
+
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int.optional
+
+      # @!attribute [r] is_active
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_active, Types::Bool.optional
+
+      # @!attribute [r] is_auto_responder_enabled
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_auto_responder_enabled, Types::Bool.optional
+
+      # @!attribute [r] is_bot_enabled
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_bot_enabled, Types::Bool.optional
+
+      # @!attribute [r] is_on_cloud
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_on_cloud, Types::Bool.optional
+
+      # @!attribute [r] is_ssl_enabled
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_ssl_enabled, Types::Bool.optional
+
+      # @!attribute [r] name
+      #   @return [String]
+      attribute? :name, Types::String.optional
+
+      # @!attribute [r] on_sync
+      #   @return [TrueClass,FalseClass]
+      attribute? :on_sync, Types::Bool.optional
+
+      # @!attribute [r] phone_number
+      #   @return [String]
+      attribute? :phone_number, Types::String.optional
+
+      # @!attribute [r] phone_number_id
+      #   @return [String]
+      attribute? :phone_number_id, Types::String.optional
+
+      # @!attribute [r] phone_number_status
+      #   @return [String]
+      attribute? :phone_number_status, Types::String.optional
+
+      # @!attribute [r] pin
+      #   @return [String]
+      attribute? :pin, Types::String.optional
+
+      # @!attribute [r] platform
+      #   @return [String]
+      attribute? :platform, Types::String.optional
+
+      # @!attribute [r] read_enabled
+      #   @return [TrueClass,FalseClass]
+      attribute? :read_enabled, Types::Bool.optional
+
+      # @!attribute [r] updated_at
+      #   @return [String]
+      attribute? :updated_at, Types::String.optional
+
+      # @!attribute [r] use_channel_responder
+      #   @return [TrueClass,FalseClass]
+      attribute? :use_channel_responder, Types::Bool.optional
+    end
+  end
+end

data/lib/qismo/objects/wa_credit_info.rb

@@ -1,7 +1,13 @@
 module Qismo
   module Objects
+    # WA credit info object
+    #
     class WaCreditInfo < Qismo::Object
+      # Wa credit info channel object
+      #
       class Channel < Qismo::Object
+        # WA last payment object
+        #
         class LastPayment < Qismo::Object
           # @!attribute [r] credit
           #   @return [String]

data/lib/qismo/objects/waca_channel.rb

@@ -0,0 +1,55 @@
+module Qismo
+  module Objects
+    # Waca channel object
+    #
+    class WacaChannel < Qismo::Object
+      # @!attribute [r] badge_url
+      #   @return [String]
+      attribute? :badge_url, Types::String.optional
+
+      # @!attribute [r] business_id
+      #   @return [String]
+      attribute? :business_id, Types::String.optional
+
+      # @!attribute [r] created_at
+      #   @return [String]
+      attribute? :created_at, Types::String.optional
+
+      # @!attribute [r] updated_at
+      #   @return [String]
+      attribute? :deleted_at, Types::Nil.optional
+
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int.optional
+
+      # @!attribute [r] is_active
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_active, Types::Bool.optional
+
+      # @!attribute [r] name
+      #   @return [String]
+      attribute? :name, Types::String.optional
+
+      # @!attribute [r] phone_number
+      #   @return [String]
+      attribute? :phone_number, Types::String.optional
+
+      # @!attribute [r] phone_number_id
+      #   @return [String]
+      attribute? :phone_number_id, Types::String.optional
+
+      # @!attribute [r] updated_at
+      #   @return [String]
+      attribute? :updated_at, Types::String.optional
+
+      # @!attribute [r] use_channel_responder
+      #   @return [TrueClass,FalseClass]
+      attribute? :use_channel_responder, Types::Bool.optional
+
+      # @!attribute [r] webhook_identifier
+      #   @return [String]
+      attribute? :webhook_identifier, Types::String.optional
+    end
+  end
+end

data/lib/qismo/objects/webhook.rb

@@ -1,5 +1,7 @@
 module Qismo
   module Objects
+    # Webhook object
+    #
     class Webhook < Qismo::Object
       # @!attribute [r] url
       #   @return [String]

data/lib/qismo/types.rb

@@ -1,10 +1,19 @@
 module Qismo
+  # Type specs module. Inherited from dry-types
+  #
   module Types
     include Dry.Types()
 
+    # @return [Integer]
     Int = Params::Integer
+
+    # @return [String]
     String = Coercible::String
+
+    # @return [TrueClass,FalseClass]
     Bool = Params::Bool
+
+    # @return [Hash]
     Hash = Params::Hash
   end
 end

data/lib/qismo/version.rb

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

data/lib/qismo/webhook_requests/on_agent_allocation_needed.rb

@@ -1,6 +1,12 @@
 module Qismo
+  # Objects module to handle objectification of incoming webhook request
+  #
   module WebhookRequests
+    # CAA webhook object
+    #
     class OnAgentAllocationNeeded < Qismo::Object
+      # Candidate agent object
+      #
       # @!attribute [r] avatar_url
       #   @return [String]
       # @!attribute [r] created_at

data/lib/qismo/webhook_requests/on_custom_button_clicked.rb

@@ -1,5 +1,7 @@
 module Qismo
   module WebhookRequests
+    # Custom button webhook object
+    #
     # @!attribute [r] additional_info
     #   @return [Array<AdditionalInfo>]
     # @!attribute [r] agent
@@ -19,8 +21,8 @@ module Qismo
     # @!attribute [r] tag
     #   @return [Array<Tag>]
     class OnCustomButtonClicked < Qismo::Object
-      # @!parse include Qismo::Models
-
+      # Custom button webhook additional info object
+      #
       # @!attribute [r] key
       #   @return [String]
       # @!attribute [r] value
@@ -30,6 +32,8 @@ module Qismo
         attribute? :value, (Types::String.optional | Types::Int.optional | Types::Params::Bool.optional)
       end
 
+      # Custom button webhook agent object
+      #
       # @!attribute [r] email
       #   @return [String]
       # @!attribute [r] name
@@ -42,6 +46,8 @@ module Qismo
         attribute? :type, Types::String.optional
       end
 
+      # Custom webhook customer object
+      #
       # @!attribute [r] avatar
       #   @return [String]
       # @!attribute [r] name
@@ -54,6 +60,8 @@ module Qismo
         attribute? :user_id, Types::String.optional
       end
 
+      # Custom button webhook tag object
+      #
       # @!attribute [r] id
       #   @return [Integer]
       # @!attribute [r] name