gitlab-customer-support-operations_zendesk 1.0.0

data/lib/support_ops_zendesk/zendesk/organizations.rb

@@ -0,0 +1,568 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Organizations within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] created_at The time the organization was created
+    # @attr [String] details Any details obout the organization, such as the address
+    # @attr [Array] domain_names An array of domain names associated with this organization
+    # @attr [String] external_id A unique external id to associate organizations to an external record
+    # @attr [Integer] group_id New tickets from users in this organization are automatically put in this group
+    # @attr [Integer] id Automatically assigned when the organization is created
+    # @attr [String] name A unique name for the organization
+    # @attr [String] notes Any notes you have about the organization
+    # @attr [Array] organization_fields Custom fields for this organization
+    # @attr [Boolean] shared_comments End users in this organization are able to comment on each other's tickets
+    # @attr [Boolean] shared_tickets End users in this organization are able to see each other's tickets
+    # @attr [Array] tags The tags of the organization
+    # @attr [String] updated_at The time of the last update of the organization
+    # @todo Show Organization's Related Information => https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#show-organizations-related-information
+    # @todo Merge Organization With Another Organization => https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#merge-organization-with-another-organization
+    # @todo Show Organization Merge => https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#show-organization-merge
+    # @todo List Organization Merges => https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#list-organization-merges
+    class Organizations < SupportOps::Zendesk::Base
+      # @!parse
+      #   # Creates/updates an organization
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::Zendesk::Organizations}
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#save!}
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#create-organization
+      #   #   Zendesk API > Organizations > Create Organization
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#update-organization
+      #   #   Zendesk API > Organizations > Update Organization
+      #   # @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_org = SupportOps::Zendesk::Organizations.new
+      #   #   new_org.name = 'My Organization'
+      #   #
+      #   #   new_org.save!
+      #   #
+      #   #   pp new_org.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_org = SupportOps::Zendesk::Organizations.get!(23409462)
+      #   #   existing_org.notes = 'Something interesting'
+      #   #
+      #   #   existing_org.save!
+      #   #
+      #   #   pp existing_org.name
+      #   #   # => "My Organization"
+      #   def save!; end
+      # @!parse
+      #   # Deletes an organization
+      #   # 
+      #   # @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/organizations/organizations/#delete-organization
+      #   #   Zendesk API > Organizations > Delete Organization
+      #   # @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_org = SupportOps::Zendesk::Organizations.get!(23409462)
+      #   #   existing_org.delete!
+      #   def delete!; end
+      # @!parse
+      #   # Creates or updates an organization
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object]
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#create_or_update!}
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#create-or-update-organization
+      #   #   Zendesk API > Organizations > Create Or Update Organization
+      #   # @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_org = SupportOps::Zendesk::Organizations.get!(123)
+      #   #   existing_org.name = 'My Organization'
+      #   #
+      #   #   existing_org.create_or_update!
+      #   #
+      #   #   pp existing_org.name
+      #   #   # => "My Organization"
+      #   def create_or_update!; end
+      # @!parse
+      #   # Lists organization memberships
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object]
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#memberships}
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#list-memberships
+      #   #   Zendesk API > Organization Memberships > List Memberships
+      #   # @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_org = SupportOps::Zendesk::Organizations.get!(123)
+      #   #   memberships = existing_org.memberships
+      #   #
+      #   #   pp memberships.first.user_id
+      #   #   # => 29
+      #   def memberships; end
+      # @!parse
+      #   # Lists organization tickets
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object]
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#tickets}
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#list-tickets
+      #   #   Zendesk API > Tickets > List Tickets
+      #   # @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_org = SupportOps::Zendesk::Organizations.get!(16)
+      #   #   tickets = existing_org.tickets
+      #   #
+      #   #   pp tickets.first.status
+      #   #   # => "pending"
+      #   def tickets; end
+      # @!parse
+      #   # Lists organization users
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object]
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#users}
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/users/users/#list-users
+      #   #   Zendesk API > USers > List Users
+      #   # @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_org = SupportOps::Zendesk::Organizations.get!(16)
+      #   #   users = existing_org.users
+      #   #
+      #   #  pp users.count
+      #   #   # => 28
+      #   def users; end
+      define_attributes :created_at, :details, :domain_names, :external_id,
+                        :group_id, :id, :name, :notes, :organization_fields,
+                        :shared_comments, :shared_tickets, :tags, :updated_at
+      readonly_attributes :created_at, :id, :updated_at
+
+      ##
+      # Returns an approximate count of organizations in the account. If the count exceeds 100,000, it is updated every 24 hours.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @return [Hash]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#count-organizations
+      #   Zendesk API > Organizations > Count Organizations
+      # @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
+      #
+      #   orgs = SupportOps::Zendesk::Organizations.count
+      #   pp orgs['value']
+      #   # => 102
+      def self.count
+        response = client.connection.get('organizations/count')
+        Oj.load(response.body)['count']
+      end
+
+      ##
+      # Lists organizations 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
+      #     organizations returned. Default to 0 (i.e. no limit)
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#list-organizations
+      #   Zendesk API > Organizations > List Organizations
+      # @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
+      #
+      #   orgs = SupportOps::Zendesk::Organizations.list(limit: 250)
+      #   pp orgs.count
+      #   # => 250
+      #   pp orgs.last.name
+      #   # => "I'm the 250th organization"
+      def self.list(**args)
+        args[:limit] = 0 unless args[:limit]
+        orgs = []
+        opts = 'page[size]=100'
+        loop do
+          response = client.connection.get("organizations?#{opts}")
+          body = Oj.load(response.body)
+          orgs += body['organizations'].map { |o| Organizations.new(o) }
+          break if args[:limit].to_i.positive? && orgs.count >= args[:limit].to_i
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        return orgs if args[:limit].to_i.zero?
+        
+        orgs.first(args[:limit].to_i)
+      end
+
+      ##
+      # Locates a specific organization in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#show-organization
+      #   Zendesk API > Organizations > Show Organization
+      # @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
+      #
+      #   org = SupportOps::Zendesk::Organizations.get(250)
+      #   pp org.name
+      #   # => "I'm the 250th organization"
+      def self.get(object)
+        if object.is_a? Organizations
+          Organizations.new(id: id).find
+        else
+          Organizations.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific organization in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#show-organization
+      #   Zendesk API > Organizations > Show Organization
+      # @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
+      #
+      #   org = SupportOps::Zendesk::Organizations.get!(250)
+      #   pp org.name
+      #   # => "I'm the 250th organization"
+      def self.get!(object)
+        if object.is_a? Organizations
+          Organizations.new(id: id).find!
+        else
+          Organizations.new(id: object).find!
+        end
+      end
+
+      ##
+      # Locates up to 100 organizations within Zendesk.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param organization_ids [Array] The organization IDs to find
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#show-many-organizations
+      #   Zendesk API > Organizations > Show Many Organizations
+      # @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
+      #
+      #   orgs = SupportOps::Zendesk::Organizations.get_many([255, 256])
+      #   pp orgs.map { |t| t.name }
+      #   # => ["Org 255", "256th Org"]
+      def self.get_many(organization_ids)
+        raise 'The parameter must be an Array' unless organization_ids.is_a? Array
+        raise 'You can only get a maximum of 100 organizations at a time' if organization_ids.count > 100
+
+        response = client.connection.get("organizations/show_many?ids=#{organization_ids.join(',')}")
+        Oj.load(response.body)['organizations'].map { |o| Organizations.new(o) }
+      end
+
+      ##
+      # Deletes multiple organizations via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param organization_ids [Array] An array of organization IDs
+      # @return [object] A {SupportOps::Zendesk::JobStatuses} instance
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#bulk-delete-organizations
+      #   Zendesk API > Organizations > Bulk Delete Organizations
+      # @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::Organizations.delete_many!([123, 456])
+      #   pp delete.id
+      #   # => "82de0b044094f0c67893ac9fe64f1a99"
+      def self.delete_many!(organization_ids)
+        raise 'The parameter must be an Array' unless organization_ids.is_a? Array
+        raise 'You can only delete a maximum of 100 organizations at a time' if organization_ids.count > 100
+
+        response = client.connection.delete("organizations/destroy_many?ids=#{organization_ids.join(',')}")
+        raise "Failed to delete organizations => #{body['details']}" if response.status != 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+
+      ##
+      # Creates multiple organizations via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param organizations [Array] An array of {SupportOps::Zendesk::Organizations} instances
+      # @return [object] A {SupportOps::Zendesk::JobStatuses} instance
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#create-many-organizations
+      #   Zendesk API > Organizations > Create Many Organizations
+      # @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
+      #
+      #   org1 = SupportOps::Zendesk::Organizations.new
+      #   org1.name = 'Org for Alice'
+      #   org2 = SupportOps::Zendesk::Organizations.new
+      #   org2.name = 'Org for Bob'
+      #
+      #   creates = SupportOps::Zendesk::Organizations.create_many!([org1, org2])
+      #   pp creates.id
+      #   # => "82de0b044094f0c67893ac9fe64f1a99"
+      def self.create_many!(organizations)
+        raise 'The parameter must be an Array' unless organizations.is_a? Array
+        raise 'You can only create a maximum of 100 organizations at a time' if organizations.count > 100
+        raise 'You can only use SupportOps::Zendesk::Organizations instances in the Array' unless organizations.reject { |o| o.is_a? SupportOps::Zendesk::Organizations }.count.zero?
+
+        data = { organizations: organizations.map { |o| to_hash(o).compact } }.to_json
+        response = client.connection.post('organizations/create_many', data)
+        raise "Failed to create organizations => #{body['details']}" if response.status != 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+
+      ##
+      # Updates multiple organizations via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param organizations [Array] An array of {SupportOps::Zendesk::Organizations} instances
+      # @return [object] A {SupportOps::Zendesk::JobStatuses} instance
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#update-many-organizations
+      #   Zendesk API > Organizations > Update Many Organizations
+      # @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
+      #
+      #   org1 = SupportOps::Zendesk::Organizations.get!(123)
+      #   org1.name = 'Org for Alice Company'
+      #   org2 = SupportOps::Zendesk::Organizations.get!(456)
+      #   org2.name = 'Org for Bob Company'
+      #
+      #   updates = SupportOps::Zendesk::Organizations.update_many!([org1, org2])
+      #   pp updates.id
+      #   # => "82de0b044094f0c67893ac9fe64f1a99"
+      def self.update_many!(organizations)
+        raise 'The parameter must be an Array' unless organizations.is_a? Array
+        raise 'You can only update a maximum of 100 organizations at a time' if organizations.count > 100
+        raise 'You can only use SupportOps::Zendesk::Organizations instances in the Array' unless organizations.reject { |o| o.is_a? SupportOps::Zendesk::Organizations }.count.zero?
+
+        data = { organizations: organizations.map { |o| to_hash(o).compact } }.to_json
+        response = client.connection.put('organizations/update_many', data)
+        raise "Failed to update organizations => #{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("organizations/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)['organization']
+      end
+
+      ##
+      # @private
+      def create_record
+        response = self.client.connection.post("organizations", { organization: attributes_for_save }.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to create organization => #{body['details']}" if response.status != 201
+        body['organization']
+      end
+
+      ##
+      # @private
+      def update_record
+        raise "Failed to update organization => You didn't change anything in the object" if attributes_for_save.keys == [:id]
+        response = self.client.connection.put("organizations/#{self.id}", { organization: attributes_for_save }.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to update organization #{self.id} => #{body['details']}" if response.status != 200
+        body['organization']
+      end
+
+      ##
+      # @private
+      def delete_record
+        response = self.client.connection.delete("organizations/#{self.id}")
+        raise "Failed to delete organization => #{body['details']}" if response.status != 204
+        true
+      end
+
+      ##
+      # @private
+      def create_or_update_record
+        response = self.client.connection.post('organizations/create_or_update', { organization: attributes_for_save }.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to create or update organization => #{body['details']}" unless [200, 201].include?(response.status)
+        body['organization']
+      end
+
+      ##
+      # @private
+      def memberships_record
+        memberships_list = []
+        opts = 'page[size]=100'
+        loop do
+          response = client.connection.get("organizations/#{self.id}/organization_memberships?#{opts}")
+          body = Oj.load(response.body)
+          memberships_list += body['organization_memberships'].map { |o| OrganizationMemberships.new(o) }
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        memberships_list
+      end
+
+      ##
+      # @private
+      def tickets_record
+        tickets_list = []
+        opts = 'page[size]=100'
+        loop do
+          response = self.client.connection.get("organizations/#{self.id}/tickets?#{opts}")
+          body = Oj.load(response.body)
+          tickets_list += body['tickets'].map { |t| Tickets.new(t) }
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        tickets_list
+      end
+
+      ##
+      # @private
+      def users_record
+        user_list = []
+        opts = 'page[size]=100'
+        loop do
+          response = self.client.connection.get("organizations/#{self.id}/users?#{opts}")
+          body = Oj.load(response.body)
+          user_list += body['users'].map { |u| Users.new(u) }
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        user_list
+      end
+    end
+  end
+end

data/lib/support_ops_zendesk/zendesk/requester_roles.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class RequesterRoles within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Various] id The identifer of the object
+    # @attr [String] name The name of the requester role
+    class RequesterRoles < SupportOps::Zendesk::Base
+      define_attributes :id, :name
+      readonly_attributes :id, :name
+
+      ##
+      # Lists requester roles
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {SupportOps::Zendesk::Client}
+      # @return [Array]
+      # @example
+      #   require 'support_ops_zendesk'
+      #   requester_roles = SupportOps::Zendesk::RequesterRoles.list
+      #   pp requester_roles.first.name
+      #   # => "Agent"
+      def self.list
+        [
+          { 'id' => 4, 'name' => 'Agent' },
+          { 'id' => 'LIGHT_AGENT', 'name' => 'Light Agent' },
+          { 'id' => 0, 'name' => 'End User' },
+          { 'id' => 2, 'name' => 'Admin' }
+        ].map { |r| RequesterRoles.new(r) }
+      end
+
+      ##
+      # Locates a requester roles within Zendesk by name
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload find_by_name(key: value)
+      #   @param name [String required] The name to search for
+      # @return [Object] An instance of {SupportOps::Zendesk::ViaTypes}
+      # @example
+      #   require 'support_ops_zendesk'
+      #   requester_role = SupportOps::Zendesk::RequesterRoles.find_by_name('Light Agent')
+      #   pp requester_role.id
+      #   # => "LIGHT_AGENT"
+      def self.find_by_name(**args)
+        raise 'You have to provide a name' unless args[:name]
+        list.detect { |r| r.name.downcase == name.downcase }
+      end
+    end
+  end
+end