RubyGems - pinterest-ruby - Versions diffs - 1.0.0 - Mend

pinterest-ruby 1.0.0

Files changed (150) hide show

data/docs/Pinterest/Endpoints/Boards.html ADDED Viewed

@@ -0,0 +1,1443 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: Pinterest::Endpoints::Boards
+    &mdash; Documentation by YARD 0.9.7
+</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 = "Pinterest::Endpoints::Boards";
+  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?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="../../_index.html">Index (B)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../Pinterest.html" title="Pinterest (module)">Pinterest</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="Pinterest::Endpoints (module)">Endpoints</a></span></span>
+     &raquo;
+    <span class="title">Boards</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>
+      <div id="content"><h1>Module: Pinterest::Endpoints::Boards
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Included in:</dt>
+    <dd><span class='object_link'><a href="../Client.html" title="Pinterest::Client (class)">Client</a></span></dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/pinterest/endpoints/boards.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Boards related endpoints.</p>
+  </div>
+</div>
+<div class="tags">
+</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="#board-instance_method" title="#board (instance method)">#<strong>board</strong>(board, fields: nil)  &#x21d2; Pinterest::Board </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns information about a board.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#boards-instance_method" title="#boards (instance method)">#<strong>boards</strong>(fields: nil)  &#x21d2; Pinterest::Collection </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the list of the boards of the authenticated user.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#create_board-instance_method" title="#create_board (instance method)">#<strong>create_board</strong>(name, description = &quot;&quot;, fields: nil)  &#x21d2; Pinterest::Board </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new board.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#delete_board-instance_method" title="#delete_board (instance method)">#<strong>delete_board</strong>(board)  &#x21d2; Boolean </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Deletes a board.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#edit_board-instance_method" title="#edit_board (instance method)">#<strong>edit_board</strong>(board, name: nil, description: nil, fields: nil)  &#x21d2; Pinterest::Board </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Edits a board.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#follow_board-instance_method" title="#follow_board (instance method)">#<strong>follow_board</strong>(board)  &#x21d2; Boolean </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Follows a board.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#following_boards-instance_method" title="#following_boards (instance method)">#<strong>following_boards</strong>(fields: nil, cursor: nil, limit: nil)  &#x21d2; Pinterest::Collection </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the list of boards followed by the authenticated user.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#search_my_boards-instance_method" title="#search_my_boards (instance method)">#<strong>search_my_boards</strong>(query, fields: nil, cursor: nil, limit: nil)  &#x21d2; Pinterest::Collection </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Search between of boards of the authenticated user.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#suggested_boards-instance_method" title="#suggested_boards (instance method)">#<strong>suggested_boards</strong>(fields: nil, cursor: nil, limit: nil)  &#x21d2; Pinterest::Collection </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the list of boards of suggested boards for the authenticated user.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#unfollow_board-instance_method" title="#unfollow_board (instance method)">#<strong>unfollow_board</strong>(board)  &#x21d2; Boolean </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Stop following a board.</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="board-instance_method">
+    #<strong>board</strong>(board, fields: nil)  &#x21d2; <tt><span class='object_link'><a href="../Board.html" title="Pinterest::Board (class)">Pinterest::Board</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns information about a board.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>board</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The board path (username/id) or user id.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>fields</span>
+        <span class='type'>(<tt>Array</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A list of fields to return.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../Board.html" title="Pinterest::Board (class)">Pinterest::Board</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>A board object.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/boards.rb', line 15</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_board'>board</span><span class='lparen'>(</span><span class='id identifier rubyid_board'>board</span><span class='comma'>,</span> <span class='label'>fields:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='comment'># Validate the board id
+</span>  <span class='id identifier rubyid_board'>board</span> <span class='op'>=</span> <span class='id identifier rubyid_validate_board'>validate_board</span><span class='lparen'>(</span><span class='id identifier rubyid_board'>board</span><span class='rparen'>)</span>
+  <span class='comment'># Ensure only valid fields are used
+</span>  <span class='id identifier rubyid_fields'>fields</span> <span class='op'>=</span> <span class='id identifier rubyid_ensure_board_fields'>ensure_board_fields</span><span class='lparen'>(</span><span class='id identifier rubyid_fields'>fields</span><span class='rparen'>)</span>
+  <span class='comment'># Perform the request and create the board
+</span>  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_perform_network_request'>perform_network_request</span><span class='lparen'>(</span><span class='label'>url:</span> <span class='id identifier rubyid_versioned_url'>versioned_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/boards/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_board'>board</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='id identifier rubyid_cleanup_params'>cleanup_params</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>fields:</span> <span class='id identifier rubyid_fields'>fields</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>,</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>data</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
+  <span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Pinterest.html" title="Pinterest (module)">Pinterest</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Board.html" title="Pinterest::Board (class)">Board</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create'><span class='object_link'><a href="../Board.html#create-class_method" title="Pinterest::Board.create (method)">create</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="boards-instance_method">
+    #<strong>boards</strong>(fields: nil)  &#x21d2; <tt><span class='object_link'><a href="../Collection.html" title="Pinterest::Collection (class)">Pinterest::Collection</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the list of the boards of the authenticated user. Pagination is not supported by Pinterest API.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>fields</span>
+        <span class='type'>(<tt>Array</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A list of fields to return.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../Collection.html" title="Pinterest::Collection (class)">Pinterest::Collection</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>An collection of board objects.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/boards.rb', line 31</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_boards'>boards</span><span class='lparen'>(</span><span class='label'>fields:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_get_boards_collection'>get_boards_collection</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/me/boards/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_fields'>fields</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="create_board-instance_method">
+    #<strong>create_board</strong>(name, description = &quot;&quot;, fields: nil)  &#x21d2; <tt><span class='object_link'><a href="../Board.html" title="Pinterest::Board (class)">Pinterest::Board</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new board.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>name</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The board name.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>description</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The board description.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>fields</span>
+        <span class='type'>(<tt>Array</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A list of fields to return.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../Board.html" title="Pinterest::Board (class)">Pinterest::Board</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The created board object.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/boards.rb', line 41</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_create_board'>create_board</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_description'>description</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>fields:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='comment'># Validate name
+</span>  <span class='id identifier rubyid_ensure_param'>ensure_param</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>You have to specify the board name.</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+  <span class='comment'># Ensure only valid fields are used
+</span>  <span class='id identifier rubyid_fields'>fields</span> <span class='op'>=</span> <span class='id identifier rubyid_ensure_board_fields'>ensure_board_fields</span><span class='lparen'>(</span><span class='id identifier rubyid_fields'>fields</span><span class='rparen'>)</span>
+  <span class='comment'># Create the board
+</span>  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_perform_network_request'>perform_network_request</span><span class='lparen'>(</span>
+    <span class='label'>method:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>POST</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>url:</span> <span class='id identifier rubyid_versioned_url'>versioned_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/boards/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
+    <span class='label'>query:</span> <span class='id identifier rubyid_cleanup_params'>cleanup_params</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>fields:</span> <span class='id identifier rubyid_fields'>fields</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>,</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span>
+    <span class='label'>body:</span> <span class='id identifier rubyid_cleanup_params'>cleanup_params</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='rparen'>)</span>
+  <span class='comment'># Wrap in a object
+</span>  <span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Pinterest.html" title="Pinterest (module)">Pinterest</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Board.html" title="Pinterest::Board (class)">Board</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create'><span class='object_link'><a href="../Board.html#create-class_method" title="Pinterest::Board.create (method)">create</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>data</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="delete_board-instance_method">
+    #<strong>delete_board</strong>(board)  &#x21d2; <tt>Boolean</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Deletes a board.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>board</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The board id.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p><code>true</code> if operation succeeded, <code>false</code> otherwise.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+89
+90
+91
+92
+93
+94
+95
+96</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/boards.rb', line 89</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_delete_board'>delete_board</span><span class='lparen'>(</span><span class='id identifier rubyid_board'>board</span><span class='rparen'>)</span>
+  <span class='comment'># Validate the board id
+</span>  <span class='id identifier rubyid_board'>board</span> <span class='op'>=</span> <span class='id identifier rubyid_validate_board'>validate_board</span><span class='lparen'>(</span><span class='id identifier rubyid_board'>board</span><span class='rparen'>)</span>
+  <span class='comment'># Perform the request
+</span>  <span class='id identifier rubyid_perform_network_request'>perform_network_request</span><span class='lparen'>(</span><span class='label'>method:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>url:</span> <span class='id identifier rubyid_versioned_url'>versioned_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/boards/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_board'>board</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
+  <span class='kw'>true</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="edit_board-instance_method">
+    #<strong>edit_board</strong>(board, name: nil, description: nil, fields: nil)  &#x21d2; <tt><span class='object_link'><a href="../Board.html" title="Pinterest::Board (class)">Pinterest::Board</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Edits a board.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>board</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The board id.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>name</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The new board name.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>description</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The new board description.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>fields</span>
+        <span class='type'>(<tt>Array</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A list of fields to return.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../Board.html" title="Pinterest::Board (class)">Pinterest::Board</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The updated board object.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt>ArgumentError</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/boards.rb', line 66</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_edit_board'>edit_board</span><span class='lparen'>(</span><span class='id identifier rubyid_board'>board</span><span class='comma'>,</span> <span class='label'>name:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>fields:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='comment'># Validate the board id
+</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'>&quot;</span><span class='tstring_content'>You have to specify a board or its id.</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_board'>board</span>
+  <span class='id identifier rubyid_board'>board</span> <span class='op'>=</span> <span class='id identifier rubyid_board'>board</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='kw'>if</span> <span class='id identifier rubyid_board'>board</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Pinterest.html" title="Pinterest (module)">Pinterest</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Board.html" title="Pinterest::Board (class)">Board</a></span></span><span class='rparen'>)</span>
+  <span class='comment'># Ensure only valid fields are used
+</span>  <span class='id identifier rubyid_fields'>fields</span> <span class='op'>=</span> <span class='id identifier rubyid_ensure_board_fields'>ensure_board_fields</span><span class='lparen'>(</span><span class='id identifier rubyid_fields'>fields</span><span class='rparen'>)</span>
+  <span class='comment'># Create the board
+</span>  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_perform_network_request'>perform_network_request</span><span class='lparen'>(</span>
+    <span class='label'>method:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PATCH</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>url:</span> <span class='id identifier rubyid_versioned_url'>versioned_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/boards/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_board'>board</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
+    <span class='label'>query:</span> <span class='id identifier rubyid_cleanup_params'>cleanup_params</span><span class='lparen'>(</span><span class='label'>fields:</span> <span class='id identifier rubyid_fields'>fields</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>,</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span><span class='comma'>,</span>
+    <span class='label'>body:</span> <span class='id identifier rubyid_cleanup_params'>cleanup_params</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='rparen'>)</span>
+  <span class='comment'># Wrap in a object
+</span>  <span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Pinterest.html" title="Pinterest (module)">Pinterest</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Board.html" title="Pinterest::Board (class)">Board</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create'><span class='object_link'><a href="../Board.html#create-class_method" title="Pinterest::Board.create (method)">create</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>data</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="follow_board-instance_method">
+    #<strong>follow_board</strong>(board)  &#x21d2; <tt>Boolean</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Follows a board.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>board</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The board id.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p><code>true</code> if operation succeeded, <code>false</code> otherwise.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+134
+135
+136
+137
+138
+139
+140
+141</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/boards.rb', line 134</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_follow_board'>follow_board</span><span class='lparen'>(</span><span class='id identifier rubyid_board'>board</span><span class='rparen'>)</span>
+  <span class='comment'># Validate the board id
+</span>  <span class='id identifier rubyid_board'>board</span> <span class='op'>=</span> <span class='id identifier rubyid_validate_board'>validate_board</span><span class='lparen'>(</span><span class='id identifier rubyid_board'>board</span><span class='rparen'>)</span>
+  <span class='comment'># Perform the request
+</span>  <span class='id identifier rubyid_perform_network_request'>perform_network_request</span><span class='lparen'>(</span><span class='label'>method:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>POST</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span><span class='label'>board:</span> <span class='id identifier rubyid_board'>board</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='id identifier rubyid_versioned_url'>versioned_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/me/following/boards/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
+  <span class='kw'>true</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="following_boards-instance_method">
+    #<strong>following_boards</strong>(fields: nil, cursor: nil, limit: nil)  &#x21d2; <tt><span class='object_link'><a href="../Collection.html" title="Pinterest::Collection (class)">Pinterest::Collection</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the list of boards followed by the authenticated user.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>fields</span>
+        <span class='type'>(<tt>Array</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A list of fields to return.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>cursor</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A cursor to paginate results, obtained by a previous call.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>limit</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The maximum number of objects to return.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../Collection.html" title="Pinterest::Collection (class)">Pinterest::Collection</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>An collection of board objects.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+126
+127
+128</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/boards.rb', line 126</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_following_boards'>following_boards</span><span class='lparen'>(</span><span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>cursor:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_get_boards_collection'>get_boards_collection</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/me/following/boards/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_fields'>fields</span><span class='comma'>,</span> <span class='id identifier rubyid_cursor'>cursor</span><span class='comma'>,</span> <span class='id identifier rubyid_limit'>limit</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="search_my_boards-instance_method">
+    #<strong>search_my_boards</strong>(query, fields: nil, cursor: nil, limit: nil)  &#x21d2; <tt><span class='object_link'><a href="../Collection.html" title="Pinterest::Collection (class)">Pinterest::Collection</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Search between of boards of the authenticated user.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>query</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The query to perform.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>fields</span>
+        <span class='type'>(<tt>Array</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A list of fields to return.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>cursor</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A cursor to paginate results, obtained by a previous call.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>limit</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The maximum number of objects to return.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../Collection.html" title="Pinterest::Collection (class)">Pinterest::Collection</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>An collection of board objects.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+105
+106
+107
+108</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/boards.rb', line 105</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_search_my_boards'>search_my_boards</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>cursor:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ensure_param'>ensure_param</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>You have to specify a query.</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_get_boards_collection'>get_boards_collection</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/me/search/boards/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_fields'>fields</span><span class='comma'>,</span> <span class='id identifier rubyid_cursor'>cursor</span><span class='comma'>,</span> <span class='id identifier rubyid_limit'>limit</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="suggested_boards-instance_method">
+    #<strong>suggested_boards</strong>(fields: nil, cursor: nil, limit: nil)  &#x21d2; <tt><span class='object_link'><a href="../Collection.html" title="Pinterest::Collection (class)">Pinterest::Collection</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the list of boards of suggested boards for the authenticated user.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>fields</span>
+        <span class='type'>(<tt>Array</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A list of fields to return.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>cursor</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A cursor to paginate results, obtained by a previous call.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>limit</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The maximum number of objects to return.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../Collection.html" title="Pinterest::Collection (class)">Pinterest::Collection</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>An collection of board objects.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+116
+117
+118</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/boards.rb', line 116</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_suggested_boards'>suggested_boards</span><span class='lparen'>(</span><span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>cursor:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_get_boards_collection'>get_boards_collection</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/me/boards/suggested/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_fields'>fields</span><span class='comma'>,</span> <span class='id identifier rubyid_cursor'>cursor</span><span class='comma'>,</span> <span class='id identifier rubyid_limit'>limit</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="unfollow_board-instance_method">
+    #<strong>unfollow_board</strong>(board)  &#x21d2; <tt>Boolean</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Stop following a board.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>board</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The board id.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p><code>true</code> if operation succeeded, <code>false</code> otherwise.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+147
+148
+149
+150
+151
+152
+153
+154</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/boards.rb', line 147</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_unfollow_board'>unfollow_board</span><span class='lparen'>(</span><span class='id identifier rubyid_board'>board</span><span class='rparen'>)</span>
+  <span class='comment'># Validate the board id
+</span>  <span class='id identifier rubyid_board'>board</span> <span class='op'>=</span> <span class='id identifier rubyid_validate_board'>validate_board</span><span class='lparen'>(</span><span class='id identifier rubyid_board'>board</span><span class='rparen'>)</span>
+  <span class='comment'># Perform the request
+</span>  <span class='id identifier rubyid_perform_network_request'>perform_network_request</span><span class='lparen'>(</span><span class='label'>method:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>url:</span> <span class='id identifier rubyid_versioned_url'>versioned_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/me/following/boards/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_board'>board</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
+  <span class='kw'>true</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Thu Jan 12 16:28:12 2017 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.7 (ruby-2.3.0).
+</div>
+    </div>
+  </body>
+</html>