doc/yard/Invoicexpress/Client/Users.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: Invoicexpress::Client::Users
— Documentation by YARD 0.8.5
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../';
framesUrl = "../../frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (U)</a> »
<span class='title'><span class='object_link'><a href="../../Invoicexpress.html" title="Invoicexpress (module)">Invoicexpress</a></span></span> » <span class='title'><span class='object_link'><a href="../Client.html" title="Invoicexpress::Client (class)">Client</a></span></span>
»
<span class="title">Users</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Invoicexpress::Client::Users
</h1>
<dl class="box">
<dt class="r1">Included in:</dt>
<dd class="r1"><span class='object_link'><a href="../Client.html" title="Invoicexpress::Client (class)">Invoicexpress::Client</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/invoicexpress/client/users.rb</dd>
</dl>
<div class="clear"></div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#accounts-instance_method" title="#accounts (instance method)">- (Array<Invoicexpress::Models::Account>) <strong>accounts</strong>(options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>This method allows you to view your accounts.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#change_account-instance_method" title="#change_account (instance method)">- (Object) <strong>change_account</strong>(account_id, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Changes the current account to the account id submitte.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#login-instance_method" title="#login (instance method)">- (Array<Invoicexpress::Models::Account>) <strong>login</strong>(login, password, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>This endpoint does not require an API KEY to be acessible.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="accounts-instance_method">
- (<tt>Array<<span class='object_link'><a href="../Models/Account.html" title="Invoicexpress::Models::Account (class)">Invoicexpress::Models::Account</a></span>></tt>) <strong>accounts</strong>(options = {})
</h3><div class="docstring">
<div class="discussion">
<p>This method allows you to view your accounts.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Models/Account.html" title="Invoicexpress::Models::Account (class)">Invoicexpress::Models::Account</a></span>></tt>)</span>
—
<div class='inline'><p>The list of accounts</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::Unauthorized When the client is unauthorized</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/users.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_accounts'>accounts</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:klass</span> <span class='op'>=></span> <span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>Account</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>users/accounts.xml</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="change_account-instance_method">
- (<tt>Object</tt>) <strong>change_account</strong>(account_id, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>Changes the current account to the account id submitte</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>account_id</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The account ID to change to</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::Unauthorized When the client is unauthorized</p>
</div>
</li>
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::NotFound When the account doesn’t exist</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
37
38
39
40
41
42
43
44</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/users.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_change_account'>change_account</span><span class='lparen'>(</span><span class='id identifier rubyid_account_id'>account_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_change_account_to'>change_account_to</span> <span class='op'>=</span> <span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>ChangeAccountTo</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
<span class='symbol'>:id</span> <span class='op'>=></span> <span class='id identifier rubyid_account_id'>account_id</span>
<span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:klass</span> <span class='op'>=></span> <span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>Account</span><span class='comma'>,</span> <span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_change_account_to'>change_account_to</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>users/change-account.xml</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="login-instance_method">
- (<tt>Array<<span class='object_link'><a href="../Models/Account.html" title="Invoicexpress::Models::Account (class)">Invoicexpress::Models::Account</a></span>></tt>) <strong>login</strong>(login, password, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>This endpoint does not require an API KEY to be acessible.
Instead it requires your current login and password.
Upon successful login it will return all the accounts which belong to you</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>login</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>Login email</p>
</div>
</li>
<li>
<span class='name'>password</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>Your password</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Models/Account.html" title="Invoicexpress::Models::Account (class)">Invoicexpress::Models::Account</a></span>></tt>)</span>
—
<div class='inline'><p>The list of your accounts</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::Unauthorized When the login/password combination is wrong</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15
16
17
18
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/users.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_login'>login</span><span class='lparen'>(</span><span class='id identifier rubyid_login'>login</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_credentials'>credentials</span> <span class='op'>=</span> <span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
<span class='symbol'>:login</span> <span class='op'>=></span> <span class='id identifier rubyid_login'>login</span><span class='comma'>,</span>
<span class='symbol'>:password</span> <span class='op'>=></span> <span class='id identifier rubyid_password'>password</span>
<span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:klass</span> <span class='op'>=></span> <span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>Account</span><span class='comma'>,</span> <span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_credentials'>credentials</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>login.xml</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Jun 20 18:40:53 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.5 (ruby-1.9.3).
</div>
</body>
</html>