Module: ConnpassApiV2::Client::UserMethods

Included in:
ConnpassApiV2::Client
Defined in:
lib/connpass_api_v2/client/user_methods.rb

Overview

connpass user endpoints (/api/v2/users)

Instance Method Summary collapse

Instance Method Details

#get_user_attended_events(nickname, start: nil, count: nil) ⇒ ConnpassApiV2::Response

Get user attended events

Parameters:

  • nickname (String)
  • start (Integer, nil) (defaults to: nil)
  • count (Integer, nil) (defaults to: nil)

Returns:

See Also:

[View source]

53
54
55
56
57
58
59
60
 
# File 'lib/connpass_api_v2/client/user_methods.rb', line 53

def get_user_attended_events(nickname, start: nil, count: nil)
  params = {
    start: start,
    count: count,
  }

  connection.get("users/#{nickname}/attended_events/", params.compact).body # steep:ignore NoMethod
end

#get_user_groups(nickname, start: nil, count: nil) ⇒ ConnpassApiV2::Response

Get user groups

Parameters:

  • nickname (String)
  • start (Integer, nil) (defaults to: nil)
  • count (Integer, nil) (defaults to: nil)

Returns:

See Also:

[View source]

35
36
37
38
39
40
41
42
 
# File 'lib/connpass_api_v2/client/user_methods.rb', line 35

def get_user_groups(nickname, start: nil, count: nil)
  params = {
    start: start,
    count: count,
  }

  connection.get("users/#{nickname}/groups/", params.compact).body # steep:ignore NoMethod
end

#get_user_presenter_events(nickname, start: nil, count: nil) ⇒ ConnpassApiV2::Response

Get user presenter events

Parameters:

  • nickname (String)
  • start (Integer, nil) (defaults to: nil)
  • count (Integer, nil) (defaults to: nil)

Returns:

See Also:

[View source]

71
72
73
74
75
76
77
78
 
# File 'lib/connpass_api_v2/client/user_methods.rb', line 71

def get_user_presenter_events(nickname, start: nil, count: nil)
  params = {
    start: start,
    count: count,
  }

  connection.get("users/#{nickname}/presenter_events/", params.compact).body # steep:ignore NoMethod
end

#get_users(nickname: nil, start: nil, count: nil) ⇒ ConnpassApiV2::Response

Search users

Parameters:

  • nickname (String, Array<String>, nil) (defaults to: nil)
  • start (Integer, nil) (defaults to: nil)
  • count (Integer, nil) (defaults to: nil)

Returns:

See Also:

[View source]

16
17
18
19
20
21
22
23
24
 
# File 'lib/connpass_api_v2/client/user_methods.rb', line 16

def get_users(nickname: nil, start: nil, count: nil)
  params = {
    nickname: Client.joined_param(nickname),
    start:    start,
    count:    count,
  }

  connection.get("users/", params.compact).body # steep:ignore NoMethod
end