Module: PaypalAPI::Users::APIs

Included in:

PaypalAPI::Users, PaypalAPI::Users

Defined in:

lib/paypal-api/api_collections/users.rb

Overview

Common methods for PaypalAPI::Users class and client.users instance

Instance Method Summary

• #create(query: nil, body: nil, headers: nil) ⇒ Response

  Create user.

• #delete(user_id, query: nil, body: nil, headers: nil) ⇒ Response

  Delete user.

• #list(query: nil, body: nil, headers: nil) ⇒ Response

  List users.

• #show(user_id, query: nil, body: nil, headers: nil) ⇒ Response

  Show user details.

• #update(user_id, query: nil, body: nil, headers: nil) ⇒ Response

  Update user.

Instance Method Details

#create(query: nil, body: nil, headers: nil) ⇒ Response

Create user

Parameters:

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/identity/v2/#users_create

# File 'lib/paypal-api/api_collections/users.rb', line 27

def create(query: nil, body: nil, headers: nil)
  headers = add_scim_content_type(headers)
  client.post("/v2/scim/Users", query: query, body: body, headers: headers)
end

#delete(user_id, query: nil, body: nil, headers: nil) ⇒ Response

Delete user

Parameters:

• user_id (String) —

  User ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/identity/v2/#users_delete

# File 'lib/paypal-api/api_collections/users.rb', line 78

def delete(user_id, query: nil, body: nil, headers: nil)
  headers = add_scim_content_type(headers)
  client.delete("/v2/scim/Users/#{encode(user_id)}", query: query, body: body, headers: headers)
end

#list(query: nil, body: nil, headers: nil) ⇒ Response

List users

Parameters:

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/identity/v2/#users_list

# File 'lib/paypal-api/api_collections/users.rb', line 39

def list(query: nil, body: nil, headers: nil)
  headers = add_scim_content_type(headers)
  client.get("/v2/scim/Users", query: query, body: body, headers: headers)
end

#show(user_id, query: nil, body: nil, headers: nil) ⇒ Response

Show user details

Parameters:

• user_id (String) —

  User ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/identity/v2/#users_get

# File 'lib/paypal-api/api_collections/users.rb', line 52

def show(user_id, query: nil, body: nil, headers: nil)
  headers = add_scim_content_type(headers)
  client.get("/v2/scim/Users/#{encode(user_id)}", query: query, body: body, headers: headers)
end

#update(user_id, query: nil, body: nil, headers: nil) ⇒ Response

Update user

Parameters:

• user_id (String) —

  User ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/identity/v2/#users_update

# File 'lib/paypal-api/api_collections/users.rb', line 65

def update(user_id, query: nil, body: nil, headers: nil)
  headers = add_scim_content_type(headers)
  client.patch("/v2/scim/Users/#{encode(user_id)}", query: query, body: body, headers: headers)
end