doc/yard/Invoicexpress/Client/Clients.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::Clients
— 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 (C)</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">Clients</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::Clients
</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/clients.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="#client-instance_method" title="#client (instance method)">- (Invoicexpress::Models::Client) <strong>client</strong>(client_id, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns a specific client.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#client_by_code-instance_method" title="#client_by_code (instance method)">- (Invoicexpress::Models::Client) <strong>client_by_code</strong>(client_code, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Use this method to obtain a client by your code.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#client_by_name-instance_method" title="#client_by_name (instance method)">- (Invoicexpress::Models::Client) <strong>client_by_name</strong>(client_name, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Use this method to obtain a client by name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#client_create_cash_invoice-instance_method" title="#client_create_cash_invoice (instance method)">- (Invoicexpress::Models::CashInvoice) <strong>client_create_cash_invoice</strong>(client_id, invoice, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>This method allows you to create a new cash invoice for a specific client.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#client_create_credit_note-instance_method" title="#client_create_credit_note (instance method)">- (Invoicexpress::Models::CreditNote) <strong>client_create_credit_note</strong>(client_id, invoice, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>This method allows you to create a new Credit Note for a specific client.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#client_create_debit_note-instance_method" title="#client_create_debit_note (instance method)">- (Invoicexpress::Models::DebitNote) <strong>client_create_debit_note</strong>(client_id, invoice, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>This method allows you to create a new Debit Note for a specific client.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#client_create_invoice-instance_method" title="#client_create_invoice (instance method)">- (Invoicexpress::Models::Invoice) <strong>client_create_invoice</strong>(client_id, invoice, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>This method allows you to create a new invoice for a specific client.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#client_invoices-instance_method" title="#client_invoices (instance method)">- (Invoicexpress::Models::ClientInvoices) <strong>client_invoices</strong>(client_id, filter = Invoicexpress::Models::Filter.new, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>This method allows you to obtain the invoices for a specific client.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#clients-instance_method" title="#clients (instance method)">- (Array<Invoicexpress::Models::Client>) <strong>clients</strong>(options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns all your clients.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create_client-instance_method" title="#create_client (instance method)">- (Invoicexpress::Models::Client) <strong>create_client</strong>(client, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Creates a new client.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update_client-instance_method" title="#update_client (instance method)">- (Invoicexpress::Models::Client) <strong>update_client</strong>(client, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Updates a client.</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="client-instance_method">
- (<tt><span class='object_link'><a href="../Models/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span></tt>) <strong>client</strong>(client_id, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns a specific client</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>client_id</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The client’s ID</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span></tt>)</span>
—
<div class='inline'><p>The remote client from the server</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::UnprocessableEntity When there are errors on the submission</p>
</div>
</li>
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::NotFound When the client ID is not found</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66
67
68
69
70</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/clients.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span><span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_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_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'>Client</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'>clients/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_client_id'>client_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbrace'>}</span><span class='tstring_content'>.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="client_by_code-instance_method">
- (<tt><span class='object_link'><a href="../Models/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span></tt>) <strong>client_by_code</strong>(client_code, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>Use this method to obtain a client by your code. Partial searches are not supported</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>client_code</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The client’s code (your code)</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span></tt>)</span>
—
<div class='inline'><p>The client</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 there are no clients with that name</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
116
117
118
119
120
121
122
123</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/clients.rb', line 116</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client_by_code'>client_by_code</span><span class='lparen'>(</span><span class='id identifier rubyid_client_code'>client_code</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_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'>Client</span><span class='comma'>,</span>
<span class='symbol'>:client_code</span> <span class='op'>=></span> <span class='id identifier rubyid_client_code'>client_code</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'>clients/find-by-code.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="client_by_name-instance_method">
- (<tt><span class='object_link'><a href="../Models/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span></tt>) <strong>client_by_name</strong>(client_name, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>Use this method to obtain a client by name. Partial searches are not supported</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>client_name</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The client’s name</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span></tt>)</span>
—
<div class='inline'><p>The client</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 there are no clients with that name</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
101
102
103
104
105
106
107
108</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/clients.rb', line 101</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client_by_name'>client_by_name</span><span class='lparen'>(</span><span class='id identifier rubyid_client_name'>client_name</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_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'>Client</span><span class='comma'>,</span>
<span class='symbol'>:client_name</span> <span class='op'>=></span> <span class='id identifier rubyid_client_name'>client_name</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'>clients/find-by-name.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="client_create_cash_invoice-instance_method">
- (<tt><span class='object_link'><a href="../Models/CashInvoice.html" title="Invoicexpress::Models::CashInvoice (class)">Invoicexpress::Models::CashInvoice</a></span></tt>) <strong>client_create_cash_invoice</strong>(client_id, invoice, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>This method allows you to create a new cash invoice for a specific client.
When creating the invoice:
- If items do not exist with the given names, new ones will be created.
- If item name already exists, the item is updated with the new values.
Regarding item taxes, if the tax name is not found, no tax is applied to that item.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>client_id</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The ID of the client</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/CashInvoice.html" title="Invoicexpress::Models::CashInvoice (class)">Invoicexpress::Models::CashInvoice</a></span></tt>)</span>
—
<div class='inline'><p>The invoice</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::UnprocessableEntity When there are errors on the submission</p>
</div>
</li>
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::NotFound When there are no clients with that name</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
158
159
160
161
162
163
164
165
166
167</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/clients.rb', line 158</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client_create_cash_invoice'>client_create_cash_invoice</span><span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span><span class='comma'>,</span> <span class='id identifier rubyid_invoice'>invoice</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_raise'>raise</span><span class='lparen'>(</span><span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>invoice has the wrong type</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_invoice'>invoice</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>CashInvoice</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'>CashInvoice</span><span class='comma'>,</span>
<span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_invoice'>invoice</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'>clients/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_client_id'>client_id</span><span class='rbrace'>}</span><span class='tstring_content'>/create/cash-invoice.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="client_create_credit_note-instance_method">
- (<tt><span class='object_link'><a href="../Models/CreditNote.html" title="Invoicexpress::Models::CreditNote (class)">Invoicexpress::Models::CreditNote</a></span></tt>) <strong>client_create_credit_note</strong>(client_id, invoice, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>This method allows you to create a new Credit Note for a specific client.
When creating the invoice:
- If items do not exist with the given names, new ones will be created.
- If item name already exists, the item is updated with the new values.
Regarding item taxes, if the tax name is not found, no tax is applied to that item.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>client_id</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The ID of the client</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/CreditNote.html" title="Invoicexpress::Models::CreditNote (class)">Invoicexpress::Models::CreditNote</a></span></tt>)</span>
—
<div class='inline'><p>The credit note</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::UnprocessableEntity When there are errors on the submission</p>
</div>
</li>
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::NotFound When there are no clients with that name</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
180
181
182
183
184
185
186
187
188
189</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/clients.rb', line 180</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client_create_credit_note'>client_create_credit_note</span><span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span><span class='comma'>,</span> <span class='id identifier rubyid_invoice'>invoice</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_raise'>raise</span><span class='lparen'>(</span><span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>credit note has the wrong type</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_invoice'>invoice</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>CreditNote</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'>CreditNote</span><span class='comma'>,</span>
<span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_invoice'>invoice</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'>clients/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_client_id'>client_id</span><span class='rbrace'>}</span><span class='tstring_content'>/create/credit-note.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="client_create_debit_note-instance_method">
- (<tt><span class='object_link'><a href="../Models/DebitNote.html" title="Invoicexpress::Models::DebitNote (class)">Invoicexpress::Models::DebitNote</a></span></tt>) <strong>client_create_debit_note</strong>(client_id, invoice, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>This method allows you to create a new Debit Note for a specific client.
When creating the invoice:
- If items do not exist with the given names, new ones will be created.
- If item name already exists, the item is updated with the new values.
Regarding item taxes, if the tax name is not found, no tax is applied to that item.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>client_id</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The ID of the client</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/DebitNote.html" title="Invoicexpress::Models::DebitNote (class)">Invoicexpress::Models::DebitNote</a></span></tt>)</span>
—
<div class='inline'><p>The debit note</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::UnprocessableEntity When there are errors on the submission</p>
</div>
</li>
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::NotFound When there are no clients with that name</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
202
203
204
205
206
207
208
209
210
211</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/clients.rb', line 202</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client_create_debit_note'>client_create_debit_note</span><span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span><span class='comma'>,</span> <span class='id identifier rubyid_invoice'>invoice</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_raise'>raise</span><span class='lparen'>(</span><span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>debit note has the wrong type</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_invoice'>invoice</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>DebitNote</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'>DebitNote</span><span class='comma'>,</span>
<span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_invoice'>invoice</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'>clients/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_client_id'>client_id</span><span class='rbrace'>}</span><span class='tstring_content'>/create/debit-note.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="client_create_invoice-instance_method">
- (<tt><span class='object_link'><a href="../Models/Invoice.html" title="Invoicexpress::Models::Invoice (class)">Invoicexpress::Models::Invoice</a></span></tt>) <strong>client_create_invoice</strong>(client_id, invoice, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>This method allows you to create a new invoice for a specific client.
When creating the invoice:
- If items do not exist with the given names, new ones will be created.
- If item name already exists, the item is updated with the new values.
Regarding item taxes, if the tax name is not found, no tax is applied to that item.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>client_id</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The ID of the client</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/Invoice.html" title="Invoicexpress::Models::Invoice (class)">Invoicexpress::Models::Invoice</a></span></tt>)</span>
—
<div class='inline'><p>The invoice</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::UnprocessableEntity When there are errors on the submission</p>
</div>
</li>
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::NotFound When there are no clients with that name</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
136
137
138
139
140
141
142
143
144
145</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/clients.rb', line 136</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client_create_invoice'>client_create_invoice</span><span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span><span class='comma'>,</span> <span class='id identifier rubyid_invoice'>invoice</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_raise'>raise</span><span class='lparen'>(</span><span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>invoice has the wrong type</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_invoice'>invoice</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>Invoice</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'>Invoice</span><span class='comma'>,</span>
<span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_invoice'>invoice</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'>clients/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_client_id'>client_id</span><span class='rbrace'>}</span><span class='tstring_content'>/create/invoice.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="client_invoices-instance_method">
- (<tt><span class='object_link'><a href="../Models/ClientInvoices.html" title="Invoicexpress::Models::ClientInvoices (class)">Invoicexpress::Models::ClientInvoices</a></span></tt>) <strong>client_invoices</strong>(client_id, filter = Invoicexpress::Models::Filter.new, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>This method allows you to obtain the invoices for a specific client.
Allowing filtering aswell.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>client_id</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The client’s ID</p>
</div>
</li>
<li>
<span class='name'>filter</span>
<span class='type'>(<tt><span class='object_link'><a href="../Models/Filter.html" title="Invoicexpress::Models::Filter (class)">Invoicexpress::Models::Filter</a></span></tt>)</span>
<em class="default">(defaults to: <tt>Invoicexpress::Models::Filter.new</tt>)</em>
—
<div class='inline'><p>An optional filter</p>
</div>
</li>
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'><p>a customizable set of options</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
<ul class="option">
<li>
<span class="name">per_page</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>10</tt>
</span>
— <div class='inline'><p>You can specify how many results you want to fetch</p>
</div>
</li>
<li>
<span class="name">page</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>1</tt>
</span>
— <div class='inline'><p>You can ask a specific page of clients</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/ClientInvoices.html" title="Invoicexpress::Models::ClientInvoices (class)">Invoicexpress::Models::ClientInvoices</a></span></tt>)</span>
—
<div class='inline'><p>The invoices result</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 client ID is not found</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
82
83
84
85
86
87
88
89
90
91
92
93</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/clients.rb', line 82</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client_invoices'>client_invoices</span><span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span><span class='comma'>,</span> <span class='id identifier rubyid_filter'>filter</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'>Filter</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</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_raise'>raise</span><span class='lparen'>(</span><span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>filter has the wrong type</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_filter'>filter</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>Filter</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'>ClientInvoices</span><span class='comma'>,</span>
<span class='symbol'>:per_page</span> <span class='op'>=></span> <span class='int'>10</span><span class='comma'>,</span>
<span class='symbol'>:page</span> <span class='op'>=></span> <span class='int'>1</span><span class='comma'>,</span>
<span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_filter'>filter</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'>clients/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_client_id'>client_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbrace'>}</span><span class='tstring_content'>/invoices.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="clients-instance_method">
- (<tt>Array<<span class='object_link'><a href="../Models/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span>></tt>) <strong>clients</strong>(options = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns all your clients</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'><p>a customizable set of options</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
<ul class="option">
<li>
<span class="name">per_page</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>30</tt>
</span>
— <div class='inline'><p>You can specify how many results you want to fetch</p>
</div>
</li>
<li>
<span class="name">page</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>1</tt>
</span>
— <div class='inline'><p>You can ask a specific page of clients</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/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span>></tt>)</span>
—
<div class='inline'><p>An array with all your clients</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">
14
15
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/clients.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_clients'>clients</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'>:per_page</span> <span class='op'>=></span> <span class='int'>30</span><span class='comma'>,</span> <span class='symbol'>:page</span> <span class='op'>=></span> <span class='int'>1</span><span class='comma'>,</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'>Client</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'>clients.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="create_client-instance_method">
- (<tt><span class='object_link'><a href="../Models/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span></tt>) <strong>create_client</strong>(client, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>Creates a new client.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>client</span>
<span class='type'>(<tt><span class='object_link'><a href="../Models/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span></tt>)</span>
—
<div class='inline'><p>The client to create</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span></tt>)</span>
—
<div class='inline'><p>The new client from the server</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::UnprocessableEntity When there are errors on the submission</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28
29
30
31
32
33
34
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/clients.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_client'>create_client</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</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='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_client'>client</span> <span class='op'>||</span> <span class='op'>!</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>Client</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Need a Invoicexpress::Models::Client instance</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Client's name is required</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_client'>client</span><span class='comma'>,</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'>Client</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'>clients.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="update_client-instance_method">
- (<tt><span class='object_link'><a href="../Models/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span></tt>) <strong>update_client</strong>(client, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>Updates a client.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>client</span>
<span class='type'>(<tt><span class='object_link'><a href="../Models/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span></tt>)</span>
—
<div class='inline'><p>The client to update</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/Client.html" title="Invoicexpress::Models::Client (class)">Invoicexpress::Models::Client</a></span></tt>)</span>
—
<div class='inline'><p>The new client from the server</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::UnprocessableEntity When there are errors on the submission</p>
</div>
</li>
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::NotFound When the Client’s ID is not found</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
46
47
48
49
50
51
52
53
54
55
56
57</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/clients.rb', line 46</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update_client'>update_client</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</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='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_client'>client</span> <span class='op'>||</span> <span class='op'>!</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>Client</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Need a Invoicexpress::Models::Client instance</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Client's ID is required</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_client'>client</span><span class='comma'>,</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'>Client</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'>clients/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbrace'>}</span><span class='tstring_content'>.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:54 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>