gitlab-customer-support-operations_zendesk 1.0.0

data/lib/support_ops_zendesk/zendesk/macros.rb

@@ -0,0 +1,407 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Macros within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Array] actions Each action describes what the macro will do
+    # @attr [Boolean] active Useful for determining if the macro should be displayed
+    # @attr [String] created_at The time the macro was created
+    # @attr [Boolean] default If true, the macro is a default macro
+    # @attr [String] description The description of the macro
+    # @attr [Integer] id The ID automatically assigned when a macro is created
+    # @attr [Integer] position The position of the macro
+    # @attr [Hash] restriction Access to this macro, a null value allows unrestricted access for all users in the account
+    # @attr [String] title The title of the macro
+    # @attr [String] updated_at The time of the last update of the macro
+    # @todo Search Macros => https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#search-macros
+    # @todo List Macro Categories => https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#list-macro-categories
+    # @todo List Supported Actions for Macros => https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#list-supported-actions-for-macros
+    # @todo List Macro Action Definitions => https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#list-macro-action-definitions
+    # @todo Show Macro Replica => https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#show-macro-replica
+    # @todo List Macro Attachments => https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#list-macro-attachments
+    # @todo Show Macro Attachment => https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#show-macro-attachment
+    # @todo Create Macro Attachment => https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#create-macro-attachment
+    # @todo Create Unassociated Macro Attachment => https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#create-unassociated-macro-attachment
+    # @todo Show Changes to Ticket => https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#show-changes-to-ticket
+    # @todo Show Ticket After Changes => https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#show-ticket-after-changes
+    class Macros < SupportOps::Zendesk::Base
+      # @!parse
+      #   # Creates/updates a macro
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::Zendesk::Automations}
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#save!}
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#create-macro
+      #   #   Zendesk API > Macros > Create Macro
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#update-macro
+      #   #   Zendesk API > Macros > Update Macro
+      #   # @example
+      #   #   require 'support_ops_zendesk'
+      #   #
+      #   #   SupportOps::Zendesk::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #   #     config.username = 'jason@example.com'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   new_macro = SupportOps::Zendesk::Macros.new
+      #   #   new_macro.title = 'General::Add replicating tag'
+      #   #   new_macro.actions = [
+      #   #       {
+      #   #         field: 'current_tags',
+      #   #         value: 'replicating'
+      #   #       }
+      #   #   ]
+      #   #
+      #   #   new_macro.save!
+      #   #
+      #   #   pp new_macro.id
+      #   #   # => 23409462
+      #   # @example
+      #   #   require 'support_ops_zendesk'
+      #   #
+      #   #   SupportOps::Zendesk::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #   #     config.username = 'jason@example.com'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   existing_macro = SupportOps::Zendesk::Macros.get!(23409462)
+      #   #   existing_macro.title = 'Support::Add replicating tag'
+      #   #
+      #   #   existing_macro.save!
+      #   #
+      #   #   pp existing_macro.title
+      #   #   # => "Support::Add replicating tag"
+      #   def save!; end
+      # @!parse
+      #   # Deletes a macro
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#delete!}
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#delete-macro
+      #   #   Zendesk API > Macros > Delete Macro
+      #   # @example
+      #   #   require 'support_ops_zendesk'
+      #   #
+      #   #   SupportOps::Zendesk::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #   #     config.username = 'jason@example.com'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   existing_macro = SupportOps::Zendesk::Macros.get!(23409462)
+      #   #   existing_macro.delete!
+      #   def delete!; end
+      define_attributes :actions, :active, :created_at, :default, :description,
+                        :id, :position, :restriction, :title, :updated_at
+      readonly_attributes :created_at, :default, :id, :updated_at
+
+      ##
+      # Lists macros in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param access [String optional] Filter macros by access, possible
+      #     values are "personal", "agents", "shared", or "account" (the
+      #     "agents" value returns all personal macros for the account's agents
+      #     and is only available to admins)
+      #   @param active [Boolean optional] Filter by active macros if true or
+      #     inactive macros if false
+      #   @param category [Integer optional] Filter macros by category
+      #   @param group_id [Integer optiona] Filter macros by group
+      #   @param only_viewable [Boolean optional] If true, returns only macros
+      #     that can be applied to tickets; If false, returns all macros the
+      #     current user can manage
+      #   @param sort_by [String optional] Possible values are "alphabetical",
+      #     "created_at", "updated_at", "usage_1h", "usage_24h", "usage_7d", or
+      #     "usage_30d" (defaults to alphabetical)
+      #   @param sort_order [String optional] One of "asc" or "desc" (defaults
+      #     to "asc" for alphabetical and position sort, "desc" for all others)
+      #   @param limit [Integer optional] The limit to the number of macros
+      #     returned. Default to 0 (i.e. no limit)
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#list-macros
+      #   Zendesk API > Macros > List Macros
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   macros = SupportOps::Zendesk::Macros.list(limit: 10)
+      #   pp macros.count
+      #   # => 10
+      #   pp macros.last.title
+      #   # => "I'm the 10th macro"
+      def self.list(**args)
+        args[:limit] = 0 unless args[:limit]
+        sort_order = (args[:sort_order] == 'desc' ? '-' : '')
+        array = []
+        opts = 'page[size]=100'
+        opts += "&access=#{args[:access]}" if args[:access]
+        opts += "&active=#{args[:active]}" if args[:active]
+        opts += "&category=#{args[:category]}" if args[:category]
+        opts += "&group_id=#{args[:group_id]}" if args[:group_id]
+        opts += "&only_viewable=#{args[:only_viewable]}" if args[:only_viewable]
+        opts += "&sort=#{sort_order}#{args[:sort_by]}" if args[:sort_by]
+        loop do
+          response = client.connection.get("macros?#{opts}")
+          body = Oj.load(response.body)
+          array += body['macros'].map { |m| Macros.new(m) }
+          break if args[:limit].to_i.positive? && array.count >= args[:limit].to_i
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        return array if args[:limit].to_i.zero?
+        
+        array.first(args[:limit].to_i)
+      end
+
+      ##
+      # Lists macros in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list_active(key: value)
+      #   @param access [String optional] Filter macros by access, possible
+      #     values are "personal", "agents", "shared", or "account" (the
+      #     "agents" value returns all personal macros for the account's agents
+      #     and is only available to admins)
+      #   @param category [Integer optional] Filter macros by category
+      #   @param group_id [Integer optiona] Filter macros by group
+      #   @param sort_by [String optional] Possible values are "alphabetical",
+      #     "created_at", "updated_at", "usage_1h", "usage_24h", "usage_7d", or
+      #     "usage_30d" (defaults to alphabetical)
+      #   @param sort_order [String optional] One of "asc" or "desc" (defaults
+      #     to "asc" for alphabetical and position sort, "desc" for all others)
+      #   @param limit [Integer optional] The limit to the number of macros
+      #     returned. Default to 0 (i.e. no limit)
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#list-macros
+      #   Zendesk API > Macros > List Macros
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   macros = SupportOps::Zendesk::Macros.list_active(limit: 10)
+      #   pp macros.count
+      #   # => 10
+      #   pp macros.last.title
+      #   # => "I'm the 10th macro"
+      def self.list_active(**args)
+        args[:limit] = 0 unless args[:limit]
+        sort_order = (args[:sort_order] == 'desc' ? '-' : '')
+        array = []
+        opts = 'page[size]=100'
+        opts += "&access=#{args[:access]}" if args[:access]
+        opts += "&category=#{args[:category]}" if args[:category]
+        opts += "&group_id=#{args[:group_id]}" if args[:group_id]
+        opts += "&sort=#{sort_order}#{args[:sort_by]}" if args[:sort_by]
+        loop do
+          response = client.connection.get("macros/active?#{opts}")
+          body = Oj.load(response.body)
+          array += body['macros'].map { |m| Macros.new(m) }
+          break if args[:limit].to_i.positive? && array.count >= args[:limit].to_i
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        return array if args[:limit].to_i.zero?
+        
+        array.first(args[:limit].to_i)
+      end
+
+      ##
+      # Locates a specific macro in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#show-macro
+      #   Zendesk API > Macros > Show Macro
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   macro = SupportOps::Zendesk::Macros.get(25)
+      #   pp macro.title
+      #   # => "I'm the 25th macro"
+      def self.get(object)
+        if object.is_a? Macros
+          Macros.new(id: id).find
+        else
+          Macros.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific macro in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#show-macro
+      #   Zendesk API > Macros > Show Macro
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   macro = SupportOps::Zendesk::Macros.get!(25)
+      #   pp macro.title
+      #   # => "I'm the 25th macro"
+      def self.get!(object)
+        if object.is_a? Macros
+          Macros.new(id: id).find!
+        else
+          Macros.new(id: object).find!
+        end
+      end
+
+      ##
+      # Updates multiple macros via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param macros [Array] An array of {SupportOps::Zendesk::Macros} instances
+      # @return [object] A {SupportOps::Zendesk::JobStatuses} instance
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#update-many-macros
+      #   Zendesk API > Macros > Update Many Macros
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   macro1 = SupportOps::Zendesk::Macros.get!(123)
+      #   macro1.active = false
+      #   macro2 = SupportOps::Zendesk::Macros.get!(456)
+      #   macro2.active = true
+      #
+      #   updates = SupportOps::Zendesk::Macros.update_many!([macro1, macro2])
+      #   pp updates.id
+      #   # => "82de0b044094f0c67893ac9fe64f1a99"
+      def self.update_many!(macros)
+        raise 'The parameter must be an Array' unless macros.is_a? Array
+        raise 'You can only update a maximum of 100 macros at a time' if macros.count > 100
+        raise 'You can only use SupportOps::Zendesk::Macros instances in the Array' unless macros.reject { |o| o.is_a? SupportOps::Zendesk::Macros }.count.zero?
+
+        data = { macros: macros.map { |a| to_hash(a).compact } }.to_json
+        response = client.connection.put('macros/update_many', data)
+        raise "Failed to update macros => #{body['details']}" if response.status != 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+
+      ##
+      # Deletes multiple macros via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param macro_ids [Array] An array of macro IDs
+      # @return [object] A {SupportOps::Zendesk::JobStatuses} instance
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#bulk-delete-macros
+      #   Zendesk API > Macros > Bulk Delete Macros
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   delete = SupportOps::Zendesk::Macros.delete_many!([123, 456])
+      #   pp delete.id
+      #   # => "82de0b044094f0c67893ac9fe64f1a99"
+      def self.delete_many!(macro_ids)
+        raise 'The parameter must be an Array' unless macro_ids.is_a? Array
+        raise 'You can only delete a maximum of 100 macros at a time' if macro_ids.count > 100
+
+        response = client.connection.delete("macros/destroy_many?ids=#{macro_ids.join(',')}")
+        raise "Failed to delete macros => #{body['details']}" if response.status != 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("macros/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)['macro']
+      end
+
+      ##
+      # @private
+      def create_record
+        response = self.client.connection.post("macros", { macro: attributes_for_save }.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to create macro => #{body['details']}" if response.status != 201
+        body['macro']
+      end
+
+      ##
+      # @private
+      def update_record
+        raise "Failed to update macro => You didn't change anything in the object" if attributes_for_save.keys == [:id]
+        response = self.client.connection.put("macros/#{self.id}", { macro: attributes_for_save }.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to update macro #{self.id} => #{body['details']}" if response.status != 200
+        body['macro']
+      end
+
+      ##
+      # @private
+      def delete_record
+        response = self.client.connection.delete("macros/#{self.id}")
+        raise "Failed to delete macro => #{body['details']}" if response.status != 204
+        true
+      end
+    end
+  end
+end

data/lib/support_ops_zendesk/zendesk/oauth_clients.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class OAuthClients within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] company The company name displayed when users are asked to grant access to your application.
+    # @attr [String] created_at The time the client was created
+    # @attr [String] description A short description of your client that is displayed to users when they are considering approving access to your application
+    # @attr [Boolean] global Whether this client is globally accessible.
+    # @attr [Integer] id Automatically assigned upon creation
+    # @attr [String] identifier The unique identifier for this client
+    # @attr [String] kind Either "public" or "confidential". Specifies whether the OAuth client operates in a public environment where credentials cannot be securely stored, or on secure servers that can safely store credentials. 
+    # @attr [String] logo_url The API logo url of this record
+    # @attr [String] name The name of this client
+    # @attr [Array] redirect_url An array of the valid redirect URIs for this client
+    # @attr [String] secret The client secret. Generated automatically on creation and returned in full only at that time
+    # @attr [String] updated_at The time of the last update of the client
+    # @attr [Integer] user_id The id of the admin who created the client
+    # @todo Create Client => https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#create-client
+    # @todo Update Client => https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#update-client
+    # @todo Delete Client => https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#delete-client
+    # @todo Generate Secret => https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#generate-secret
+    class OAuthClients < SupportOps::Zendesk::Base
+      define_attributes :company, :created_at, :description, :global, :id,
+                        :identifier, :kind, :logo_url, :name, :redirect_url,
+                        :secret, :updated_at, :user_id
+      readonly_attributes :created_at, :global, :id, :logo_url, :secret,
+                          :updated_at
+
+      ##
+      # Lists OAuth clients in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param limit [Integer optional] The limit to the number of
+      #     oauth clients returned. Default to 0 (i.e. no limit)
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#list-clients
+      #   Zendesk API > OAuth Clients > List Clients
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   oauth_clients = SupportOps::Zendesk::OAuthClients.list(limit: 25)
+      #   pp oauth_clients.count
+      #   # => 25
+      #   pp oauth_clients.last.name
+      #   # => "25th OAuth Client"
+      def self.list(**args)
+        args[:limit] = 0 unless args[:limit]
+        array = []
+        opts = "page[size]=100&sort=#{args[:sort]}"
+        loop do
+          response = client.connection.get("oauth/clients?#{opts}")
+          body = Oj.load(response.body)
+          array += body['clients'].map { |c| OAuthClients.new(c) }
+          break if args[:limit].to_i.positive? && array.count >= args[:limit].to_i
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        return array if args[:limit].to_i.zero?
+        
+        array.first(args[:limit].to_i)
+      end
+
+      ##
+      # Locates a OAuth client within Zendesk by name. Can utilize a cache for quicker results
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload find_by_name(key: value)
+      #   @param name [String required] The name to search for
+      #   @param cache [Array] An Array of SupportOps::Zendesk::OAuthClients to use as a cache
+      # @return [Object] An instance of {SupportOps::Zendesk::OAuthClients}
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   oauth_clients = SupportOps::Zendesk::OAuthClients.list
+      #   oauth_client = SupportOps::Zendesk::OAuthClients.find_by_name(name: '25th OAuth Client', cache: oauth_clients)
+      #   pp oauth_client.name
+      #   # => "25th OAuth Client"
+      #   pp oauth_client.id
+      #   # => 125
+      def self.find_by_name(**args)
+        raise 'You have to provide a name' unless args[:name]
+        if args[:cache]
+          raise 'Provided cache is not an Array' unless args[:cache].is_a? Array
+          oauth_clients = args[:cache]
+        else
+          oauth_clients = list
+        end
+        oauth_clients.detect { |c| c.name.downcase == args[:name].to_s.downcase }
+      end
+
+      ##
+      # Locates a specific OAuth client in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#show-client
+      #   Zendesk API > OAuth Clients > Show Client
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   oauth_client = SupportOps::Zendesk::OAuthClients.get(125)
+      #   pp oauth_client.name
+      #   # => "25th OAuth Client"
+      def self.get(object)
+        if object.is_a? OAuthClients
+          OAuthClients.new(id: id).find
+        else
+          OAuthClients.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific OAuth client in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#show-client
+      #   Zendesk API > OAuth Clients > Show Client
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   oauth_client = SupportOps::Zendesk::OAuthClients.get!(125)
+      #   pp oauth_client.name
+      #   # => "25th OAuth Client"
+      def self.get!(object)
+        if object.is_a? OAuthClients
+          OAuthClients.new(id: id).find!
+        else
+          OAuthClients.new(id: object).find!
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("oauth/clients/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)['client']
+      end
+    end
+  end
+end