Module: Broadstreet::UserMethods

Included in:

Client

Defined in:

lib/broadstreet/user_methods.rb

Instance Method Summary

• #create_newsletter_subscription(params) ⇒ Object

  Add an email address to the broadstreet newsletter.

• #create_user(params) ⇒ Hash

  Create a new broadstreet user.

Instance Method Details

#create_newsletter_subscription(params) ⇒ Object

Add an email address to the broadstreet newsletter

param [Hash] params: Detail for the email address

Parameters:

• params (Hash) —

  a customizable set of options

Options Hash (params):

• email: (String) —

  The email address to add

Returns:

• nil

# File 'lib/broadstreet/user_methods.rb', line 21

def create_newsletter_subscription(params)
  request(:post, 'api/0/newsletter', params)
  nil
end

#create_user(params) ⇒ Hash

Create a new broadstreet user

Parameters:

• params: (Hash) —

  Detail for the user

• params (Hash) —

  a customizable set of options

Options Hash (params):

• name: (String) —

  A name for the user (optional)

• email: (String) —

  An email address

• password: (String) —

  A password

Returns:

• (Hash) —

  user detail

# File 'lib/broadstreet/user_methods.rb', line 12

def create_user(params)
  request(:post, 'api/0/users', params).user
end