RubyGems - moxiworks_platform - Versions diffs - 0.13.15 → 0.13.16 - Mend

moxiworks_platform 0.13.15 → 0.13.16

Files changed (36) hide show

checksums.yaml +4 -4
data/.gitignore +3 -1
data/Gemfile +2 -0
data/lib/moxiworks_platform/action_log.rb +31 -2
data/lib/moxiworks_platform/company.rb +0 -3
data/lib/moxiworks_platform/contact.rb +5 -6
data/lib/moxiworks_platform/listing.rb +11 -1
data/lib/moxiworks_platform/version.rb +1 -1
data/publish_docs.sh +7 -2
metadata +2 -28
data/MoxiworksPlatform/ActionLog.html +0 -1155
data/MoxiworksPlatform/Agent.html +0 -3668
data/MoxiworksPlatform/Brand.html +0 -2897
data/MoxiworksPlatform/BuyerTransaction.html +0 -4703
data/MoxiworksPlatform/Company.html +0 -678
data/MoxiworksPlatform/Config.html +0 -323
data/MoxiworksPlatform/Contact.html +0 -7540
data/MoxiworksPlatform/Credentials.html +0 -1078
data/MoxiworksPlatform/EmailCampaign.html +0 -1076
data/MoxiworksPlatform/Event.html +0 -2987
data/MoxiworksPlatform/Exception.html +0 -117
data/MoxiworksPlatform/Exception/ArgumentError.html +0 -146
data/MoxiworksPlatform/Exception/AuthorizationError.html +0 -134
data/MoxiworksPlatform/Exception/PlatformError.html +0 -141
data/MoxiworksPlatform/Exception/RemoteRequestFailure.html +0 -134
data/MoxiworksPlatform/Gallery.html +0 -877
data/MoxiworksPlatform/Group.html +0 -941
data/MoxiworksPlatform/Listing.html +0 -6242
data/MoxiworksPlatform/Office.html +0 -2144
data/MoxiworksPlatform/PresentationLog.html +0 -1715
data/MoxiworksPlatform/Resource.html +0 -1906
data/MoxiworksPlatform/SellerTransaction.html +0 -4222
data/MoxiworksPlatform/Session.html +0 -209
data/MoxiworksPlatform/SoldListing.html +0 -5606
data/MoxiworksPlatform/Task.html +0 -2351
data/MoxiworksPlatform/Team.html +0 -2147

data/MoxiworksPlatform/EmailCampaign.html DELETED

@@ -1,1076 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Class: MoxiworksPlatform::EmailCampaign
-    &mdash; Documentation by YARD 0.9.5
-</title>
-  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
-  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  pathId = "MoxiworksPlatform::EmailCampaign";
-  relpath = '../';
-</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 class="nav_wrap">
-      <iframe id="nav" src="../class_list.html"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="../_index.html">Index (E)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../MoxiworksPlatform.html" title="MoxiworksPlatform (module)">MoxiworksPlatform</a></span></span>
-     &raquo;
-    <span class="title">EmailCampaign</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <iframe id="search_frame" src="../class_list.html"></iframe>
-      <div id="content"><h1>Class: MoxiworksPlatform::EmailCampaign
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName"><span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next"><span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></li>
-            <li class="next">MoxiworksPlatform::EmailCampaign</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-    </dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/moxiworks_platform/email_campaign.rb</dd>
-  </dl>
-</div>
-  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
-  <ul class="summary">
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#area-instance_method" title="#area (instance method)">#<strong>area</strong>  &#x21d2; String </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>the area used for this EmailCampaign.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#email_address-instance_method" title="#email_address (instance method)">#<strong>email_address</strong>  &#x21d2; String </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>the email address that is configured for this email campaign.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#last_sent-instance_method" title="#last_sent (instance method)">#<strong>last_sent</strong>  &#x21d2; Integer </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>the Unix timestamp representing the date/time that the last email of this
-campaign was sent.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#moxi_works_agent_id-instance_method" title="#moxi_works_agent_id (instance method)">#<strong>moxi_works_agent_id</strong>  &#x21d2; String </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>moxi_works_agent_id is the Moxi Works Platform ID of the agent which an
-ActionLog entry is or is to be associated with.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#next_scheduled-instance_method" title="#next_scheduled (instance method)">#<strong>next_scheduled</strong>  &#x21d2; Integer </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>the Unix timestamp representing the date/time the next email of this
-campaign will be sent.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#partner_contact_id-instance_method" title="#partner_contact_id (instance method)">#<strong>partner_contact_id</strong>  &#x21d2; String </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>*your system&#39;s* unique ID for the Contact.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#subscribed_at-instance_method" title="#subscribed_at (instance method)">#<strong>subscribed_at</strong>  &#x21d2; Integer </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>the Unix timestamp representing the date/time this campaign was created.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#subscription_type-instance_method" title="#subscription_type (instance method)">#<strong>subscription_type</strong>  &#x21d2; String </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>the type of this EmailCampaign.</p>
-</div></span>
-</li>
-  </ul>
-  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Resource.html#headers-instance_method" title="MoxiworksPlatform::Resource#headers (method)">#headers</a></span></p>
-    <h2>
-      Class Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#search-class_method" title="search (class method)">.<strong>search</strong>(opts = {})  &#x21d2; Array </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Search an Agent&#39;s Email Campaigns in Moxi Works Platform.</p>
-</div></span>
-</li>
-    </ul>
-  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Resource.html#accept_header-class_method" title="MoxiworksPlatform::Resource.accept_header (method)">accept_header</a></span>, <span class='object_link'><a href="Resource.html#attr_accessor-class_method" title="MoxiworksPlatform::Resource.attr_accessor (method)">attr_accessor</a></span>, <span class='object_link'><a href="Resource.html#attributes-class_method" title="MoxiworksPlatform::Resource.attributes (method)">attributes</a></span>, <span class='object_link'><a href="Resource.html#attributes-instance_method" title="MoxiworksPlatform::Resource#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="Resource.html#auth_header-class_method" title="MoxiworksPlatform::Resource.auth_header (method)">auth_header</a></span>, <span class='object_link'><a href="Resource.html#check_for_error_in_response-class_method" title="MoxiworksPlatform::Resource.check_for_error_in_response (method)">check_for_error_in_response</a></span>, <span class='object_link'><a href="Resource.html#content_type_header-class_method" title="MoxiworksPlatform::Resource.content_type_header (method)">content_type_header</a></span>, <span class='object_link'><a href="Resource.html#float_attrs-instance_method" title="MoxiworksPlatform::Resource#float_attrs (method)">#float_attrs</a></span>, <span class='object_link'><a href="Resource.html#headers-class_method" title="MoxiworksPlatform::Resource.headers (method)">headers</a></span>, <span class='object_link'><a href="Resource.html#init_attrs_from_hash-instance_method" title="MoxiworksPlatform::Resource#init_attrs_from_hash (method)">#init_attrs_from_hash</a></span>, <span class='object_link'><a href="Resource.html#initialize-instance_method" title="MoxiworksPlatform::Resource#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Resource.html#method_missing-instance_method" title="MoxiworksPlatform::Resource#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="Resource.html#numeric_attrs-instance_method" title="MoxiworksPlatform::Resource#numeric_attrs (method)">#numeric_attrs</a></span>, <span class='object_link'><a href="Resource.html#numeric_value_for-instance_method" title="MoxiworksPlatform::Resource#numeric_value_for (method)">#numeric_value_for</a></span>, <span class='object_link'><a href="Resource.html#send_request-class_method" title="MoxiworksPlatform::Resource.send_request (method)">send_request</a></span>, <span class='object_link'><a href="Resource.html#to_hash-instance_method" title="MoxiworksPlatform::Resource#to_hash (method)">#to_hash</a></span>, <span class='object_link'><a href="Resource.html#underscore-class_method" title="MoxiworksPlatform::Resource.underscore (method)">underscore</a></span>, <span class='object_link'><a href="Resource.html#underscore_array-class_method" title="MoxiworksPlatform::Resource.underscore_array (method)">underscore_array</a></span>, <span class='object_link'><a href="Resource.html#underscore_attribute_names-class_method" title="MoxiworksPlatform::Resource.underscore_attribute_names (method)">underscore_attribute_names</a></span>, <span class='object_link'><a href="Resource.html#underscore_hash-class_method" title="MoxiworksPlatform::Resource.underscore_hash (method)">underscore_hash</a></span>, <span class='object_link'><a href="Resource.html#user_agent_header-class_method" title="MoxiworksPlatform::Resource.user_agent_header (method)">user_agent_header</a></span></p>
-<div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Resource.html#initialize-instance_method" title="MoxiworksPlatform::Resource#initialize (method)">MoxiworksPlatform::Resource</a></span></p>
-</div>
-<div id="method_missing_details" class="method_details_list">
-  <h2>Dynamic Method Handling</h2>
-  <p class="notice super">
-    This class handles dynamic methods through the <tt>method_missing</tt> method
-      in the class <span class='object_link'><a href="Resource.html#method_missing-instance_method" title="MoxiworksPlatform::Resource#method_missing (method)">MoxiworksPlatform::Resource</a></span>
-  </p>
-</div>
-  <div id="instance_attr_details" class="attr_details">
-    <h2>Instance Attribute Details</h2>
-      <span id="area=-instance_method"></span>
-      <div class="method_details first">
-  <h3 class="signature first" id="area-instance_method">
-    #<strong>area</strong>  &#x21d2; <tt>String</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>the area used for this EmailCampaign</p>
-<p>This will likely be simply a zip code, but allow for arbitrary human
-readable</p>
-<pre class="code ruby"><code class="ruby">strings referencing geographical locations.</code></pre>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-45
-46
-47</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/email_campaign.rb', line 45</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_area'>area</span>
-  <span class='ivar'>@area</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id="email_address=-instance_method"></span>
-      <div class="method_details ">
-  <h3 class="signature " id="email_address-instance_method">
-    #<strong>email_address</strong>  &#x21d2; <tt>String</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>the email address that is configured for this email campaign</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-30
-31
-32</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/email_campaign.rb', line 30</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_email_address'>email_address</span>
-  <span class='ivar'>@email_address</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id="last_sent=-instance_method"></span>
-      <div class="method_details ">
-  <h3 class="signature " id="last_sent-instance_method">
-    #<strong>last_sent</strong>  &#x21d2; <tt>Integer</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>the Unix timestamp representing the date/time that the last email of this
-campaign was sent.</p>
-<p>if no email has been sent for this campaign, the value will be 0</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Integer</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-53</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/email_campaign.rb', line 53</span>
-<span class='id identifier rubyid_attr_writer'>attr_writer</span> <span class='symbol'>:last_sent</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id="moxi_works_agent_id=-instance_method"></span>
-      <div class="method_details ">
-  <h3 class="signature " id="moxi_works_agent_id-instance_method">
-    #<strong>moxi_works_agent_id</strong>  &#x21d2; <tt>String</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>moxi_works_agent_id is the Moxi Works Platform ID of the agent which an
-ActionLog entry is or is to be associated with.</p>
-<p>this must be set for any Moxi Works Platform transaction</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>the Moxi Works Platform ID of the agent</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-10
-11
-12</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/email_campaign.rb', line 10</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_moxi_works_agent_id'>moxi_works_agent_id</span>
-  <span class='ivar'>@moxi_works_agent_id</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id="next_scheduled=-instance_method"></span>
-      <div class="method_details ">
-  <h3 class="signature " id="next_scheduled-instance_method">
-    #<strong>next_scheduled</strong>  &#x21d2; <tt>Integer</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>the Unix timestamp representing the date/time the next email of this
-campaign will be sent.</p>
-<p>if no email is scheduled to be sent for this campaign, the value will be 0</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Integer</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-61</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/email_campaign.rb', line 61</span>
-<span class='id identifier rubyid_attr_writer'>attr_writer</span> <span class='symbol'>:next_scheduled</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id="partner_contact_id=-instance_method"></span>
-      <div class="method_details ">
-  <h3 class="signature " id="partner_contact_id-instance_method">
-    #<strong>partner_contact_id</strong>  &#x21d2; <tt>String</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>*your system&#39;s* unique ID for the Contact</p>
-<p>this must be set for any Moxi Works Platform transaction</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>your system&#39;s unique ID for the contact</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-18
-19
-20</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/email_campaign.rb', line 18</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_partner_contact_id'>partner_contact_id</span>
-  <span class='ivar'>@partner_contact_id</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id="subscribed_at=-instance_method"></span>
-      <div class="method_details ">
-  <h3 class="signature " id="subscribed_at-instance_method">
-    #<strong>subscribed_at</strong>  &#x21d2; <tt>Integer</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>the Unix timestamp representing the date/time this campaign was created</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Integer</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-36</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/email_campaign.rb', line 36</span>
-<span class='id identifier rubyid_attr_writer'>attr_writer</span> <span class='symbol'>:subscribed_at</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id="subscription_type=-instance_method"></span>
-      <div class="method_details ">
-  <h3 class="signature " id="subscription_type-instance_method">
-    #<strong>subscription_type</strong>  &#x21d2; <tt>String</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>the type of this EmailCampaign</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-24
-25
-26</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/email_campaign.rb', line 24</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_subscription_type'>subscription_type</span>
-  <span class='ivar'>@subscription_type</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-  <div id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="search-class_method">
-    .<strong>search</strong>(opts = {})  &#x21d2; <tt>Array</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Search an Agent&#39;s Email Campaigns in Moxi Works Platform</p>
-  </div>
-</div>
-<div class="tags">
-  <div class="examples">
-    <p class="tag_title">Examples:</p>
-      <pre class="example code"><code><span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>EmailCampaign</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span>
-<span class='label'>moxi_works_agent_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>123abc</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-<span class='label'>partner_contact_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mySystemsContactID</span><span class='tstring_end'>&#39;</span></span>
-  <span class='rparen'>)</span></code></pre>
-  </div>
-<p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>opts</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>named parameter Hash</p>
-</div>
-    </li>
-</ul>
-    <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
-    <ul class="option">
-        <li>
-          <span class="name">:moxi_works_agent_id</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
-this contact is associated</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:partner_contact_id</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p><strong>REQUIRED</strong> Your system&#39;s unique ID for this contact.</p>
-</div>
-        </li>
-    </ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Array</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>containing MoxiworkPlatform::EmailCampaign objects</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Raises:</p>
-<ul class="raise">
-    <li>
-        <span class='type'></span>
-        <div class='inline'>
-<p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
-aren&#39;t included</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-79
-80
-81
-82
-83
-84
-85
-86
-87
-88
-89
-90
-91
-92
-93
-94
-95
-96
-97
-98
-99
-100
-101</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/email_campaign.rb', line 79</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</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='op'>::</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Exception</span><span class='op'>::</span><span class='const'>ArgumentError</span><span class='comma'>,</span>
-        <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>arguments must be passed as named parameters</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Hash</span>
-  <span class='id identifier rubyid_url'>url</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/api/email_campaigns</span><span class='tstring_end'>&quot;</span></span>
-  <span class='id identifier rubyid_required_opts'>required_opts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:moxi_works_agent_id</span><span class='comma'>,</span> <span class='symbol'>:partner_contact_id</span><span class='rbracket'>]</span>
-  <span class='id identifier rubyid_required_opts'>required_opts</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_opt'>opt</span><span class='op'>|</span>
-    <span class='id identifier rubyid_raise'>raise</span> <span class='op'>::</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Exception</span><span class='op'>::</span><span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opt'>opt</span><span class='embexpr_end'>}</span><span class='tstring_content'> required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span>
-        <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='id identifier rubyid_opt'>opt</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='id identifier rubyid_opt'>opt</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
-  <span class='kw'>end</span>
-  <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='const'>MoxiResponseArray</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span>
-  <span class='const'>RestClient</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='label'>method:</span> <span class='symbol'>:get</span><span class='comma'>,</span>
-                              <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
-                              <span class='label'>payload:</span> <span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_response'>response</span><span class='op'>|</span>
-    <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_response'>response</span> <span class='kw'>if</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span>
-    <span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span>
-    <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_check_for_error_in_response'>check_for_error_in_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
-    <span class='id identifier rubyid_json'>json</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
-    <span class='id identifier rubyid_json'>json</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span>
-      <span class='id identifier rubyid_results'>results</span> <span class='op'>&lt;&lt;</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>EmailCampaign</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_r'>r</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
-    <span class='kw'>end</span>
-  <span class='kw'>end</span>
-  <span class='id identifier rubyid_results'>results</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Fri Apr 20 10:00:20 2018 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.5 (ruby-2.2.4).
-</div>
-    </div>
-  </body>
-</html>