desk 0.3.3 → 1.0.0

data/lib/desk/client/brand.rb

@@ -0,0 +1,11 @@
+module Desk
+  class Client
+    module Brand
+
+      def brand_endpoints
+        [ :list, :show ]
+      end
+
+    end
+  end
+end

data/lib/desk/client/case.rb

@@ -2,53 +2,70 @@ module Desk
   class Client
     # Defines methods related to cases
     module Case
-      # Returns extended information of cases
-      #
-      #   @option options [Boolean, String, Integer]
-      #   @example Return extended information for 12345
-      #     Desk.cases(:case_id => 12345)
-      #     Desk.cases(:email => "customer@example.com", :count => 5)
-      #     Desk.cases(:since_id => 12345)
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/cases/show
-      def cases(*args)
+
+      def case_endpoints
+        [ :list, :search, :create, :update, 
+          :list_replies, :show_reply, :create_reply, :update_reply,
+          :list_notes, :show_note, :create_note,
+          :list_attachments, :show_attachment, :create_attachment, :delete_attachment,
+          :list_history
+        ]
+      end
+
+      def show_case(case_id, *args)
         options = args.last.is_a?(Hash) ? args.pop : {}
-        response = get("cases",options)
-        response
-      end
-
-      # Returns extended information on a single case
-      #
-      #   @option options [String]
-      #   @example Return extended information for 12345
-      #     Desk.case(12345)
-      #     Desk.case(12345, :by => "external_id")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/cases/show
-      def case(id, *args)
+        case_id = "e-#{case_id}" if options[:by] == "external_id"
+        get("cases/#{case_id}")
+      end
+      alias_method :case, :show_case
+
+      def show_case_message(case_id)
+        get("cases/#{case_id}/message")
+      end
+      alias_method :case_message, :show_case_message
+
+      def list_case_message_attachments(case_id, *args)
         options = args.last.is_a?(Hash) ? args.pop : {}
-        response = get("cases/#{id}",options)
-        response.case
-      end
-
-      # Updates a single case
-      #
-      #   @option options [String]
-      #   @example Return extended information for 12345
-      #     Desk.update_case(12345, :subject => "New Subject")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/cases/update
-      def update_case(id, *args)
+        get("cases/#{case_id}/message/attachments", options)
+      end
+      alias_method :case_message_attachments, :list_case_message_attachments
+
+      def list_case_reply_attachments(case_id, reply_id, *args)
         options = args.last.is_a?(Hash) ? args.pop : {}
-        response = put("cases/#{id}",options)
-        response.case
+        get("cases/#{case_id}/replies/#{reply_id}/attachments", options)
+      end
+      alias_method :case_reply_attachments, :list_case_reply_attachments
+
+      def show_case_message_attachment(case_id, attachment_id)
+        get("cases/#{case_id}/message/attachments/#{attachment_id}")
+      end
+      alias_method :case_message_attachment, :show_case_message_attachment
+
+      def show_case_reply_attachment(case_id, reply_id, attachment_id)
+        get("cases/#{case_id}/replies/#{reply_id}/attachments/#{attachment_id}")
+      end
+      alias_method :case_reply_attachment, :show_case_reply_attachment
+
+      def create_case_message_attachment(case_id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        post("cases/#{case_id}/message/attachments", options)
+      end
+
+      def create_case_reply_attachment(case_id, reply_id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        post("cases/#{case_id}/replies/#{reply_id}/attachments", options)
+      end
+
+      def delete_case_message_attachment(case_id, attachment_id)
+        delete("cases/#{case_id}/message/attachments/#{attachment_id}")
+      end
+
+      def delete_case_reply_attachment(case_id, reply_id, attachment_id)
+        delete("cases/#{case_id}/replies/#{reply_id}/attachments/#{attachment_id}")
       end
 
-      def case_url(id)
-        "https://#{subdomain}.desk.com/agent/case/#{id}"
+      def case_url(case_id)
+        "https://#{subdomain}.desk.com/agent/case/#{case_id}"
       end
     end
   end

data/lib/desk/client/company.rb

@@ -0,0 +1,11 @@
+module Desk
+  class Client
+    module Company
+
+      def company_endpoints
+        [ :list, :show, :create, :update, :search, :list_cases ]
+      end
+
+    end
+  end
+end

data/lib/desk/client/custom_field.rb

@@ -0,0 +1,10 @@
+module Desk
+  class Client
+    module CustomField
+
+      def custom_field_endpoints
+        [ :list, :show ]
+      end
+    end
+  end
+end

data/lib/desk/client/customer.rb

@@ -1,146 +1,48 @@
 module Desk
   class Client
-    # Defines methods related to customers
     module Customer
-      # Returns extended information of customers
-      #
-      #   @option options [Boolean, String, Integer]
-      #   @example Return extended information for customers
-      #     Desk.customers
-      #     Desk.customers(:since_id => 12345, :count => 5)
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/customers
-      def customers(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = get("customers",options)
-        response
+
+      def customer_endpoints
+        [ :list, :show, :create, :update, :search ]
       end
 
-      # Returns extended information on a single customer
-      #
-      #   @option options [String]
-      #   @example Return extended information for customer 12345
-      #     Desk.customer(12345)
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/customers/show
-      def customer(id)
-        response = get("customers/#{id}")
-        response.customer
+      def customer_add_key(key, customer, value, type)
+        customer.send(key) << {:value => value, :type => type}
+        customer = Desk.update_customer(customer.id, {key.to_sym => customer.send(key)})
       end
 
-      # Create a new customer
-      #
-      #   @option options [String]
-      #   @example Return extended information for 12345
-      #     Desk.create_customer(:name => "Chris Warren", :twitter => "cdwarren")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/customers/create
-      def create_customer(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = post("customers",options)
-        if response['success']
-          return response['results']['customer']
-        else
-          return response
+      def customer_delete_key(key, customer, *args)
+        a = args.last.is_a?(Array) ? args.pop : args
+        customer.send(key).delete_if do |item|
+          a.include?(item.type) || a.include?(item.value)
         end
+        customer = Desk.update_customer(customer.id, {key.to_sym => customer.send(key)})
       end
 
-      # Update a customer
-      #
-      #   @option options [String]
-      #   @example Return extended information for 12345
-      #     Desk.update_customer(12345, :name => "Christopher Warren")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/customers/update
-      def update_customer(id, *args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = put("customers/#{id}",options)
-        if response['success']
-          return response['results']['customer']
-        else
-          return response
-        end
+      def customer_add_address(customer, address, type = "home")
+        customer_add_key("addresses", customer, address, type)
       end
 
-      # Create a new customer email
-      #
-      #   @option options [String]
-      #   @example Return extended information for 12345
-      #     Desk.create_customer_email(12345, "foo@example.com")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/customers/emails/create
-      def create_customer_email(id, email, *args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        options.merge!({:email => email})
-        response = post("customers/#{id}/emails",options)
-        if response['success']
-          return response['results']['email']
-        else
-          return response
-        end
+      def customer_delete_address(customer, *args)
+        customer_delete_key("addresses", customer, args)
       end
 
-      # Update a customer's email
-      #
-      #   @option options [String]
-      #   @example Return extended information for 12345
-      #     Desk.update_customer_email(12345, 12345, :email => "foo@example.com")
-      #     Desk.update_customer_email(12345, 12345, :customer_contact_type => "work")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/customers/emails/update
-      def update_customer_email(id, email_id, *args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = put("customers/#{id}/emails/#{email_id}",options)
-        if response['success']
-          return response['results']['email']
-        else
-          return response
-        end
+      def customer_add_email(customer, email, type = "home")
+        customer_add_key("emails", customer, email, type)
       end
 
-      # Create a new customer phone number
-      #
-      #   @option options [String]
-      #   @example Return extended information for 12345
-      #     Desk.create_customer_phone(12345, "555-368-7147")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/customers/phones/create
-      def create_customer_phone(id, phone, *args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        options.merge!({:phone => phone})
-        response = post("customers/#{id}/phones",options)
-        if response['success']
-          return response['results']['phone']
-        else
-          return response
-        end
+      def customer_delete_email(customer, *args)
+        customer_delete_key("emails", customer, args)
       end
 
-      # Update a customer's phone number
-      #
-      #   @option options [String]
-      #   @example Return extended information for 12345
-      #     Desk.update_customer_phone(12345, 12345, :phone => "555-368-7147")
-      #     Desk.update_customer_phone(12345, 12345, :customer_contact_type => "work")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/customers/phones/update
-      def update_customer_phone(id, phone_id, *args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = put("customers/#{id}/phones/#{phone_id}",options)
-        if response['success']
-          return response['results']['phone']
-        else
-          return response
-        end
+      def customer_add_phone_number(customer, phone_number, type = "home")
+        customer_add_key("phone_numbers", customer, phone_number, type)
+      end
+
+      def customer_delete_phone_number(customer, *args)
+        customer_delete_key("phone_numbers", customer, args)
       end
+
     end
   end
 end

data/lib/desk/client/facebook_user.rb

@@ -0,0 +1,11 @@
+module Desk
+  class Client
+    module FacebookUser
+
+      def facebook_user_endpoints
+        [ :list, :show ]
+      end
+
+    end
+  end
+end

data/lib/desk/client/filter.rb

@@ -0,0 +1,11 @@
+module Desk
+  class Client
+    module Filter
+
+      def filter_endpoints
+        [ :list, :show, :list_cases ]
+      end
+
+    end
+  end
+end

data/lib/desk/client/group.rb

@@ -1,37 +1,11 @@
 module Desk
   class Client
-    # Defines methods related to groups
     module Group
-      # Returns extended information of groups
-      #
-      #   @option options [Boolean, String, Integer]
-      #   @example Return extended information for 12345
-      #     Desk.groups
-      #     Desk.groups(:count => 5)
-      #     Desk.groups(:count => 5, :page => 3)
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/groups
-      def groups(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = get("groups",options)
-        response
-      end
 
-      # Returns extended information on a single group
-      #
-      #   @param id [Integer] a group ID
-      #   @option options [Hash]
-      #   @example Return extended information for 12345
-      #     Desk.group(12345)
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/groups/show
-      def group(id)
-        response = get("groups/#{id}")
-        response.group
+      def group_endpoints
+        [ :list, :show, :list_filters, :list_users ]
       end
 
     end
   end
-end
+end

data/lib/desk/client/insight.rb

@@ -0,0 +1,17 @@
+module Desk
+  class Client
+    module Insight
+
+      def show_insights_meta
+        get("insights/meta")
+      end
+      alias_method :insights_meta, :show_insights_meta
+
+      def create_insights_report(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        post("insights/reports", options)
+      end
+
+    end
+  end
+end

data/lib/desk/client/integration_url.rb

@@ -0,0 +1,11 @@
+module Desk
+  class Client
+    module IntegrationUrl
+
+      def integration_url_endpoints
+        [ :list, :show, :create, :update, :delete ]
+      end
+
+    end
+  end
+end

data/lib/desk/client/job.rb

@@ -0,0 +1,11 @@
+module Desk
+  class Client
+    module Job
+
+      def job_endpoints
+        [ :list, :show, :create ]
+      end
+
+    end
+  end
+end

data/lib/desk/client/label.rb

@@ -0,0 +1,11 @@
+module Desk
+  class Client
+    module Label
+
+      def label_endpoints
+        [ :list, :show, :create, :update, :delete ]
+      end
+
+    end
+  end
+end

data/lib/desk/client/macro.rb

@@ -1,140 +1,10 @@
 module Desk
   class Client
-    # Defines methods related to macros
     module Macro
-      # Returns extended information of macros
-      #
-      #   @option options [Boolean, String, Integer]
-      #   @example Return extended information for 12345
-      #     Desk.macros
-      #     Desk.macros(:count => 5)
-      #     Desk.macros(:count => 5, :page => 3)
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/macros
-      def macros(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = get("macros",options)
-        response
-      end
-
-      # Returns extended information on a single macro
-      #
-      #   @param id [Integer] a macro ID
-      #   @option options [Hash]
-      #   @example Return extended information for 12345
-      #     Desk.macro(12345)
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/macros/show
-      def macro(id)
-        response = get("macros/#{id}")
-        response.macro
-      end
-
-      # Creates a new macro
-      #
-      #   @param name [String] A macro name
-      #   @option options [Hash]
-      #   @example Creates a new macro
-      #     Desk.create_macro("name")
-      #     Desk.create_macro("name")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/macros/create
-      def create_macro(name, *args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = post("macros",options)
-        if response['success']
-          return response['results']['macro']
-        else
-          return response
-        end
-      end
-
-      # Updates a single macro
-      #
-      #   @param id [Integer] a macro ID
-      #   @option options [String]
-      #   @example Updates information for macro 12345
-      #     Desk.update_macro(12345, :subject => "New Subject")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/macros/update
-      def update_macro(id, *args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = put("macros/#{id}",options)
-        if response['success']
-          return response['results']['macro']
-        else
-          return response
-        end
-      end
-
-      # Deletes a single macro
-      #
-      #   @param id [Integer] a macro ID
-      #   @example Deletes macro 12345
-      #     Desk.update_macro(12345, :subject => "New Subject")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/macros/update
-      def delete_macro(id)
-        response = delete("macros/#{id}")
-        response
-      end
-
-      ##########
-      # Macro Actions
-      ##########
-
-      # Returns extended information of macros
-      #
-      #   @option options [Boolean, String, Integer]
-      #   @example Return extended information for 12345
-      #     Desk.macro_actions(1)
-      #     Desk.macro_actions(1, :count => 5)
-      #     Desk.macro_actions(1, :count => 5, :page => 3)
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/macros/actions
-      def macro_actions(id, *args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = get("macros/#{id}/actions",options)
-        response['results']
-      end
-
-      # Returns extended information on a single macro
-      #
-      #   @param id [Integer] a macro ID
-      #   @option options [Hash]
-      #   @example Return extended information for 12345
-      #     Desk.macro_action(12345, "set-case-description")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/macros/actions/show
-      def macro_action(id, slug)
-        response = get("macros/#{id}/actions/#{slug}")
-        response['action']
-      end
 
-      # Updates a single macro action
-      #
-      #   @param id [Integer] a macro ID
-      #   @option options [String]
-      #   @example Updates information for macro 12345
-      #     Desk.update_macro_action(12345, "set-case-description", :value => "New Subject")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/macros/actions/update
-      def update_macro_action(id, slug, *args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = put("macros/#{id}/actions/#{slug}",options)
-        if response['success']
-          return response['results']['action']
-        else
-          return response
-        end
+      def macro_endpoints
+        [ :list, :show, :create, :update, :delete,
+          :list_actions, :show_action, :update_action ]
       end
 
     end