Module: Vindi::Rest::Role

Included in:

Vindi::Rest

Defined in:

lib/vindi/rest/role.rb

Overview

Methods for the roles API

See Also:

• https://vindi.github.io/api-docs/dist/#!/roles

Instance Method Summary

• #list_roles(options = {}) ⇒ Array<Hash>

  List roles for the authenticate user.

Instance Method Details

#list_roles(options = {}) ⇒ Array<Hash>

List roles for the authenticate user

Examples:

Get all roles from merchant vindi

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :page (Integer) — default: 1 —

  Page number.

• :merchant (Integer) —

  Merchant account

Returns:

• (Array<Hash>) —

  A list of roles for a merchant.

# File 'lib/vindi/rest/role.rb', line 13

def list_roles(options = {})
  get('roles', options)[:roles]
end