zendesk_support_api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4914120c422052e97716f808fe888ec810bee8977f4fcd9d275cc6b1705c4ca0
-  data.tar.gz: 4cded8d95430a510322e44f0310f18ce9c01a5776a4dac4ab476eaee487fbecf
+  metadata.gz: c78cf01ac68e20c32f2e1d3ac3d47a9b4574012200718e33d06f3f92d75d9a68
+  data.tar.gz: f066e3f7c5fbfd5008a8a2d8b3fff4ba416c8d9e5a3373a7f8b8d586126c5fb9
 SHA512:
-  metadata.gz: 0065aa4ea3865fd6169a1650ed126d1748e290190dd5a5755c72fda7e37f6f365599e1f73fe178c07d68aa6ed2fed202cad6f6768fec91567c86dd2dafc2817a
-  data.tar.gz: 89c5da1d7258032fe2c56369a7d31e69131137012ada8573618b61693be110ac8a5e0b5bb196afa4cdca0ad1a1e20c21b7ddaa4c51da58f4ddda62e1aef7f162
+  metadata.gz: f55d3a02c043022f70047bfe080d1227a9f1ea4dd9355f6e670ddb33187fd7bd6b79fbf207a99c671616ab0f370e56d4f9b8a510b966d50947a7c6e9ccf5c46e
+  data.tar.gz: 4eeb5abd58621fc511552e686859e68e95cbec5b8cca8363b93c1b9a57cdb2e1f01860b21158351a5290e44b3c929307b231bfd3f65917d7e8fc3a6451211492

data/.yardoc/checksums

@@ -1,7 +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 f73dc3643644c6bf5f1a82593971b78a47b384fc
+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 e6591152418f6cbe5b2a2ff5d68799f735ed597d
+lib/zendesk_support_api/version.rb b95930e804ad2f9d4718efe8b3c740f79304913f
+lib/zendesk_support_api/organizations.rb 684c74525f26697a7a6e5fca921a1a937b0d20c8

data/README.md

@@ -43,13 +43,31 @@ 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.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/client.rb

@@ -5,6 +5,7 @@ module ZendeskSupportAPI
   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'
 

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/version.rb

@@ -3,5 +3,5 @@
 module ZendeskSupportAPI
   # Outputs the gem version
 
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_support_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jason Colyer
@@ -55,6 +55,7 @@ files:
 - 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