qismo 0.13.0 → 0.15.0

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
@@ -18,42 +20,48 @@ module Qismo
     #   @return [Integer]
     # @!attribute [r] tag
     #   @return [Array<Tag>]
-    class OnCustomButtonClicked < Qismo::Models::Base
-      # @!parse include Qismo::Models
-
+    class OnCustomButtonClicked < Qismo::Object
+      # Custom button webhook additional info object
+      #
       # @!attribute [r] key
       #   @return [String]
       # @!attribute [r] value
       #   @return [String,Integer,TrueClass,FalseClass]
-      class AdditionalInfo < Qismo::Models::Base
+      class AdditionalInfo < Qismo::Object
         attribute? :key, Types::String.optional
         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
       #   @return [String]
       # @!attribute [r] type
       #   @return [String]
-      class Agent < Qismo::Models::Base
+      class Agent < Qismo::Object
         attribute? :email, Types::String.optional
         attribute? :name, Types::String.optional
         attribute? :type, Types::String.optional
       end
 
+      # Custom webhook customer object
+      #
       # @!attribute [r] avatar
       #   @return [String]
       # @!attribute [r] name
       #   @return [String]
       # @!attribute [r] user_id
       #   @return [String]
-      class Customer < Qismo::Models::Base
+      class Customer < Qismo::Object
         attribute? :avatar, Types::String.optional
         attribute? :name, Types::String.optional
         attribute? :user_id, Types::String.optional
       end
 
+      # Custom button webhook tag object
+      #
       # @!attribute [r] id
       #   @return [Integer]
       # @!attribute [r] name
@@ -64,7 +72,7 @@ module Qismo
       #   @return [String]
       # @!attribute [r] room_tag_created_at
       #   @return [String]
-      class Tag < Qismo::Models::Base
+      class Tag < Qismo::Object
         attribute? :id, Types::Int.optional
         attribute? :name, Types::String.optional
         attribute? :created_at, Types::String.optional

data/lib/qismo/webhook_requests/on_custom_channel_message_sent.rb

@@ -1,8 +1,12 @@
 module Qismo
   module WebhookRequests
+    # Custom channel webhook object
+    #
     # @!attribute [r] payload
     #   @return [Payload]
-    class OnCustomChannelMessageSent < Qismo::Models::Base
+    class OnCustomChannelMessageSent < Qismo::Object
+      # Custom channel webhook from object
+      #
       # @!attribute [r] avatar_url
       #   @return [String]
       # @!attribute [r] email
@@ -11,13 +15,15 @@ module Qismo
       #   @return [Integer]
       # @!attribute [r] name
       #   @return [String]
-      class From < Qismo::Models::Base
+      class From < Qismo::Object
         attribute? :avatar_url, Types::String.optional
         attribute? :email, Types::String.optional
         attribute? :id, Types::Int.optional
         attribute? :name, Types::String.optional
       end
 
+      # Custom channel webhook message object
+      #
       # @!attribute [r] comment_before_id
       #   @return [Integer]
       # @!attribute [r] created_at
@@ -38,7 +44,7 @@ module Qismo
       #   @return [String]
       # @!attribute [r] unix_timestamp
       #   @return [String]
-      class Message < Qismo::Models::Base
+      class Message < Qismo::Object
         attribute? :comment_before_id, Types::Int.optional
         attribute? :created_at, Types::String.optional
         attribute? :id, Types::Int.optional
@@ -51,12 +57,16 @@ module Qismo
         attribute? :unix_timestamp, Types::String.optional
       end
 
+      # Custom channel webhook participant object
+      #
       # @!attribute [r] email
       #   @return [String]
-      class Participant < Qismo::Models::Base
+      class Participant < Qismo::Object
         attribute? :email, Types::String.optional
       end
 
+      # Custom channel webhook room object
+      #
       # @!attribute [r] id
       #   @return [String]
       # @!attribute [r] name
@@ -67,7 +77,7 @@ module Qismo
       #   @return [Array<Participant>]
       # @!attribute [r] room_avatar
       #   @return [String]
-      class Room < Qismo::Models::Base
+      class Room < Qismo::Object
         attribute? :id, Types::String.optional
         attribute? :name, Types::String.optional
         attribute? :options, Types::String.optional
@@ -75,6 +85,8 @@ module Qismo
         attribute? :room_avatar, Types::String.optional
       end
 
+      # Custom channel webhook payload object
+      #
       # @!attribute [r] from
       #   @return [From]
       # @!attribute [r] message
@@ -83,7 +95,7 @@ module Qismo
       #   @return [Room]
       # @!attribute [r] type
       #   @return [String]
-      class Payload < Qismo::Models::Base
+      class Payload < Qismo::Object
         attribute? :from, From.optional
         attribute? :message, Message.optional
         attribute? :room, Room.optional

data/lib/qismo/webhook_requests/on_message_for_bot_sent.rb

@@ -1,6 +1,10 @@
 module Qismo
   module WebhookRequests
-    class OnMessageForBotSent < Qismo::Models::Base
+    # Chatbot webhook object
+    #
+    class OnMessageForBotSent < Qismo::Object
+      # Chatbot webhook from object
+      #
       # @!attribute [r] avatar_url
       #   @return [String]
       # @!attribute [r] email
@@ -9,13 +13,15 @@ module Qismo
       #   @return [Integer]
       # @!attribute [r] name
       #   @return [String]
-      class From < Qismo::Models::Base
+      class From < Qismo::Object
         attribute? :avatar_url, Types::String.optional
         attribute? :email, Types::String.optional
         attribute? :id, Types::Int.optional
         attribute? :name, Types::String.optional
       end
 
+      # Chatbot webhook message object
+      #
       # @!attribute [r] comment_before_id
       #   @return [Integer]
       # @!attribute [r] created_at
@@ -36,7 +42,7 @@ module Qismo
       #   @return [String]
       # @!attribute [r] unix_timestamp
       #   @return [String]
-      class Message < Qismo::Models::Base
+      class Message < Qismo::Object
         attribute? :comment_before_id, Types::Int.optional
         attribute? :created_at, Types::String.optional
         attribute? :id, Types::Int.optional
@@ -49,12 +55,16 @@ module Qismo
         attribute? :unix_timestamp, Types::String.optional
       end
 
+      # Chatbot webhook participant object
+      #
       # @!attribute [r] email
       #   @return [String]
-      class Participant < Qismo::Models::Base
+      class Participant < Qismo::Object
         attribute? :email, Types::String.optional
       end
 
+      # Chatbot webhook room object
+      #
       # @!attribute [r] id
       #   @return [String]
       # @!attribute [r] name
@@ -65,7 +75,7 @@ module Qismo
       #   @return [Array<Participant>]
       # @!attribute [r] room_avatar
       #   @return [String]
-      class Room < Qismo::Models::Base
+      class Room < Qismo::Object
         attribute? :id, Types::String.optional
         attribute? :name, Types::String.optional
         attribute? :options, Types::String.optional
@@ -73,6 +83,8 @@ module Qismo
         attribute? :room_avatar, Types::String.optional
       end
 
+      # Chatbot webhook payload object
+      #
       # @!attribute [r] from
       #   @return [From]
       # @!attribute [r] message
@@ -81,7 +93,7 @@ module Qismo
       #   @return [Room]
       # @!attribute [r] type
       #   @return [String]
-      class Payload < Qismo::Models::Base
+      class Payload < Qismo::Object
         attribute? :from, From.optional
         attribute? :message, Message.optional
         attribute? :room, Room.optional

data/lib/qismo/webhook_requests/on_new_session_initiated.rb

@@ -1,12 +1,16 @@
 module Qismo
   module WebhookRequests
+    # New session webhook object
+    #
     # @!attribute [r] is_new_session
     #   @return [TrueClass,FalseClass]
     # @!attribute [r] payload
     #   @return [Payload]
     # @!attribute [r] room_log
     #   @return [RoomLog]
-    class OnNewSessionInitiated < Qismo::Models::Base
+    class OnNewSessionInitiated < Qismo::Object
+      # New session webhook from object
+      #
       # @!attribute [r] avatar_url
       #   @return [String]
       # @!attribute [r] email
@@ -15,13 +19,15 @@ module Qismo
       #   @return [Integer]
       # @!attribute [r] name
       #   @return [String]
-      class From < Qismo::Models::Base
+      class From < Qismo::Object
         attribute? :avatar_url, Types::String.optional
         attribute? :email, Types::String.optional
         attribute? :id, Types::Int.optional
         attribute? :name, Types::String.optional
       end
 
+      # New session webhook message object
+      #
       # @!attribute [r] comment_before_id
       #   @return [Integer]
       # @!attribute [r] created_at
@@ -42,7 +48,7 @@ module Qismo
       #   @return [String]
       # @!attribute [r] unix_timestamp
       #   @return [String]
-      class Message < Qismo::Models::Base
+      class Message < Qismo::Object
         attribute? :comment_before_id, Types::Int.optional
         attribute? :created_at, Types::String.optional
         attribute? :id, Types::Int.optional
@@ -55,12 +61,16 @@ module Qismo
         attribute? :unix_timestamp, Types::String.optional
       end
 
+      # New session webhook participant object
+      #
       # @!attribute [r] email
       #   @return [String]
-      class Participant < Qismo::Models::Base
+      class Participant < Qismo::Object
         attribute? :email, Types::String.optional
       end
 
+      # New session webhook room object
+      #
       # @!attribute [r] id
       #   @return [String]
       # @!attribute [r] name
@@ -71,7 +81,7 @@ module Qismo
       #   @return [Array<Participant>]
       # @!attribute [r] room_avatar
       #   @return [String]
-      class Room < Qismo::Models::Base
+      class Room < Qismo::Object
         attribute? :id, Types::String.optional
         attribute? :name, Types::String.optional
         attribute? :options, Types::String.optional
@@ -79,6 +89,8 @@ module Qismo
         attribute? :room_avatar, Types::String.optional
       end
 
+      # New session webhook message payload object
+      #
       # @!attribute [r] from
       #   @return [From]
       # @!attribute [r] message
@@ -87,27 +99,33 @@ module Qismo
       #   @return [Room]
       # @!attribute [r] type
       #   @return [String]
-      class Payload < Qismo::Models::Base
+      class Payload < Qismo::Object
         attribute? :from, From.optional
         attribute? :message, Message.optional
         attribute? :room, Room.optional
       end
 
+      # New session webhook user property object
+      #
       # @!attribute [r] key
       #   @return [String]
       # @!attribute [r] value
       #   @return [String,Integer,TrueClass,FalseClass]
-      class UserProperty < Qismo::Models::Base
+      class UserProperty < Qismo::Object
         attribute? :key, Types::String.optional
         attribute? :value, (Types::String.optional | Types::Int.optional | Types::Params::Bool.optional)
       end
 
+      # New session webhook additional extras object
+      #
       # @!attribute [r] timezone_offset
       #   @return [String]
-      class AdditionalExtras < Qismo::Models::Base
+      class AdditionalExtras < Qismo::Object
         attribute? :timezone_offset, Types::String
       end
 
+      # New session webhook extras object
+      #
       # @!attribute [r] additional_extras
       #   @return [AdditionalExtras]
       # @!attribute [r] notes
@@ -116,13 +134,15 @@ module Qismo
       #   @return [String]
       # @!attribute [r] user_properties
       #   @return [Array<UserProperty>]
-      class Extras < Qismo::Models::Base
+      class Extras < Qismo::Object
         attribute? :additional_extras, AdditionalExtras.optional
         attribute? :notes, Types::String
         attribute? :timezone_offset, Types::String
         attribute? :user_properties, Types.Array(UserProperty.optional).optional
       end
 
+      # New session webhook room log object
+      #
       # @!attribute [r] channel_id
       #   @return [Integer]
       # @!attribute [r] created_at
@@ -147,7 +167,7 @@ module Qismo
       #   @return [String]
       # @!attribute [r] user_id
       #   @return [String]
-      class RoomLog < Qismo::Models::Base
+      class RoomLog < Qismo::Object
         attribute? :channel_id, Types::Int
         attribute? :created_at, Types::String
         attribute? :extras, Extras

data/lib/qismo/webhook_requests/on_room_resolved.rb

@@ -1,21 +1,27 @@
 module Qismo
   module WebhookRequests
+    # Room resolve webhook object
+    #
     # @!attribute [r] customer
     #   @return [Customer]
     # @!attribute [r] resolved_by
     #   @return [ResolvedBy]
     # @!attribute [r] service
     #   @return [Service]
-    class OnRoomResolved < Qismo::Models::Base
+    class OnRoomResolved < Qismo::Object
+      # Room resolve webhook additional info object
+      #
       # @!attribute [r] key
       #   @return [String]
       # @!attribute [r] value
       #   @return [String,Integer,TrueClass,FalseClass]
-      class AdditionalInfo < Qismo::Models::Base
+      class AdditionalInfo < Qismo::Object
         attribute? :key, Types::String.optional
         attribute? :value, (Types::String.optional | Types::Int.optional | Types::Params::Bool.optional)
       end
 
+      # Room resolve webhook customer object
+      #
       # @!attribute [r] additional_info
       #   @return [Array<AdditionalInfo>]
       # @!attribute [r] avatar
@@ -24,13 +30,15 @@ module Qismo
       #   @return [String]
       # @!attribute [r] user_id
       #   @return [String]
-      class Customer < Qismo::Models::Base
+      class Customer < Qismo::Object
         attribute? :additional_info, Types.Array(AdditionalInfo.optional).optional
         attribute? :avatar, Types::String.optional
         attribute? :name, Types::String.optional
         attribute? :user_id, Types::String.optional
       end
 
+      # Room resolve webhook resolved by object
+      #
       # @!attribute [r] email
       #   @return [String]
       # @!attribute [r] id
@@ -41,7 +49,7 @@ module Qismo
       #   @return [String]
       # @!attribute [r] type
       #   @return [String]
-      class ResolvedBy < Qismo::Models::Base
+      class ResolvedBy < Qismo::Object
         attribute? :email, Types::String.optional
         attribute? :id, Types::Int.optional
         attribute? :is_available, Types::Bool.optional
@@ -49,6 +57,8 @@ module Qismo
         attribute? :type, Types::String.optional
       end
 
+      # Room resolve webhook service object
+      #
       # @!attribute [r] first_comment_id
       #   @return [String]
       # @!attribute [r] last_comment_id
@@ -63,7 +73,7 @@ module Qismo
       #   @return [String]
       # @!attribute [r] source
       #   @return [String]
-      class Service < Qismo::Models::Base
+      class Service < Qismo::Object
         attribute? :first_comment_id, Types::String.optional
         attribute? :last_comment_id, Types::String.optional
         attribute? :id, Types::Int.optional

data/lib/qismo.rb

@@ -6,9 +6,33 @@ require "http"
 
 require "qismo/version"
 require "qismo/types"
-require "qismo/util"
+require "qismo/error"
 
-require "qismo/models/base"
+require "qismo/object"
+require "qismo/objectified_hash"
+require "qismo/collection"
+
+require "qismo/objects/customer_room"
+require "qismo/objects/tag"
+require "qismo/objects/room_additional_info"
+require "qismo/objects/broadcast_log"
+require "qismo/objects/user"
+require "qismo/objects/agent_service"
+require "qismo/objects/webhook"
+require "qismo/objects/office_hour"
+require "qismo/objects/hsm_template"
+require "qismo/objects/wa_credit_info"
+require "qismo/objects/broadcast_job"
+require "qismo/objects/custom_channel_message_response"
+require "qismo/objects/custom_channel"
+require "qismo/objects/fb_channel"
+require "qismo/objects/ig_channel"
+require "qismo/objects/line_channel"
+require "qismo/objects/qiscus_channel"
+require "qismo/objects/telegram_channel"
+require "qismo/objects/wa_channel"
+require "qismo/objects/waca_channel"
+require "qismo/objects/list_channels_response"
 
 require "qismo/webhook_requests/on_agent_allocation_needed"
 require "qismo/webhook_requests/on_custom_button_clicked"
@@ -17,40 +41,10 @@ require "qismo/webhook_requests/on_message_for_bot_sent"
 require "qismo/webhook_requests/on_new_session_initiated"
 require "qismo/webhook_requests/on_room_resolved"
 
-require "qismo/error"
-require "qismo/model"
 require "qismo/api"
 require "qismo/client"
 
+# Qismo ruby root module
+#
 module Qismo
-  class << self
-    # @!parse extend Qismo::Api
-
-    def configure
-      yield client
-
-      client
-    end
-
-    private
-
-    # @return [Qismo::Client]
-    def client
-      @client ||= Client.new
-    end
-
-    def method_missing(method, *args, &block)
-      return super unless client.respond_to?(method)
-
-      client.send(method, *args, &block)
-    end
-
-    def respond_to?(method_name, include_private = false)
-      client.respond_to?(method_name, include_private) || super(method_name, include_private)
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      client.respond_to?(method_name, include_private) || super(method_name, include_private)
-    end
-  end
 end

data/qismo.gemspec

@@ -44,4 +44,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency("activesupport")
   spec.add_runtime_dependency("http")
   spec.add_runtime_dependency("dry-struct", "~> 1.6")
+  spec.add_runtime_dependency("dry-validation", "~> 1.10")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qismo
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Qiscus Integration
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
 description: Ruby wrapper for Qiscus Omnichannel public API
 email:
 - developer@qiscus.net
@@ -65,12 +79,32 @@ files:
 - lib/qismo.rb
 - lib/qismo/api.rb
 - lib/qismo/client.rb
+- lib/qismo/collection.rb
 - lib/qismo/error.rb
-- lib/qismo/model.rb
-- lib/qismo/models/base.rb
-- lib/qismo/models/customer_room.rb
+- lib/qismo/object.rb
+- lib/qismo/objectified_hash.rb
+- lib/qismo/objects/agent_service.rb
+- lib/qismo/objects/broadcast_job.rb
+- lib/qismo/objects/broadcast_log.rb
+- lib/qismo/objects/custom_channel.rb
+- lib/qismo/objects/custom_channel_message_response.rb
+- lib/qismo/objects/customer_room.rb
+- lib/qismo/objects/fb_channel.rb
+- lib/qismo/objects/hsm_template.rb
+- lib/qismo/objects/ig_channel.rb
+- lib/qismo/objects/line_channel.rb
+- lib/qismo/objects/list_channels_response.rb
+- lib/qismo/objects/office_hour.rb
+- lib/qismo/objects/qiscus_channel.rb
+- lib/qismo/objects/room_additional_info.rb
+- lib/qismo/objects/tag.rb
+- lib/qismo/objects/telegram_channel.rb
+- lib/qismo/objects/user.rb
+- lib/qismo/objects/wa_channel.rb
+- lib/qismo/objects/wa_credit_info.rb
+- lib/qismo/objects/waca_channel.rb
+- lib/qismo/objects/webhook.rb
 - lib/qismo/types.rb
-- lib/qismo/util.rb
 - lib/qismo/version.rb
 - lib/qismo/webhook_requests/on_agent_allocation_needed.rb
 - lib/qismo/webhook_requests/on_custom_button_clicked.rb