Class: Mailfloss::Resources::Users

Inherits:
Base
  • Object
show all
Defined in:
lib/mailfloss/resources.rb,
sig/resources.rbs

Overview

GET /users

Instance Attribute Summary

Attributes inherited from Base

#client

Instance Method Summary collapse

Methods inherited from Base

#encode, #initialize

Constructor Details

This class inherits a constructor from Mailfloss::Resources::Base

Instance Method Details

#get(user_id) ⇒ Hash

GET /users/user_id

Parameters:

  • user_id (String)

Returns:

  • (Hash) —

    { id:, email:, name:, role:, is_primary:, status:, created_at: }



94
95
96
 
# File 'lib/mailfloss/resources.rb', line 94

def get(user_id)
  client.request(:get, "/users/#{encode(user_id)}")
end

#list(per_page: nil, cursor: nil) ⇒ Hash

GET /users — organization members.

Parameters:

  • per_page: (Integer, nil) (defaults to: nil)
  • cursor: (String, nil) (defaults to: nil)

Returns:

  • (Hash) —

    { data: [User], pagination: { next_cursor:, has_more: } }



87
88
89
 
# File 'lib/mailfloss/resources.rb', line 87

def list(per_page: nil, cursor: nil)
  client.request(:get, "/users", query: { per_page: per_page, cursor: cursor })
end