zendesk_support_api 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c78cf01ac68e20c32f2e1d3ac3d47a9b4574012200718e33d06f3f92d75d9a68
+  data.tar.gz: f066e3f7c5fbfd5008a8a2d8b3fff4ba416c8d9e5a3373a7f8b8d586126c5fb9
+SHA512:
+  metadata.gz: f55d3a02c043022f70047bfe080d1227a9f1ea4dd9355f6e670ddb33187fd7bd6b79fbf207a99c671616ab0f370e56d4f9b8a510b966d50947a7c6e9ccf5c46e
+  data.tar.gz: 4eeb5abd58621fc511552e686859e68e95cbec5b8cca8363b93c1b9a57cdb2e1f01860b21158351a5290e44b3c929307b231bfd3f65917d7e8fc3a6451211492

data/.gitlab-ci.yml

@@ -0,0 +1,13 @@
+image: ruby:2.6.1-alpine
+
+pages:
+  script:
+  - gem install yard
+  - yard doc
+  - rm -rf public
+  - mv doc public
+  artifacts:
+    paths:
+    - public
+  only:
+  - master

data/.yardoc/checksums

@@ -0,0 +1,8 @@
+lib/zendesk_support_api.rb fee89f019b11ec8feb844644e000cec6cad6a695
+lib/zendesk_support_api/jobs.rb 15e3db660bb16f1a2bc580ce17a9368f81fc9d0e
+lib/zendesk_support_api/users.rb eb4f8d81f6f9ccf779679f7bfe354c0cc6be8d0c
+lib/zendesk_support_api/client.rb 19147ca149a521a068e8a8818ad9b26091df0542
+lib/zendesk_support_api/groups.rb bcc2a0b1af5bf3552c7838d80f339efbf8636e53
+lib/zendesk_support_api/search.rb e741717c61809c578afbcd44f9b8e8f18a8c0363
+lib/zendesk_support_api/version.rb b95930e804ad2f9d4718efe8b3c740f79304913f
+lib/zendesk_support_api/organizations.rb 684c74525f26697a7a6e5fca921a1a937b0d20c8

data/README.md

@@ -0,0 +1,73 @@
+# ZendeskSupportAPI
+
+
+## Documentation
+
+Documentation (generated via yard) can be found [here](https://reyloc.gitlab.io/zendesk_support_api/)
+
+## Installation
+
+The gem can be installed either via rubygems or bundler:
+
+### Rubygems
+
+```bash
+gem install zendesk_support_api
+```
+
+### Bundler
+
+```ruby
+gem "zendesk_support_api"
+```
+
+The current requirements for the gem are:
+
+* 'faraday', '~>1.0.0'
+* 'oj', '~>3.10.6'
+
+## Configuration
+
+Configuration is done through the creation of a `ZendeskSupportAPI::Client`
+instance:
+
+```ruby
+require 'zendesk_support_api'
+
+client = ZendeskSupportAPI::Client.new('user@example.com', '123abc', 'https://zendesk.com/api/v2')
+```
+
+## Usage
+
+Soon to come
+
+## Changelog
+
+* v0.1.0 - Initial creation of gem
+* v0.2.0 - Added Search functions, Fixed some yard syntax/formatting, Changed version number
+* v0.3.0 - Changed version number, Added Group functions, Added User.groups function
+* v0.4.0 - Added Organization functions, Changed version number
+
+## Upcoming changes
+
+* v0.5.0 - Requests
+* v0.6.0 - Tickets
+* v0.7.0 - Attachments?
+* v0.8.0 - Satisfaction
+* v0.9.0 - Sessions
+* v0.10.0 - Tags
+* v0.11.0 - Views
+* v0.12.0 - Triggers
+* v0.13.0 - Automations
+* v0.14.0 - SLA
+* v0.15.0 - Targets
+* v0.16.0 - Macros
+* v0.17.0 - Brands
+* v0.18.0 - Locales
+* v0.19.0 - Schedules
+* v0.20.0 - Ticket Forms
+* v0.21.0 - Ticket Fields
+* v0.22.0 - User Fields
+* v0.23.0 - Organization Fields
+* v0.24.0 - Account Settings
+* v1.0.0 - Usage details, any polishing needed

data/lib/zendesk_support_api.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'oj'
+
+# ZendeskSupportAPI - https://developer.zendesk.com/rest_api/docs/support/introduction
+module ZendeskSupportAPI
+  require 'zendesk_support_api/client'
+  require 'zendesk_support_api/version'
+end

data/lib/zendesk_support_api/client.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module ZendeskSupportAPI
+  # Client class - https://developer.zendesk.com/rest_api/docs/support/introduction#security-and-authentication
+  class Client
+    require 'zendesk_support_api/groups'
+    require 'zendesk_support_api/jobs'
+    require 'zendesk_support_api/organizations'
+    require 'zendesk_support_api/search'
+    require 'zendesk_support_api/users'
+
+    # Create a new instance of Client
+    #
+    # @param user [String] - The API username to use
+    # @param token [String] - The API token to use
+    # @param url [String] - The API URL to use
+    #
+    # @example
+    #   ZendeskSupportAPI::Client.new('user', '123', 'zendesk.com/api')
+    #   #=> #<ZendeskSupportAPI::Client:0x00007f88779cb330 @user="user",
+    #   #=>    @token="123", @url="zendesk.com/api">
+    def initialize(user, token, url)
+      @user = user
+      @token = token
+      @url = url
+    end
+
+    # Make a request to the Zendesk Support API
+    #
+    # @param http_method [Symbol] The HTTP method to utilize
+    # @param endpoint [String] The endpoint to hit
+    # @param params [Hash] Parameters for the request
+    # @return [Hash]
+    #
+    # @example
+    #   client = ZendeskSupportAPI::Client.new('user', '123', 'zendesk.com/api')
+    #   client.response(:get, 'users.json')
+    #   #=> {users:[{user1},{user2}...{user100}]}
+
+    def request(http_method, endpoint, params = {})
+      response = client.public_send(http_method, endpoint, params)
+      Oj.load(response.body)
+    end
+
+    # Outputs a spinner symbol
+    #
+    # @param string [String] The string to output at the beginning
+    # @param num [Integer] The index of the iteration
+    # @return [String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Client.spinner('users', 1) #=> Grabbing users... \
+    #   ZendeskSupportAPI::Client.spinner('groups', 3) #=> /
+
+    def spinner(string, num)
+      print "Grabbing #{string}... " if num.to_i == 1
+      symbols = ['-', '\\', '|', '/']
+      print symbols[num.to_i % 4]
+      print "\b"
+    end
+
+    # Handles responses that create jobs
+    #
+    # @param job [Hash] - The output from a request that created a job
+    # @return [Hash]
+
+    def handle_job(job)
+      print 'Checking job'
+      while job['job_status']['status'] != 'completed'
+        print '.'
+        job = ZendeskSupportAPI::Jobs.show(self, job['job_status']['id'])
+      end
+      puts 'completed'
+      job['job_status']['results']
+    end
+
+    private
+
+    # Creates a new Faraday instance
+    #
+    # @return [ZendeskSupportAPI::Client]
+
+    def client
+      @client ||= Faraday.new(@url) do |c|
+        c.request :url_encoded
+        c.adapter Faraday.default_adapter
+        c.basic_auth "#{@user}/token", @token
+      end
+    end
+  end
+end

data/lib/zendesk_support_api/groups.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+module ZendeskSupportAPI
+  # Groups class - https://developer.zendesk.com/rest_api/docs/support/groups
+  class Groups
+    # Function to return a string that side-loads users
+    #
+    # @return [String]
+
+    def self.user_map(groups, users)
+      groups.map { |g| group_object(g, users) }
+    end
+
+    # Creates a group hash (for mappping the user into the group Hash)
+    #
+    # @param group [Hash] The group details to use
+    # @param users [Array] The Array of users to use
+    # @return [Hash]
+
+    def self.group_object(group, users)
+      group['user'] = users.select { |u| u['id'] == group['user_id'] }
+      group
+    end
+
+    # Returns the string of the next_page for pagination
+    #
+    # @param res [Hash] The Hash containing the response from a request
+    # @return [nil|String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.next_page(response) #=> nil
+    #   ZendeskSupportAPI::Users.next_page(response)
+    #   #=> "memberships.json?include=users&page=3
+
+    def self.next_page(res)
+      (res['next_page'].nil? ? nil : res['next_page'].split('/').last)
+    end
+
+    # Lists groups (first 100)
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Groups.list(client)
+    #   #=> [
+    #   #=>   {
+    #   #=>     "name":       "DJs",
+    #   #=>     "created_at": "2009-05-13T00:07:08Z",
+    #   #=>     "updated_at": "2011-07-22T00:11:12Z",
+    #   #=>     "id":         211
+    #   #=>   },
+    #   #=>   {
+    #   #=>     "name":       "MCs",
+    #   #=>     "created_at": "2009-08-26T00:07:08Z",
+    #   #=>     "updated_at": "2010-05-13T00:07:08Z",
+    #   #=>     "id":         122
+    #   #=>   }
+    #   #=> ]
+
+    def self.list(client)
+      client.request(:get, 'groups.json')['groups']
+    end
+
+    # Shows assignable groups (first 100)
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Groups.assignable(client)
+    #   #=> [
+    #   #=>   {
+    #   #=>     "name":       "DJs",
+    #   #=>     "created_at": "2009-05-13T00:07:08Z",
+    #   #=>     "updated_at": "2011-07-22T00:11:12Z",
+    #   #=>     "id":         211
+    #   #=>   },
+    #   #=>   {
+    #   #=>     "name":       "MCs",
+    #   #=>     "created_at": "2009-08-26T00:07:08Z",
+    #   #=>     "updated_at": "2010-05-13T00:07:08Z",
+    #   #=>     "id":         122
+    #   #=>   }
+    #   #=> ]
+
+    def self.assignable(client)
+      client.request(:get, 'assignable.json')['groups']
+    end
+
+    # Shows info about a specific group
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param gid [Integer] The Group ID
+    # @return [Hash]
+    #
+    # @example
+    #   ZendeskSupportAPI::Groups.show(client, 122)
+    #   #=> {
+    #   #=>   "name":       "MCs",
+    #   #=>   "created_at": "2009-08-26T00:07:08Z",
+    #   #=>   "updated_at": "2010-05-13T00:07:08Z",
+    #   #=>   "id":         122
+    #   #=> }
+
+    def self.show(client, gid)
+      client.request(:get, "groups/#{gid}.json")['group']
+    end
+
+    # Create a group
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param group [Hash] The group details to use
+    # @return [String|Hash]
+    #
+    # @example
+    #   group = {
+    #     name: 'Test Group'
+    #   }
+    #   ZendeskSupportAPI::Groups.create(client, group)
+    #   #=> {
+    #   #=>   "name": "Test Group",
+    #   #=>   "created_at": "2011-04-20T17:49:00Z",
+    #   #=>    "updated_at": "2011-04-20T17:49:00Z",
+    #   #=>    "id":         123
+    #   #=> }
+
+    def self.create(client, group)
+      res = client.request(:post, 'groups.json', group: group)
+      return "Creation failed: #{res['details']}" if res['error']
+
+      res
+    end
+
+    # Updates a group
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param gid [Integer] The group ID to use
+    # @param group [Hash] The group details to use
+    # @return [String|Hash]
+    #
+    # @example
+    #   group = {
+    #     name: 'Test Group - defunct'
+    #   }
+    #   ZendeskSupportAPI::Groups.update(client, 123, group)
+    #   #=> {
+    #   #=>   "name": "Test Group - defunct",
+    #   #=>   "created_at": "2011-04-20T17:49:00Z",
+    #   #=>    "updated_at": "2011-07-20T17:49:00Z",
+    #   #=>    "id":         123
+    #   #=> }
+
+    def self.update(client, gid, group)
+      res = client.request(:post, "groups/#{gid}.json", group: group)
+      return "Update failed: #{res['details']}" if res['error']
+
+      res
+    end
+
+    # Deletes a group
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param gid [Integer] The group ID to use
+    # @return [String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Groups.delete(client, 123)
+    #   #=> Group 123 has been deleted
+
+    def self.delete(client, gid)
+      res = client.request(:delete, "groups/#{gid}.json")
+      return "Deletion of #{gid} failed: #{res['error']}" if res['error']
+
+      "Group #{gid} has been deleted"
+    end
+  end
+end

data/lib/zendesk_support_api/jobs.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module ZendeskSupportAPI
+  # Jobs class - https://developer.zendesk.com/rest_api/docs/support/job_statuses
+  class Jobs
+    # Make a request to show the job status
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param id [String] The id of the job to check
+    # @return [Hash]
+    #
+    # @example
+    #   client = ZendeskSupportAPI::Client.new('user', '123', 'zendesk.com/api')
+    #   ZendeskSupportAPI::Jobs.show(client, 'abc123')
+    #   #=> {
+    #   #=>   "job_status"=> {
+    #   #=>     "id"=>"abc123",
+    #   #=>     "url"=>"abc123.json",
+    #   #=>     "total"=>2,
+    #   #=>     "progress"=>2,
+    #   #=>     "status"=>"completed",
+    #   #=>     "message"=>"Completed at 2020-04-29 13:26:40 +0000",
+    #   #=>     "results"=> [
+    #   #=>       {
+    #   #=>         "id"=>369731992959,
+    #   #=>         "status"=>"Updated",
+    #   #=>         "email"=>"test@example.com"
+    #   #=>       },
+    #   #=>       {
+    #   #=>         "id"=>369728778639,
+    #   #=>         "status"=>"Updated",
+    #   #=>         "email"=>"test2@example.com"
+    #   #=>       }
+    #   #=>     ]
+    #   #=>   }
+    #   #=> }
+
+    def self.show(client, id)
+      client.request(:get, "job_statuses/#{id}.json")
+    end
+
+    # Make a request to show all job statuses
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @return [Hash]
+    #
+    # @example
+    #   ZendeskSupportAPI::Jobs.show_many(client, ['abc123', 'def456'])
+    #   #=> {
+    #   #=>   "job_statuses": [
+    #   #=>     {
+    #   #=>       "id": "abc123",
+    #   #=>       "status": "completed",
+    #   #=>       ...
+    #   #=>     },
+    #   #=>     {
+    #   #=>      "id": "def456",
+    #   #=>      "status": "completed",
+    #   #=>      ...
+    #   #=>     }
+    #   #=>   ]
+    #   #=> }
+
+    def self.list(client)
+      client.request(:get, 'job_statuses.json')['job_statuses']
+    end
+
+    # Show many job statuses
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param ids [Array] An Array of job IDs to show
+    # @return [Hash]
+    #
+    # @example
+    #   ZendeskSupportAPI::Jobs.show_many(client, ['abc123', 'def456'])
+    #   #=> {
+    #   #=>   "job_statuses": [
+    #   #=>     {
+    #   #=>       "id": "abc123",
+    #   #=>       "status": "completed",
+    #   #=>       ...
+    #   #=>     },
+    #   #=>     {
+    #   #=>      "id": "def456",
+    #   #=>      "status": "completed",
+    #   #=>      ...
+    #   #=>     }
+    #   #=>   ]
+    #   #=> }
+
+    def self.show_many(client, ids)
+      client.request(:get, "job_statuses/show_many.json?ids=#{ids.join(',')}")
+    end
+  end
+end

data/lib/zendesk_support_api/organizations.rb

@@ -0,0 +1,268 @@
+# frozen_string_literal: true
+
+module ZendeskSupportAPI
+  # Organizations class - https://developer.zendesk.com/rest_api/docs/support/organizations
+  class Organizations
+    # Prints out organizations
+    #
+    # @return [String]
+
+    def self.orgs
+      'organizations'
+    end
+
+    # Lists Organizations (first 100)
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Organizations.list(client)
+    #   #=> [
+    #   #=>   {
+    #   #=>     "url": "https://zendesk.com/api/v2/organizations/1.json",
+    #   #=>     "id": 1,
+    #   #=>     "name": "One Organization",
+    #   #=>     ...
+    #   #=>   },
+    #   #=>   ...
+    #   #=>   {
+    #   #=>     "url": "https://zendesk.com/api/v2/organizations/100.json",
+    #   #=>     "id: 100,
+    #   #=>     "name": "Other Organization",
+    #   #=>     ...
+    #   #=>   }
+    #   #=> ]
+
+    def self.list(client)
+      client.request(:get, "#{orgs}.json")[orgs]
+    end
+
+    # Shows info about an organization
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param oid [Integer] The Organization ID to use
+    # @return [Hash]
+    #
+    # @example
+    #   ZendeskSupportAPI::Organizations.show(client, 123)
+    #   #=> {
+    #   #=>   "url": "https://zendesk.com/api/v2/organizations/1.json",
+    #   #=>   "id": 1,
+    #   #=>   "name": "One Organization",
+    #   #=>   ...
+    #   #=> }
+
+    def self.show(client, oid)
+      client.request(:get, "#{orgs}/#{oid}.json")['organization']
+    end
+
+    # Show several organizations
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param oids [Array] An Array of Organization IDs to show
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Organizations.show(client, [1,2])
+    #   #=> [
+    #   #=>   {
+    #   #=>     "url": "https://zendesk.com/api/v2/organizations/1.json",
+    #   #=>     "id": 1,
+    #   #=>     "name": "One Organization",
+    #   #=>     ...
+    #   #=>   },
+    #   #=>   {
+    #   #=>     "url": "https://zendesk.com/api/v2/organizations/2.json",
+    #   #=>     "id": 2,
+    #   #=>     "name": "Two Organization",
+    #   #=>     ...
+    #   #=>   }
+    #   #=> ]
+
+    def self.show_many(client, oids)
+      ids = "ids=#{oids.join(',')}"
+      client.request(:get, "#{orgs}/show_many.json?#{ids}")[orgs]
+    end
+
+    # Creates an organization
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param org [Hash] The organization info to use
+    # @return [Hash|String]
+    #
+    # @example
+    #   org = {
+    #     name: 'Test Organization',
+    #   }
+    #   ZendeskSupportAPI::Organizations.create(client, org)
+    #   #=> {
+    #   #=>   "url": "",
+    #   #=>   "id": 123,
+    #   #=>   "name": "Test Organization",
+    #   #=>   ...
+    #   #=> }
+
+    def self.create(client, org)
+      res = client.request(:post, "#{orgs}.json", organization: org)
+      return "Creation failed: #{res['details']}" if res['error']
+
+      res['organization']
+    end
+
+    # Creates many organizations
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param users [Array] The organizations to create
+    # @return [ZendeskSupportAPI::Client.handle_job]
+
+    def self.create_many(client, orgs)
+      url = "#{orgs}/create_many.json"
+      res = client.request(:post, url, organizations: orgs)
+      client.handle_job(res)
+    end
+
+    # Creates or updates an organization
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param org [Hash] The organization info to use
+    # @return [Hash|String]
+    #
+    # @example
+    #   org = {
+    #     name: 'Test Organization',
+    #   }
+    #   ZendeskSupportAPI::Organizations.create_or_update(client, org)
+    #   #=> {
+    #   #=>   "url": "",
+    #   #=>   "id": 123,
+    #   #=>   "name": "Test Organization",
+    #   #=>   ...
+    #   #=> }
+
+    def self.create_or_update(client, org)
+      url = "#{orgs}/create_or_update.json"
+      res = client.request(:post, url, organization: org)
+      return "Create/Update failed: #{res['description']}" if res['error']
+
+      res['organization']
+    end
+
+    # Updates an organization
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param oid [Integer] The Organization ID to use
+    # @param org [Hash] The organization info to use
+    # @return [Hash|String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Organizations.update(client, 123, org)
+    #   #=> {organization}
+
+    def self.update(client, oid, org)
+      res = client.request(:post, "#{orgs}/#{oid}.json", organization: org)
+      return "Update of #{uid} failed: #{res['error']}" if res['error']
+
+      res['organization']
+    end
+
+    # Updates many organizations
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param orgs [Array] The organizations to update
+    # @return [ZendeskSupportAPI::Client.handle_job]
+
+    def self.update_many(client, orgs)
+      url = "#{orgs}/update_many.json"
+      res = client.request(:put, url, organizations: orgs)
+      client.handle_job(res)
+    end
+
+    # Deletes an organization
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param oid [Integer] The Organization ID to delete
+    # @return [String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Organizations.delete(client, 123)
+    #   #=> Organization 123 has been deleted
+    #   ZendeskSupportAPI::Organizations.delete(client, 123)
+    #   #=> "Deletion of 123 failed: RecordNotFound"
+
+    def self.delete(client, oid)
+      res = client.request(:delete, "#{orgs}/#{oid}.json")
+      return "Deletion of #{oid} failed: #{res['error']}" if res['error']
+
+      "Organization #{uid} has been deleted"
+    end
+
+    # Deletes many organizations
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param ids [Array] The array of Organization IDs to delete
+    # @return [ZendeskSupportAPI::Client.handle_job
+
+    def self.bulk_delete(client, ids)
+      url = "#{orgs}/destroy_many.json?ids=#{ids.join(',')}"
+      res = client.request(:delete, url)
+      client.handle_job(res)
+    end
+
+    # Searches for orgs by their external_id (first 100)
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param eid [String] The External ID to use
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Organizations.search_by_external_id(client, 'abc123')
+    #   #=> [
+    #   #=>   {
+    #   #=>     "url": "https://zendesk.com/api/v2/organizations/1.json",
+    #   #=>     "id": 1,
+    #   #=>     "name": "One Organization",
+    #   #=>     ...
+    #   #=>   },
+    #   #=>   ...
+    #   #=>   {
+    #   #=>     "url": "https://zendesk.com/api/v2/organizations/100.json",
+    #   #=>     "id: 100,
+    #   #=>     "name": "Other Organization",
+    #   #=>     ...
+    #   #=>   }
+    #   #=> ]
+
+    def self.search_by_external_id(client, eid)
+      client.request(:get, "#{orgs}/search.json?external_id=#{eid}")[orgs]
+    end
+
+    # Get an Organization's members
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param oid [Integer] The Organization ID to use
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Organizations.members(client, 123)
+    #   #=> [
+    #   #=>   {
+    #   #=>     "id": 1,
+    #   #=>     "name": "Albert",
+    #   #=>     "email": "albert@example.com",
+    #   #=>     ...
+    #   #=>   },
+    #   #=>   ...
+    #   #=>   {
+    #   #=>     "id": 22,
+    #   #=>     "name": "Victor",
+    #   #=>     "email": "victor@example.com",
+    #   #=>     ...
+    #   #=>   }
+    #   #=> ]
+
+    def self.members(client, oid)
+      url = "#{orgs}/#{oid}/organization_memberships.json?include=users"
+      client.request(:get, url)['users']
+    end
+  end
+end

data/lib/zendesk_support_api/search.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module ZendeskSupportAPI
+  # Search class - https://developer.zendesk.com/rest_api/docs/support/search
+  class Search
+    # Perform a search and list results (first 100)
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param query [String] The query to use
+    # @param sort [String] The sorting method to use (defaults to revelance)
+    # @param order [String] The order to use (defaults to desc)
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Search.list(client, 'bob')
+    #   #=> [
+    #   #=>   {
+    #   #=>     "name":        "Bob McBob",
+    #   #=>     "created_at":  "2009-05-13T00:07:08Z",
+    #   #=>     "updated_at":  "2011-07-22T00:11:12Z",
+    #   #=>     "id":          211,
+    #   #=>     "result_type": "user"
+    #   #=>     "url":         "https://zendesk.com/api/v2/users/211.json"
+    #   #=>   },
+    #   #=>   {
+    #   #=>     "name":        "Bob's Company",
+    #   #=>     "created_at":  "2009-08-26T00:07:08Z",
+    #   #=>     "updated_at":  "2010-05-13T00:07:08Z",
+    #   #=>     "id":          122,
+    #   #=>     "result_type": "group"
+    #   #=>     "url":         "https://zendesk.com/api/v2/groups/122.json"
+    #   #=>   },
+    #   #=>   ...
+    #   #=> ]
+
+    def self.list(client, query, sort = '', order = 'desc')
+      return bad_search("invalid sort - #{sort}") unless sort_valid?(sort)
+      return bad_search("invalid order - #{order}") unless order_valid?(order)
+
+      sort_order = sort_order_string(sort, order)
+      client.request(:get, "search.json?query=#{query}#{sort_order}")['results']
+    end
+
+    # Determines if a given sort string is valid
+    #
+    # @param sort [String] The sort string to check
+    # @return [Boolean]
+    #
+    # @example
+    #   ZendeskSupportAPI::Search.sort_valid? 'updated_at'
+    #   #=> true
+    #   ZendeskSupportAPI::Search.sort_valid? 'ticket_type'
+    #   #=> true
+    #   ZendeskSupportAPI::Search.sort_valid? 'random'
+    #   #=> false
+
+    def self.sort_valid?(sort)
+      return true if sort.empty?
+
+      valid = %w[updated_at created_at priority status ticket_type]
+      valid.include? sort
+    end
+
+    # Determines if a given order string is valid
+    #
+    # @param order [String] The order string to check
+    # @return [Boolean]
+    #
+    # @example
+    #   ZendeskSupportAPI::Search.order_valid? 'asc'
+    #   #=> true
+    #   ZendeskSupportAPI::Search.order_valid? 'desc'
+    #   #=> true
+    #   ZendeskSupportAPI::Search.order_valid? 'random'
+    #   #=> false
+
+    def self.order_valid?(order)
+      valid = %w[asc desc]
+      valid.include? order
+    end
+
+    # Prints out an error message
+    #
+    # @param string [String] The error that occurred
+    # @return [String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Search.bad_search('invalid sort - name')
+    #   #=> "Search cannot be completed: invalid sort - name"
+
+    def self.bad_search(string)
+      "Search cannot be completed: #{string}"
+    end
+
+    # Determines the sort and order to use in the query
+    #
+    # @param sort [String] The sort string to use
+    # @param order [String] The order string to use
+    # @return [String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Search.sort_order_string('', 'asc')
+    #   #=> "&order_by=asc"
+    #   ZendeskSupportAPI::Search.sort_order_string('priority', 'desc')
+    #   #=> "&sort_by=priority"
+    #   ZendeskSupportAPI::Search.sort_order_string('updated_at', 'asc')
+    #   #=> "&sort_by=updated_at&order_by=asc"
+
+    def self.sort_order_string(sort, order)
+      sort = (sort.empty? ? '' : "&sort_by=#{sort}")
+      order = (order == 'desc' ? '' : '&order_by=asc')
+      "#{sort}#{order}"
+    end
+  end
+end

data/lib/zendesk_support_api/users.rb

@@ -0,0 +1,317 @@
+# frozen_string_literal: true
+
+module ZendeskSupportAPI
+  # Users class - https://developer.zendesk.com/rest_api/docs/support/users
+  class Users
+    # Function to return a string that side-loads organizations
+    #
+    # @return [String]
+
+    def self.included
+      'include=organizations'
+    end
+
+    # Maps users into user_objects
+    #
+    # @param users [Array] The Array of users to map
+    # @param orgs [Array] The Array of orgs to use in mapping
+    # @return [Hash]
+
+    def self.user_map(users, orgs)
+      users.map { |u| user_object(u, orgs) }
+    end
+
+    # Returns the string of the next_page for pagination
+    #
+    # @param res [Hash] The Hash containing the response from a request
+    # @return [nil|String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.next_page(response) #=> nil
+    #   ZendeskSupportAPI::Users.next_page(response)
+    #   #=> "users.json?include=organizations&page=56
+
+    def self.next_page(res)
+      (res['next_page'].nil? ? nil : res['next_page'].split('/').last)
+    end
+
+    # Lists out users (first 100)
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @return [Hash]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.list(client)
+    #   #=> {users:[{user1},{user2}...{user100}]}
+
+    def self.list(client)
+      res = client.request(:get, "users.json?#{included}")
+      res['users'].map { |u| user_object(u, res['organizations']) }
+      res['users']
+    end
+
+    # Lists out all users (paginates over every page)
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @return [Hash]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.all(client)
+    #   #=> Grabbing users (total: 215336)... / ...done
+    #   #=> {users:[{user1},{user2}...{user201520}]}
+
+    def self.all(client)
+      users = []
+      page = "users.json?#{included}&page=1"
+      until page.nil?
+        res = client.request(:get, page)
+        client.spinner("users (total: #{res['count']})", page.split('=').last)
+        users += user_map(res['users'], res['organizations'])
+        page = next_page(res)
+      end
+      puts ' ...done'
+      users
+    end
+
+    # Grabs a specific user
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param id [Integer] The User's ID to use
+    # @return [Hash]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.show(client, 123)
+    #   #=> {
+    #   #=>   "id"=>123,
+    #   #=>   "url"=>"https://zendesk.com/api/users/123.json",
+    #   #=>   "name"=>"Test User",
+    #   #=>   ...
+    #   #=> }
+
+    def self.show(client, id)
+      res = client.request(:get, "users/#{id}.json?#{included}")
+      user_object(res['user'], res['organizations'])
+    end
+
+    # Shows many users
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param ids [Array] An array of User IDs to use
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.show_many(client, [123, 456])
+    #   #=> [
+    #   #=>   {
+    #   #=>     "id": 123,
+    #   #=>     "name": "Johnny Appleseed",
+    #   #=>     ...
+    #   #=>   },
+    #   #=>   {
+    #   #=>     "id": 456,
+    #   #=>     "name": "Rupert Root",
+    #   #=>     ...
+    #   #=>   }
+    #   #=> ]
+
+    def self.show_many(client, ids)
+      ids = ids.join(',')
+      res = client.request(:get, "users/show_many.json?#{included}&ids=#{ids}")
+      res['users'].map { |u| user_object(u, res['organizations']) }
+      res['users']
+    end
+
+    # Creates a user hash (for mapping the org into the user Hash)
+    #
+    # @param user [Hash] The user details to use
+    # @param orgs [Array] The Array of orgs to use
+    # @return [Hash]
+
+    def self.user_object(user, orgs)
+      oid = 'organization_id'
+      user['organization'] = orgs.select { |o| o['id'] == user[oid] }
+      user
+    end
+
+    # Creates a user
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param user [Hash] The user to create
+    # @return [Hash|String] Either the user details or the error
+    #
+    # @example
+    #   user = {name: 'Roger Wilco', email: 'rw@example.com'}
+    #   ZendeskSupportAPI::Users.create(client, user)
+    #   #=> {
+    #   #=>   "user": {
+    #   #=>     "id":   9873843,
+    #   #=>     "name": "Roger Wilco",
+    #   #=>     "email": "rw@example.com"
+    #   #=>     ...
+    #   #=>   }
+    #   #=> }
+    #   ZendeskSupportAPI::User.create(client, user)
+    #   #=> Creation failed: => "Creation failed: {\"email\"=>[{\"description\"
+    #   #=> =>\"Email: rw@example.com is already being used by another user\",
+    #   #=> \"error\"=>\"DuplicateValue\"}]}"
+
+    def self.create(client, user)
+      res = client.request(:post, 'users.json', user: user)
+      return "Creation failed: #{res['details']}" if res['error']
+
+      res
+    end
+
+    # Creates many users
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param users [Array] The users to create
+    # @return [ZendeskSupportAPI::Client.handle_job]
+
+    def self.create_many(client, users)
+      res = client.request(:post, 'users/create_many.json', users: users)
+      client.handle_job(res)
+    end
+
+    # Creates or updates a user
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param user [Hash] The user to create/update
+    # @return [Hash|String] Either the user details or the error
+    #
+    # @example
+    #   ZendeskSupportAPI::User.create_or_update(client, user)
+    #   #=> {
+    #   #=>   "user": {
+    #   #=>     "id":   9873843,
+    #   #=>     "name": "Roger Wilco",
+    #   #=>     "email": "rw@example.com"
+    #   #=>     ...
+    #   #=>   }
+    #   #=> }
+
+    def self.create_or_update(client, user)
+      res = client.request(:post, 'users/create_or_update.json', user: user)
+      return "Create/Update failed: #{res['description']}" if res['error']
+
+      res
+    end
+
+    # Creates or updates many users
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param users [Array] The users to create/update
+    # @return [ZendeskSupportAPI::Client.handle_job]
+
+    def self.create_or_update_many(client, users)
+      res = client.request(:post,
+                           'users/create_or_update_many.json',
+                           users: users)
+      client.handle_job(res)
+    end
+
+    # Updates a user
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param uid [Integer] The User's ID
+    # @param user [Hash] The user details to update
+    # @return [Hash|String] Either the user details or the error
+    #
+    # @example
+    #   ZendeskSupportAPI::User.update(client, 123, user)
+    #   #=> {user}
+
+    def self.update(client, uid, user)
+      res = client.request(:put, "users/#{uid}.json", user: user)
+      return "Update of #{uid} failed: #{res['error']}" if res['error']
+
+      res
+    end
+
+    # Updates many users
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param users [Array] The users to update
+    # @return [ZendeskSupportAPI::Client.handle_job]
+
+    def self.update_many(client, users)
+      res = client.request(:put, 'users/update_many.json', users: users)
+      client.handle_job(res)
+    end
+
+    # Deletes a user
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param uid [Integer] The User ID to delete
+    # @return [String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.delete(client, 123)
+    #   #=> User 123 has been deleted
+    #   ZendeskSupportAPI::Users.delete(client, 123)
+    #   #=> "Deletion of 123 failed: RecordNotFound"
+
+    def self.delete(client, uid)
+      res = client.request(:delete, "users/#{uid}.json")
+      return "Deletion of #{uid} failed: #{res['error']}" if res['error']
+
+      "User #{uid} has been deleted"
+    end
+
+    # Deletes many users
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param ids [Array] The array of User IDs to delete
+    # @return [ZendeskSupportAPI::Client.handle_job]
+
+    def self.delete_many(client, ids)
+      ids = ids.join(',')
+      res = client.request(:delete, "users/destroy_many.json?ids=#{ids}")
+      client.handle_job(res)
+    end
+
+    # Suspends a user
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param id [Integer] The User ID to suspend
+    # @return [String] Either a success message or an error
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.suspend(client, 123)
+    #   #=> User 123 is suspended
+
+    def self.suspend(client, id)
+      res = client.request(:put, "users/#{id}.json", user: { suspended: true })
+      return "Suspension of #{id} failed: #{res['error']}" if res['error']
+
+      "User #{id} suspended" if res['user']['suspended']
+    end
+
+    # Shows a users groups
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param uid [Integer] The User ID to use
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.groups(client, 1234)
+    #   #=> [
+    #   #=>   {
+    #   #=>     "name":       "DJs",
+    #   #=>     "created_at": "2009-05-13T00:07:08Z",
+    #   #=>     "updated_at": "2011-07-22T00:11:12Z",
+    #   #=>     "id":         211
+    #   #=>   },
+    #   #=>   {
+    #   #=>     "name":       "MCs",
+    #   #=>     "created_at": "2009-08-26T00:07:08Z",
+    #   #=>     "updated_at": "2010-05-13T00:07:08Z",
+    #   #=>     "id":         122
+    #   #=>   }
+    #   #=> ]
+
+    def self.groups(client, uid)
+      client.request(:get, "users/#{uid}/groups.json")['groups']
+    end
+  end
+end

data/lib/zendesk_support_api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ZendeskSupportAPI
+  # Outputs the gem version
+
+  VERSION = '0.4.0'
+end

data/zendesk_support_api.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zendesk_support_api/version'
+
+Gem::Specification.new do |s|
+  s.name = 'zendesk_support_api'
+  s.version = ZendeskSupportAPI::VERSION
+  s.date = '2020-04-28'
+  s.summary = 'Zendesk Support API wrapper gem'
+  s.description = 'TBD'
+  s.authors = ['Jason Colyer']
+  s.email = 'jcolyer2007@gmail.com'
+  s.homepage = 'https://gitlab.com/reyloc/zendesk_support_api'
+  s.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r(^(test|spec|features)/)) }
+  end
+  # s.homepage = 'TBD'
+  s.license = 'MIT'
+  s.add_dependency 'faraday', '~>1.0.0'
+  s.add_dependency 'oj', '~>3.10.6'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: zendesk_support_api
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Jason Colyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.6
+description: TBD
+email: jcolyer2007@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitlab-ci.yml"
+- ".yardoc/checksums"
+- ".yardoc/complete"
+- ".yardoc/object_types"
+- ".yardoc/objects/root.dat"
+- ".yardoc/proxy_types"
+- README.md
+- lib/zendesk_support_api.rb
+- lib/zendesk_support_api/client.rb
+- lib/zendesk_support_api/groups.rb
+- lib/zendesk_support_api/jobs.rb
+- lib/zendesk_support_api/organizations.rb
+- lib/zendesk_support_api/search.rb
+- lib/zendesk_support_api/users.rb
+- lib/zendesk_support_api/version.rb
+- zendesk_support_api.gemspec
+homepage: https://gitlab.com/reyloc/zendesk_support_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Zendesk Support API wrapper gem
+test_files: []