Module: ChatWork::Client::IncomingRequestMethods

Included in:
ChatWork::Client
Defined in:
lib/chatwork/client/incoming_request_methods.rb

Instance Method Summary collapse

Instance Method Details

#destroy_incoming_request(request_id:) {|response_body, response_header| ... } ⇒ Object Also known as: decline_incoming_request

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:



71
72
73
 
# File 'lib/chatwork/client/incoming_request_methods.rb', line 71

def destroy_incoming_request(request_id:, &block)
  delete("/incoming_requests/#{request_id}", &block)
end

#get_incoming_requests {|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:



29
30
31
 
# File 'lib/chatwork/client/incoming_request_methods.rb', line 29

def get_incoming_requests(&block)
  get("/incoming_requests", &block)
end

#update_incoming_request(request_id:) {|response_body, response_header| ... } ⇒ Hashie::Mash Also known as: approve_incoming_request

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:



57
58
59
 
# File 'lib/chatwork/client/incoming_request_methods.rb', line 57

def update_incoming_request(request_id:, &block)
  put("/incoming_requests/#{request_id}", &block)
end