gitlab_support_readiness 1.0.0

data/lib/support_readiness/zendesk/ticket_fields.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class TicketFields within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @todo List ticket field options
+    # @todo Show ticket field option
+    # @todo Create or update ticket field option
+    # @todo Delete ticket field option
+    # @todo Reorder ticket fields
+    class TicketFields < Readiness::Client
+      attr_accessor :active, :agent_description, :collapsed_for_agents, :custom_field_options, :description, :editable_in_portal, :id, :key, :position, :regexp_for_validation, :removable, :required, :system_field_options, :tag, :title, :title_in_portal, :type, :visible_in_portal
+
+      ##
+      # Creates a new {Readiness::Zendesk::TicketFields} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Zendesk::TicketFields}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::TicketFields.new
+      def initialize(object = {})
+        @active = object['active']
+        @agent_description = object['agent_description']
+        @collapsed_for_agents = object['collapsed_for_agents']
+        @custom_field_options = object['custom_field_options']
+        @description = object['description']
+        @editable_in_portal = object['editable_in_portal']
+        @id = object['id']
+        @key = object['key']
+        @position = object['position']
+        @regexp_for_validation = object['regexp_for_validation']
+        @removable = object['removable']
+        @required = object['required']
+        @system_field_options = object['system_field_options']
+        @tag = object['tag']
+        @title = object['title']
+        @title_in_portal = object['title_in_portal']
+        @type = object['type']
+        @visible_in_portal = object['visible_in_portal']
+      end
+
+      ##
+      # Lists all ticket fields.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/#list-ticket-fields Zendesk API > Ticket Fields > List Ticket Fields
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   fields = Readiness::Zendesk::TicketFields.list(client, 2)
+      #   pp fields.count
+      #   # => 200
+      def self.list(client, limit = 0, sort = 'id')
+        array = []
+        opts = "page[size]=100"
+        loop do
+          response = client.connection.get("ticket_fields?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['ticket_fields'].map { |f| TicketFields.new(f) }
+          break if limit != 0 && array.count >= (limit * 100)
+          break unless body['meta']['has_more']
+
+          opts = body['links'] ['next'].split('?').last
+        end
+        array
+      end
+
+      ##
+      # Locates a ticket field within Zendesk. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param fid [Integer] The ticket field ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/#show-ticket-field Zendesk API > Ticket Fields > Show Ticket Field
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   field = Readiness::Zendesk::TicketFields.find(client, 89)
+      #   pp field.title
+      #   # => "Age"
+      def self.find(client, fid)
+        response = client.connection.get("ticket_fields/#{fid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: fid }) unless response.status == 200
+        return TicketFields.new(Oj.load(response.body)['ticket_field']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a ticket field within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param fid [Integer] The ticket field ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/#show-ticket-field Zendesk API > Ticket Fields > Show Ticket Field
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   field = Readiness::Zendesk::TicketFields.find!(client, 89)
+      #   pp field.title
+      #   # => "Age"
+      def self.find!(client, fid)
+        response = client.connection.get("ticket_fields/#{fid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find ticket field', id: fid }) unless response.status == 200
+        TicketFields.new(Oj.load(response.body)['ticket_field'])
+      end
+
+      ##
+      # Creates a ticket field. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param field [Object] An instance of {Readiness::Zendesk::TicketFields}
+      # @return [Object] An instance of {Readiness::Zendesk::TicketFields}
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/#create-ticket-field Zendesk API > Ticket Fields > Create Ticket Field
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   field = Readiness::Zendesk::TicketFields.new
+      #   field.type = 'text'
+      #   field.title = 'Age'
+      #   create = Readiness::Zendesk::TicketFields.create!(client, field)
+      #   pp create.id
+      #   # => 89
+      def self.create!(client, field)
+        response = client.connection.post 'ticket_fields', to_clean_json_with_key(field, 'ticket_field')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create ticket field', message: Oj.load(response.body)}) unless response.status == 201
+        TicketFields.new(Oj.load(response.body)['ticket_field'])
+      end
+
+      ##
+      # Updates a ticket field. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param field [Object] An instance of {Readiness::Zendesk::TicketFields}
+      # @return [Object] An instance of {Readiness::Zendesk::TicketFields}
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/#update-ticket-field Zendesk API > Ticket Fields > Update Ticket Field
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   field = Readiness::Zendesk::TicketFields.find!(client, 21938362)
+      #   field.title = 'Pies'
+      #   field.custom_field_options = [
+      #     { name: 'Apple Pie', value: 'apple' },
+      #     { name: 'Pecan Pie', value: 'pecan' }
+      #   ]
+      #   update = Readiness::Zendesk::TicketFields.update!(client, field)
+      #   pp update.title
+      #   # => "Pies"
+      def self.update!(client, field)
+        response = client.connection.put "ticket_fields/#{field.id}", to_clean_json_with_key(field, 'ticket_field')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update ticket field', message: Oj.load(response.body)}) unless response.status == 200
+        TicketFields.new(Oj.load(response.body)['ticket_field'])
+      end
+
+      ##
+      # Deletes a ticket field. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param field [Object] An instance of {Readiness::Zendesk::TicketFields}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/#delete-ticket-field Zendesk API > Ticket Fields > Delete Ticket Field
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   field = Readiness::Zendesk::TicketFields.find!(client, 34)
+      #   delete = Readiness::Zendesk::TicketFields.delete!(client, field)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, field)
+        response = client.connection.delete "ticket_fields/#{field.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete a ticket field', id: field.id, message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk/ticket_forms.rb

@@ -0,0 +1,290 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class TicketForms within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class TicketForms < Readiness::Client
+      attr_accessor :active, :agent_conditions, :default, :display_name, :end_user_conditions, :end_user_visible, :id, :in_all_brands, :name, :position, :restricted_brand_ids, :ticket_field_ids
+
+      ##
+      # Creates a new {Readiness::Zendesk::TicketForms} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Zendesk::TicketForms}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::TicketForms.new
+      def initialize(object = {})
+        @active = object['active']
+        @agent_conditions = object['agent_conditions']
+        @default = object['default']
+        @display_name = object['display_name']
+        @end_user_conditions = object['end_user_conditions']
+        @end_user_visible = object['end_user_visible']
+        @id = object['id']
+        @in_all_brands = object['in_all_brands']
+        @name = object['name']
+        @position = object['position']
+        @restricted_brand_ids = object['restricted_brand_ids']
+        @ticket_field_ids = object['ticket_field_ids']
+      end
+
+      ##
+      # Lists the first 100 ticket forms
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/#list-ticket-forms Zendesk API > Ticket Forms > List Ticket Forms
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   forms = Readiness::Zendesk::TicketForms.list(client)
+      #   pp forms.first.id
+      #   # => 47
+      def self.list(client)
+        response = client.connection.get('ticket_forms')
+        handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+        Oj.load(response.body)['ticket_forms'].map { |f| TicketForms.new(f) }
+      end
+
+      ##
+      # Locates a ticket form within Zendesk. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param fid [Integer] The ticket form ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/#show-ticket-form Zendesk API > Ticket Forms > Show Ticket Form
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   form = Readiness::Zendesk::TicketForms.find(client, 47)
+      #   pp form.name
+      #   # => "Snowboard Problem"
+      def self.find(client, fid)
+        response = client.connection.get("ticket_forms/#{fid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: oid }) unless response.status == 200
+        return TicketForms.new(Oj.load(response.body)['ticket_form']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates aa ticket form within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param fid [Integer] The ticket form ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/#show-ticket-form Zendesk API > Ticket Forms > Show Ticket Form
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   form = Readiness::Zendesk::TicketForms.find!(client, 47)
+      #   pp form.name
+      #   # => "Snowboard Problem"
+      def self.find!(client, fid)
+        response = client.connection.get("ticket_forms/#{fid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find ticket form', id: fid }) unless response.status == 200
+        TicketForms.new(Oj.load(response.body)['ticket_form'])
+      end
+
+      ##
+      # Locates up to 100 ticket forms within Zendesk.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param fids [Array] The tikcet form IDs to find
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/#show-many-ticket-forms Zendesk API > Ticket Forms > Show Many Ticket Forms
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   forms = Readiness::Zendesk::TicketForms.find!(client, [47, 50, 52])
+      #   pp forms.first.name
+      #   # => "Snowboard Problem"
+      def self.find_many(client, fids)
+        response = client.connection.get("ticket_forms/show_many?ids=#{fids.join(',')}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: fids }) unless response.status == 200
+        Oj.load(response.body)['ticket_forms'].map { |f| TicketForms.new(f) }
+      end
+
+      ##
+      # Creates a ticket form. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param form [Object] An instance of {Readiness::Zendesk::TicketForms}
+      # @return [Object] An instance of {Readiness::Zendesk::TicketForms}
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/#create-ticket-form Zendesk API > Ticket Forms > Create Ticket Form
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   form = Readiness::Zendesk::TicketForms.new
+      #   form.name = 'Snowboard Problem'
+      #   form.end_user_visible = true
+      #   form.display_name = 'Snowboard Damage'
+      #   form.position = 9999
+      #   form.active = true
+      #   form.in_all_brands = false
+      #   form.restricted_brand_ids = [1, 4, 6, 12, 34]
+      #   form.ticket_field_ids = [2, 3, 4, 32, 33]
+      #   form.agent_conditions = []
+      #   form.end_user_conditions = []
+      #   form.default = false
+      #   create = Readiness::Zendesk::TicketForms.create!(client, form)
+      #   pp create.id
+      #   # => 47
+      def self.create!(client, form)
+        response = client.connection.post 'ticket_forms', to_clean_json_with_key(form, 'ticket_form')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create ticket form', message: Oj.load(response.body)}) unless response.status == 201
+        TicketForms.new(Oj.load(response.body)['ticket_form'])
+      end
+
+      ##
+      # Updates a ticket form. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param form [Object] An instance of {Readiness::Zendesk::TicketForms}
+      # @return [Object] An instance of {Readiness::Zendesk::TicketForms}
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/#update-ticket-form Zendesk API > Ticket Forms > Update Ticket Form
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   form = Readiness::Zendesk::TicketForms.find!(client, 47)
+      #   form.name = 'Snowboard Fixed'
+      #   form.display_name = 'Snowboard has been fixed'
+      #   form.position = 9999
+      #   form.active = true
+      #   form.in_all_brands = true
+      #   form.restricted_brand_ids = []
+      #   form.agent_conditions = []
+      #   form.end_user_conditions = []
+      #   update = Readiness::Zendesk::TicketForms.update!(client, form)
+      #   pp update.name
+      #   # => "Snowboard Fixed"
+      def self.update!(client, form)
+        response = client.connection.put "ticket_forms/#{form.id}", to_clean_json_with_key(form, 'ticket_form')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update ticket form', message: Oj.load(response.body)}) unless response.status == 200
+        TicketForms.new(Oj.load(response.body)['ticket_form'])
+      end
+
+      ##
+      # Deletes a ticket form. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param form [Object] An instance of {Readiness::Zendesk::TicketForms}
+      # @return [Object] An instance of {Readiness::Zendesk::TicketForms}
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/#update-ticket-form Zendesk API > Ticket Forms > Delete Ticket Form
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   form = Readiness::Zendesk::TicketForms.find!(client, 47)
+      #   delete = Readiness::Zendesk::TicketForms.delete!(client, form)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, form)
+        response = client.connection.delete "ticket_forms/#{form.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete a ticket form', id: form.id, message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+
+      ##
+      # Clones a ticket form. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param form [Object] An instance of {Readiness::Zendesk::TicketForms}
+      # @return [Object] An instance of {Readiness::Zendesk::TicketForms}
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/#clone-an-already-existing-ticket-form Zendesk API > Ticket Forms > Clone an Already Existing Ticket Form
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   form = Readiness::Zendesk::TicketForms.find!(client, 47)
+      #   clone = Readiness::Zendesk::TicketForms.clone!(client, form)
+      #   pp clone.id
+      #   # => 48
+      def self.clone!(client, form)
+        response = client.connection.post "ticket_forms/#{form.id}/clone", { prepend_clone_title: true }.to_json
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Clone a ticket form', id: form.id, message: Oj.load(response.body)}) unless response.status == 200
+        TicketForms.new(Oj.load(response.body)['ticket_form'])
+      end
+
+      ##
+      # Reorders the ticket forms. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param fids [Array] The ticket form IDs to reorder (order in Array is important)
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/#reorder-ticket-forms Zendesk API > Ticket Forms > Reorder Ticket Forms
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   form = Readiness::Zendesk::TicketForms.find!(client, 47)
+      #   reorder = Readiness::Zendesk::TicketForms.reorder!(client, [2, 23, 46, 50])
+      #   pp reorder.count
+      #   # => 4
+      def self.reorder(client, fids)
+        response = client.connection.put 'ticket_forms/reorder', { ticket_form_ids: fids }.to_json
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Clone a ticket form', id: form.id, message: Oj.load(response.body)}) unless response.status == 200
+        Oj.load(response.body)['ticket_form'].map { |f| TicketForms.new(f) }
+      end
+    end
+  end
+end