gitlab-customer-support-operations_zendesk 1.0.0

data/lib/support_ops_zendesk/zendesk/via_types.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class ViaTypes within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Integer] id An auto-generated id
+    # @attr [String] name Theh name of the via type
+    class ViaTypes < SupportOps::Zendesk::Base
+      define_attributes :id, :name
+      readonly_attributes :id, :name
+
+      ##
+      # Lists via types
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @return [Array]
+      # @example
+      #   require 'support_ops_zendesk'
+      #   types = SupportOps::Zendesk::ViaTypes.list
+      #   pp types.first.name
+      #   # => "Web form"
+      def self.list
+        [
+          { 'id' => 0, 'name' => 'Web form' },
+          { 'id' => 4, 'name' => 'Email' },
+          { 'id' => 5, 'name' => 'Web service (API)' },
+          { 'id' => 8, 'name' => 'Trigger, automation' },
+          { 'id' => 9, 'name' => 'Linked problem' },
+          { 'id' => 10, 'name' => 'Group deletion' },
+          { 'id' => 11, 'name' => 'Change user' },
+          { 'id' => 12, 'name' => 'Delete user' },
+          { 'id' => 13, 'name' => 'Change group' },
+          { 'id' => 14, 'name' => 'Push resource' },
+          { 'id' => 15, 'name' => 'iPhone' },
+          { 'id' => 16, 'name' => 'Get Satisfaction' },
+          { 'id' => 17, 'name' => 'Feedback tab' },
+          { 'id' => 19, 'name' => 'Merge' },
+          { 'id' => 20, 'name' => 'Batch' },
+          { 'id' => 21, 'name' => 'Recover from suspended ticket' },
+          { 'id' => 22, 'name' => 'Automatic Solution Suggestions' },
+          { 'id' => 23, 'name' => 'X (formerly Twitter) like' },
+          { 'id' => 24, 'name' => 'Topic' },
+          { 'id' => 25, 'name' => 'Merge user' },
+          { 'id' => 26, 'name' => 'X DM' },
+          { 'id' => 27, 'name' => 'Closed ticket' },
+          { 'id' => 28, 'name' => 'LogMeIn Rescue' },
+          { 'id' => 29, 'name' => 'Chat' },
+          { 'id' => 30, 'name' => 'X' },
+          { 'id' => 31, 'name' => 'Ticket sharing' },
+          { 'id' => 32, 'name' => 'Macro reference' },
+          { 'id' => 33, 'name' => 'Voicemail' },
+          { 'id' => 34, 'name' => 'Phone call (incoming)' },
+          { 'id' => 35, 'name' => 'Phone call (outbound)' },
+          { 'id' => 36, 'name' => 'Blog' },
+          { 'id' => 37, 'name' => 'Text message' },
+          { 'id' => 38, 'name' => 'Facebook post' },
+          { 'id' => 39, 'name' => 'Import' },
+          { 'id' => 40, 'name' => 'GitHub' },
+          { 'id' => 41, 'name' => 'Facebook private message' },
+          { 'id' => 42, 'name' => 'Lotus' },
+          { 'id' => 43, 'name' => 'Monitor event' },
+          { 'id' => 44, 'name' => 'CTI* voicemail' },
+          { 'id' => 45, 'name' => 'CTI phone call (inbound)' },
+          { 'id' => 46, 'name' => 'CTI phone call (outbound)' },
+          { 'id' => 47, 'name' => 'Churned account' },
+          { 'id' => 48, 'name' => 'Web Widget' },
+          { 'id' => 49, 'name' => 'Mobile SDK' },
+          { 'id' => 50, 'name' => 'Help center post' },
+          { 'id' => 51, 'name' => 'Sample ticket' },
+          { 'id' => 52, 'name' => 'Sample interactive ticket' },
+          { 'id' => 53, 'name' => 'Admin setting' },
+          { 'id' => 54, 'name' => 'Satisfaction prediction' },
+          { 'id' => 55, 'name' => 'Channel framework' },
+          { 'id' => 56, 'name' => 'Mobile' },
+          { 'id' => 57, 'name' => 'SMS text messages (through Talk)' },
+          { 'id' => 58, 'name' => 'Ticket tagging' },
+          { 'id' => 59, 'name' => 'Connect IPM' },
+          { 'id' => 60, 'name' => 'Connect Mail' },
+          { 'id' => 61, 'name' => 'Connect SMS' },
+          { 'id' => 62, 'name' => 'Rule revision' },
+          { 'id' => 63, 'name' => 'Answer Bot for agents' },
+          { 'id' => 64, 'name' => 'Answer Bot for Slack' },
+          { 'id' => 65, 'name' => 'Answer Bot for SDK' },
+          { 'id' => 66, 'name' => 'Answer Bot API' },
+          { 'id' => 67, 'name' => 'Answer Bot for Web Widget' },
+          { 'id' => 68, 'name' => 'Symphony' },
+          { 'id' => 69, 'name' => 'Side conversation' },
+          { 'id' => 70, 'name' => 'Answer Bot' },
+          { 'id' => 71, 'name' => 'Omnichannel' },
+          { 'id' => 72, 'name' => 'LINE' },
+          { 'id' => 73, 'name' => 'WeChat' },
+          { 'id' => 74, 'name' => 'WhatsApp' },
+          { 'id' => 75, 'name' => 'Native messaging' },
+          { 'id' => 76, 'name' => 'Mailgun' },
+          { 'id' => 77, 'name' => 'MessageBird SMS' },
+          { 'id' => 78, 'name' => 'Sunshine Conversations Facebook Messenger' },
+          { 'id' => 79, 'name' => 'Telegram messenger' },
+          { 'id' => 80, 'name' => 'Sunshine Conversations Twilio SMS' },
+          { 'id' => 81, 'name' => 'Viber messenger' },
+          { 'id' => 82, 'name' => 'Google RCS messaging' },
+          { 'id' => 83, 'name' => 'Apple Messages for Business' },
+          { 'id' => 84, 'name' => 'Google Business Messages' },
+          { 'id' => 85, 'name' => 'KakaoTalk messenger' },
+          { 'id' => 86, 'name' => 'Instagram Direct Messenger' },
+          { 'id' => 87, 'name' => 'Sunshine Conversations API' },
+          { 'id' => 88, 'name' => 'Sunshine Conversations X DM' },
+          { 'id' => 89, 'name' => 'Offline Chat Message' },
+          { 'id' => 90, 'name' => 'Chat transcript' },
+          { 'id' => 91, 'name' => 'Slack Connect Business Messaging' }
+        ].map { |v| ViaTypes.new(v) }
+      end
+
+      ##
+      # Locates a via type within Zendesk by name
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param name [String] The via type name to look for
+      # @return [Object] An instance of {SupportOps::Zendesk::ViaTypes}
+      # @example
+      #   require 'support_ops_zendesk'
+      #   type = SupportOps::Zendesk::ViaTypes.find_by_name('Web form')
+      #   pp type.id
+      #   # => 0
+      def self.find_by_name(name)
+        ViaTypes.list.detect { |v| v.name == name }
+      end
+    end
+  end
+end