Add english reference url

lib/chatwork/contacts.rb

@@ -5,6 +5,7 @@ module Contacts
     # Get the list of your contacts
     #
     # @see http://developer.chatwork.com/ja/endpoint_contacts.html#GET-contacts
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @return [Array<Hash>]
     #

lib/chatwork/file.rb

@@ -8,6 +8,7 @@ module File
     # @param account_id [Integer]
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-files
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @return [Array<Hash>]
     #
@@ -33,6 +34,7 @@ def self.get(room_id:, account_id:)
     # Get information about the specified file
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-files-file_id
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param file_id [Integer]

lib/chatwork/incoming_request.rb

@@ -7,6 +7,7 @@ module IncomingRequest
     # (*This method returns up to 100 entries. We are planning to implement pagination to support larger number of data retrieval)
     #
     # @see http://developer.chatwork.com/ja/endpoint_incoming_requests.html#GET-incoming_requests
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @return [Array<Hash>]
     #
@@ -31,6 +32,7 @@ def self.get
     # You can approve a contact approval request you received
     #
     # @see http://developer.chatwork.com/ja/endpoint_incoming_requests.html#PUT-incoming_requests-request_id
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param request_id [Integer]
     #
@@ -54,6 +56,7 @@ def self.update(request_id:)
     # You can decline a contact approval request you received
     #
     # @see http://developer.chatwork.com/ja/endpoint_incoming_requests.html#DELETE-incoming_requests-request_id
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param request_id [Integer]
     def self.destroy(request_id:)

lib/chatwork/me.rb

@@ -5,6 +5,7 @@ module Me
     # Get your account information
     #
     # @see http://developer.chatwork.com/ja/endpoint_me.html#GET-me
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @return [Hash]
     #

lib/chatwork/member.rb

@@ -5,6 +5,7 @@ module Member
     # Get the list of all chat members associated with the specified chat
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-members
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     #
@@ -30,6 +31,7 @@ def self.get(room_id:)
     # Change associated members of group chat at once
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-members
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param members_admin_ids [Array<Integer>, String] List of user IDs who will be given administrator permission for the group chat.

lib/chatwork/message.rb

@@ -7,6 +7,7 @@ module Message
     # If the parameter is not set, it returns the next 100 entries from previous call.
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-messages
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param force   [Boolean, Integer] Flag which forces to get 100 newest entries regardless of previous calls.
@@ -34,6 +35,7 @@ def self.get(room_id:, force: nil)
     # Add new message to the chat
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms-room_id-messages
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param body    [String] message body
@@ -51,6 +53,7 @@ def self.create(room_id:, body:)
     # Mark messages as read
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-messages-read
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param message_id [String]
@@ -69,6 +72,7 @@ def self.read(room_id:, message_id: nil)
     # Mark messages as unread
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-messages-unread
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param message_id [String]
@@ -87,6 +91,7 @@ def self.unread(room_id:, message_id:)
     # Get information about the specified message
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-messages-message_id
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param message_id [String]
@@ -112,6 +117,7 @@ def self.find(room_id:, message_id:)
     # Update the specified message
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-messages-message_id
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param message_id [String]
@@ -130,6 +136,7 @@ def self.update(room_id:, message_id:, body:)
     # Destroy the specified message
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-messages-message_id
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param message_id [String]

lib/chatwork/my_status.rb

@@ -5,6 +5,7 @@ module MyStatus
     # Get the number of: unread messages, unread To messages, and unfinished tasks.
     #
     # @see http://developer.chatwork.com/ja/endpoint_my.html#GET-my-status
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @return [Hash]
     #

lib/chatwork/my_task.rb

@@ -7,6 +7,7 @@ module MyTask
     # (*This method returns up to 100 entries. We are planning to implement pagination to support larger number of data retrieval)
     #
     # @see http://developer.chatwork.com/ja/endpoint_my.html#GET-my-tasks
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param assigned_by_account_id [Integer] Account ID of the person who assigned task
     # @param status [String] Task status (open, done)

lib/chatwork/room.rb

@@ -5,6 +5,7 @@ module Room
     # Get the list of all chats on your account
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @return [Array<Hash>]
     #
@@ -35,6 +36,7 @@ def self.get
     # Create a new group chat
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param description [String] Description of the group chat
     # @param icon_preset [String] Type of the group chat icon (group, check, document, meeting, event, project, business,
@@ -69,6 +71,7 @@ def self.create(description: nil, icon_preset: nil, members_admin_ids:, members_
     # Get chat name, icon, and Type (my, direct, or group)
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     #
@@ -98,6 +101,7 @@ def self.find(room_id:)
     # Change the title and icon type of the specified chat
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param description [String] Description of the group chat
@@ -111,6 +115,7 @@ def self.update(room_id:, description: nil, icon_preset: nil, name: nil)
     # Leave/Delete a group chat
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#DELETE-rooms-room_id
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param action_type [String] leave from a room or delete a room (leave, delete)

lib/chatwork/task.rb

@@ -7,6 +7,7 @@ module Task
     # (*This method returns up to 100 entries. We are planning to implement pagination to support larger number of data retrieval)
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-tasks
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param account_id [Integer]
@@ -42,6 +43,7 @@ def self.get(room_id:, account_id:, assigned_by_account_id: nil, status: nil)
     # Add a new task to the chat
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms-room_id-tasks
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param body    [String] Task description
@@ -67,6 +69,7 @@ def self.create(room_id:, body:, to_ids:, limit: nil)
     # Get information about the specified task
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-tasks-task_id
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param room_id [Integer]
     # @param task_id [Integer]