gitlab_support_readiness 1.0.0

data/lib/support_readiness/zendesk/triggers.rb

@@ -0,0 +1,269 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Triggers within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Triggers < Readiness::Client
+      attr_accessor :actions, :active, :category_id, :conditions, :default, :description, :id, :position, :title
+
+      ##
+      # Creates a new {Readiness::Zendesk::Triggers} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Zendesk::Triggers}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::Triggers.new
+      def initialize(object = {})
+        @actions = object['actions']
+        @active = object['active']
+        @category_id = object['category_id']
+        @conditions = object['conditions']
+        @default = object['default']
+        @description = object['description']
+        @id = object['id']
+        @position = object['position']
+        @title = object['title']
+      end
+
+      ##
+      # Lists triggers
+      #
+      # @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/business-rules/triggers/#list-ticket-triggers Zendesk API > Ticket Triggers > List Ticket Triggers
+      # @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)
+      #   triggers = Readiness::Zendesk::Triggers.list(client)
+      #   pp triggers.first.id
+      #   # => 25
+      def self.list(client)
+        array = []
+        opts = "page[size]=100"
+        loop do
+          response = client.connection.get("triggers?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['triggers'].map { |t| Triggers.new(t) }
+          break unless body['meta']['has_more']
+
+          opts = body['links'] ['next'].split('?').last
+        end
+        array
+      end
+
+      ##
+      # Locates a trigger 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 tid [Integer] The trigger ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/#show-ticket-trigger Zendesk API > Ticket Triggers > Show Ticket Trigger
+      # @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)
+      #   trigger = Readiness::Zendesk::Triggers.find(client, 25)
+      #   pp trigger.title
+      #   # => "Close and Save"
+      def self.find(client, tid)
+        response = client.connection.get("triggers/#{tid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: tid }) unless response.status == 200
+        return Triggers.new(Oj.load(response.body)['trigger']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a trigger within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param tid [Integer] The trigger ID to find
+      # @return [Object] An instance of {Readiness::Zendesk::Triggers}
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/#show-ticket-trigger Zendesk API > Ticket Triggers > Show Ticket Trigger
+      # @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)
+      #   trigger = Readiness::Zendesk::Triggers.find!(client, 25)
+      #   pp trigger.title
+      #   # => "Close and Save"
+      def self.find!(client, tid)
+        response = client.connection.get("triggers/#{tid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find trigger', id: tid }) unless response.status == 200
+        Triggers.new(Oj.load(response.body)['trigger'])
+      end
+
+      ##
+      # Creates a trigger. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param trigger [Object] An instance of {Readiness::Zendesk::Triggers}
+      # @return [Object] An instance of {Readiness::Zendesk::Triggers}
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/#create-trigger Zendesk API > Ticket Triggers > Create Ticket Trigger
+      # @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)
+      #   trigger = Readiness::Zendesk::Triggers.new
+      #   trigger.title = 'Roger Wilco'
+      #   trigger.conditions = {
+      #     all: [
+      #       { field: 'status', operator: 'is', value: 'open' },
+      #       { field: 'priority', operator: 'less_than', value: 'high' }
+      #     ],
+      #     any: []
+      #   }
+      #   trigger.actions = [
+      #     { field: 'group_id', value: '20455932' }
+      #   ]
+      #   trigger.category_id = '10026'
+      #   create = Readiness::Zendesk::Triggers.create!(client, trigger)
+      #   pp create.id
+      #   # => 25
+      def self.create!(client, trigger)
+        response = client.connection.post 'triggers', to_clean_json_with_key(trigger, 'trigger')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create trigger', message: Oj.load(response.body)}) unless response.status == 201
+        Triggers.new(Oj.load(response.body)['trigger'])
+      end
+
+      ##
+      # Updates a trigger. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param trigger [Object] An instance of {Readiness::Zendesk::Triggers}
+      # @return [Object] An instance of {Readiness::Zendesk::Triggers}
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/#update-ticket-trigger Zendesk API > Ticket Triggers > Update Ticket Trigger
+      # @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)
+      #   trigger = Readiness::Zendesk::Triggers.find!(client, 25)
+      #   trigger.title = 'Assign to priority group'
+      #   update = Readiness::Zendesk::Triggers.update!(client, trigger)
+      #   pp update.title
+      #   # => "Assign to priority group"
+      def self.update!(client, trigger)
+        response = client.connection.put "triggers/#{trigger.id}", to_clean_json_with_key(trigger, 'trigger')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update trigger', id: trigger.id, message: Oj.load(response.body)}) unless response.status == 200
+        Triggers.new(Oj.load(response.body)['trigger'])
+      end
+
+      ##
+      # Updates multiple triggers via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param triggers [Array] An array of {Readiness::Zendesk::Triggers} instances
+      # @return [Array] An array of {Readiness::Zendesk::Triggers} instances
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/#update-many-ticket-triggers Zendesk API > Ticket Triggers > Update Many Ticket Triggers
+      # @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)
+      #   trigger1 = Readiness::Zendesk::Triggers.find!(client, 25)
+      #   trigger1.category_id = '10027'
+      #   trigger2 = Readiness::Zendesk::Triggers.find!(client, 26)
+      #   trigger2.category_id = '10027'
+      #   triggers = [trigger1, trigger2]
+      #   updates = Readiness::Zendesk::Triggers.update_many!(client, triggers)
+      #   pp updates.map { |u| u.category_id }
+      #   # => ["10027", "10027"]
+      def self.update_many!(client, triggers)
+        data = { triggers: triggers.map { |t| to_hash(t).compact } }.to_json
+        response = client.connection.put('triggers/update_many', data)
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update many triggers', message: Oj.load(response.body)}) unless response.status == 200
+        Oj.load(response.body)['trigger'].map { |t| Triggers.new(t) }
+      end
+
+      ##
+      # Deletes a trigger. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param trigger [Object] An instance of {Readiness::Zendesk::Triggers}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/#delete-ticket-trigger Zendesk API > Ticket Triggers > Delete Ticket Trigger
+      # @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)
+      #   trigger = Readiness::Zendesk::Triggers.find!(client, 198)
+      #   delete = Readiness::Zendesk::Triggers.delete!(client, trigger)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, trigger)
+        response = client.connection.delete "triggers/#{trigger.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete a trigger', id: trigger.id, message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+
+      ##
+      # Deletes multiple triggers via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param tids [Array] An array of trigger IDs
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/#bulk-delete-ticket-triggers Zendesk API > Ticket Triggers > Bulk Delete Ticket Triggers
+      # @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)
+      #   deletes = Readiness::Zendesk::Triggers.delete!(client, [25, 23, 27, 22])
+      #   pp deletes
+      #   # => true
+      def self.delete_many(client, tids)
+        response = client.connection.delete("triggers/destroy_many?ids=#{tids.join(',')}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete many triggers', message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+    end
+  end
+end