Module: ChatWork::IncomingRequest

Defined in:
lib/chatwork/incoming_request.rb

Class Method Summary collapse

Class Method Details

.destroy(request_id:) {|response_body, response_header| ... } ⇒ Object Also known as: decline

You can decline a contact approval request you received

Parameters:

  • request_id (Integer)

Yields:

  • (response_body, response_header) —

    if block was given, return response body and response header through block arguments

Yield Parameters:

  • response_body (Hashie::Mash) —

    response body

  • response_header (Hash<String, String>) —

    response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)

See Also:



72
73
74
 
# File 'lib/chatwork/incoming_request.rb', line 72

def self.destroy(request_id:, &block)
  ChatWork.client.destroy_incoming_request(request_id: request_id, &block)
end

.get {|response_body, response_header| ... } ⇒ Array<Hashie::Mash>

You can get the list of contact approval request you received

(*This method returns up to 100 entries. We are planning to implement pagination to support larger number of data retrieval)

Examples:

response format

[
  {
    "request_id": 123,
    "account_id": 363,
    "message": "hogehoge",
    "name": "John Smith",
    "chatwork_id": "tarochatworkid",
    "organization_id": 101,
    "organization_name": "Hello Company",
    "department": "Marketing",
    "avatar_image_url": "https://example.com/abc.png"
  }
]

Yields:

  • (response_body, response_header) —

    if block was given, return response body and response header through block arguments

Yield Parameters:

  • response_body (Array<Hashie::Mash>) —

    response body

  • response_header (Hash<String, String>) —

    response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)

Returns:

  • (Array<Hashie::Mash>)

See Also:



30
31
32
 
# File 'lib/chatwork/incoming_request.rb', line 30

def self.get(&block)
  ChatWork.client.get_incoming_requests(&block)
end

.update(request_id:) {|response_body, response_header| ... } ⇒ Hashie::Mash Also known as: approve

You can approve a contact approval request you received

Examples:

response format

{
  "account_id": 363,
  "room_id": 1234,
  "name": "John Smith",
  "chatwork_id": "tarochatworkid",
  "organization_id": 101,
  "organization_name": "Hello Company",
  "department": "Marketing",
  "avatar_image_url": "https://example.com/abc.png"
}

Parameters:

  • request_id (Integer)

Yields:

  • (response_body, response_header) —

    if block was given, return response body and response header through block arguments

Yield Parameters:

  • response_body (Hashie::Mash) —

    response body

  • response_header (Hash<String, String>) —

    response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)

Returns:

  • (Hashie::Mash)

See Also:



58
59
60
 
# File 'lib/chatwork/incoming_request.rb', line 58

def self.update(request_id:, &block)
  ChatWork.client.update_incoming_request(request_id: request_id, &block)
end