Module: StrawberryAPI::Client::Users
- Included in:
- StrawberryAPI::Client
- Defined in:
- lib/strawberry_api/client/users.rb
Instance Method Summary collapse
-
#add_team_to_user(user_id:, team_id:) ⇒ Boolean
Adds a team to a user.
-
#create_user(username:, firstname: nil, lastname: nil, password:, role_id:, user_matrix_attributes: nil) ⇒ StrawberryAPI::User
Creates a new user.
-
#delete_user(id:) ⇒ Boolean
Deletes a user.
-
#remove_team_from_user(user_id:, team_id:) ⇒ Boolean
Removes a team from a user.
-
#update_user(id:, **options) ⇒ StrawberryAPI::User
Updates a user.
-
#user(id:) ⇒ Array<StrawberryAPI::User>
Fetches all users.
-
#user_api_keys(id:) ⇒ StrawberryAPI::ApiKey
Fetches a user API keys.
-
#user_settings(id:) ⇒ Hash
Fetches a user settings.
-
#users ⇒ Array<StrawberryAPI::User>
Fetches all users.
Instance Method Details
#add_team_to_user(user_id:, team_id:) ⇒ Boolean
Adds a team to a user
88 89 90 |
# File 'lib/strawberry_api/client/users.rb', line 88 def add_team_to_user(user_id:, team_id:) post("/users/#{user_id}/teams/#{team_id}").success? end |
#create_user(username:, firstname: nil, lastname: nil, password:, role_id:, user_matrix_attributes: nil) ⇒ StrawberryAPI::User
Creates a new user
37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# File 'lib/strawberry_api/client/users.rb', line 37 def create_user(username:, firstname: nil, lastname: nil, password:, role_id:, user_matrix_attributes: nil) body = { username: username, firstname: firstname, lastname: lastname, password: password, password_confirmation: password, role_id: role_id, user_matrix_attributes: user_matrix_attributes }.to_json data = post("/users", body: body).parse['user'] data.nil? ? nil : User.new(data) end |
#delete_user(id:) ⇒ Boolean
Deletes a user
77 78 79 |
# File 'lib/strawberry_api/client/users.rb', line 77 def delete_user(id:) delete("/users/#{id}").success? end |
#remove_team_from_user(user_id:, team_id:) ⇒ Boolean
Removes a team from a user
99 100 101 |
# File 'lib/strawberry_api/client/users.rb', line 99 def remove_team_from_user(user_id:, team_id:) delete("/users/#{user_id}/teams/#{team_id}").success? end |
#update_user(id:, **options) ⇒ StrawberryAPI::User
Updates a user
64 65 66 67 68 69 |
# File 'lib/strawberry_api/client/users.rb', line 64 def update_user(id:, **) body = args.to_json data = put("/users/#{id}", body: body).parse data.nil? ? nil : User.new(data) end |
#user(id:) ⇒ Array<StrawberryAPI::User>
Fetches all users
21 22 23 24 |
# File 'lib/strawberry_api/client/users.rb', line 21 def user(id:) data = get("/users/#{id}?with_teams=true").parse['user'] data.nil? ? nil : User.new(data) end |
#user_api_keys(id:) ⇒ StrawberryAPI::ApiKey
Fetches a user API keys
119 120 121 |
# File 'lib/strawberry_api/client/users.rb', line 119 def user_api_keys(id:) ApiKey.find(user_id: id) end |
#user_settings(id:) ⇒ Hash
Fetches a user settings
109 110 111 |
# File 'lib/strawberry_api/client/users.rb', line 109 def user_settings(id:) get("/users/#{id}/settings").parse['user_settings'] end |
#users ⇒ Array<StrawberryAPI::User>
Fetches all users
10 11 12 13 14 |
# File 'lib/strawberry_api/client/users.rb', line 10 def users get("/users").parse['users']&.map do |user| User.new(user) end end |