gitlab-customer-support-operations_zendesk 1.0.0

data/lib/support_ops_zendesk/zendesk/users.rb

@@ -0,0 +1,889 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Users within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Boolean] active false if the user has been deleted
+    # @attr [String] alias An alias displayed to end users
+    # @attr [String] created_at The time the user was created
+    # @attr [Integer] custom_role_id A custom role if the user is an agent on the Enterprise plan or above
+    # @attr [Integer] default_group_id The id of the user's default group
+    # @attr [String] details Any details you want to store about the user, such as an address
+    # @attr [String] email The user's primary email address.
+    # @attr [Integer] external_id A unique identifier from another system.
+    # @attr [String] iana_time_zone The time zone for the user
+    # @attr [Integer] id Automatically assigned when the user is created
+    # @attr [String] last_login_at Last time the user signed in to Zendesk Support or made an API request using an API token or basic authentication
+    # @attr [String] locale The user's locale. A BCP-47 compliant tag for the locale. If both "locale" and "locale_id" are present on create or update, "locale_id" is ignored and only "locale" is used.
+    # @attr [Integer] locale_id The user's language identifier
+    # @attr [Boolean] moderator Designates whether the user has forum moderation capabilities
+    # @attr [String] name The user's name
+    # @attr [String] notes Any notes you want to store about the user
+    # @attr [Boolean] only_private_comments true if the user can only create private comments
+    # @attr [Integer] organization_id The id of the user's organization. If the user has more than one organization memberships, the id of the user's default organization
+    # @attr [String] phone The user's primary phone number
+    # @attr [Boolean] report_csv This parameter is inert and has no effect. It may be deprecated in the future. Previously, this parameter determined whether a user could access a CSV report in a legacy Guide dashboard. This dashboard has been removed.
+    # @attr [Boolean] restricted_agent If the agent has any restrictions; false for admins and unrestricted agents, true for other agents
+    # @attr [String] role The user's role. Possible values are "end-user", "agent", or "admin"
+    # @attr [Integer] role_type The user's role id. 0 for a custom agent, 1 for a light agent, 2 for a chat agent, 3 for a chat agent added to the Support account as a contributor (Chat Phase 4), 4 for an admin, and 5 for a billing admin
+    # @attr [Boolean] shared If the user is shared from a different Zendesk Support instance. Ticket sharing accounts only
+    # @attr [Boolean] shared_agent If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only
+    # @attr [Boolean] shared_phone_number Whether the phone number is shared or not.
+    # @attr [String] signature The user's signature. Only agents and admins can have signatures
+    # @attr [Boolean] suspended If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal
+    # @attr [Array] tags The user's tags. Only present if your account has user tagging enabled
+    # @attr [String] ticket_restriction Specifies which tickets the user has access to. Possible values are: "organization", "groups", "assigned", "requested", null. "groups" and "assigned" are valid only for agents. If you pass an invalid value to an end user (for example, "groups"), they will be assigned to "requested", regardless of their previous access
+    # @attr [String] time_zone The user's time zone.
+    # @attr [Boolean] two_factor_auth_enabled If two factor authentication is enabled
+    # @attr [String] updated_at The time the user was last updated
+    # @attr [Object] user_fields 	Values of custom fields in the user's profile.
+    # @attr [Boolean] verified Any of the user's identities is verified.
+    # @todo Show User Related Information => https://developer.zendesk.com/api-reference/ticketing/users/users/#show-user-related-information
+    # @todo Show Self => https://developer.zendesk.com/api-reference/ticketing/users/users/#show-self
+    # @todo Merge End Users => https://developer.zendesk.com/api-reference/ticketing/users/users/#merge-end-users
+    # @todo Request User Create => https://developer.zendesk.com/api-reference/ticketing/users/users/#request-user-create
+    class Users < SupportOps::Zendesk::Base
+      # @!parse
+      #   # Creates/updates a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::Zendesk::Users}
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#save!}
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/users/users/#create-user
+      #   #   Zendesk API > Users > Create User
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/users/users/#update-user
+      #   #   Zendesk API > Users > Update User
+      #   # @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_user = SupportOps::Zendesk::Users.new
+      #   #   new_user.custom_role_id = 123456
+      #   #   new_user.email = 'roge@example.org'
+      #   #   new_user.name = 'Roger Wilco'
+      #   #   new_user.organization_id = 57542
+      #   #   new_user.role = 'agent'
+      #   #   new_user.role_type = 0
+      #   #
+      #   #   new_user.save!
+      #   #
+      #   #   pp new_user.id
+      #   #   # => 9873843
+      #   # @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_user = SupportOps::Zendesk::Users.get!(9873843)
+      #   #   existing_user.name = 'Roger Wilco II'
+      #   #
+      #   #   existing_user.save!
+      #   #
+      #   #   pp existing_user.name
+      #   #   # => "Roger Wilco II"
+      #   def save!; end
+      # @!parse
+      #   # Deletes a user
+      #   # 
+      #   # @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/users/users/#delete-user
+      #   #   Zendesk API > Users > Delete User
+      #   # @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_user = SupportOps::Zendesk::Users.get!(9873843)
+      #   #   existing_user.delete!
+      #   def delete!; end
+      # @!parse
+      #   # List the organization details of a user.
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Various]
+      #   #   - If there is no organization, it returns nil
+      #   #   - If there is an organization, a {SupportOps::Zendesk::Organizations} instance
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#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
+      #   #
+      #   #   user = SupportOps::Zendesk::Users.get!(9873843)
+      #   #   org = user.organization
+      #   #   pp org.name
+      #   #   # => "Bob's Burgers"
+      #   def organization; end
+      # @!parse
+      #   # Creates or updates a user
+      #   #
+      #   # @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/users/users/#create-or-update-user
+      #   #   Zendesk API > Users > Create Or Update User
+      #   # @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_user = SupportOps::Zendesk::Users.get!(9873843)
+      #   #   existing_user.name = 'Roger Wilco II'
+      #   #
+      #   #   existing_user.create_or_update!
+      #   #
+      #   #   pp existing_user.name
+      #   #   # => "Roger Wilco II"
+      #   def create_or_update!; end
+      # @!parse
+      #   # Lists requested ticketrs for a user
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Array]
+      #   # @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_user = SupportOps::Zendesk::Users.get!(9873843)
+      #   #   tickets = existing_user.tickets
+      #   #
+      #   #   pp tickets.count
+      #   #   # => 28
+      #   def tickets; end
+      # @!parse
+      #   # Lists CCd tickets for a user
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Array]
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#ccd_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_user = SupportOps::Zendesk::Users.get!(9873843)
+      #   #   tickets = existing_user.ccd_tickets
+      #   #
+      #   #   pp tickets.count
+      #   #   # => 2
+      #   def ccd_tickets; end
+      # @!parse
+      #   # Lists assigned tickets for a user
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Array]
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#assigned_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_user = SupportOps::Zendesk::Users.get!(9873843)
+      #   #   tickets = existing_user.assigned_tickets
+      #   #
+      #   #   pp tickets.count
+      #   #   # => 56
+      #   def assigned_tickets; end
+      # @!parse
+      #   # List organization members for a user
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Array]
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#organization_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_user = SupportOps::Zendesk::Users.get!(9873843)
+      #   #   memberships = existing_user.organization_memberships
+      #   #
+      #   #   pp memberships.map { |m| m.organization_id }
+      #   #   # => [123, 854]
+      #   def organization_memberships; end
+      # @!parse
+      #   # List group members for a user
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Array]
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#group_memberships}
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/#list-memberships
+      #   #   Zendesk API > Group 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_user = SupportOps::Zendesk::Users.get!(9873843)
+      #   #   memberships = existing_user.group_memberships
+      #   #
+      #   #   pp memberships.map { |m| m.group_id }
+      #   #   # => [28, 59]
+      #   def group_memberships; end
+      # @!parse
+      #   # Sets the password for a user
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#set_password!}
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/users/user_passwords/#set-a-users-password
+      #   #   Zendesk API > User Password > Set a User's Password
+      #   # @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_user = SupportOps::Zendesk::Users.get!(9873843)
+      #   #   existing_user.password = 'Test123!'
+      #   #
+      #   #   existing_user.set_password!
+      #   def set_password!; end
+      # @!parse
+      #   # Lists the organizations a user
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Array]
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#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
+      #   #
+      #   #   existing_user = SupportOps::Zendesk::Users.get!(9873843)
+      #   #   orgs = existing_user.organizations
+      #   #
+      #   #   pp orgs.map { |o| o.id }
+      #   #   # => [123, 854]
+      #   def organizations; end
+      # @!parse
+      #   # Lists the groups a user
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Array]
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#groups}
+      #   # @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_user = SupportOps::Zendesk::Users.get!(9873843)
+      #   #   groups = existing_user.groups
+      #   #
+      #   #   pp groups.map { |g| g.id }
+      #   #   # => [28, 59]
+      #   def groups; end
+
+      define_attributes :active, :alias, :created_at, :custom_role_id,
+                        :default_group_id, :details, :email, :external_id,
+                        :iana_time_zone, :id, :last_login_at, :locale,
+                        :locale_id, :moderator, :name, :notes,
+                        :only_private_comments, :organization_id, :password,
+                        :phone, :report_csv, :restricted_agent, :role,
+                        :role_type, :shared, :shared_agent,
+                        :shared_phone_number, :signature, :suspended, :tags,
+                        :ticket_restriction, :time_zone,
+                        :two_factor_auth_enabled, :updated_at, :user_fields,
+                        :verified
+      readonly_attributes :id, :created_at, :last_login_at, :updated_at
+
+      ##
+      # Lists users in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param external_id [String optional] TList users by external id.
+      #     External id has to be unique for each user under the same account.
+      #   @param permission_set [Integer optional] For custom roles which is
+      #     available on the Enterprise plan and above. You can only filter by
+      #     one role ID per request
+      #   @param role [String optional] Filters the results by role. Possible
+      #     values are "end-user", "agent", or "admin". Allowed values are
+      #     "end-user", "agent", or "admin".
+      #   @param roles [Array optional] Filters the results by more than one
+      #     role
+      #   @param limit [Integer optional] The limit to the number of tickets
+      #     returned. Default to 0 (i.e. no limit)
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/users/users/#list-users
+      #   Zendesk API > USers > List Users
+      # @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
+      #
+      #   users = SupportOps::Zendesk::Users.list(limit: 250)
+      #   pp users.count
+      #   # => 250
+      #   pp users.last.email
+      #   # => "gabe@example.com"
+      def self.list(**args)
+        args[:external_id] = nil unless args[:external_id]
+        args[:permission_set] = nil unless args[:permission_set]
+        args[:role] = nil unless args[:role]
+        args[:roles] = [] unless args[:roles]
+        args[:limit] = 0 unless args[:limit]
+        params = ''
+        params += args[:roles].map { |r| "role[]=#{r}" }.join('&') unless args[:roles].count.zero?
+        params += '&' unless args[:roles].count.zero?
+        params += "external_id=#{args[:external_id]}&" unless args[:external_id].nil?
+        params += "permission_set=#{args[:permission_set]}&" unless args[:permission_set].nil?
+        params += "role=#{args[:role]}&" unless args[:role].nil?
+        users = []
+        opts = "#{params}page[size]=100"
+        loop do
+          response = client.connection.get("users?#{opts}")
+          body = Oj.load(response.body)
+          users += body['users'].map { |t| Users.new(t) }
+          break if args[:limit].to_i.positive? && users.count >= args[:limit].to_i
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        return users if args[:limit].to_i.zero?
+        
+        users.first(args[:limit].to_i)
+      end
+
+      ##
+      # Returns an approximate count of users 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/users/users/#count-users
+      #   Zendesk API > Users > Count Users
+      # @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
+      #
+      #   users = SupportOps::Zendesk::Users.count
+      #   pp users['value']
+      #   # => 102
+      def self.count
+        response = client.connection.get('users/count')
+        Oj.load(response.body)['count']
+      end
+
+      ##
+      # Locates a specific user in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/users/users/#show-user
+      #   Zendesk API > Users > Show User
+      # @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
+      #
+      #   user = SupportOps::Zendesk::Users.get(13983927615772)
+      #   pp user.email
+      #   # => "gabe@example.com"
+      def self.get(object)
+        if object.is_a? Users
+          Users.new(id: id).find
+        else
+          Users.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific user in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/users/users/#show-user
+      #   Zendesk API > Users > Show User
+      # @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
+      #
+      #   user = SupportOps::Zendesk::Users.get!(13983927615772)
+      #   pp user.email
+      #   # => "gabe@example.com"
+      def self.get!(object)
+        if object.is_a? Users
+          Users.new(id: id).find!
+        else
+          Users.new(id: object).find!
+        end
+      end
+
+      ##
+      # Locates up to 100 users within Zendesk.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param user_ids [Array] The ticket IDs to find
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/users/users/#show-many-users Zendesk API > Users > Show Many 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
+      #
+      #   users = SupportOps::Zendesk::Users.get_many([255, 256])
+      #   pp users.map { |u| u.name }
+      #   # => ["Alice", "Bob"]
+      def self.get_many(user_ids)
+        raise 'The parameter must be an Array' unless user_ids.is_a? Array
+        raise 'You can only get a maximum of 100 users at a time' if user_ids.count > 100
+
+        response = client.connection.get("users/show_many?ids=#{user_ids.join(',')}")
+        Oj.load(response.body)['users'].map { |u| Users.new(u) }
+      end
+
+      ##
+      # Deletes multiple users via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param user_ids [Array] An array of user IDs
+      # @return [object] A {SupportOps::Zendesk::JobStatuses} instance
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/users/users/#bulk-delete-users
+      #   Zendesk API > Users > Bulk Delete 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
+      #
+      #   delete = SupportOps::Zendesk::Users.delete_many!([35436, 35437])
+      #   pp delete.id
+      #   # => "82de0b044094f0c67893ac9fe64f1a99"
+      def self.delete_many!(user_ids)
+        raise 'The parameter must be an Array' unless user_ids.is_a? Array
+        raise 'You can only delete a maximum of 100 users at a time' if user_ids.count > 100
+
+        response = client.connection.delete("users/destroy_many?ids=#{user_ids.join(',')}")
+        raise "Failed to users users => #{body['details']}" if response.status != 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+
+      ##
+      # Creates multiple users via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param users [Array] An array of {SupportOps::Zendesk::Users} instances
+      # @return [object] A {SupportOps::Zendesk::JobStatuses} instance
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/users/users/#create-many-users
+      #   Zendesk API > Users > Create Many 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
+      #
+      #   user1 = SupportOps::Zendesk::Users.new
+      #   user1.name = 'Alice'
+      #   user1.email = 'alice@example.com'
+      #   user2 = SupportOps::Zendesk::Users.new
+      #   user2.name = 'Bob'
+      #   user2.email = 'bob@example.com'
+      #
+      #   creates = SupportOps::Zendesk::Users.create_many!([user1, user2])
+      #   pp creates.id
+      #   # => "82de0b044094f0c67893ac9fe64f1a99"
+      def self.create_many!(users)
+        raise 'The parameter must be an Array' unless users.is_a? Array
+        raise 'You can only create a maximum of 100 users at a time' if users.count > 100
+        raise 'You can only use SupportOps::Zendesk::Users instances in the Array' unless users.reject { |t| t.is_a? SupportOps::Zendesk::Users }.count.zero?
+
+        data = { users: users.map { |u| to_hash(u).compact } }.to_json
+        response = client.connection.post('users/create_many', data)
+        raise "Failed to create users => #{body['details']}" if response.status != 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+
+      ##
+      # Updates multiple users via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param users [Array] An array of {SupportOps::Zendesk::Users} instances
+      # @return [object] A {SupportOps::Zendesk::JobStatuses} instance
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/users/users/#update-many-users
+      #   Zendesk API > Users > Update Many 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
+      #
+      #   user1 = SupportOps::Zendesk::Users.get!(123)
+      #   user1.name = 'Alice2'
+      #   user2 = SupportOps::Zendesk::Users.get!(456)
+      #   user2.name = 'Bob2'
+      #
+      #   updates = SupportOps::Zendesk::Users.update_many!([user1, user2])
+      #   pp updates.id
+      #   # => "82de0b044094f0c67893ac9fe64f1a99"
+      def self.update_many!(users)
+        raise 'The parameter must be an Array' unless users.is_a? Array
+        raise 'You can only update a maximum of 100 users at a time' if users.count > 100
+        raise 'You can only use SupportOps::Zendesk::Tickets instances in the Array' unless users.reject { |t| t.is_a? SupportOps::Zendesk::Users }.count.zero?
+
+        data = { users: users.map { |u| to_hash(u).compact } }.to_json
+        response = client.connection.put('users/update_many', data)
+        raise "Failed to update users => #{body['details']}" if response.status != 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+
+      ##
+      # Create or update multiple users via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param users [Array] An array of {SupportOps::Zendesk::Users} instances
+      # @return [object] A {SupportOps::Zendesk::JobStatuses} instance
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/users/users/#create-or-update-many-users
+      #   Zendesk API > Users > Create Or Update Many 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
+      #
+      #   user1 = SupportOps::Zendesk::Users.get!(123)
+      #   user1.name = 'Alice2'
+      #   user2 = SupportOps::Zendesk::Users.new
+      #   user2.name = 'Bob'
+      #   user2.email = 'bob@example.com'
+      #
+      #   updates = SupportOps::Zendesk::Users.create_or_update_many!([user1, user2])
+      #   pp updates.id
+      #   # => "82de0b044094f0c67893ac9fe64f1a99"
+      def self.create_or_update_many!(users)
+        raise 'The parameter must be an Array' unless users.is_a? Array
+        raise 'You can only create or update a maximum of 100 users at a time' if users.count > 100
+        raise 'You can only use SupportOps::Zendesk::Tickets instances in the Array' unless users.reject { |t| t.is_a? SupportOps::Zendesk::Users }.count.zero?
+
+        data = { users: users.map { |u| to_hash(u).compact } }.to_json
+        response = client.connection.put('users/create_or_update_many', data)
+        raise "Failed to create or update users => #{body['details']}" if response.status != 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+
+      ##
+      # Logout up to 100 users
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param user_ids [Array] An array of user IDs
+      # @return [Boolean]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/users/users/#logout-many-users
+      #   Zendesk API > Users > Logout many 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
+      #
+      #   logout = SupportOps::Zendesk::Users.logout_many!([123, 456])
+      #   pp logout.id
+      #   # => true
+      def self.logout_many(user_ids)
+        raise 'The parameter must be an Array' unless user_ids.is_a? Array
+        raise 'You can only logout a maximum of 100 users at a time' if user_ids.count > 100
+
+        response = client.connection.delete("users/logout_many?ids=#{user_ids.join(',')}")
+        raise "Failed to logout users => #{body['details']}" if response.status != 202
+        true
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("users/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)['user']
+      end
+
+      ##
+      # @private
+      def create_record
+        response = self.client.connection.post("users", { user: attributes_for_save }.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to create user => #{body}" if response.status != 201
+        body['user']
+      end
+
+      ##
+      # @private
+      def update_record
+        raise "Failed to update user => You didn't change anything in the object" if attributes_for_save.keys == [:id]
+        response = self.client.connection.put("users/#{self.id}", { user: attributes_for_save }.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to update user #{self.id} => #{body}" if response.status != 200
+        body['user']
+      end
+
+      ##
+      # @private
+      def delete_record
+        response = self.client.connection.delete("users/#{self.id}")
+        body = Oj.load(response.body)
+        raise "Failed to delete user => #{body}" if response.status != 200
+        true
+      end
+
+      ##
+      # @private
+      def organization_record
+        return nil if self.organization_id.nil?
+
+        Organizations.get(self.organization_id)
+      end
+
+      ##
+      # @private
+      def create_or_update_record
+        response = self.client.connection.post('users/create_or_update', { user: attributes_for_save }.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to create or update user => #{body}" unless [200, 201].include?(response.status)
+        body['user']
+      end
+
+      ##
+      # @private
+      def tickets_record
+        list = []
+        opts = 'page[size]=100'
+        loop do
+          response = self.client.connection.get("users/#{self.id}/tickets/requested?#{opts}")
+          body = Oj.load(response.body)
+          list += body['tickets'].map { |t| Tickets.new(t) }
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        list
+      end
+
+      ##
+      # @private
+      def ccd_ticket_record
+        list = []
+        opts = 'page[size]=100'
+        loop do
+          response = self.client.connection.get("users/#{self.id}/tickets/ccd?#{opts}")
+          body = Oj.load(response.body)
+          list += body['tickets'].map { |t| Tickets.new(t) }
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        list
+      end
+
+      ##
+      # @private
+      def assigned_ticket_record
+        list = []
+        page = 1
+        loop do
+          response = self.client.connection.get("users/#{self.id}/tickets/assigned?page=#{page}")
+          body = Oj.load(response.body)
+          list += body['tickets'].map { |t| Tickets.new(t) }
+          break unless body['tickets'].count == 100
+
+          page += 1
+        end
+        list
+      end
+
+      ##
+      # @private
+      def organization_memberships_record
+        response = client.connection.get("users/#{self.id}/organization_memberships?page[size]=100")
+        Oj.load(response.body)['organization_memberships'].map { |m| OrganizationMemberships.new(m) }
+      end
+
+      ##
+      # @private
+      def group_memberships_record
+        response = client.connection.get("users/#{self.id}/group_memberships?page[size]=100")
+        Oj.load(response.body)['group_memberships'].map { |m| GroupMemberships.new(m) }
+      end
+
+      ##
+      # @private
+      def set_password_record
+        response = client.connection.post "users/#{self.id}/password", { password: self.password }.to_json
+        body = Oj.load(response.body)
+        raise "Failed to set user password => #{body['details']}" if response.status != 200
+        true
+      end
+
+      ##
+      # @private
+      def organizations_record
+        orgs = []
+        memberships = self.organization_memberships
+        memberships.each do |m|
+          orgs.push(Organizations.get!(m.organization_id))
+        end
+        orgs
+      end
+
+      ##
+      # @private
+      def groups_record
+        groups = []
+        memberships = self.group_memberships
+        memberships.each do |m|
+          groups.push(Groups.get!(m.group_id))
+        end
+        groups
+      end
+    end
+  end
+end