module Assistly
  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
      #     Assistly.macros
      #     Assistly.macros(:count => 5)
      #     Assistly.macros(:count => 5, :page => 3)
      # @format :json
      # @authenticated true
      # @see http://dev.assistly.com/docs/api/macros
      def macros(*args)
        options = args.last.is_a?(Hash) ? args.pop : {}
        response = get("macros",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
      #     Assistly.macro(12345)
      # @format :json
      # @authenticated true
      # @see http://dev.assistly.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
      #     Assistly.create_macro("name")
      #     Assistly.create_macro("name")
      # @format :json
      # @authenticated true
      # @see http://dev.assistly.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
      #     Assistly.update_macro(12345, :subject => "New Subject")
      # @format :json
      # @authenticated true
      # @see http://dev.assistly.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
      #     Assistly.update_macro(12345, :subject => "New Subject")
      # @format :json
      # @authenticated true
      # @see http://dev.assistly.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
      #     Assistly.macro_actions(1)
      #     Assistly.macro_actions(1, :count => 5)
      #     Assistly.macro_actions(1, :count => 5, :page => 3)
      # @format :json
      # @authenticated true
      # @see http://dev.assistly.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
      #     Assistly.macro_action(12345, "set-case-description")
      # @format :json
      # @authenticated true
      # @see http://dev.assistly.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
      #     Assistly.update_macro_action(12345, "set-case-description", :value => "New Subject")
      # @format :json
      # @authenticated true
      # @see http://dev.assistly.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
      end
      
    end
  end
end