gitlab_support_readiness 1.0.0

data/lib/support_readiness/zendesk/organization_fields.rb

@@ -0,0 +1,233 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class OrganizationFields within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class OrganizationFields < Readiness::Client
+      attr_accessor :active, :custom_field_options, :description, :id, :key, :position, :regexp_for_validation, :title, :type
+
+      ##
+      # Creates a new {Readiness::Zendesk::OrganizationFields} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Zendesk::OrganizationFields}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::OrganizationFields.new
+      def initialize(object = {})
+        @active = object['active']
+        @custom_field_options = object['custom_field_options']
+        @description = object['description']
+        @id = object['id']
+        @key = object['key']
+        @position = object['position']
+        @regexp_for_validation = object['regexp_for_validation']
+        @title = object['title']
+        @type = object['type']
+      end
+
+      ##
+      # Lists all organization 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/organizations/organization_fields/#list-organization-fields Zendesk API > Organization Fields > List Organization 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::OrganizationFields.list(client)
+      #   pp fields.first.id
+      #   # => 7
+      def self.list(client, limit = 0, sort = 'id')
+        array = []
+        opts = "page[size]=100"
+        loop do
+          response = client.connection.get("organization_fields?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['organization_fields'].map { |f| OrganizationFields.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 an organization 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 organization field ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/#show-organization-field > Organization Fields > Show Organization 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::OrganizationFields.find(client, 8)
+      #   pp field.title
+      #   # => "Custom Field 1"
+      def self.find(client, fid)
+        response = client.connection.get("organization_fields/#{fid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: fid }) unless response.status == 200
+        return OrganizationFields.new(Oj.load(response.body)['organization_field']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates an organization 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 organization field ID to find
+      # @return [Object] An instance of {Readiness::Zendesk::OrganizationFields}
+      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/#show-organization-field > Organization Fields > Show Organization 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::OrganizationFields.find!(client, 8)
+      #   pp field.title
+      #   # => "Custom Field 1"
+      def self.find!(client, fid)
+        response = client.connection.get("organization_fields/#{fid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find organization field', id: fid }) unless response.status == 200
+        OrganizationFields.new(Oj.load(response.body)['organization_field'])
+      end
+
+      ##
+      # Creates an organization 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::OrganizationFields}
+      # @return [Object] An instance of {Readiness::Zendesk::OrganizationFields}
+      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/#create-organization-field Zendesk API > Organization Fields > Create Organization 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::OrganizationFields.new
+      #   field.type = 'text'
+      #   field.title = 'Support desc'
+      #   field.description = 'This field describes the support plan this organization has'
+      #   field.position: 0
+      #   field.active = true
+      #   field.key = 'support_description'
+      #   create = Readiness::Zendesk::OrganizationFields.create!(client, field)
+      #   pp create.id
+      #   # => 75
+      def self.create!(client, field)
+        response = client.connection.post 'organization_fields', to_clean_json_with_key(field, 'organization_field')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create organization field', message: Oj.load(response.body)}) unless response.status == 201
+        OrganizationFields.new(Oj.load(response.body)['organization_field'])
+      end
+
+      ##
+      # Updates an organization 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::OrganizationFields}
+      # @return [Object] An instance of {Readiness::Zendesk::OrganizationFields}
+      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/#update-organization-field Zendesk API > Organization Fields > Update Organization 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::OrganizationFields.find!(client, 75)
+      #   field.title = 'Support description'
+      #   update = Readiness::Zendesk::OrganizationFields.update!(client, field)
+      #   pp create.title
+      #   # => "Support description"
+      def self.update!(client, field)
+        response = client.connection.put "organization_fields/#{field.id}", to_clean_json_with_key(field, 'ticket_field')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update organization field', message: Oj.load(response.body)}) unless response.status == 200
+        OrganizationFields.new(Oj.load(response.body)['organization_field'])
+      end
+
+      ##
+      # Deletes an organization 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::OrganizationFields}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/#delete-organization-field Zendesk API > Organization Fields > Delete Organization 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::OrganizationFields.find!(client, 75)
+      #   delete = Readiness::Zendesk::OrganizationFields.delete!(client, field)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, field)
+        response = client.connection.delete "organization_fields/#{field.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete an organization field', id: field.id, message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+
+      ##
+      # Reorders organization fields. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param fids [Array] An Array of field IDs (order is important)
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/#reorder-organization-field Zendesk API > Organization Fields > Reorder Organization 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)
+      #   reorder = Readiness::Zendesk::OrganizationFields.reorder!(client, [4, 5, 2, 8])
+      #   pp reorder
+      #   # => true
+      def self.reorder!(client, fids)
+        response = client.connection.put 'organization_fields/reorder', { organization_field_ids: fids }.to_json
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Reorder organization fields', id: fids, message: Oj.load(response.body)}) unless response.status == 200
+        true
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk/organization_memberships.rb

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class OrganizationMemberships within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class OrganizationMemberships < Readiness::Client
+      attr_accessor :id, :default, :organization_id, :organization_name, :user_id, :view_tickets
+
+      ##
+      # Creates a new {Readiness::Zendesk::OrganizationMemberships} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Zendesk::OrganizationMemberships}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::OrganizationMemberships.new
+      def initialize(object = {})
+        @id = object['id']
+        @default = object['default']
+        @organization_id = object['organization_id']
+        @organization_name = object['organization_name']
+        @user_id = object['user_id']
+        @view_tickets = object['view_tickets']
+      end
+
+      ##
+      # Lists the first 100 organization memberships
+      #
+      # @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/organizations/organization_memberships/#list-memberships Zendesk API > Organization Memberships > List Memberships
+      # @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)
+      #   memberships = Readiness::Zendesk::OrganizationMemberships.list(client)
+      #   pp memberships.first.id
+      #   # => 4
+      def self.list(client)
+        response = client.connection.get("organization_memberships?page[size]=100")
+        handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+        Oj.load(response.body)['organization_memberships'].map { |m| OrganizationMemberships.new(m) }
+      end
+
+      ##
+      # Lists many organization memberships. Does not stop until it ends or the page limit is hit.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param limit [Integer] The number of pages to stop at. Using 0 means to list all.
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#list-memberships Zendesk API > Organization Memberships > List Memberships
+      # @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)
+      #   memberships = Readiness::Zendesk::OrganizationMemberships.list_many(client, 2)
+      #   pp memberships.count
+      #   # => 200
+      def self.list_many(client, limit = 0)
+        array = []
+        opts = "page[size]=100"
+        loop do
+          response = client.connection.get("organization_memberships?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['organization_memberships'].map { |o| OrganizationMemberships.new(o) }
+          break if limit != 0 && array.count >= (limit * 100)
+          break unless body['meta']['has_more']
+
+          opts = body['links'] ['next'].split('?').last
+        end
+        array
+      end
+
+      ##
+      # Locates an organization membership 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 oid [Integer] The organization membership ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#show-membership Zendesk API > Organization Memberships > Show Membership
+      # @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)
+      #   membership = Readiness::Zendesk::OrganizationMemberships.find(client, 4)
+      #   pp membership.user_id
+      #   # => 29
+      def self.find(client, oid)
+        response = client.connection.get("organization_memberships/#{oid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: oid }) unless response.status == 200
+        return OrganizationMemberships.new(Oj.load(response.body)['organization_membership']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates an organization membership within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param oid [Integer] The organization membership ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#show-membership Zendesk API > Organization Memberships > Show Membership
+      # @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)
+      #   membership = Readiness::Zendesk::OrganizationMemberships.find!(client, 4)
+      #   pp membership.user_id
+      #   # => 29
+      def self.find!(client, oid)
+        response = client.connection.get("organization_memberships/#{oid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find organization membership', id: oid }) unless response.status == 200
+        OrganizationMemberships.new(Oj.load(response.body)['organization_membership'])
+      end
+
+      ##
+      # Creates an organization membership. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param membership [Object] An instance of {Readiness::Zendesk::OrganizationMemberships}
+      # @return [Object] An instance of {Readiness::Zendesk::OrganizationMemberships}
+      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#create-membership Zendesk API > Organization Memberships > Create Membership
+      # @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)
+      #   membership = Readiness::Zendesk::OrganizationMemberships.new
+      #   membership.user_id = 72
+      #   membership.organization_id = 88
+      #   create = Readiness::Zendesk::OrganizationMemberships.create!(client, membership)
+      #   pp create.id
+      #   # => 461
+      def self.create!(client, membership)
+        response = client.connection.post 'organization_memberships', to_clean_json_with_key(membership, 'organization_membership')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create organization membership', message: Oj.load(response.body)}) unless response.status == 201
+        OrganizationMemberships.new(Oj.load(response.body)['organization_membership'])
+      end
+
+      ##
+      # Creates multiple organization memberships via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param memberships [Array] An array of {Readiness::Zendesk::OrganizationMemberships} instances
+      # @return [object] A {Readiness::Zendesk::JobStatuses} instance
+      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#create-many-memberships Zendesk API > Organization Memberships > Create Many Memberships
+      # @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)
+      #   membership1 = Readiness::Zendesk::OrganizationMemberships.new
+      #   membership1.user_id = 72
+      #   membership1.organization_id = 88
+      #   membership2 = Readiness::Zendesk::OrganizationMemberships.new
+      #   membership2.user_id = 27
+      #   membership2.organization_id = 88
+      #   creates = Readiness::Zendesk::OrganizationMemberships.create_many!(client, membership)
+      #   pp creates.id
+      #   # => "8b726e606741012ffc2d782bcb7848fe"
+      def self.create_many!(client, memberships)
+        data = { organization_memberships: memberships.map { |t| to_hash(t).compact } }.to_json
+        response = client.connection.post('organization_memberships/create_many', data)
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create many organization memberships', message: Oj.load(response.body)}) unless response.status == 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+
+      ##
+      # Deletes an organization membership. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param membership [Object] An instance of {Readiness::Zendesk::OrganizationMemberships}
+      # @return [Boolean]
+      # @see hhttps://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#delete-membership Zendesk API > Organization Memberships > Delete Membership
+      # @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)
+      #   membership = Readiness::Zendesk::OrganizationMemberships.find!(client, 461)
+      #   delete = Readiness::Zendesk::OrganizationMemberships.delete!(client, membership)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, membership)
+        response = client.connection.delete "organization_memberships/#{membership.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete organization membership', message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+
+      ##
+      # Deletes multiple organization memberships via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param mids [Array] An array of organization memberships IDs
+      # @return [object] A {Readiness::Zendesk::JobStatuses} instance
+      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#bulk-delete-memberships Zendesk API > Organization Memberships > Bulk Delete Memberships
+      # @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::OrganizationMemberships.delete!(client, [461, 462])
+      #   pp deletes.id
+      #   # => "82de0b044094f0c67893ac9fe64f1a99"
+      def self.delete_many(client, mids)
+        response = client.connection.delete("organization_memberships/destroy_many?ids=#{mids.join(',')}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete many organization memberships', message: Oj.load(response.body)}) unless response.status == 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+    end
+  end
+end