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

pinterest-ruby 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (150) hide show

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

@@ -0,0 +1,1296 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: Pinterest::Endpoints::Pins
+    &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::Pins";
+  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 (P)</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">Pins</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::Pins
+</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/pins.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Pins 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_pins-instance_method" title="#board_pins (instance method)">#<strong>board_pins</strong>(board, fields: nil, cursor: nil, limit: nil)  &#x21d2; Pinterest::Collection </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the list of pins of a board of the authenticated user.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#create_pin-instance_method" title="#create_pin (instance method)">#<strong>create_pin</strong>(board, image, note: nil, link: nil, fields: nil)  &#x21d2; Pinterest::User </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new pin.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#delete_pin-instance_method" title="#delete_pin (instance method)">#<strong>delete_pin</strong>(pin)  &#x21d2; Boolean </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Deletes a pin.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#edit_pin-instance_method" title="#edit_pin (instance method)">#<strong>edit_pin</strong>(pin, board: nil, note: nil, link: nil, fields: nil)  &#x21d2; Pinterest::User </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Edits a pin.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#likes-instance_method" title="#likes (instance method)">#<strong>likes</strong>(fields: nil, cursor: nil, limit: nil)  &#x21d2; Pinterest::Collection </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the list of liked pins of the authenticated user.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#pin-instance_method" title="#pin (instance method)">#<strong>pin</strong>(pin, fields: nil)  &#x21d2; Pinterest::User </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns information about a pin.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#pins-instance_method" title="#pins (instance method)">#<strong>pins</strong>(fields: nil, cursor: nil, limit: nil)  &#x21d2; Pinterest::Collection </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the list of pins of the authenticated user.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#search_my_pins-instance_method" title="#search_my_pins (instance method)">#<strong>search_my_pins</strong>(query = &quot;&quot;, fields: nil, cursor: nil, limit: nil)  &#x21d2; Pinterest::Collection </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Search between of pins of the authenticated user.</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_pins-instance_method">
+    #<strong>board_pins</strong>(board, 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 pins of a board of the authenticated user.</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|String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The board path (username/id) or 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>
+    <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 pin objects.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+118
+119
+120
+121</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/pins.rb', line 118</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_board_pins'>board_pins</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='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_validate_board'>validate_board</span><span class='lparen'>(</span><span class='id identifier rubyid_board'>board</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_get_pins_collection'>get_pins_collection</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'>/pins/</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="create_pin-instance_method">
+    #<strong>create_pin</strong>(board, image, note: nil, link: nil, fields: nil)  &#x21d2; <tt><span class='object_link'><a href="../User.html" title="Pinterest::User (class)">Pinterest::User</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new pin.</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 id.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>image</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The image to pin.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>note</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The note to attach to the pin.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>link</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The link to attach to the pin.</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="../User.html" title="Pinterest::User (class)">Pinterest::User</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The new created pin object.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/pins.rb', line 35</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_create_pin'>create_pin</span><span class='lparen'>(</span><span class='id identifier rubyid_board'>board</span><span class='comma'>,</span> <span class='id identifier rubyid_image'>image</span><span class='comma'>,</span> <span class='label'>note:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>link:</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='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_pin_fields'>ensure_pin_fields</span><span class='lparen'>(</span><span class='id identifier rubyid_fields'>fields</span><span class='rparen'>)</span>
+  <span class='comment'># Create the payload
+</span>  <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>note:</span> <span class='id identifier rubyid_note'>note</span><span class='comma'>,</span> <span class='label'>board:</span> <span class='id identifier rubyid_board'>board</span><span class='comma'>,</span> <span class='label'>link:</span> <span class='id identifier rubyid_link'>link</span><span class='rbrace'>}</span>
+  <span class='comment'># Add the image - Try to detect whether is a URL or a path
+</span>  <span class='id identifier rubyid_payload'>payload</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_add_image'>add_image</span><span class='lparen'>(</span><span class='id identifier rubyid_image'>image</span><span class='rparen'>)</span><span class='rparen'>)</span>
+  <span class='comment'># Perform the request and create the pin
+</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'>/pins/</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_payload'>payload</span><span class='rparen'>)</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="../Pin.html" title="Pinterest::Pin (class)">Pin</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create'><span class='object_link'><a href="../Pin.html#create-class_method" title="Pinterest::Pin.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_pin-instance_method">
+    #<strong>delete_pin</strong>(pin)  &#x21d2; <tt>Boolean</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Deletes a pin.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>pin</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The pin 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">
+80
+81
+82
+83
+84
+85
+86
+87</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/pins.rb', line 80</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_delete_pin'>delete_pin</span><span class='lparen'>(</span><span class='id identifier rubyid_pin'>pin</span><span class='rparen'>)</span>
+  <span class='comment'># Validate the board id
+</span>  <span class='id identifier rubyid_pin'>pin</span> <span class='op'>=</span> <span class='id identifier rubyid_validate_pin'>validate_pin</span><span class='lparen'>(</span><span class='id identifier rubyid_pin'>pin</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'>/pins/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_pin'>pin</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_pin-instance_method">
+    #<strong>edit_pin</strong>(pin, board: nil, note: nil, link: nil, fields: nil)  &#x21d2; <tt><span class='object_link'><a href="../User.html" title="Pinterest::User (class)">Pinterest::User</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Edits a pin.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>pin</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The pin id.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>board</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The new board path (username/id) or id.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>note</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The new note to attach to the pin.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>link</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The new link to attach to the pin.</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="../User.html" title="Pinterest::User (class)">Pinterest::User</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The updated pin object.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/pins.rb', line 61</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_edit_pin'>edit_pin</span><span class='lparen'>(</span><span class='id identifier rubyid_pin'>pin</span><span class='comma'>,</span> <span class='label'>board:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>note:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>link:</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='id identifier rubyid_pin'>pin</span> <span class='op'>=</span> <span class='id identifier rubyid_validate_pin'>validate_pin</span><span class='lparen'>(</span><span class='id identifier rubyid_pin'>pin</span><span class='rparen'>)</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='kw'>if</span> <span class='id identifier rubyid_board'>board</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_pin_fields'>ensure_pin_fields</span><span class='lparen'>(</span><span class='id identifier rubyid_fields'>fields</span><span class='rparen'>)</span>
+  <span class='comment'># Create the payload
+</span>  <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='id identifier rubyid_cleanup_params'>cleanup_params</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>note:</span> <span class='id identifier rubyid_note'>note</span><span class='comma'>,</span> <span class='label'>board:</span> <span class='id identifier rubyid_board'>board</span><span class='comma'>,</span> <span class='label'>link:</span> <span class='id identifier rubyid_link'>link</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='comment'># Perform the request and create the pin
+</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'>/pins/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_pin'>pin</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='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</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="../Pin.html" title="Pinterest::Pin (class)">Pin</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create'><span class='object_link'><a href="../Pin.html#create-class_method" title="Pinterest::Pin.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="likes-instance_method">
+    #<strong>likes</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 liked pins of 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 pin objects.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+129
+130
+131</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/pins.rb', line 129</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_likes'>likes</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_pins_collection'>get_pins_collection</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/me/likes/</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="pin-instance_method">
+    #<strong>pin</strong>(pin, fields: nil)  &#x21d2; <tt><span class='object_link'><a href="../User.html" title="Pinterest::User (class)">Pinterest::User</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns information about a pin.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>pin</span>
+        <span class='type'>(<tt>Fixnum|String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The pin 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="../User.html" title="Pinterest::User (class)">Pinterest::User</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>A pin 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/pins.rb', line 15</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_pin'>pin</span><span class='lparen'>(</span><span class='id identifier rubyid_pin'>pin</span><span class='comma'>,</span> <span class='label'>fields:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='comment'># Validate the pin id
+</span>  <span class='id identifier rubyid_pin'>pin</span> <span class='op'>=</span> <span class='id identifier rubyid_validate_pin'>validate_pin</span><span class='lparen'>(</span><span class='id identifier rubyid_pin'>pin</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_pin_fields'>ensure_pin_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 pin
+</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'>/pins/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_pin'>pin</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="../Pin.html" title="Pinterest::Pin (class)">Pin</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create'><span class='object_link'><a href="../Pin.html#create-class_method" title="Pinterest::Pin.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="pins-instance_method">
+    #<strong>pins</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 pins of 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 pin objects.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+95
+96
+97</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/pins.rb', line 95</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_pins'>pins</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_pins_collection'>get_pins_collection</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/me/pins/</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_pins-instance_method">
+    #<strong>search_my_pins</strong>(query = &quot;&quot;, 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 pins 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>
+        <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
+        &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 pin objects.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+106
+107
+108
+109</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/endpoints/pins.rb', line 106</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_search_my_pins'>search_my_pins</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</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='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_pins_collection'>get_pins_collection</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/me/search/pins/</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>
+</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>