Module: AppStoreConnectApi::Domain::Users

Included in:

AppStoreConnectApi::Domain

Defined in:

lib/app_store_connect_api/domain/users.rb

Instance Method Summary

• #add_user_visible_apps(user_id, visible_app_ids) ⇒ Object
• #delete_user(user_id) ⇒ Object
• #remove_user_visible_apps(user_id, visible_app_ids) ⇒ Object
• #replace_user_visible_apps(user_id, visible_app_ids) ⇒ Object
• #update_user(user_id, attributes = {}, relationships = {}) ⇒ Object
• #user(user_id, options = {}) ⇒ Object
• #user_visible_app_ids(user_id, options = {}) ⇒ Object
• #user_visible_apps(user_id, options = {}) ⇒ Object
• #users(options = {}) ⇒ Object

Instance Method Details

#add_user_visible_apps(user_id, visible_app_ids) ⇒ Object

See Also:

• https://developer.apple.com/documentation/appstoreconnectapi/add_visible_apps_to_a_user

# File 'lib/app_store_connect_api/domain/users.rb', line 40

def add_user_visible_apps(user_id, visible_app_ids)
  post "/v1/users/#{user_id}/relationships/visibleApps", data: Utils::RelationshipMapper.resource_keys(visible_app_ids, 'apps')
end

#delete_user(user_id) ⇒ Object

See Also:

• https://developer.apple.com/documentation/appstoreconnectapi/remove_a_user_account

# File 'lib/app_store_connect_api/domain/users.rb', line 25

def delete_user(user_id)
  delete "/v1/users/#{user_id}"
end

#remove_user_visible_apps(user_id, visible_app_ids) ⇒ Object

See Also:

• https://developer.apple.com/documentation/appstoreconnectapi/remove_visible_apps_from_a_user

# File 'lib/app_store_connect_api/domain/users.rb', line 50

def remove_user_visible_apps(user_id, visible_app_ids)
  delete "/v1/users/#{user_id}/relationships/visibleApps", data: Utils::RelationshipMapper.resource_keys(visible_app_ids, 'apps')
end

#replace_user_visible_apps(user_id, visible_app_ids) ⇒ Object

See Also:

• https://developer.apple.com/documentation/appstoreconnectapi/replace_the_list_of_visible_apps_for_a_user

# File 'lib/app_store_connect_api/domain/users.rb', line 45

def replace_user_visible_apps(user_id, visible_app_ids)
  patch "/v1/users/#{user_id}/relationships/visibleApps", data: Utils::RelationshipMapper.resource_keys(visible_app_ids, 'apps')
end

#update_user(user_id, attributes = {}, relationships = {}) ⇒ Object

See Also:

• https://developer.apple.com/documentation/appstoreconnectapi/modify_a_user_account

# File 'lib/app_store_connect_api/domain/users.rb', line 17

def update_user(user_id, attributes = {}, relationships = {})
  patch "/v1/users/#{user_id}", data: { attributes: attributes,
                                        relationships: Utils::RelationshipMapper.expand(relationships, 'visibleApps' => 'apps'),
                                        id: user_id,
                                        type: 'users' }
end

#user(user_id, options = {}) ⇒ Object

See Also:

• https://developer.apple.com/documentation/appstoreconnectapi/read_user_information

# File 'lib/app_store_connect_api/domain/users.rb', line 12

def user(user_id, options = {})
  get "/v1/users/#{user_id}", options
end

#user_visible_app_ids(user_id, options = {}) ⇒ Object

See Also:

• https://developer.apple.com/documentation/appstoreconnectapi/get_all_visible_app_resource_ids_for_a_user

# File 'lib/app_store_connect_api/domain/users.rb', line 35

def user_visible_app_ids(user_id, options = {})
  get "/v1/users/#{user_id}/relationships/visibleApps", options
end

#user_visible_apps(user_id, options = {}) ⇒ Object

See Also:

• https://developer.apple.com/documentation/appstoreconnectapi/list_all_apps_visible_to_a_user

# File 'lib/app_store_connect_api/domain/users.rb', line 30

def user_visible_apps(user_id, options = {})
  get "/v1/users/#{user_id}/visibleApps", options
end

#users(options = {}) ⇒ Object

See Also:

• https://developer.apple.com/documentation/appstoreconnectapi/list_users

# File 'lib/app_store_connect_api/domain/users.rb', line 7

def users(options = {})
  get '/v1/users', options
end