Helix SwarmHelix Swarm

HelixWebServicesClient.html

  • //
  • guest/
  • ptomiak/
  • hws/
  • build/
  • doc/
  • helix_web_services_client_ruby/
  • HelixWebServicesClient.html #1
  • View
  • Commits
  • Open Download .zip Download (260 KB) 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4.   <head>
  5.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>
  7.   Class: HelixWebServicesClient
  8.   
  9.     &mdash; Documentation by YARD 0.8.7.6
  10.   
  11. </title>
  12.  
  13.   <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
  14.  
  15.   <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
  16.  
  17. <script type="text/javascript" charset="utf-8">
  18.   hasFrames = window.top.frames.main ? true : false;
  19.   relpath = '';
  20.   framesUrl = "frames.html#!HelixWebServicesClient.html";
  21. </script>
  22.  
  23.  
  24.   <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
  25.  
  26.   <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
  27.  
  28.  
  29.   </head>
  30.   <body>
  31.     <div id="header">
  32.       <div id="menu">
  33.   
  34.     <a href="_index.html">Index (H)</a> &raquo;
  35.     
  36.     
  37.     <span class="title">HelixWebServicesClient</span>
  38.   
  39.  
  40.   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
  41. </div>
  42.  
  43.       <div id="search">
  44.   
  45.     <a class="full_list_link" id="class_list_link"
  46.         href="class_list.html">
  47.       Class List
  48.     </a>
  49.   
  50.     <a class="full_list_link" id="method_list_link"
  51.         href="method_list.html">
  52.       Method List
  53.     </a>
  54.   
  55.     <a class="full_list_link" id="file_list_link"
  56.         href="file_list.html">
  57.       File List
  58.     </a>
  59.   
  60. </div>
  61.       <div class="clear"></div>
  62.     </div>
  63.  
  64.     <iframe id="search_frame"></iframe>
  65.  
  66.     <div id="content"><h1>Class: HelixWebServicesClient
  67.   
  68.   
  69.   
  70. </h1>
  71.  
  72. <dl class="box">
  73.   
  74.     <dt class="r1">Inherits:</dt>
  75.     <dd class="r1">
  76.       <span class="inheritName">Object</span>
  77.       
  78.         <ul class="fullTree">
  79.           <li>Object</li>
  80.           
  81.             <li class="next">HelixWebServicesClient</li>
  82.           
  83.         </ul>
  84.         <a href="#" class="inheritanceTree">show all</a>
  85.       
  86.       </dd>
  87.     
  88.   
  89.   
  90.     
  91.   
  92.     
  93.   
  94.   
  95.   
  96.     <dt class="r2 last">Defined in:</dt>
  97.     <dd class="r2 last">lib/helix_web_services_client.rb<span class="defines">,<br />
  98.   lib/helix_web_services_client/jobs.rb,<br /> lib/helix_web_services_client/login.rb,<br /> lib/helix_web_services_client/files.rb,<br /> lib/helix_web_services_client/users.rb,<br /> lib/helix_web_services_client/config.rb,<br /> lib/helix_web_services_client/depots.rb,<br /> lib/helix_web_services_client/labels.rb,<br /> lib/helix_web_services_client/groups.rb,<br /> lib/helix_web_services_client/changes.rb,<br /> lib/helix_web_services_client/servers.rb,<br /> lib/helix_web_services_client/streams.rb,<br /> lib/helix_web_services_client/version.rb,<br /> lib/helix_web_services_client/clients.rb,<br /> lib/helix_web_services_client/branches.rb,<br /> lib/helix_web_services_client/projects.rb,<br /> lib/helix_web_services_client/commands.rb,<br /> lib/helix_web_services_client/triggers.rb,<br /> lib/helix_web_services_client/counters.rb,<br /> lib/helix_web_services_client/helix_sync.rb,<br /> lib/helix_web_services_client/protections.rb</span>
  99. </dd>
  100.   
  101. </dl>
  102. <div class="clear"></div>
  103.  
  104. <h2>Overview</h2><div class="docstring">
  105.   <div class="discussion">
  106.     
  107. <p>The client object handles authenticating and making calls to Helix Web
  108. Services.</p>
  109.  
  110. <p>See our user guide online at: <a
  111. href="https://swarm.workshop.perforce.com/projects/perforce-software-helix-web-services/view/main/build/doc/p4ws.html#ruby_client_sdk_overview">swarm.workshop.perforce.com/projects/perforce-software-helix-web-services/view/main/build/doc/p4ws.html#ruby_client_sdk_overview</a></p>
  112.  
  113.  
  114.   </div>
  115. </div>
  116. <div class="tags">
  117.   
  118.  
  119. </div>
  120.   <h2>Constant Summary</h2>
  121.   
  122.     <dl class="constants">
  123.       
  124.         <dt id="INITIALIZE_LOCAL_OPTIONS-constant" class="">INITIALIZE_LOCAL_OPTIONS =
  125.           <div class="docstring">
  126.   <div class="discussion">
  127.     
  128. <p>Some values to initialize are only used by this class, and are not passed
  129. on to the Faraday initializer</p>
  130.  
  131.  
  132.   </div>
  133. </div>
  134. <div class="tags">
  135.   
  136.  
  137. </div>
  138.         </dt>
  139.         <dd><pre class="code"><span class='lbracket'>[</span><span class='symbol'>:user</span><span class='comma'>,</span> <span class='symbol'>:password</span><span class='comma'>,</span> <span class='symbol'>:ticket</span><span class='comma'>,</span> <span class='symbol'>:prefix</span><span class='comma'>,</span> <span class='symbol'>:api_level</span><span class='comma'>,</span> <span class='symbol'>:settings</span><span class='comma'>,</span> <span class='symbol'>:debug</span><span class='rbracket'>]</span></pre></dd>
  140.       
  141.         <dt id="VERSION-constant" class="">VERSION =
  142.           
  143.         </dt>
  144.         <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>2015.1.0.pre1</span><span class='tstring_end'>&#39;</span></span></pre></dd>
  145.       
  146.     </dl>
  147.   
  148.  
  149.  
  150.  
  151.  
  152.   <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
  153.   <ul class="summary">
  154.     
  155.       <li class="public ">
  156.   <span class="summary_signature">
  157.     
  158.       <a href="#api_level-instance_method" title="#api_level (instance method)">- (Object) <strong>api_level</strong> </a>
  159.     
  160.  
  161.     
  162.   </span>
  163.   
  164.   
  165.   
  166.     
  167.     
  168.   
  169.   
  170.   
  171.   
  172.   
  173.  
  174.   
  175.     <span class="summary_desc"><div class='inline'>
  176. <p>The API level to use.</p>
  177. </div></span>
  178.   
  179. </li>
  180.  
  181.     
  182.       <li class="public ">
  183.   <span class="summary_signature">
  184.     
  185.       <a href="#prefix-instance_method" title="#prefix (instance method)">- (Object) <strong>prefix</strong> </a>
  186.     
  187.  
  188.     
  189.   </span>
  190.   
  191.   
  192.   
  193.     
  194.     
  195.   
  196.   
  197.   
  198.   
  199.   
  200.  
  201.   
  202.     <span class="summary_desc"><div class='inline'>
  203. <p>Typically, Helix Web Services is mounted under /hws behind a reverse proxy.</p>
  204. </div></span>
  205.   
  206. </li>
  207.  
  208.     
  209.       <li class="public ">
  210.   <span class="summary_signature">
  211.     
  212.       <a href="#ticket-instance_method" title="#ticket (instance method)">- (Object) <strong>ticket</strong> </a>
  213.     
  214.  
  215.     
  216.   </span>
  217.   
  218.   
  219.   
  220.     
  221.     
  222.   
  223.   
  224.   
  225.   
  226.   
  227.  
  228.   
  229.     <span class="summary_desc"><div class='inline'>
  230. <p>Upon successful login, we store the P4 ticket return value here.</p>
  231. </div></span>
  232.   
  233. </li>
  234.  
  235.     
  236.       <li class="public ">
  237.   <span class="summary_signature">
  238.     
  239.       <a href="#user-instance_method" title="#user (instance method)">- (Object) <strong>user</strong> </a>
  240.     
  241.  
  242.     
  243.   </span>
  244.   
  245.   
  246.   
  247.     
  248.     
  249.   
  250.   
  251.   
  252.   
  253.   
  254.  
  255.   
  256.     <span class="summary_desc"><div class='inline'>
  257. <p>The Helix Versioning Engine login.</p>
  258. </div></span>
  259.   
  260. </li>
  261.  
  262.     
  263.   </ul>
  264.  
  265.  
  266.  
  267.  
  268.   
  269.     <h2>
  270.       Class Method Summary
  271.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  272.     </h2>
  273.  
  274.     <ul class="summary">
  275.       
  276.         <li class="public ">
  277.   <span class="summary_signature">
  278.     
  279.       <a href="#open-class_method" title="open (class method)">+ (Object) <strong>open</strong>(connection) </a>
  280.     
  281.  
  282.     
  283.   </span>
  284.   
  285.   
  286.   
  287.   
  288.   
  289.   
  290.   
  291.  
  292.   
  293.     <span class="summary_desc"><div class='inline'>
  294. <p>Provides standard I/O style interface, where when called in a block, will
  295. automatically close() the client when done.</p>
  296. </div></span>
  297.   
  298. </li>
  299.  
  300.       
  301.     </ul>
  302.   
  303.     <h2>
  304.       Instance Method Summary
  305.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  306.     </h2>
  307.  
  308.     <ul class="summary">
  309.       
  310.         <li class="public ">
  311.   <span class="summary_signature">
  312.     
  313.       <a href="#add_setting-instance_method" title="#add_setting (instance method)">- (Object) <strong>add_setting</strong>(key, value) </a>
  314.     
  315.  
  316.     
  317.   </span>
  318.   
  319.   
  320.   
  321.   
  322.   
  323.   
  324.   
  325.  
  326.   
  327.     <span class="summary_desc"><div class='inline'>
  328. <p>Set an override for all requests.</p>
  329. </div></span>
  330.   
  331. </li>
  332.  
  333.       
  334.         <li class="public ">
  335.   <span class="summary_signature">
  336.     
  337.       <a href="#arg_params-instance_method" title="#arg_params (instance method)">- (Object) <strong>arg_params</strong>(arg_values) </a>
  338.     
  339.  
  340.     
  341.   </span>
  342.   
  343.   
  344.   
  345.   
  346.   
  347.   
  348.   
  349.  
  350.   
  351.     <span class="summary_desc"><div class='inline'>
  352. <p>Creates a hash and creates keys &#39;arg1&#39;, &#39;arg2&#39;, etc that
  353. points to the values in the arg_values array.</p>
  354. </div></span>
  355.   
  356. </li>
  357.  
  358.       
  359.         <li class="public ">
  360.   <span class="summary_signature">
  361.     
  362.       <a href="#assert_ok-instance_method" title="#assert_ok (instance method)">- (Object) <strong>assert_ok</strong>(response) </a>
  363.     
  364.  
  365.     
  366.   </span>
  367.   
  368.   
  369.   
  370.   
  371.   
  372.   
  373.   
  374.  
  375.   
  376.     <span class="summary_desc"><div class='inline'>
  377. <p>Raises an error when the response is not 200.</p>
  378. </div></span>
  379.   
  380. </li>
  381.  
  382.       
  383.         <li class="public ">
  384.   <span class="summary_signature">
  385.     
  386.       <a href="#branch-instance_method" title="#branch (instance method)">- (Object) <strong>branch</strong>(branch) </a>
  387.     
  388.  
  389.     
  390.   </span>
  391.   
  392.   
  393.   
  394.   
  395.   
  396.   
  397.   
  398.  
  399.   
  400.     <span class="summary_desc"><div class='inline'>
  401. <p>Returns the branch instance indicated by the branch name (or model).</p>
  402. </div></span>
  403.   
  404. </li>
  405.  
  406.       
  407.         <li class="public ">
  408.   <span class="summary_signature">
  409.     
  410.       <a href="#branches-instance_method" title="#branches (instance method)">- (Object) <strong>branches</strong> </a>
  411.     
  412.  
  413.     
  414.   </span>
  415.   
  416.   
  417.   
  418.   
  419.   
  420.   
  421.   
  422.  
  423.   
  424.     <span class="summary_desc"><div class='inline'>
  425. <p>Array of Branch objects stored in the system.</p>
  426. </div></span>
  427.   
  428. </li>
  429.  
  430.       
  431.         <li class="public ">
  432.   <span class="summary_signature">
  433.     
  434.       <a href="#change-instance_method" title="#change (instance method)">- (Object) <strong>change</strong>(change) </a>
  435.     
  436.  
  437.     
  438.   </span>
  439.   
  440.   
  441.   
  442.   
  443.   
  444.   
  445.   
  446.  
  447.   
  448.     <span class="summary_desc"><div class='inline'>
  449. <p>Returns the Change indicated by the change number or model.</p>
  450. </div></span>
  451.   
  452. </li>
  453.  
  454.       
  455.         <li class="public ">
  456.   <span class="summary_signature">
  457.     
  458.       <a href="#changes-instance_method" title="#changes (instance method)">- (Object) <strong>changes</strong>(options = nil) </a>
  459.     
  460.  
  461.     
  462.   </span>
  463.   
  464.   
  465.   
  466.   
  467.   
  468.   
  469.   
  470.  
  471.   
  472.     <span class="summary_desc"><div class='inline'>
  473. <p>List changelists in the system.</p>
  474. </div></span>
  475.   
  476. </li>
  477.  
  478.       
  479.         <li class="public ">
  480.   <span class="summary_signature">
  481.     
  482.       <a href="#client-instance_method" title="#client (instance method)">- (Object) <strong>client</strong>(client) </a>
  483.     
  484.  
  485.     
  486.   </span>
  487.   
  488.   
  489.   
  490.   
  491.   
  492.   
  493.   
  494.  
  495.   
  496.     <span class="summary_desc"><div class='inline'>
  497. <p>Returns the client instance indicated by the client name or model.</p>
  498. </div></span>
  499.   
  500. </li>
  501.  
  502.       
  503.         <li class="public ">
  504.   <span class="summary_signature">
  505.     
  506.       <a href="#clients-instance_method" title="#clients (instance method)">- (Object) <strong>clients</strong> </a>
  507.     
  508.  
  509.     
  510.   </span>
  511.   
  512.   
  513.   
  514.   
  515.   
  516.   
  517.   
  518.  
  519.   
  520.     <span class="summary_desc"><div class='inline'>
  521. <p>Array of Client objects stored in the system.</p>
  522. </div></span>
  523.   
  524. </li>
  525.  
  526.       
  527.         <li class="public ">
  528.   <span class="summary_signature">
  529.     
  530.       <a href="#close-instance_method" title="#close (instance method)">- (Object) <strong>close</strong> </a>
  531.     
  532.  
  533.     
  534.   </span>
  535.   
  536.   
  537.   
  538.   
  539.   
  540.   
  541.   
  542.  
  543.   
  544.     <span class="summary_desc"><div class='inline'></div></span>
  545.   
  546. </li>
  547.  
  548.       
  549.         <li class="public ">
  550.   <span class="summary_signature">
  551.     
  552.       <a href="#command-instance_method" title="#command (instance method)">- (OpenModel) <strong>command</strong>(cmd, *args) </a>
  553.     
  554.  
  555.     
  556.   </span>
  557.   
  558.   
  559.   
  560.   
  561.   
  562.   
  563.   
  564.  
  565.   
  566.     <span class="summary_desc"><div class='inline'>
  567. <p>Execute a Perforce command.</p>
  568. </div></span>
  569.   
  570. </li>
  571.  
  572.       
  573.         <li class="public ">
  574.   <span class="summary_signature">
  575.     
  576.       <a href="#command_with_input-instance_method" title="#command_with_input (instance method)">- (Object) <strong>command_with_input</strong>(cmd, input, *args) </a>
  577.     
  578.  
  579.     
  580.   </span>
  581.   
  582.   
  583.   
  584.   
  585.   
  586.   
  587.   
  588.  
  589.   
  590.     <span class="summary_desc"><div class='inline'>
  591. <p>Generic run command with and input body.</p>
  592. </div></span>
  593.   
  594. </li>
  595.  
  596.       
  597.         <li class="public ">
  598.   <span class="summary_signature">
  599.     
  600.       <a href="#commit_change-instance_method" title="#commit_change (instance method)">- (Object) <strong>commit_change</strong>(change) </a>
  601.     
  602.  
  603.     
  604.   </span>
  605.   
  606.   
  607.   
  608.   
  609.   
  610.   
  611.   
  612.  
  613.   
  614.     <span class="summary_desc"><div class='inline'>
  615. <p>Submits the shelved changelist.</p>
  616. </div></span>
  617.   
  618. </li>
  619.  
  620.       
  621.         <li class="public ">
  622.   <span class="summary_signature">
  623.     
  624.       <a href="#counter-instance_method" title="#counter (instance method)">- (Object) <strong>counter</strong>(counter) </a>
  625.     
  626.  
  627.     
  628.   </span>
  629.   
  630.   
  631.   
  632.   
  633.   
  634.   
  635.   
  636.  
  637.   
  638.     <span class="summary_desc"><div class='inline'>
  639. <p>Return the counter hash for a particular counter key.</p>
  640. </div></span>
  641.   
  642. </li>
  643.  
  644.       
  645.         <li class="public ">
  646.   <span class="summary_signature">
  647.     
  648.       <a href="#counters-instance_method" title="#counters (instance method)">- (Object) <strong>counters</strong> </a>
  649.     
  650.  
  651.     
  652.   </span>
  653.   
  654.   
  655.   
  656.   
  657.   
  658.   
  659.   
  660.  
  661.   
  662.     <span class="summary_desc"><div class='inline'>
  663. <p>List all counters in the system.</p>
  664. </div></span>
  665.   
  666. </li>
  667.  
  668.       
  669.         <li class="public ">
  670.   <span class="summary_signature">
  671.     
  672.       <a href="#create_branch-instance_method" title="#create_branch (instance method)">- (Object) <strong>create_branch</strong>(branch) </a>
  673.     
  674.  
  675.     
  676.   </span>
  677.   
  678.   
  679.   
  680.   
  681.   
  682.   
  683.   
  684.  
  685.   
  686.     <span class="summary_desc"><div class='inline'>
  687. <p>Creates a new branch in the system.</p>
  688. </div></span>
  689.   
  690. </li>
  691.  
  692.       
  693.         <li class="public ">
  694.   <span class="summary_signature">
  695.     
  696.       <a href="#create_change-instance_method" title="#create_change (instance method)">- (Object) <strong>create_change</strong>(change) </a>
  697.     
  698.  
  699.     
  700.   </span>
  701.   
  702.   
  703.   
  704.   
  705.   
  706.   
  707.   
  708.  
  709.   
  710.     <span class="summary_desc"><div class='inline'>
  711. <p>Creates a new changelist, that can be used for a few different tasks.</p>
  712. </div></span>
  713.   
  714. </li>
  715.  
  716.       
  717.         <li class="public ">
  718.   <span class="summary_signature">
  719.     
  720.       <a href="#create_client-instance_method" title="#create_client (instance method)">- (Object) <strong>create_client</strong>(client) </a>
  721.     
  722.  
  723.     
  724.   </span>
  725.   
  726.   
  727.   
  728.   
  729.   
  730.   
  731.   
  732.  
  733.   
  734.     <span class="summary_desc"><div class='inline'>
  735. <p>Creates a new client in the system.</p>
  736. </div></span>
  737.   
  738. </li>
  739.  
  740.       
  741.         <li class="public ">
  742.   <span class="summary_signature">
  743.     
  744.       <a href="#create_depot-instance_method" title="#create_depot (instance method)">- (Object) <strong>create_depot</strong>(depot) </a>
  745.     
  746.  
  747.     
  748.   </span>
  749.   
  750.   
  751.   
  752.   
  753.   
  754.   
  755.   
  756.  
  757.   
  758.     <span class="summary_desc"><div class='inline'>
  759. <p>Creates a new depot in the system.</p>
  760. </div></span>
  761.   
  762. </li>
  763.  
  764.       
  765.         <li class="public ">
  766.   <span class="summary_signature">
  767.     
  768.       <a href="#create_group-instance_method" title="#create_group (instance method)">- (Object) <strong>create_group</strong>(group) </a>
  769.     
  770.  
  771.     
  772.   </span>
  773.   
  774.   
  775.   
  776.   
  777.   
  778.   
  779.   
  780.  
  781.   
  782.     <span class="summary_desc"><div class='inline'>
  783. <p>Creates a new group in the system.</p>
  784. </div></span>
  785.   
  786. </li>
  787.  
  788.       
  789.         <li class="public ">
  790.   <span class="summary_signature">
  791.     
  792.       <a href="#create_helix_sync_client-instance_method" title="#create_helix_sync_client (instance method)">- (Object) <strong>create_helix_sync_client</strong>(project_id, device, root) </a>
  793.     
  794.  
  795.     
  796.   </span>
  797.   
  798.   
  799.   
  800.   
  801.   
  802.   
  803.   
  804.  
  805.   
  806.     <span class="summary_desc"><div class='inline'>
  807. <p>Create a new client workspace specification for a Helix Sync project.</p>
  808. </div></span>
  809.   
  810. </li>
  811.  
  812.       
  813.         <li class="public ">
  814.   <span class="summary_signature">
  815.     
  816.       <a href="#create_helix_sync_pending_changelist-instance_method" title="#create_helix_sync_pending_changelist (instance method)">- (Object) <strong>create_helix_sync_pending_changelist</strong>(project_id) </a>
  817.     
  818.  
  819.     
  820.   </span>
  821.   
  822.   
  823.   
  824.   
  825.   
  826.   
  827.   
  828.  
  829.   
  830.     <span class="summary_desc"><div class='inline'>
  831. <p>Get a pending changelist number for the Helix Sync project.</p>
  832. </div></span>
  833.   
  834. </li>
  835.  
  836.       
  837.         <li class="public ">
  838.   <span class="summary_signature">
  839.     
  840.       <a href="#create_job-instance_method" title="#create_job (instance method)">- (Object) <strong>create_job</strong>(job) </a>
  841.     
  842.  
  843.     
  844.   </span>
  845.   
  846.   
  847.   
  848.   
  849.   
  850.   
  851.   
  852.  
  853.   
  854.     <span class="summary_desc"><div class='inline'>
  855. <p>Creates a new job in the system.</p>
  856. </div></span>
  857.   
  858. </li>
  859.  
  860.       
  861.         <li class="public ">
  862.   <span class="summary_signature">
  863.     
  864.       <a href="#create_label-instance_method" title="#create_label (instance method)">- (Object) <strong>create_label</strong>(label) </a>
  865.     
  866.  
  867.     
  868.   </span>
  869.   
  870.   
  871.   
  872.   
  873.   
  874.   
  875.   
  876.  
  877.   
  878.     <span class="summary_desc"><div class='inline'>
  879. <p>Creates a new label in the system.</p>
  880. </div></span>
  881.   
  882. </li>
  883.  
  884.       
  885.         <li class="public ">
  886.   <span class="summary_signature">
  887.     
  888.       <a href="#create_server-instance_method" title="#create_server (instance method)">- (Object) <strong>create_server</strong>(server) </a>
  889.     
  890.  
  891.     
  892.   </span>
  893.   
  894.   
  895.   
  896.   
  897.   
  898.   
  899.   
  900.  
  901.   
  902.     <span class="summary_desc"><div class='inline'>
  903. <p>Creates a new server in the system based on the Server instance.</p>
  904. </div></span>
  905.   
  906. </li>
  907.  
  908.       
  909.         <li class="public ">
  910.   <span class="summary_signature">
  911.     
  912.       <a href="#create_stream-instance_method" title="#create_stream (instance method)">- (Object) <strong>create_stream</strong>(stream) </a>
  913.     
  914.  
  915.     
  916.   </span>
  917.   
  918.   
  919.   
  920.   
  921.   
  922.   
  923.   
  924.  
  925.   
  926.     <span class="summary_desc"><div class='inline'>
  927. <p>Creates a new stream in the system based on the Stream instance.</p>
  928. </div></span>
  929.   
  930. </li>
  931.  
  932.       
  933.         <li class="public ">
  934.   <span class="summary_signature">
  935.     
  936.       <a href="#create_user-instance_method" title="#create_user (instance method)">- (Object) <strong>create_user</strong>(user) </a>
  937.     
  938.  
  939.     
  940.   </span>
  941.   
  942.   
  943.   
  944.   
  945.   
  946.   
  947.   
  948.  
  949.   
  950.     <span class="summary_desc"><div class='inline'>
  951. <p>Creates a new user in the system based on the User instance.</p>
  952. </div></span>
  953.   
  954. </li>
  955.  
  956.       
  957.         <li class="public ">
  958.   <span class="summary_signature">
  959.     
  960.       <a href="#delete_branch-instance_method" title="#delete_branch (instance method)">- (Object) <strong>delete_branch</strong>(branch) </a>
  961.     
  962.  
  963.     
  964.   </span>
  965.   
  966.   
  967.   
  968.   
  969.   
  970.   
  971.   
  972.  
  973.   
  974.     <span class="summary_desc"><div class='inline'>
  975. <p>Deletes the branch specification in the system.</p>
  976. </div></span>
  977.   
  978. </li>
  979.  
  980.       
  981.         <li class="public ">
  982.   <span class="summary_signature">
  983.     
  984.       <a href="#delete_client-instance_method" title="#delete_client (instance method)">- (Object) <strong>delete_client</strong>(client) </a>
  985.     
  986.  
  987.     
  988.   </span>
  989.   
  990.   
  991.   
  992.   
  993.   
  994.   
  995.   
  996.  
  997.   
  998.     <span class="summary_desc"><div class='inline'>
  999. <p>Deletes the client specification in the system.</p>
  1000. </div></span>
  1001.   
  1002. </li>
  1003.  
  1004.       
  1005.         <li class="public ">
  1006.   <span class="summary_signature">
  1007.     
  1008.       <a href="#delete_counter-instance_method" title="#delete_counter (instance method)">- (Object) <strong>delete_counter</strong>(counter) </a>
  1009.     
  1010.  
  1011.     
  1012.   </span>
  1013.   
  1014.   
  1015.   
  1016.   
  1017.   
  1018.   
  1019.   
  1020.  
  1021.   
  1022.     <span class="summary_desc"><div class='inline'>
  1023. <p>Delete the counter.</p>
  1024. </div></span>
  1025.   
  1026. </li>
  1027.  
  1028.       
  1029.         <li class="public ">
  1030.   <span class="summary_signature">
  1031.     
  1032.       <a href="#delete_depot-instance_method" title="#delete_depot (instance method)">- (Object) <strong>delete_depot</strong>(depot) </a>
  1033.     
  1034.  
  1035.     
  1036.   </span>
  1037.   
  1038.   
  1039.   
  1040.   
  1041.   
  1042.   
  1043.   
  1044.  
  1045.   
  1046.     <span class="summary_desc"><div class='inline'>
  1047. <p>Deletes the depot specification in the system.</p>
  1048. </div></span>
  1049.   
  1050. </li>
  1051.  
  1052.       
  1053.         <li class="public ">
  1054.   <span class="summary_signature">
  1055.     
  1056.       <a href="#delete_file-instance_method" title="#delete_file (instance method)">- (Object) <strong>delete_file</strong>(path) </a>
  1057.     
  1058.  
  1059.     
  1060.   </span>
  1061.   
  1062.   
  1063.   
  1064.   
  1065.   
  1066.   
  1067.   
  1068.  
  1069.   
  1070.     <span class="summary_desc"><div class='inline'></div></span>
  1071.   
  1072. </li>
  1073.  
  1074.       
  1075.         <li class="public ">
  1076.   <span class="summary_signature">
  1077.     
  1078.       <a href="#delete_group-instance_method" title="#delete_group (instance method)">- (Object) <strong>delete_group</strong>(group) </a>
  1079.     
  1080.  
  1081.     
  1082.   </span>
  1083.   
  1084.   
  1085.   
  1086.   
  1087.   
  1088.   
  1089.   
  1090.  
  1091.   
  1092.     <span class="summary_desc"><div class='inline'>
  1093. <p>Deletes the group specification in the system.</p>
  1094. </div></span>
  1095.   
  1096. </li>
  1097.  
  1098.       
  1099.         <li class="public ">
  1100.   <span class="summary_signature">
  1101.     
  1102.       <a href="#delete_job-instance_method" title="#delete_job (instance method)">- (Object) <strong>delete_job</strong>(job_id) </a>
  1103.     
  1104.  
  1105.     
  1106.   </span>
  1107.   
  1108.   
  1109.   
  1110.   
  1111.   
  1112.   
  1113.   
  1114.  
  1115.   
  1116.     <span class="summary_desc"><div class='inline'>
  1117. <p>Deletes the job specification in the system.</p>
  1118. </div></span>
  1119.   
  1120. </li>
  1121.  
  1122.       
  1123.         <li class="public ">
  1124.   <span class="summary_signature">
  1125.     
  1126.       <a href="#delete_label-instance_method" title="#delete_label (instance method)">- (Object) <strong>delete_label</strong>(label) </a>
  1127.     
  1128.  
  1129.     
  1130.   </span>
  1131.   
  1132.   
  1133.   
  1134.   
  1135.   
  1136.   
  1137.   
  1138.  
  1139.   
  1140.     <span class="summary_desc"><div class='inline'>
  1141. <p>Deletes the label specification in the system.</p>
  1142. </div></span>
  1143.   
  1144. </li>
  1145.  
  1146.       
  1147.         <li class="public ">
  1148.   <span class="summary_signature">
  1149.     
  1150.       <a href="#delete_server-instance_method" title="#delete_server (instance method)">- (Object) <strong>delete_server</strong>(server) </a>
  1151.     
  1152.  
  1153.     
  1154.   </span>
  1155.   
  1156.   
  1157.   
  1158.   
  1159.   
  1160.   
  1161.   
  1162.  
  1163.   
  1164.     <span class="summary_desc"><div class='inline'></div></span>
  1165.   
  1166. </li>
  1167.  
  1168.       
  1169.         <li class="public ">
  1170.   <span class="summary_signature">
  1171.     
  1172.       <a href="#delete_stream-instance_method" title="#delete_stream (instance method)">- (Object) <strong>delete_stream</strong>(stream) </a>
  1173.     
  1174.  
  1175.     
  1176.   </span>
  1177.   
  1178.   
  1179.   
  1180.   
  1181.   
  1182.   
  1183.   
  1184.  
  1185.   
  1186.     <span class="summary_desc"><div class='inline'></div></span>
  1187.   
  1188. </li>
  1189.  
  1190.       
  1191.         <li class="public ">
  1192.   <span class="summary_signature">
  1193.     
  1194.       <a href="#delete_user-instance_method" title="#delete_user (instance method)">- (Object) <strong>delete_user</strong>(user) </a>
  1195.     
  1196.  
  1197.     
  1198.   </span>
  1199.   
  1200.   
  1201.   
  1202.   
  1203.   
  1204.   
  1205.   
  1206.  
  1207.   
  1208.     <span class="summary_desc"><div class='inline'></div></span>
  1209.   
  1210. </li>
  1211.  
  1212.       
  1213.         <li class="public ">
  1214.   <span class="summary_signature">
  1215.     
  1216.       <a href="#depot-instance_method" title="#depot (instance method)">- (Object) <strong>depot</strong>(depot) </a>
  1217.     
  1218.  
  1219.     
  1220.   </span>
  1221.   
  1222.   
  1223.   
  1224.   
  1225.   
  1226.   
  1227.   
  1228.  
  1229.   
  1230.     <span class="summary_desc"><div class='inline'>
  1231. <p>Returns the depot instance indicated by the depot name (or depot object).</p>
  1232. </div></span>
  1233.   
  1234. </li>
  1235.  
  1236.       
  1237.         <li class="public ">
  1238.   <span class="summary_signature">
  1239.     
  1240.       <a href="#depots-instance_method" title="#depots (instance method)">- (Object) <strong>depots</strong> </a>
  1241.     
  1242.  
  1243.     
  1244.   </span>
  1245.   
  1246.   
  1247.   
  1248.   
  1249.   
  1250.   
  1251.   
  1252.  
  1253.   
  1254.     <span class="summary_desc"><div class='inline'>
  1255. <p>Array of Depot objects stored in the system.</p>
  1256. </div></span>
  1257.   
  1258. </li>
  1259.  
  1260.       
  1261.         <li class="public ">
  1262.   <span class="summary_signature">
  1263.     
  1264.       <a href="#execute_method_no_body-instance_method" title="#execute_method_no_body (instance method)">- (Object) <strong>execute_method_no_body</strong>(method, path, params = nil) </a>
  1265.     
  1266.  
  1267.     
  1268.   </span>
  1269.   
  1270.   
  1271.   
  1272.   
  1273.   
  1274.   
  1275.   
  1276.  
  1277.   
  1278.     <span class="summary_desc"><div class='inline'>
  1279. <p>Runs the method against Helix Web Services, checks for errors, then parses
  1280. the JSON response.</p>
  1281. </div></span>
  1282.   
  1283. </li>
  1284.  
  1285.       
  1286.         <li class="public ">
  1287.   <span class="summary_signature">
  1288.     
  1289.       <a href="#execute_method_with_body-instance_method" title="#execute_method_with_body (instance method)">- (Object) <strong>execute_method_with_body</strong>(method, path, params = nil, body = nil) </a>
  1290.     
  1291.  
  1292.     
  1293.   </span>
  1294.   
  1295.   
  1296.   
  1297.   
  1298.   
  1299.   
  1300.   
  1301.  
  1302.   
  1303.     <span class="summary_desc"><div class='inline'>
  1304. <p>Runs the method against Helix Web Services, checks for errors, then parses
  1305. the JSON response.</p>
  1306. </div></span>
  1307.   
  1308. </li>
  1309.  
  1310.       
  1311.         <li class="public ">
  1312.   <span class="summary_signature">
  1313.     
  1314.       <a href="#fetch_helix_sync_latest_changelist-instance_method" title="#fetch_helix_sync_latest_changelist (instance method)">- (Object) <strong>fetch_helix_sync_latest_changelist</strong>(project_id) </a>
  1315.     
  1316.  
  1317.     
  1318.   </span>
  1319.   
  1320.   
  1321.   
  1322.   
  1323.   
  1324.   
  1325.   
  1326.  
  1327.   
  1328.     <span class="summary_desc"><div class='inline'>
  1329. <p>Retrieve the latest changelist.</p>
  1330. </div></span>
  1331.   
  1332. </li>
  1333.  
  1334.       
  1335.         <li class="public ">
  1336.   <span class="summary_signature">
  1337.     
  1338.       <a href="#fetch_helix_sync_pending_changelist-instance_method" title="#fetch_helix_sync_pending_changelist (instance method)">- (Object) <strong>fetch_helix_sync_pending_changelist</strong>(project_id) </a>
  1339.     
  1340.  
  1341.     
  1342.   </span>
  1343.   
  1344.   
  1345.   
  1346.   
  1347.   
  1348.   
  1349.   
  1350.  
  1351.   
  1352.     <span class="summary_desc"><div class='inline'>
  1353. <p>Retrieve the pending changelist.</p>
  1354. </div></span>
  1355.   
  1356. </li>
  1357.  
  1358.       
  1359.         <li class="public ">
  1360.   <span class="summary_signature">
  1361.     
  1362.       <a href="#file-instance_method" title="#file (instance method)">- (Object) <strong>file</strong>(path) </a>
  1363.     
  1364.  
  1365.     
  1366.   </span>
  1367.   
  1368.   
  1369.   
  1370.   
  1371.   
  1372.   
  1373.   
  1374.  
  1375.   
  1376.     <span class="summary_desc"><div class='inline'>
  1377. <p>Returns the file metadata at this location, with the <code>content</code>
  1378. field filled out.</p>
  1379. </div></span>
  1380.   
  1381. </li>
  1382.  
  1383.       
  1384.         <li class="public ">
  1385.   <span class="summary_signature">
  1386.     
  1387.       <a href="#files-instance_method" title="#files (instance method)">- (Object) <strong>files</strong>(path = &#39;&#39;) </a>
  1388.     
  1389.  
  1390.     
  1391.   </span>
  1392.   
  1393.   
  1394.   
  1395.   
  1396.   
  1397.   
  1398.   
  1399.  
  1400.   
  1401.     <span class="summary_desc"><div class='inline'>
  1402. <p>General file browsing method.</p>
  1403. </div></span>
  1404.   
  1405. </li>
  1406.  
  1407.       
  1408.         <li class="public ">
  1409.   <span class="summary_signature">
  1410.     
  1411.       <a href="#group-instance_method" title="#group (instance method)">- (Object) <strong>group</strong>(group) </a>
  1412.     
  1413.  
  1414.     
  1415.   </span>
  1416.   
  1417.   
  1418.   
  1419.   
  1420.   
  1421.   
  1422.   
  1423.  
  1424.   
  1425.     <span class="summary_desc"><div class='inline'>
  1426. <p>Returns the group instance indicated by the group name (or group object).</p>
  1427. </div></span>
  1428.   
  1429. </li>
  1430.  
  1431.       
  1432.         <li class="public ">
  1433.   <span class="summary_signature">
  1434.     
  1435.       <a href="#groups-instance_method" title="#groups (instance method)">- (Object) <strong>groups</strong> </a>
  1436.     
  1437.  
  1438.     
  1439.   </span>
  1440.   
  1441.   
  1442.   
  1443.   
  1444.   
  1445.   
  1446.   
  1447.  
  1448.   
  1449.     <span class="summary_desc"><div class='inline'>
  1450. <p>Array of Group objects stored in the system.</p>
  1451. </div></span>
  1452.   
  1453. </li>
  1454.  
  1455.       
  1456.         <li class="public ">
  1457.   <span class="summary_signature">
  1458.     
  1459.       <a href="#hve_path-instance_method" title="#hve_path (instance method)">- (Object) <strong>hve_path</strong>(subpath) </a>
  1460.     
  1461.  
  1462.     
  1463.   </span>
  1464.   
  1465.   
  1466.   
  1467.   
  1468.   
  1469.   
  1470.   
  1471.  
  1472.   
  1473.     <span class="summary_desc"><div class='inline'></div></span>
  1474.   
  1475. </li>
  1476.  
  1477.       
  1478.         <li class="public ">
  1479.   <span class="summary_signature">
  1480.     
  1481.       <a href="#increment_counter-instance_method" title="#increment_counter (instance method)">- (Object) <strong>increment_counter</strong>(counter) </a>
  1482.     
  1483.  
  1484.     
  1485.   </span>
  1486.   
  1487.   
  1488.   
  1489.   
  1490.   
  1491.   
  1492.   
  1493.  
  1494.   
  1495.     <span class="summary_desc"><div class='inline'>
  1496. <p>Increment the value of a numerical counter.</p>
  1497. </div></span>
  1498.   
  1499. </li>
  1500.  
  1501.       
  1502.         <li class="public ">
  1503.   <span class="summary_signature">
  1504.     
  1505.       <a href="#initialize-instance_method" title="#initialize (instance method)">- (HelixWebServicesClient) <strong>initialize</strong>(options) </a>
  1506.     
  1507.  
  1508.     
  1509.   </span>
  1510.   
  1511.   
  1512.     <span class="note title constructor">constructor</span>
  1513.   
  1514.   
  1515.   
  1516.   
  1517.   
  1518.   
  1519.  
  1520.   
  1521.     <span class="summary_desc"><div class='inline'>
  1522. <p>Client initialization can handle ensuring a valid security token to the
  1523. server.</p>
  1524. </div></span>
  1525.   
  1526. </li>
  1527.  
  1528.       
  1529.         <li class="public ">
  1530.   <span class="summary_signature">
  1531.     
  1532.       <a href="#job-instance_method" title="#job (instance method)">- (Object) <strong>job</strong>(job_id) </a>
  1533.     
  1534.  
  1535.     
  1536.   </span>
  1537.   
  1538.   
  1539.   
  1540.   
  1541.   
  1542.   
  1543.   
  1544.  
  1545.   
  1546.     <span class="summary_desc"><div class='inline'>
  1547. <p>Returns the array of jobs in the system.</p>
  1548. </div></span>
  1549.   
  1550. </li>
  1551.  
  1552.       
  1553.         <li class="public ">
  1554.   <span class="summary_signature">
  1555.     
  1556.       <a href="#jobs-instance_method" title="#jobs (instance method)">- (Object) <strong>jobs</strong> </a>
  1557.     
  1558.  
  1559.     
  1560.   </span>
  1561.   
  1562.   
  1563.   
  1564.   
  1565.   
  1566.   
  1567.   
  1568.  
  1569.   
  1570.     <span class="summary_desc"><div class='inline'></div></span>
  1571.   
  1572. </li>
  1573.  
  1574.       
  1575.         <li class="public ">
  1576.   <span class="summary_signature">
  1577.     
  1578.       <a href="#label-instance_method" title="#label (instance method)">- (Object) <strong>label</strong>(label) </a>
  1579.     
  1580.  
  1581.     
  1582.   </span>
  1583.   
  1584.   
  1585.   
  1586.   
  1587.   
  1588.   
  1589.   
  1590.  
  1591.   
  1592.     <span class="summary_desc"><div class='inline'>
  1593. <p>Returns the label instance indicated by the label name (or label object).</p>
  1594. </div></span>
  1595.   
  1596. </li>
  1597.  
  1598.       
  1599.         <li class="public ">
  1600.   <span class="summary_signature">
  1601.     
  1602.       <a href="#labels-instance_method" title="#labels (instance method)">- (Object) <strong>labels</strong> </a>
  1603.     
  1604.  
  1605.     
  1606.   </span>
  1607.   
  1608.   
  1609.   
  1610.   
  1611.   
  1612.   
  1613.   
  1614.  
  1615.   
  1616.     <span class="summary_desc"><div class='inline'>
  1617. <p>Array of Label objects stored in the system.</p>
  1618. </div></span>
  1619.   
  1620. </li>
  1621.  
  1622.       
  1623.         <li class="public ">
  1624.   <span class="summary_signature">
  1625.     
  1626.       <a href="#login-instance_method" title="#login (instance method)">- (Object) <strong>login</strong>(user, password) </a>
  1627.     
  1628.  
  1629.     
  1630.   </span>
  1631.   
  1632.   
  1633.   
  1634.   
  1635.   
  1636.   
  1637.   
  1638.  
  1639.   
  1640.     <span class="summary_desc"><div class='inline'>
  1641. <p>Generates a host unlocked ticket for the user.</p>
  1642. </div></span>
  1643.   
  1644. </li>
  1645.  
  1646.       
  1647.         <li class="public ">
  1648.   <span class="summary_signature">
  1649.     
  1650.       <a href="#p4_ticket%3F-instance_method" title="#p4_ticket? (instance method)">- (Boolean) <strong>p4_ticket?</strong>(str) </a>
  1651.     
  1652.  
  1653.     
  1654.   </span>
  1655.   
  1656.   
  1657.   
  1658.   
  1659.   
  1660.   
  1661.   
  1662.  
  1663.   
  1664.     <span class="summary_desc"><div class='inline'></div></span>
  1665.   
  1666. </li>
  1667.  
  1668.       
  1669.         <li class="public ">
  1670.   <span class="summary_signature">
  1671.     
  1672.       <a href="#path_for-instance_method" title="#path_for (instance method)">- (Object) <strong>path_for</strong>(subpath) </a>
  1673.     
  1674.  
  1675.     
  1676.   </span>
  1677.   
  1678.   
  1679.   
  1680.   
  1681.   
  1682.   
  1683.   
  1684.  
  1685.   
  1686.     <span class="summary_desc"><div class='inline'>
  1687. <p>Basically just prepends the prefix to our subpath, typically,
  1688. &#39;/p4&#39;.</p>
  1689. </div></span>
  1690.   
  1691. </li>
  1692.  
  1693.       
  1694.         <li class="public ">
  1695.   <span class="summary_signature">
  1696.     
  1697.       <a href="#project-instance_method" title="#project (instance method)">- (Object) <strong>project</strong>(project_id) </a>
  1698.     
  1699.  
  1700.     
  1701.   </span>
  1702.   
  1703.   
  1704.   
  1705.   
  1706.   
  1707.   
  1708.   
  1709.  
  1710.   
  1711.     <span class="summary_desc"><div class='inline'>
  1712. <p>Return the project details.</p>
  1713. </div></span>
  1714.   
  1715. </li>
  1716.  
  1717.       
  1718.         <li class="public ">
  1719.   <span class="summary_signature">
  1720.     
  1721.       <a href="#projects-instance_method" title="#projects (instance method)">- (Object) <strong>projects</strong>(details: nil, extension: nil) </a>
  1722.     
  1723.  
  1724.     
  1725.   </span>
  1726.   
  1727.   
  1728.   
  1729.   
  1730.   
  1731.   
  1732.   
  1733.  
  1734.   
  1735.     <span class="summary_desc"><div class='inline'>
  1736. <p>Lists the projects available on the server for the user.</p>
  1737. </div></span>
  1738.   
  1739. </li>
  1740.  
  1741.       
  1742.         <li class="public ">
  1743.   <span class="summary_signature">
  1744.     
  1745.       <a href="#protections-instance_method" title="#protections (instance method)">- (Object) <strong>protections</strong> </a>
  1746.     
  1747.  
  1748.     
  1749.   </span>
  1750.   
  1751.   
  1752.   
  1753.   
  1754.   
  1755.   
  1756.   
  1757.  
  1758.   
  1759.     <span class="summary_desc"><div class='inline'>
  1760. <p>Fetch all protections in the system.</p>
  1761. </div></span>
  1762.   
  1763. </li>
  1764.  
  1765.       
  1766.         <li class="public ">
  1767.   <span class="summary_signature">
  1768.     
  1769.       <a href="#remove_setting-instance_method" title="#remove_setting (instance method)">- (Object) <strong>remove_setting</strong>(key) </a>
  1770.     
  1771.  
  1772.     
  1773.   </span>
  1774.   
  1775.   
  1776.   
  1777.   
  1778.   
  1779.   
  1780.   
  1781.  
  1782.   
  1783.     <span class="summary_desc"><div class='inline'>
  1784. <p>Remove a setting added via add_setting.</p>
  1785. </div></span>
  1786.   
  1787. </li>
  1788.  
  1789.       
  1790.         <li class="public ">
  1791.   <span class="summary_signature">
  1792.     
  1793.       <a href="#run_method_no_body-instance_method" title="#run_method_no_body (instance method)">- (Object) <strong>run_method_no_body</strong>(method, path, params = nil) </a>
  1794.     
  1795.  
  1796.     
  1797.   </span>
  1798.   
  1799.   
  1800.   
  1801.   
  1802.   
  1803.   
  1804.   
  1805.  
  1806.   
  1807.     <span class="summary_desc"><div class='inline'></div></span>
  1808.   
  1809. </li>
  1810.  
  1811.       
  1812.         <li class="public ">
  1813.   <span class="summary_signature">
  1814.     
  1815.       <a href="#run_method_with_body-instance_method" title="#run_method_with_body (instance method)">- (Object) <strong>run_method_with_body</strong>(method, path, params = nil, body = nil) </a>
  1816.     
  1817.  
  1818.     
  1819.   </span>
  1820.   
  1821.   
  1822.   
  1823.   
  1824.   
  1825.   
  1826.   
  1827.  
  1828.   
  1829.     <span class="summary_desc"><div class='inline'></div></span>
  1830.   
  1831. </li>
  1832.  
  1833.       
  1834.         <li class="public ">
  1835.   <span class="summary_signature">
  1836.     
  1837.       <a href="#server-instance_method" title="#server (instance method)">- (Object) <strong>server</strong>(server) </a>
  1838.     
  1839.  
  1840.     
  1841.   </span>
  1842.   
  1843.   
  1844.   
  1845.   
  1846.   
  1847.   
  1848.   
  1849.  
  1850.   
  1851.     <span class="summary_desc"><div class='inline'>
  1852. <p>Returns a HelixWebServicesClient::OpenModel for the login.</p>
  1853. </div></span>
  1854.   
  1855. </li>
  1856.  
  1857.       
  1858.         <li class="public ">
  1859.   <span class="summary_signature">
  1860.     
  1861.       <a href="#servers-instance_method" title="#servers (instance method)">- (Object) <strong>servers</strong> </a>
  1862.     
  1863.  
  1864.     
  1865.   </span>
  1866.   
  1867.   
  1868.   
  1869.   
  1870.   
  1871.   
  1872.   
  1873.  
  1874.   
  1875.     <span class="summary_desc"><div class='inline'>
  1876. <p>Returns an array of Server objects representing people in the system.</p>
  1877. </div></span>
  1878.   
  1879. </li>
  1880.  
  1881.       
  1882.         <li class="public ">
  1883.   <span class="summary_signature">
  1884.     
  1885.       <a href="#services-instance_method" title="#services (instance method)">- (Object) <strong>services</strong> </a>
  1886.     
  1887.  
  1888.     
  1889.   </span>
  1890.   
  1891.   
  1892.   
  1893.   
  1894.   
  1895.   
  1896.   
  1897.  
  1898.   
  1899.     <span class="summary_desc"><div class='inline'>
  1900. <p>Returns an array of all service definitions in the system.</p>
  1901. </div></span>
  1902.   
  1903. </li>
  1904.  
  1905.       
  1906.         <li class="public ">
  1907.   <span class="summary_signature">
  1908.     
  1909.       <a href="#set_auth-instance_method" title="#set_auth (instance method)">- (Object) <strong>set_auth</strong>(user, token) </a>
  1910.     
  1911.  
  1912.     
  1913.   </span>
  1914.   
  1915.   
  1916.   
  1917.   
  1918.   
  1919.   
  1920.   
  1921.  
  1922.   
  1923.     <span class="summary_desc"><div class='inline'>
  1924. <p>Note: this class is really just common implementation.</p>
  1925. </div></span>
  1926.   
  1927. </li>
  1928.  
  1929.       
  1930.         <li class="public ">
  1931.   <span class="summary_signature">
  1932.     
  1933.       <a href="#set_counter-instance_method" title="#set_counter (instance method)">- (Object) <strong>set_counter</strong>(counter) </a>
  1934.     
  1935.  
  1936.     
  1937.   </span>
  1938.   
  1939.   
  1940.   
  1941.   
  1942.   
  1943.   
  1944.   
  1945.  
  1946.   
  1947.     <span class="summary_desc"><div class='inline'>
  1948. <p>Set the counter value.</p>
  1949. </div></span>
  1950.   
  1951. </li>
  1952.  
  1953.       
  1954.         <li class="public ">
  1955.   <span class="summary_signature">
  1956.     
  1957.       <a href="#stream-instance_method" title="#stream (instance method)">- (Object) <strong>stream</strong>(stream) </a>
  1958.     
  1959.  
  1960.     
  1961.   </span>
  1962.   
  1963.   
  1964.   
  1965.   
  1966.   
  1967.   
  1968.   
  1969.  
  1970.   
  1971.     <span class="summary_desc"><div class='inline'>
  1972. <p>Fetch single stream details.</p>
  1973. </div></span>
  1974.   
  1975. </li>
  1976.  
  1977.       
  1978.         <li class="public ">
  1979.   <span class="summary_signature">
  1980.     
  1981.       <a href="#streams-instance_method" title="#streams (instance method)">- (Object) <strong>streams</strong> </a>
  1982.     
  1983.  
  1984.     
  1985.   </span>
  1986.   
  1987.   
  1988.   
  1989.   
  1990.   
  1991.   
  1992.   
  1993.  
  1994.   
  1995.     <span class="summary_desc"><div class='inline'>
  1996. <p>Returns an array of Stream objects representing people in the system.</p>
  1997. </div></span>
  1998.   
  1999. </li>
  2000.  
  2001.       
  2002.         <li class="public ">
  2003.   <span class="summary_signature">
  2004.     
  2005.       <a href="#submit_helix_sync_pending_change-instance_method" title="#submit_helix_sync_pending_change (instance method)">- (Object) <strong>submit_helix_sync_pending_change</strong>(project_id) </a>
  2006.     
  2007.  
  2008.     
  2009.   </span>
  2010.   
  2011.   
  2012.   
  2013.   
  2014.   
  2015.   
  2016.   
  2017.  
  2018.   
  2019.     <span class="summary_desc"><div class='inline'>
  2020. <p>Submits the pending changelist for the helix sync project.</p>
  2021. </div></span>
  2022.   
  2023. </li>
  2024.  
  2025.       
  2026.         <li class="public ">
  2027.   <span class="summary_signature">
  2028.     
  2029.       <a href="#triggers-instance_method" title="#triggers (instance method)">- (OpenModel) <strong>triggers</strong> </a>
  2030.     
  2031.  
  2032.     
  2033.   </span>
  2034.   
  2035.   
  2036.   
  2037.   
  2038.   
  2039.   
  2040.   
  2041.  
  2042.   
  2043.     <span class="summary_desc"><div class='inline'>
  2044. <p>Fetch the list of trigger lines in the system.</p>
  2045. </div></span>
  2046.   
  2047. </li>
  2048.  
  2049.       
  2050.         <li class="public ">
  2051.   <span class="summary_signature">
  2052.     
  2053.       <a href="#update_branch-instance_method" title="#update_branch (instance method)">- (Object) <strong>update_branch</strong>(branch) </a>
  2054.     
  2055.  
  2056.     
  2057.   </span>
  2058.   
  2059.   
  2060.   
  2061.   
  2062.   
  2063.   
  2064.   
  2065.  
  2066.   
  2067.     <span class="summary_desc"><div class='inline'>
  2068. <p>Updates the branch specification.</p>
  2069. </div></span>
  2070.   
  2071. </li>
  2072.  
  2073.       
  2074.         <li class="public ">
  2075.   <span class="summary_signature">
  2076.     
  2077.       <a href="#update_client-instance_method" title="#update_client (instance method)">- (Object) <strong>update_client</strong>(client) </a>
  2078.     
  2079.  
  2080.     
  2081.   </span>
  2082.   
  2083.   
  2084.   
  2085.   
  2086.   
  2087.   
  2088.   
  2089.  
  2090.   
  2091.     <span class="summary_desc"><div class='inline'>
  2092. <p>Updates the client specification.</p>
  2093. </div></span>
  2094.   
  2095. </li>
  2096.  
  2097.       
  2098.         <li class="public ">
  2099.   <span class="summary_signature">
  2100.     
  2101.       <a href="#update_depot-instance_method" title="#update_depot (instance method)">- (Object) <strong>update_depot</strong>(depot) </a>
  2102.     
  2103.  
  2104.     
  2105.   </span>
  2106.   
  2107.   
  2108.   
  2109.   
  2110.   
  2111.   
  2112.   
  2113.  
  2114.   
  2115.     <span class="summary_desc"><div class='inline'>
  2116. <p>Updates the depot specification.</p>
  2117. </div></span>
  2118.   
  2119. </li>
  2120.  
  2121.       
  2122.         <li class="public ">
  2123.   <span class="summary_signature">
  2124.     
  2125.       <a href="#update_group-instance_method" title="#update_group (instance method)">- (Object) <strong>update_group</strong>(group) </a>
  2126.     
  2127.  
  2128.     
  2129.   </span>
  2130.   
  2131.   
  2132.   
  2133.   
  2134.   
  2135.   
  2136.   
  2137.  
  2138.   
  2139.     <span class="summary_desc"><div class='inline'>
  2140. <p>Updates the group specification.</p>
  2141. </div></span>
  2142.   
  2143. </li>
  2144.  
  2145.       
  2146.         <li class="public ">
  2147.   <span class="summary_signature">
  2148.     
  2149.       <a href="#update_job-instance_method" title="#update_job (instance method)">- (Object) <strong>update_job</strong>(job) </a>
  2150.     
  2151.  
  2152.     
  2153.   </span>
  2154.   
  2155.   
  2156.   
  2157.   
  2158.   
  2159.   
  2160.   
  2161.  
  2162.   
  2163.     <span class="summary_desc"><div class='inline'>
  2164. <p>Updates the job specification.</p>
  2165. </div></span>
  2166.   
  2167. </li>
  2168.  
  2169.       
  2170.         <li class="public ">
  2171.   <span class="summary_signature">
  2172.     
  2173.       <a href="#update_label-instance_method" title="#update_label (instance method)">- (Object) <strong>update_label</strong>(label) </a>
  2174.     
  2175.  
  2176.     
  2177.   </span>
  2178.   
  2179.   
  2180.   
  2181.   
  2182.   
  2183.   
  2184.   
  2185.  
  2186.   
  2187.     <span class="summary_desc"><div class='inline'>
  2188. <p>Updates the label specification.</p>
  2189. </div></span>
  2190.   
  2191. </li>
  2192.  
  2193.       
  2194.         <li class="public ">
  2195.   <span class="summary_signature">
  2196.     
  2197.       <a href="#update_protections-instance_method" title="#update_protections (instance method)">- (Object) <strong>update_protections</strong>(protections) </a>
  2198.     
  2199.  
  2200.     
  2201.   </span>
  2202.   
  2203.   
  2204.   
  2205.   
  2206.   
  2207.   
  2208.   
  2209.  
  2210.   
  2211.     <span class="summary_desc"><div class='inline'>
  2212. <p>Updates the protections table based on the Protections instance passed in.</p>
  2213. </div></span>
  2214.   
  2215. </li>
  2216.  
  2217.       
  2218.         <li class="public ">
  2219.   <span class="summary_signature">
  2220.     
  2221.       <a href="#update_server-instance_method" title="#update_server (instance method)">- (Object) <strong>update_server</strong>(server) </a>
  2222.     
  2223.  
  2224.     
  2225.   </span>
  2226.   
  2227.   
  2228.   
  2229.   
  2230.   
  2231.   
  2232.   
  2233.  
  2234.   
  2235.     <span class="summary_desc"><div class='inline'></div></span>
  2236.   
  2237. </li>
  2238.  
  2239.       
  2240.         <li class="public ">
  2241.   <span class="summary_signature">
  2242.     
  2243.       <a href="#update_stream-instance_method" title="#update_stream (instance method)">- (Object) <strong>update_stream</strong>(stream) </a>
  2244.     
  2245.  
  2246.     
  2247.   </span>
  2248.   
  2249.   
  2250.   
  2251.   
  2252.   
  2253.   
  2254.   
  2255.  
  2256.   
  2257.     <span class="summary_desc"><div class='inline'></div></span>
  2258.   
  2259. </li>
  2260.  
  2261.       
  2262.         <li class="public ">
  2263.   <span class="summary_signature">
  2264.     
  2265.       <a href="#update_triggers-instance_method" title="#update_triggers (instance method)">- (Object) <strong>update_triggers</strong>(triggers) </a>
  2266.     
  2267.  
  2268.     
  2269.   </span>
  2270.   
  2271.   
  2272.   
  2273.   
  2274.   
  2275.   
  2276.   
  2277.  
  2278.   
  2279.     <span class="summary_desc"><div class='inline'>
  2280. <p>Update the triggers table using the Triggers model instance.</p>
  2281. </div></span>
  2282.   
  2283. </li>
  2284.  
  2285.       
  2286.         <li class="public ">
  2287.   <span class="summary_signature">
  2288.     
  2289.       <a href="#update_user-instance_method" title="#update_user (instance method)">- (Object) <strong>update_user</strong>(user) </a>
  2290.     
  2291.  
  2292.     
  2293.   </span>
  2294.   
  2295.   
  2296.   
  2297.   
  2298.   
  2299.   
  2300.   
  2301.  
  2302.   
  2303.     <span class="summary_desc"><div class='inline'></div></span>
  2304.   
  2305. </li>
  2306.  
  2307.       
  2308.         <li class="public ">
  2309.   <span class="summary_signature">
  2310.     
  2311.       <a href="#upload_file-instance_method" title="#upload_file (instance method)">- (Object) <strong>upload_file</strong>(file) </a>
  2312.     
  2313.  
  2314.     
  2315.   </span>
  2316.   
  2317.   
  2318.   
  2319.   
  2320.   
  2321.   
  2322.   
  2323.  
  2324.   
  2325.     <span class="summary_desc"><div class='inline'>
  2326. <p>Upload a single file&#39;s content.</p>
  2327. </div></span>
  2328.   
  2329. </li>
  2330.  
  2331.       
  2332.         <li class="public ">
  2333.   <span class="summary_signature">
  2334.     
  2335.       <a href="#upload_files-instance_method" title="#upload_files (instance method)">- (Object) <strong>upload_files</strong>(files: [], path: nil, description: nil) </a>
  2336.     
  2337.  
  2338.     
  2339.   </span>
  2340.   
  2341.   
  2342.   
  2343.   
  2344.   
  2345.   
  2346.   
  2347.  
  2348.   
  2349.     <span class="summary_desc"><div class='inline'>
  2350. <p>Upload multiple files.</p>
  2351. </div></span>
  2352.   
  2353. </li>
  2354.  
  2355.       
  2356.         <li class="public ">
  2357.   <span class="summary_signature">
  2358.     
  2359.       <a href="#user_details-instance_method" title="#user_details (instance method)">- (Object) <strong>user_details</strong>(user) </a>
  2360.     
  2361.  
  2362.     
  2363.   </span>
  2364.   
  2365.   
  2366.   
  2367.   
  2368.   
  2369.   
  2370.   
  2371.  
  2372.   
  2373.     <span class="summary_desc"><div class='inline'>
  2374. <p>Returns a HelixWebServicesClient::OpenModel for the login.</p>
  2375. </div></span>
  2376.   
  2377. </li>
  2378.  
  2379.       
  2380.         <li class="public ">
  2381.   <span class="summary_signature">
  2382.     
  2383.       <a href="#users-instance_method" title="#users (instance method)">- (Object) <strong>users</strong> </a>
  2384.     
  2385.  
  2386.     
  2387.   </span>
  2388.   
  2389.   
  2390.   
  2391.   
  2392.   
  2393.   
  2394.   
  2395.  
  2396.   
  2397.     <span class="summary_desc"><div class='inline'>
  2398. <p>Returns an array of User objects representing people in the system.</p>
  2399. </div></span>
  2400.   
  2401. </li>
  2402.  
  2403.       
  2404.         <li class="public ">
  2405.   <span class="summary_signature">
  2406.     
  2407.       <a href="#version-instance_method" title="#version (instance method)">- (Object) <strong>version</strong> </a>
  2408.     
  2409.  
  2410.     
  2411.   </span>
  2412.   
  2413.   
  2414.   
  2415.   
  2416.   
  2417.   
  2418.   
  2419.  
  2420.   
  2421.     <span class="summary_desc"><div class='inline'>
  2422. <p>Return the product version ID of the Helix Web Services instance.</p>
  2423. </div></span>
  2424.   
  2425. </li>
  2426.  
  2427.       
  2428.     </ul>
  2429.   
  2430.  
  2431. <div id="constructor_details" class="method_details_list">
  2432.   <h2>Constructor Details</h2>
  2433.   
  2434.     <div class="method_details first">
  2435.   <h3 class="signature first" id="initialize-instance_method">
  2436.   
  2437.     - (<tt><span class='object_link'><a href="" title="HelixWebServicesClient (class)">HelixWebServicesClient</a></span></tt>) <strong>initialize</strong>(options) 
  2438.   
  2439.  
  2440.   
  2441.  
  2442.   
  2443. </h3><div class="docstring">
  2444.   <div class="discussion">
  2445.     
  2446. <p>Client initialization can handle ensuring a valid security token to the
  2447. server.</p>
  2448.  
  2449. <p>Any client created via new should take care to call <code>close()</code>.</p>
  2450.  
  2451. <h2 id="label-Available+Options">Available Options</h2>
  2452.  
  2453. <p>These options are used to configure the underlying Faraday connection:</p>
  2454. <ul><li>
  2455. <p><code>:url</code> - String base URL.</p>
  2456. </li><li>
  2457. <p><code>:params</code> - Hash of URI query unencoded key/value pairs.</p>
  2458. </li><li>
  2459. <p><code>:header</code> - Hash of unencoded HTTP header key/value pairs.</p>
  2460. </li><li>
  2461. <p><code>:request</code> - Hash of request options.</p>
  2462. </li><li>
  2463. <p><code>:ssl</code> - Hash of SSL options.</p>
  2464. </li><li>
  2465. <p><code>:proxy</code> - Hash of Proxy options.</p>
  2466. </li></ul>
  2467.  
  2468. <p>These options are specific to Helix Web Services:</p>
  2469. <ul><li>
  2470. <p><code>:user</code> - The Helix Versioning Engine login</p>
  2471. </li><li>
  2472. <p><code>:password</code> - If set, we will generate a ticket using this
  2473. password during initialization</p>
  2474. </li><li>
  2475. <p><code>:ticket</code> - If not nil, we will use this ticket as our
  2476. authentication password</p>
  2477. </li><li>
  2478. <p><code>:debug</code> - Add response logging if set to true</p>
  2479. </li></ul>
  2480.  
  2481.  
  2482.   </div>
  2483. </div>
  2484. <div class="tags">
  2485.   <p class="tag_title">Parameters:</p>
  2486. <ul class="param">
  2487.   
  2488.     <li>
  2489.       
  2490.         <span class='name'>options</span>
  2491.       
  2492.       
  2493.         <span class='type'>(<tt>Hash</tt>)</span>
  2494.       
  2495.       
  2496.       
  2497.         &mdash;
  2498.         <div class='inline'>
  2499. <p>See the section available options above</p>
  2500. </div>
  2501.       
  2502.     </li>
  2503.   
  2504. </ul>
  2505.  
  2506.  
  2507. </div><table class="source_code">
  2508.   <tr>
  2509.     <td>
  2510.       <pre class="lines">
  2511.  
  2512.  
  2513. 56
  2514. 57
  2515. 58
  2516. 59
  2517. 60
  2518. 61
  2519. 62
  2520. 63
  2521. 64
  2522. 65
  2523. 66
  2524. 67
  2525. 68
  2526. 69
  2527. 70
  2528. 71
  2529. 72
  2530. 73
  2531. 74
  2532. 75
  2533. 76
  2534. 77
  2535. 78
  2536. 79
  2537. 80
  2538. 81
  2539. 82
  2540. 83
  2541. 84
  2542. 85
  2543. 86
  2544. 87
  2545. 88
  2546. 89
  2547. 90
  2548. 91
  2549. 92</pre>
  2550.     </td>
  2551.     <td>
  2552.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 56</span>
  2553.  
  2554. <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
  2555.   <span class='ivar'>@api_level</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:api_level</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:api_level</span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>78</span><span class='tstring_end'>&#39;</span></span>
  2556.  
  2557.   <span class='comment'># Filter out options we pass to Faraday
  2558. </span>  <span class='id identifier rubyid_faraday_options'>faraday_options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='op'>|</span> <span class='op'>!</span><span class='const'>INITIALIZE_LOCAL_OPTIONS</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  2559.  
  2560.   <span class='ivar'>@conn</span> <span class='op'>=</span> <span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_faraday_options'>faraday_options</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_conn'>conn</span><span class='op'>|</span>
  2561.     <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span> <span class='symbol'>:multipart</span>
  2562.     <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span> <span class='symbol'>:url_encoded</span>
  2563.     <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='symbol'>:logger</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:debug</span><span class='rbracket'>]</span>
  2564.     <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span> <span class='symbol'>:net_http</span>
  2565.   <span class='kw'>end</span>
  2566.  
  2567.   <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:url</span><span class='rparen'>)</span>
  2568.     <span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='const'>URI</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:url</span><span class='rbracket'>]</span><span class='rparen'>)</span>
  2569.     <span class='ivar'>@prefix</span> <span class='op'>=</span> <span class='id identifier rubyid_url'>url</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span> <span class='op'>?</span> <span class='id identifier rubyid_url'>url</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
  2570.   <span class='kw'>end</span>
  2571.  
  2572.   <span class='ivar'>@user</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:user</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:user</span><span class='rparen'>)</span>
  2573.  
  2574.   <span class='ivar'>@ticket</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:ticket</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:ticket</span><span class='rparen'>)</span>
  2575.  
  2576.   <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:settings</span><span class='rparen'>)</span>
  2577.     <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:settings</span><span class='rbracket'>]</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_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
  2578.       <span class='id identifier rubyid_add_setting'>add_setting</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
  2579.     <span class='kw'>end</span>
  2580.   <span class='kw'>end</span>
  2581.  
  2582.   <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:password</span><span class='rparen'>)</span> <span class='kw'>and</span> <span class='ivar'>@user</span>
  2583.     <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='ivar'>@conn</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path_for'>path_for</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/auth/v1/login</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  2584.                           <span class='label'>user:</span> <span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='label'>password:</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:password</span><span class='rbracket'>]</span><span class='rparen'>)</span>
  2585.     <span class='id identifier rubyid_assert_ok'>assert_ok</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
  2586.     <span class='ivar'>@ticket</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
  2587.   <span class='kw'>end</span>
  2588.  
  2589.   <span class='id identifier rubyid_set_auth'>set_auth</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='id identifier rubyid_ticket'>ticket</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
  2590. <span class='kw'>end</span></pre>
  2591.     </td>
  2592.   </tr>
  2593. </table>
  2594. </div>
  2595.   
  2596. </div>
  2597.  
  2598.   <div id="instance_attr_details" class="attr_details">
  2599.     <h2>Instance Attribute Details</h2>
  2600.     
  2601.       
  2602.       <span id="api_level=-instance_method"></span>
  2603.       <div class="method_details first">
  2604.   <h3 class="signature first" id="api_level-instance_method">
  2605.   
  2606.     - (<tt>Object</tt>) <strong>api_level</strong> 
  2607.   
  2608.  
  2609.   
  2610.  
  2611.   
  2612. </h3><div class="docstring">
  2613.   <div class="discussion">
  2614.     
  2615. <p>The API level to use. Defaults to 78 (2015.1)</p>
  2616.  
  2617.  
  2618.   </div>
  2619. </div>
  2620. <div class="tags">
  2621.   
  2622.  
  2623. </div><table class="source_code">
  2624.   <tr>
  2625.     <td>
  2626.       <pre class="lines">
  2627.  
  2628.  
  2629. 26
  2630. 27
  2631. 28</pre>
  2632.     </td>
  2633.     <td>
  2634.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 26</span>
  2635.  
  2636. <span class='kw'>def</span> <span class='id identifier rubyid_api_level'>api_level</span>
  2637.   <span class='ivar'>@api_level</span>
  2638. <span class='kw'>end</span></pre>
  2639.     </td>
  2640.   </tr>
  2641. </table>
  2642. </div>
  2643.     
  2644.       
  2645.       <span id="prefix=-instance_method"></span>
  2646.       <div class="method_details ">
  2647.   <h3 class="signature " id="prefix-instance_method">
  2648.   
  2649.     - (<tt>Object</tt>) <strong>prefix</strong> 
  2650.   
  2651.  
  2652.   
  2653.  
  2654.   
  2655. </h3><div class="docstring">
  2656.   <div class="discussion">
  2657.     
  2658. <p>Typically, Helix Web Services is mounted under /hws behind a reverse proxy.
  2659. If a path is specified in the originating URL, we save the prefix here, and
  2660. preprend it to every request.</p>
  2661.  
  2662.  
  2663.   </div>
  2664. </div>
  2665. <div class="tags">
  2666.   
  2667.  
  2668. </div><table class="source_code">
  2669.   <tr>
  2670.     <td>
  2671.       <pre class="lines">
  2672.  
  2673.  
  2674. 23
  2675. 24
  2676. 25</pre>
  2677.     </td>
  2678.     <td>
  2679.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 23</span>
  2680.  
  2681. <span class='kw'>def</span> <span class='id identifier rubyid_prefix'>prefix</span>
  2682.   <span class='ivar'>@prefix</span>
  2683. <span class='kw'>end</span></pre>
  2684.     </td>
  2685.   </tr>
  2686. </table>
  2687. </div>
  2688.     
  2689.       
  2690.       <span id="ticket=-instance_method"></span>
  2691.       <div class="method_details ">
  2692.   <h3 class="signature " id="ticket-instance_method">
  2693.   
  2694.     - (<tt>Object</tt>) <strong>ticket</strong> 
  2695.   
  2696.  
  2697.   
  2698.  
  2699.   
  2700. </h3><div class="docstring">
  2701.   <div class="discussion">
  2702.     
  2703. <p>Upon successful login, we store the P4 ticket return value here.</p>
  2704.  
  2705.  
  2706.   </div>
  2707. </div>
  2708. <div class="tags">
  2709.   
  2710.  
  2711. </div><table class="source_code">
  2712.   <tr>
  2713.     <td>
  2714.       <pre class="lines">
  2715.  
  2716.  
  2717. 18
  2718. 19
  2719. 20</pre>
  2720.     </td>
  2721.     <td>
  2722.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 18</span>
  2723.  
  2724. <span class='kw'>def</span> <span class='id identifier rubyid_ticket'>ticket</span>
  2725.   <span class='ivar'>@ticket</span>
  2726. <span class='kw'>end</span></pre>
  2727.     </td>
  2728.   </tr>
  2729. </table>
  2730. </div>
  2731.     
  2732.       
  2733.       <span id="user=-instance_method"></span>
  2734.       <div class="method_details ">
  2735.   <h3 class="signature " id="user-instance_method">
  2736.   
  2737.     - (<tt>Object</tt>) <strong>user</strong> 
  2738.   
  2739.  
  2740.   
  2741.  
  2742.   
  2743. </h3><div class="docstring">
  2744.   <div class="discussion">
  2745.     
  2746. <p>The Helix Versioning Engine login</p>
  2747.  
  2748.  
  2749.   </div>
  2750. </div>
  2751. <div class="tags">
  2752.   
  2753.  
  2754. </div><table class="source_code">
  2755.   <tr>
  2756.     <td>
  2757.       <pre class="lines">
  2758.  
  2759.  
  2760. 15
  2761. 16
  2762. 17</pre>
  2763.     </td>
  2764.     <td>
  2765.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 15</span>
  2766.  
  2767. <span class='kw'>def</span> <span class='id identifier rubyid_user'>user</span>
  2768.   <span class='ivar'>@user</span>
  2769. <span class='kw'>end</span></pre>
  2770.     </td>
  2771.   </tr>
  2772. </table>
  2773. </div>
  2774.     
  2775.   </div>
  2776.  
  2777.  
  2778.   <div id="class_method_details" class="method_details_list">
  2779.     <h2>Class Method Details</h2>
  2780.  
  2781.     
  2782.       <div class="method_details first">
  2783.   <h3 class="signature first" id="open-class_method">
  2784.   
  2785.     + (<tt>Object</tt>) <strong>open</strong>(connection) 
  2786.   
  2787.  
  2788.   
  2789.  
  2790.   
  2791. </h3><div class="docstring">
  2792.   <div class="discussion">
  2793.     
  2794. <p>Provides standard I/O style interface, where when called in a block, will
  2795. automatically close() the client when done. Otherwise, your code should
  2796. call client.close() manually.</p>
  2797.  
  2798.  
  2799.   </div>
  2800. </div>
  2801. <div class="tags">
  2802.   
  2803.  
  2804. </div><table class="source_code">
  2805.   <tr>
  2806.     <td>
  2807.       <pre class="lines">
  2808.  
  2809.  
  2810. 119
  2811. 120
  2812. 121
  2813. 122
  2814. 123
  2815. 124
  2816. 125
  2817. 126
  2818. 127
  2819. 128
  2820. 129</pre>
  2821.     </td>
  2822.     <td>
  2823.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 119</span>
  2824.  
  2825. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_connection'>connection</span><span class='rparen'>)</span>
  2826.   <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_connection'>connection</span><span class='rparen'>)</span>
  2827.  
  2828.   <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
  2829.     <span class='kw'>yield</span> <span class='id identifier rubyid_client'>client</span>
  2830.   <span class='kw'>else</span>
  2831.     <span class='kw'>return</span> <span class='id identifier rubyid_client'>client</span>
  2832.   <span class='kw'>end</span>
  2833. <span class='kw'>ensure</span>
  2834.   <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_client'>client</span>
  2835. <span class='kw'>end</span></pre>
  2836.     </td>
  2837.   </tr>
  2838. </table>
  2839. </div>
  2840.     
  2841.   </div>
  2842.  
  2843.   <div id="instance_method_details" class="method_details_list">
  2844.     <h2>Instance Method Details</h2>
  2845.  
  2846.     
  2847.       <div class="method_details first">
  2848.   <h3 class="signature first" id="add_setting-instance_method">
  2849.   
  2850.     - (<tt>Object</tt>) <strong>add_setting</strong>(key, value) 
  2851.   
  2852.  
  2853.   
  2854.  
  2855.   
  2856. </h3><div class="docstring">
  2857.   <div class="discussion">
  2858.     
  2859. <p>Set an override for all requests.</p>
  2860.  
  2861. <p>See “configuration” in HWS documentation.</p>
  2862.  
  2863. <p>This will automatically add the right prefix for overriding an HWS setting.</p>
  2864.  
  2865.  
  2866.   </div>
  2867. </div>
  2868. <div class="tags">
  2869.   <p class="tag_title">Parameters:</p>
  2870. <ul class="param">
  2871.   
  2872.     <li>
  2873.       
  2874.         <span class='name'>key</span>
  2875.       
  2876.       
  2877.         <span class='type'>(<tt>String</tt>)</span>
  2878.       
  2879.       
  2880.       
  2881.         &mdash;
  2882.         <div class='inline'>
  2883. <p>The setting value as indicated in documentation, e.g., <code>P4PORT</code></p>
  2884. </div>
  2885.       
  2886.     </li>
  2887.   
  2888.     <li>
  2889.       
  2890.         <span class='name'>value</span>
  2891.       
  2892.       
  2893.         <span class='type'>(<tt>String</tt>)</span>
  2894.       
  2895.       
  2896.       
  2897.         &mdash;
  2898.         <div class='inline'>
  2899. <p>The value to set</p>
  2900. </div>
  2901.       
  2902.     </li>
  2903.   
  2904. </ul>
  2905.  
  2906.  
  2907. </div><table class="source_code">
  2908.   <tr>
  2909.     <td>
  2910.       <pre class="lines">
  2911.  
  2912.  
  2913. 105
  2914. 106
  2915. 107
  2916. 108
  2917. 109</pre>
  2918.     </td>
  2919.     <td>
  2920.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 105</span>
  2921.  
  2922. <span class='kw'>def</span> <span class='id identifier rubyid_add_setting'>add_setting</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
  2923.   <span class='comment'># Note: Rack will automatically convert all hyphens to underscores...
  2924. </span>  <span class='comment'># but Nginx will (by default) block all underscores. Find a happy middle.
  2925. </span>  <span class='ivar'>@conn</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>X-Perforce-Helix-Web-Services-</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>_</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>-</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
  2926. <span class='kw'>end</span></pre>
  2927.     </td>
  2928.   </tr>
  2929. </table>
  2930. </div>
  2931.     
  2932.       <div class="method_details ">
  2933.   <h3 class="signature " id="arg_params-instance_method">
  2934.   
  2935.     - (<tt>Object</tt>) <strong>arg_params</strong>(arg_values) 
  2936.   
  2937.  
  2938.   
  2939.  
  2940.   
  2941. </h3><div class="docstring">
  2942.   <div class="discussion">
  2943.     
  2944. <p>Creates a hash and creates keys &#39;arg1&#39;, &#39;arg2&#39;, etc that
  2945. points to the values in the arg_values array. This is basically only used
  2946. by the run methods</p>
  2947.  
  2948.  
  2949.   </div>
  2950. </div>
  2951. <div class="tags">
  2952.   
  2953.  
  2954. </div><table class="source_code">
  2955.   <tr>
  2956.     <td>
  2957.       <pre class="lines">
  2958.  
  2959.  
  2960. 45
  2961. 46
  2962. 47
  2963. 48
  2964. 49</pre>
  2965.     </td>
  2966.     <td>
  2967.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/commands.rb', line 45</span>
  2968.  
  2969. <span class='kw'>def</span> <span class='id identifier rubyid_arg_params'>arg_params</span><span class='lparen'>(</span><span class='id identifier rubyid_arg_values'>arg_values</span><span class='rparen'>)</span>
  2970.   <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
  2971.   <span class='id identifier rubyid_arg_values'>arg_values</span><span class='period'>.</span><span class='id identifier rubyid_each_index'>each_index</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_ii'>ii</span><span class='op'>|</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>arg</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ii'>ii</span> <span class='op'>+</span> <span class='int'>1</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_arg_values'>arg_values</span><span class='lbracket'>[</span><span class='id identifier rubyid_ii'>ii</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
  2972.   <span class='id identifier rubyid_params'>params</span>
  2973. <span class='kw'>end</span></pre>
  2974.     </td>
  2975.   </tr>
  2976. </table>
  2977. </div>
  2978.     
  2979.       <div class="method_details ">
  2980.   <h3 class="signature " id="assert_ok-instance_method">
  2981.   
  2982.     - (<tt>Object</tt>) <strong>assert_ok</strong>(response) 
  2983.   
  2984.  
  2985.   
  2986.  
  2987.   
  2988. </h3><div class="docstring">
  2989.   <div class="discussion">
  2990.     
  2991. <p>Raises an error when the response is not 200. Some errors may have
  2992. diagnostic information in the response body, so we pass that on as well</p>
  2993.  
  2994.  
  2995.   </div>
  2996. </div>
  2997. <div class="tags">
  2998.   
  2999.  
  3000. </div><table class="source_code">
  3001.   <tr>
  3002.     <td>
  3003.       <pre class="lines">
  3004.  
  3005.  
  3006. 208
  3007. 209
  3008. 210
  3009. 211
  3010. 212
  3011. 213
  3012. 214
  3013. 215
  3014. 216
  3015. 217
  3016. 218
  3017. 219
  3018. 220
  3019. 221
  3020. 222
  3021. 223
  3022. 224
  3023. 225
  3024. 226</pre>
  3025.     </td>
  3026.     <td>
  3027.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 208</span>
  3028.  
  3029. <span class='kw'>def</span> <span class='id identifier rubyid_assert_ok'>assert_ok</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
  3030.   <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>&gt;=</span> <span class='int'>400</span>
  3031.   <span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>==</span> <span class='int'>403</span>
  3032.     <span class='id identifier rubyid_fail'>fail</span> <span class='const'>Errors</span><span class='op'>::</span><span class='const'>Unauthenticated</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Illegal login or password</span><span class='tstring_end'>&#39;</span></span>
  3033.   <span class='kw'>elsif</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>==</span> <span class='int'>404</span>
  3034.     <span class='id identifier rubyid_fail'>fail</span> <span class='const'>Errors</span><span class='op'>::</span><span class='const'>ResourceNotFound</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Required resource not found</span><span class='tstring_end'>&#39;</span></span>
  3035.   <span class='kw'>elsif</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>==</span> <span class='int'>500</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
  3036.     <span class='id identifier rubyid_messages'>messages</span> <span class='op'>=</span> <span class='kw'>nil</span>
  3037.     <span class='kw'>begin</span>
  3038.       <span class='id identifier rubyid_messages'>messages</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='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
  3039.     <span class='kw'>rescue</span> <span class='const'>Exception</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
  3040.       <span class='id identifier rubyid_messages'>messages</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
  3041.     <span class='kw'>end</span>
  3042.     <span class='id identifier rubyid_fail'>fail</span> <span class='const'>Errors</span><span class='op'>::</span><span class='const'>PerforceProblem</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_messages'>messages</span><span class='rparen'>)</span><span class='comma'>,</span>
  3043.          <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Unknown issue from the Perforce server</span><span class='tstring_end'>&#39;</span></span>
  3044.   <span class='kw'>else</span>
  3045.     <span class='id identifier rubyid_fail'>fail</span> <span class='const'>Errors</span><span class='op'>::</span><span class='const'>ServerError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown problem. Response code: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  3046.   <span class='kw'>end</span>
  3047. <span class='kw'>end</span></pre>
  3048.     </td>
  3049.   </tr>
  3050. </table>
  3051. </div>
  3052.     
  3053.       <div class="method_details ">
  3054.   <h3 class="signature " id="branch-instance_method">
  3055.   
  3056.     - (<tt>Object</tt>) <strong>branch</strong>(branch) 
  3057.   
  3058.  
  3059.   
  3060.  
  3061.   
  3062. </h3><div class="docstring">
  3063.   <div class="discussion">
  3064.     
  3065. <p>Returns the branch instance indicated by the branch name (or model)</p>
  3066.  
  3067.  
  3068.   </div>
  3069. </div>
  3070. <div class="tags">
  3071.   
  3072.  
  3073. </div><table class="source_code">
  3074.   <tr>
  3075.     <td>
  3076.       <pre class="lines">
  3077.  
  3078.  
  3079. 14
  3080. 15
  3081. 16
  3082. 17
  3083. 18</pre>
  3084.     </td>
  3085.     <td>
  3086.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/branches.rb', line 14</span>
  3087.  
  3088. <span class='kw'>def</span> <span class='id identifier rubyid_branch'>branch</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span>
  3089.   <span class='id identifier rubyid_branch'>branch</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_branch'>branch</span> <span class='kw'>unless</span> <span class='id identifier rubyid_branch'>branch</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
  3090.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>branches/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  3091.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  3092. <span class='kw'>end</span></pre>
  3093.     </td>
  3094.   </tr>
  3095. </table>
  3096. </div>
  3097.     
  3098.       <div class="method_details ">
  3099.   <h3 class="signature " id="branches-instance_method">
  3100.   
  3101.     - (<tt>Object</tt>) <strong>branches</strong> 
  3102.   
  3103.  
  3104.   
  3105.  
  3106.   
  3107. </h3><div class="docstring">
  3108.   <div class="discussion">
  3109.     
  3110. <p>Array of Branch objects stored in the system. Not all fields will be filled
  3111. out (e.g., view).</p>
  3112.  
  3113.  
  3114.   </div>
  3115. </div>
  3116. <div class="tags">
  3117.   
  3118.  
  3119. </div><table class="source_code">
  3120.   <tr>
  3121.     <td>
  3122.       <pre class="lines">
  3123.  
  3124.  
  3125. 8
  3126. 9
  3127. 10
  3128. 11</pre>
  3129.     </td>
  3130.     <td>
  3131.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/branches.rb', line 8</span>
  3132.  
  3133. <span class='kw'>def</span> <span class='id identifier rubyid_branches'>branches</span>
  3134.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>branches</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  3135.   <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_a'>a</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  3136. <span class='kw'>end</span></pre>
  3137.     </td>
  3138.   </tr>
  3139. </table>
  3140. </div>
  3141.     
  3142.       <div class="method_details ">
  3143.   <h3 class="signature " id="change-instance_method">
  3144.   
  3145.     - (<tt>Object</tt>) <strong>change</strong>(change) 
  3146.   
  3147.  
  3148.   
  3149.  
  3150.   
  3151. </h3><div class="docstring">
  3152.   <div class="discussion">
  3153.     
  3154. <p>Returns the Change indicated by the change number or model.</p>
  3155.  
  3156. <p>If there are files submitted with the change, the change.files field should
  3157. be filled out.</p>
  3158.  
  3159.  
  3160.   </div>
  3161. </div>
  3162. <div class="tags">
  3163.   
  3164.  
  3165. </div><table class="source_code">
  3166.   <tr>
  3167.     <td>
  3168.       <pre class="lines">
  3169.  
  3170.  
  3171. 21
  3172. 22
  3173. 23
  3174. 24
  3175. 25</pre>
  3176.     </td>
  3177.     <td>
  3178.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/changes.rb', line 21</span>
  3179.  
  3180. <span class='kw'>def</span> <span class='id identifier rubyid_change'>change</span><span class='lparen'>(</span><span class='id identifier rubyid_change'>change</span><span class='rparen'>)</span>
  3181.   <span class='id identifier rubyid_change_id'>change_id</span> <span class='op'>=</span> <span class='id identifier rubyid_change'>change</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_change'>change</span><span class='period'>.</span><span class='id identifier rubyid_change'>change</span> <span class='op'>:</span> <span class='id identifier rubyid_change'>change</span>
  3182.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>changes/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_change_id'>change_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  3183.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='rparen'>)</span>
  3184. <span class='kw'>end</span></pre>
  3185.     </td>
  3186.   </tr>
  3187. </table>
  3188. </div>
  3189.     
  3190.       <div class="method_details ">
  3191.   <h3 class="signature " id="changes-instance_method">
  3192.   
  3193.     - (<tt>Object</tt>) <strong>changes</strong>(options = nil) 
  3194.   
  3195.  
  3196.   
  3197.  
  3198.   
  3199. </h3><div class="docstring">
  3200.   <div class="discussion">
  3201.     
  3202. <p>List changelists in the system</p>
  3203.  
  3204. <p>options: - :max - cap the number of results - :status - :pending,
  3205. :submitted, or :shelved (see Change) - :user - The perforce login to check
  3206. out - :files - Depot path pattern to restrict changes to</p>
  3207.  
  3208.  
  3209.   </div>
  3210. </div>
  3211. <div class="tags">
  3212.   
  3213.  
  3214. </div><table class="source_code">
  3215.   <tr>
  3216.     <td>
  3217.       <pre class="lines">
  3218.  
  3219.  
  3220. 12
  3221. 13
  3222. 14
  3223. 15</pre>
  3224.     </td>
  3225.     <td>
  3226.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/changes.rb', line 12</span>
  3227.  
  3228. <span class='kw'>def</span> <span class='id identifier rubyid_changes'>changes</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  3229.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>changes</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
  3230.   <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_obj'>obj</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  3231. <span class='kw'>end</span></pre>
  3232.     </td>
  3233.   </tr>
  3234. </table>
  3235. </div>
  3236.     
  3237.       <div class="method_details ">
  3238.   <h3 class="signature " id="client-instance_method">
  3239.   
  3240.     - (<tt>Object</tt>) <strong>client</strong>(client) 
  3241.   
  3242.  
  3243.   
  3244.  
  3245.   
  3246. </h3><div class="docstring">
  3247.   <div class="discussion">
  3248.     
  3249. <p>Returns the client instance indicated by the client name or model</p>
  3250.  
  3251.  
  3252.   </div>
  3253. </div>
  3254. <div class="tags">
  3255.   
  3256.  
  3257. </div><table class="source_code">
  3258.   <tr>
  3259.     <td>
  3260.       <pre class="lines">
  3261.  
  3262.  
  3263. 12
  3264. 13
  3265. 14
  3266. 15
  3267. 16</pre>
  3268.     </td>
  3269.     <td>
  3270.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/clients.rb', line 12</span>
  3271.  
  3272. <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span>
  3273.   <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span> <span class='kw'>unless</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
  3274.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>clients/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  3275.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  3276. <span class='kw'>end</span></pre>
  3277.     </td>
  3278.   </tr>
  3279. </table>
  3280. </div>
  3281.     
  3282.       <div class="method_details ">
  3283.   <h3 class="signature " id="clients-instance_method">
  3284.   
  3285.     - (<tt>Object</tt>) <strong>clients</strong> 
  3286.   
  3287.  
  3288.   
  3289.  
  3290.   
  3291. </h3><div class="docstring">
  3292.   <div class="discussion">
  3293.     
  3294. <p>Array of Client objects stored in the system. Not all fields will be filled
  3295. out (e.g., view).</p>
  3296.  
  3297.  
  3298.   </div>
  3299. </div>
  3300. <div class="tags">
  3301.   
  3302.  
  3303. </div><table class="source_code">
  3304.   <tr>
  3305.     <td>
  3306.       <pre class="lines">
  3307.  
  3308.  
  3309. 6
  3310. 7
  3311. 8
  3312. 9</pre>
  3313.     </td>
  3314.     <td>
  3315.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/clients.rb', line 6</span>
  3316.  
  3317. <span class='kw'>def</span> <span class='id identifier rubyid_clients'>clients</span>
  3318.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>clients</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  3319.   <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_a'>a</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  3320. <span class='kw'>end</span></pre>
  3321.     </td>
  3322.   </tr>
  3323. </table>
  3324. </div>
  3325.     
  3326.       <div class="method_details ">
  3327.   <h3 class="signature " id="close-instance_method">
  3328.   
  3329.     - (<tt>Object</tt>) <strong>close</strong> 
  3330.   
  3331.  
  3332.   
  3333.  
  3334.   
  3335. </h3><table class="source_code">
  3336.   <tr>
  3337.     <td>
  3338.       <pre class="lines">
  3339.  
  3340.  
  3341. 94
  3342. 95</pre>
  3343.     </td>
  3344.     <td>
  3345.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 94</span>
  3346.  
  3347. <span class='kw'>def</span> <span class='id identifier rubyid_close'>close</span>
  3348. <span class='kw'>end</span></pre>
  3349.     </td>
  3350.   </tr>
  3351. </table>
  3352. </div>
  3353.     
  3354.       <div class="method_details ">
  3355.   <h3 class="signature " id="command-instance_method">
  3356.   
  3357.     - (<tt><span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>) <strong>command</strong>(cmd, *args) 
  3358.   
  3359.  
  3360.   
  3361.  
  3362.   
  3363. </h3><div class="docstring">
  3364.   <div class="discussion">
  3365.     
  3366. <p>Execute a Perforce command.</p>
  3367.  
  3368. <p>First argument should always be the command, followed by command line
  3369. arguments.</p>
  3370.  
  3371. <p>Expect to always have an array of hashes as output.</p>
  3372.  
  3373. <p>Not all commands are allowed, since the command will be executed on the web
  3374. server. In general, if your command requires a client workspace, it will
  3375. likely fail, or be blocked.</p>
  3376.  
  3377.  
  3378.   </div>
  3379. </div>
  3380. <div class="tags">
  3381.   
  3382. <p class="tag_title">Returns:</p>
  3383. <ul class="return">
  3384.   
  3385.     <li>
  3386.       
  3387.       
  3388.         <span class='type'>(<tt><span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>)</span>
  3389.       
  3390.       
  3391.       
  3392.         &mdash;
  3393.         <div class='inline'>
  3394. <p>wraps the output in an OpenModel instance</p>
  3395. </div>
  3396.       
  3397.     </li>
  3398.   
  3399. </ul>
  3400.  
  3401. </div><table class="source_code">
  3402.   <tr>
  3403.     <td>
  3404.       <pre class="lines">
  3405.  
  3406.  
  3407. 18
  3408. 19
  3409. 20
  3410. 21
  3411. 22</pre>
  3412.     </td>
  3413.     <td>
  3414.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/commands.rb', line 18</span>
  3415.  
  3416. <span class='kw'>def</span> <span class='id identifier rubyid_command'>command</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
  3417.   <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_arg_params'>arg_params</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
  3418.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>commands/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
  3419.   <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_a'>a</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='kw'>if</span> <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span>
  3420. <span class='kw'>end</span></pre>
  3421.     </td>
  3422.   </tr>
  3423. </table>
  3424. </div>
  3425.     
  3426.       <div class="method_details ">
  3427.   <h3 class="signature " id="command_with_input-instance_method">
  3428.   
  3429.     - (<tt>Object</tt>) <strong>command_with_input</strong>(cmd, input, *args) 
  3430.   
  3431.  
  3432.   
  3433.  
  3434.   
  3435. </h3><div class="docstring">
  3436.   <div class="discussion">
  3437.     
  3438. <p>Generic run command with and input body.</p>
  3439.  
  3440. <p>The first argument is the general command, followed by the input data, then
  3441. followed by additional command line arguments.</p>
  3442.  
  3443. <p>Expect the output to always be an array of hashes.</p>
  3444.  
  3445. <p>Not all commands are allowed, since the command will be executed on the web
  3446. server. In general, if your command requires a client workspace, it will
  3447. likely fail, or be blocked.</p>
  3448.  
  3449.  
  3450.   </div>
  3451. </div>
  3452. <div class="tags">
  3453.   
  3454.  
  3455. </div><table class="source_code">
  3456.   <tr>
  3457.     <td>
  3458.       <pre class="lines">
  3459.  
  3460.  
  3461. 34
  3462. 35
  3463. 36
  3464. 37
  3465. 38
  3466. 39
  3467. 40</pre>
  3468.     </td>
  3469.     <td>
  3470.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/commands.rb', line 34</span>
  3471.  
  3472. <span class='kw'>def</span> <span class='id identifier rubyid_command_with_input'>command_with_input</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='comma'>,</span> <span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
  3473.   <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_arg_params'>arg_params</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
  3474.   <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:cmd</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_cmd'>cmd</span>
  3475.   <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>commands/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  3476.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
  3477.   <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_a'>a</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='kw'>if</span> <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>==</span> <span class='kw'>false</span> <span class='kw'>and</span> <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span>
  3478. <span class='kw'>end</span></pre>
  3479.     </td>
  3480.   </tr>
  3481. </table>
  3482. </div>
  3483.     
  3484.       <div class="method_details ">
  3485.   <h3 class="signature " id="commit_change-instance_method">
  3486.   
  3487.     - (<tt>Object</tt>) <strong>commit_change</strong>(change) 
  3488.   
  3489.  
  3490.   
  3491.  
  3492.   
  3493. </h3><div class="docstring">
  3494.   <div class="discussion">
  3495.     
  3496. <p>Submits the shelved changelist.</p>
  3497.  
  3498. <p>This changelist should be pending, with no open files, and list of shelved
  3499. changes. If you require resolves, this method will fail.</p>
  3500.  
  3501.  
  3502.   </div>
  3503. </div>
  3504. <div class="tags">
  3505.   <p class="tag_title">Parameters:</p>
  3506. <ul class="param">
  3507.   
  3508.     <li>
  3509.       
  3510.         <span class='name'>change</span>
  3511.       
  3512.       
  3513.         <span class='type'>(<tt>String</tt>)</span>
  3514.       
  3515.       
  3516.       
  3517.         &mdash;
  3518.         <div class='inline'>
  3519. <p>The changelist number</p>
  3520. </div>
  3521.       
  3522.     </li>
  3523.   
  3524. </ul>
  3525.  
  3526.  
  3527. </div><table class="source_code">
  3528.   <tr>
  3529.     <td>
  3530.       <pre class="lines">
  3531.  
  3532.  
  3533. 61
  3534. 62
  3535. 63
  3536. 64</pre>
  3537.     </td>
  3538.     <td>
  3539.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/changes.rb', line 61</span>
  3540.  
  3541. <span class='kw'>def</span> <span class='id identifier rubyid_commit_change'>commit_change</span><span class='lparen'>(</span><span class='id identifier rubyid_change'>change</span><span class='rparen'>)</span>
  3542.   <span class='id identifier rubyid_change_id'>change_id</span> <span class='op'>=</span> <span class='id identifier rubyid_change'>change</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_change'>change</span><span class='period'>.</span><span class='id identifier rubyid_change'>change</span> <span class='op'>:</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_change'>change</span><span class='rparen'>)</span>
  3543.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>changes/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_change_id'>change_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  3544. <span class='kw'>end</span></pre>
  3545.     </td>
  3546.   </tr>
  3547. </table>
  3548. </div>
  3549.     
  3550.       <div class="method_details ">
  3551.   <h3 class="signature " id="counter-instance_method">
  3552.   
  3553.     - (<tt>Object</tt>) <strong>counter</strong>(counter) 
  3554.   
  3555.  
  3556.   
  3557.  
  3558.   
  3559. </h3><div class="docstring">
  3560.   <div class="discussion">
  3561.     
  3562. <p>Return the counter hash for a particular counter key.</p>
  3563.  
  3564.  
  3565.   </div>
  3566. </div>
  3567. <div class="tags">
  3568.   <p class="tag_title">Parameters:</p>
  3569. <ul class="param">
  3570.   
  3571.     <li>
  3572.       
  3573.         <span class='name'>counter</span>
  3574.       
  3575.       
  3576.         <span class='type'>(<tt>String</tt>)</span>
  3577.       
  3578.       
  3579.       
  3580.         &mdash;
  3581.         <div class='inline'>
  3582. <p>The counter ID</p>
  3583. </div>
  3584.       
  3585.     </li>
  3586.   
  3587. </ul>
  3588.  
  3589.  
  3590. </div><table class="source_code">
  3591.   <tr>
  3592.     <td>
  3593.       <pre class="lines">
  3594.  
  3595.  
  3596. 14
  3597. 15
  3598. 16
  3599. 17</pre>
  3600.     </td>
  3601.     <td>
  3602.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/counters.rb', line 14</span>
  3603.  
  3604. <span class='kw'>def</span> <span class='id identifier rubyid_counter'>counter</span><span class='lparen'>(</span><span class='id identifier rubyid_counter'>counter</span><span class='rparen'>)</span>
  3605.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>counters/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_counter'>counter</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  3606.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  3607. <span class='kw'>end</span></pre>
  3608.     </td>
  3609.   </tr>
  3610. </table>
  3611. </div>
  3612.     
  3613.       <div class="method_details ">
  3614.   <h3 class="signature " id="counters-instance_method">
  3615.   
  3616.     - (<tt>Object</tt>) <strong>counters</strong> 
  3617.   
  3618.  
  3619.   
  3620.  
  3621.   
  3622. </h3><div class="docstring">
  3623.   <div class="discussion">
  3624.     
  3625. <p>List all counters in the system. Each counter typically has a
  3626. <code>counter</code> and <code>value</code> attribute.</p>
  3627.  
  3628.  
  3629.   </div>
  3630. </div>
  3631. <div class="tags">
  3632.   
  3633.  
  3634. </div><table class="source_code">
  3635.   <tr>
  3636.     <td>
  3637.       <pre class="lines">
  3638.  
  3639.  
  3640. 6
  3641. 7
  3642. 8
  3643. 9</pre>
  3644.     </td>
  3645.     <td>
  3646.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/counters.rb', line 6</span>
  3647.  
  3648. <span class='kw'>def</span> <span class='id identifier rubyid_counters'>counters</span>
  3649.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>counters</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  3650.   <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_a'>a</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  3651. <span class='kw'>end</span></pre>
  3652.     </td>
  3653.   </tr>
  3654. </table>
  3655. </div>
  3656.     
  3657.       <div class="method_details ">
  3658.   <h3 class="signature " id="create_branch-instance_method">
  3659.   
  3660.     - (<tt>Object</tt>) <strong>create_branch</strong>(branch) 
  3661.   
  3662.  
  3663.   
  3664.  
  3665.   
  3666. </h3><div class="docstring">
  3667.   <div class="discussion">
  3668.     
  3669. <p>Creates a new branch in the system.</p>
  3670.  
  3671.  
  3672.   </div>
  3673. </div>
  3674. <div class="tags">
  3675.   
  3676.  
  3677. </div><table class="source_code">
  3678.   <tr>
  3679.     <td>
  3680.       <pre class="lines">
  3681.  
  3682.  
  3683. 21
  3684. 22
  3685. 23
  3686. 24</pre>
  3687.     </td>
  3688.     <td>
  3689.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/branches.rb', line 21</span>
  3690.  
  3691. <span class='kw'>def</span> <span class='id identifier rubyid_create_branch'>create_branch</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span>
  3692.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>branches</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span>
  3693.   <span class='kw'>true</span>
  3694. <span class='kw'>end</span></pre>
  3695.     </td>
  3696.   </tr>
  3697. </table>
  3698. </div>
  3699.     
  3700.       <div class="method_details ">
  3701.   <h3 class="signature " id="create_change-instance_method">
  3702.   
  3703.     - (<tt>Object</tt>) <strong>create_change</strong>(change) 
  3704.   
  3705.  
  3706.   
  3707.  
  3708.   
  3709. </h3><div class="docstring">
  3710.   <div class="discussion">
  3711.     
  3712. <p>Creates a new changelist, that can be used for a few different tasks.</p>
  3713.  
  3714. <p>The change should be a hash with the following top-level keys:</p>
  3715. <ul><li>
  3716. <p><code>Description</code>: The change description (optional)</p>
  3717. </li><li>
  3718. <p><code>Files</code>: An array of Hashes</p>
  3719. </li></ul>
  3720.  
  3721. <p>Each hash in the <code>Files</code> array can contain these keys:</p>
  3722. <ul><li>
  3723. <p><code>DepotFile</code>: The depot path</p>
  3724. </li><li>
  3725. <p><code>Action</code>: One of &#39;upload&#39;, &#39;move&#39;, or
  3726. &#39;branch&#39;</p>
  3727. </li><li>
  3728. <p><code>FromDepotFile</code>: if action is &#39;move&#39; or
  3729. &#39;branch&#39;, the source file</p>
  3730. </li><li>
  3731. <p><code>Content</code>: Base64-encoded file content for &#39;upload&#39;
  3732. actions</p>
  3733. </li><li>
  3734. <p><code>RequireVersion</code>: Optional value for &#39;upload&#39; actions,
  3735. if set, will  fail the upload if the current file version is not  this
  3736. version.</p>
  3737. </li></ul>
  3738.  
  3739.  
  3740.   </div>
  3741. </div>
  3742. <div class="tags">
  3743.   <p class="tag_title">Parameters:</p>
  3744. <ul class="param">
  3745.   
  3746.     <li>
  3747.       
  3748.         <span class='name'>change</span>
  3749.       
  3750.       
  3751.         <span class='type'>(<tt>Hash</tt>)</span>
  3752.       
  3753.       
  3754.       
  3755.         &mdash;
  3756.         <div class='inline'>
  3757. <p>See method description</p>
  3758. </div>
  3759.       
  3760.     </li>
  3761.   
  3762. </ul>
  3763.  
  3764.  
  3765. </div><table class="source_code">
  3766.   <tr>
  3767.     <td>
  3768.       <pre class="lines">
  3769.  
  3770.  
  3771. 50
  3772. 51
  3773. 52
  3774. 53</pre>
  3775.     </td>
  3776.     <td>
  3777.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/changes.rb', line 50</span>
  3778.  
  3779. <span class='kw'>def</span> <span class='id identifier rubyid_create_change'>create_change</span><span class='lparen'>(</span><span class='id identifier rubyid_change'>change</span><span class='rparen'>)</span>
  3780.   <span class='id identifier rubyid_change'>change</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_change'>change</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_change'>change</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  3781.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>changes</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_change'>change</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  3782. <span class='kw'>end</span></pre>
  3783.     </td>
  3784.   </tr>
  3785. </table>
  3786. </div>
  3787.     
  3788.       <div class="method_details ">
  3789.   <h3 class="signature " id="create_client-instance_method">
  3790.   
  3791.     - (<tt>Object</tt>) <strong>create_client</strong>(client) 
  3792.   
  3793.  
  3794.   
  3795.  
  3796.   
  3797. </h3><div class="docstring">
  3798.   <div class="discussion">
  3799.     
  3800. <p>Creates a new client in the system.</p>
  3801.  
  3802.  
  3803.   </div>
  3804. </div>
  3805. <div class="tags">
  3806.   
  3807.  
  3808. </div><table class="source_code">
  3809.   <tr>
  3810.     <td>
  3811.       <pre class="lines">
  3812.  
  3813.  
  3814. 19
  3815. 20
  3816. 21
  3817. 22
  3818. 23</pre>
  3819.     </td>
  3820.     <td>
  3821.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/clients.rb', line 19</span>
  3822.  
  3823. <span class='kw'>def</span> <span class='id identifier rubyid_create_client'>create_client</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span>
  3824.   <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  3825.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>clients</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  3826.   <span class='kw'>true</span>
  3827. <span class='kw'>end</span></pre>
  3828.     </td>
  3829.   </tr>
  3830. </table>
  3831. </div>
  3832.     
  3833.       <div class="method_details ">
  3834.   <h3 class="signature " id="create_depot-instance_method">
  3835.   
  3836.     - (<tt>Object</tt>) <strong>create_depot</strong>(depot) 
  3837.   
  3838.  
  3839.   
  3840.  
  3841.   
  3842. </h3><div class="docstring">
  3843.   <div class="discussion">
  3844.     
  3845. <p>Creates a new depot in the system.</p>
  3846.  
  3847.  
  3848.   </div>
  3849. </div>
  3850. <div class="tags">
  3851.   
  3852.  
  3853. </div><table class="source_code">
  3854.   <tr>
  3855.     <td>
  3856.       <pre class="lines">
  3857.  
  3858.  
  3859. 20
  3860. 21
  3861. 22
  3862. 23</pre>
  3863.     </td>
  3864.     <td>
  3865.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/depots.rb', line 20</span>
  3866.  
  3867. <span class='kw'>def</span> <span class='id identifier rubyid_create_depot'>create_depot</span><span class='lparen'>(</span><span class='id identifier rubyid_depot'>depot</span><span class='rparen'>)</span>
  3868.   <span class='id identifier rubyid_depot'>depot</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_depot'>depot</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_depot'>depot</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  3869.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>depots</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_depot'>depot</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  3870. <span class='kw'>end</span></pre>
  3871.     </td>
  3872.   </tr>
  3873. </table>
  3874. </div>
  3875.     
  3876.       <div class="method_details ">
  3877.   <h3 class="signature " id="create_group-instance_method">
  3878.   
  3879.     - (<tt>Object</tt>) <strong>create_group</strong>(group) 
  3880.   
  3881.  
  3882.   
  3883.  
  3884.   
  3885. </h3><div class="docstring">
  3886.   <div class="discussion">
  3887.     
  3888. <p>Creates a new group in the system.</p>
  3889.  
  3890.  
  3891.   </div>
  3892. </div>
  3893. <div class="tags">
  3894.   
  3895.  
  3896. </div><table class="source_code">
  3897.   <tr>
  3898.     <td>
  3899.       <pre class="lines">
  3900.  
  3901.  
  3902. 20
  3903. 21
  3904. 22
  3905. 23</pre>
  3906.     </td>
  3907.     <td>
  3908.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/groups.rb', line 20</span>
  3909.  
  3910. <span class='kw'>def</span> <span class='id identifier rubyid_create_group'>create_group</span><span class='lparen'>(</span><span class='id identifier rubyid_group'>group</span><span class='rparen'>)</span>
  3911.   <span class='id identifier rubyid_group'>group</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_group'>group</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_group'>group</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  3912.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>groups</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_group'>group</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  3913. <span class='kw'>end</span></pre>
  3914.     </td>
  3915.   </tr>
  3916. </table>
  3917. </div>
  3918.     
  3919.       <div class="method_details ">
  3920.   <h3 class="signature " id="create_helix_sync_client-instance_method">
  3921.   
  3922.     - (<tt>Object</tt>) <strong>create_helix_sync_client</strong>(project_id, device, root) 
  3923.   
  3924.  
  3925.   
  3926.  
  3927.   
  3928. </h3><div class="docstring">
  3929.   <div class="discussion">
  3930.     
  3931. <p>Create a new client workspace specification for a Helix Sync project.</p>
  3932.  
  3933. <p>Returns a simple object with a &#39;client&#39; property.</p>
  3934.  
  3935.  
  3936.   </div>
  3937. </div>
  3938. <div class="tags">
  3939.   
  3940.  
  3941. </div><table class="source_code">
  3942.   <tr>
  3943.     <td>
  3944.       <pre class="lines">
  3945.  
  3946.  
  3947. 8
  3948. 9
  3949. 10
  3950. 11
  3951. 12
  3952. 13
  3953. 14
  3954. 15
  3955. 16</pre>
  3956.     </td>
  3957.     <td>
  3958.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 8</span>
  3959.  
  3960. <span class='kw'>def</span> <span class='id identifier rubyid_create_helix_sync_client'>create_helix_sync_client</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='comma'>,</span> <span class='id identifier rubyid_device'>device</span><span class='comma'>,</span> <span class='id identifier rubyid_root'>root</span><span class='rparen'>)</span>
  3961.   <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span>
  3962.       <span class='label'>project:</span> <span class='id identifier rubyid_project_id'>project_id</span><span class='comma'>,</span>
  3963.       <span class='label'>device:</span> <span class='id identifier rubyid_device'>device</span><span class='comma'>,</span>
  3964.       <span class='label'>root:</span> <span class='id identifier rubyid_root'>root</span>
  3965.   <span class='rbrace'>}</span>
  3966.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/helix_sync/v1/clients</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
  3967.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  3968. <span class='kw'>end</span></pre>
  3969.     </td>
  3970.   </tr>
  3971. </table>
  3972. </div>
  3973.     
  3974.       <div class="method_details ">
  3975.   <h3 class="signature " id="create_helix_sync_pending_changelist-instance_method">
  3976.   
  3977.     - (<tt>Object</tt>) <strong>create_helix_sync_pending_changelist</strong>(project_id) 
  3978.   
  3979.  
  3980.   
  3981.  
  3982.   
  3983. </h3><div class="docstring">
  3984.   <div class="discussion">
  3985.     
  3986. <p>Get a pending changelist number for the Helix Sync project.</p>
  3987.  
  3988. <p>If the changelist already exists, it should just return that.</p>
  3989.  
  3990. <p>IMPORTANT: The changelist should be updated to use your local client. You
  3991. won&#39;t be able to use or submit this changelist.</p>
  3992.  
  3993.  
  3994.   </div>
  3995. </div>
  3996. <div class="tags">
  3997.   <p class="tag_title">Parameters:</p>
  3998. <ul class="param">
  3999.   
  4000.     <li>
  4001.       
  4002.         <span class='name'>project_id</span>
  4003.       
  4004.       
  4005.         <span class='type'>(<tt>String</tt>)</span>
  4006.       
  4007.       
  4008.       
  4009.         &mdash;
  4010.         <div class='inline'>
  4011. <p>The project ID.</p>
  4012. </div>
  4013.       
  4014.     </li>
  4015.   
  4016. </ul>
  4017.  
  4018. <p class="tag_title">Returns:</p>
  4019. <ul class="return">
  4020.   
  4021.     <li>
  4022.       
  4023.       
  4024.         <span class='type'></span>
  4025.       
  4026.       
  4027.       
  4028.         
  4029.         <div class='inline'>
  4030. <p>A hash containing a <code>change</code> field</p>
  4031. </div>
  4032.       
  4033.     </li>
  4034.   
  4035. </ul>
  4036.  
  4037. </div><table class="source_code">
  4038.   <tr>
  4039.     <td>
  4040.       <pre class="lines">
  4041.  
  4042.  
  4043. 27
  4044. 28
  4045. 29
  4046. 30</pre>
  4047.     </td>
  4048.     <td>
  4049.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 27</span>
  4050.  
  4051. <span class='kw'>def</span> <span class='id identifier rubyid_create_helix_sync_pending_changelist'>create_helix_sync_pending_changelist</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span>
  4052.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/helix_sync/v1/changes/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  4053.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  4054. <span class='kw'>end</span></pre>
  4055.     </td>
  4056.   </tr>
  4057. </table>
  4058. </div>
  4059.     
  4060.       <div class="method_details ">
  4061.   <h3 class="signature " id="create_job-instance_method">
  4062.   
  4063.     - (<tt>Object</tt>) <strong>create_job</strong>(job) 
  4064.   
  4065.  
  4066.   
  4067.  
  4068.   
  4069. </h3><div class="docstring">
  4070.   <div class="discussion">
  4071.     
  4072. <p>Creates a new job in the system.</p>
  4073.  
  4074.  
  4075.   </div>
  4076. </div>
  4077. <div class="tags">
  4078.   
  4079.  
  4080. </div><table class="source_code">
  4081.   <tr>
  4082.     <td>
  4083.       <pre class="lines">
  4084.  
  4085.  
  4086. 19
  4087. 20
  4088. 21
  4089. 22
  4090. 23
  4091. 24
  4092. 25</pre>
  4093.     </td>
  4094.     <td>
  4095.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/jobs.rb', line 19</span>
  4096.  
  4097. <span class='kw'>def</span> <span class='id identifier rubyid_create_job'>create_job</span><span class='lparen'>(</span><span class='id identifier rubyid_job'>job</span><span class='rparen'>)</span>
  4098.   <span class='id identifier rubyid_job'>job</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_job'>job</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_job'>job</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  4099.   <span class='id identifier rubyid_job'>job</span><span class='period'>.</span><span class='const'>Job</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>new</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_job'>job</span><span class='period'>.</span><span class='id identifier rubyid_job'>job</span>
  4100.   <span class='id identifier rubyid_job'>job</span><span class='period'>.</span><span class='const'>Status</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>open</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_job'>job</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span>
  4101.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>jobs</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  4102.                            <span class='id identifier rubyid_job'>job</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  4103. <span class='kw'>end</span></pre>
  4104.     </td>
  4105.   </tr>
  4106. </table>
  4107. </div>
  4108.     
  4109.       <div class="method_details ">
  4110.   <h3 class="signature " id="create_label-instance_method">
  4111.   
  4112.     - (<tt>Object</tt>) <strong>create_label</strong>(label) 
  4113.   
  4114.  
  4115.   
  4116.  
  4117.   
  4118. </h3><div class="docstring">
  4119.   <div class="discussion">
  4120.     
  4121. <p>Creates a new label in the system.</p>
  4122.  
  4123.  
  4124.   </div>
  4125. </div>
  4126. <div class="tags">
  4127.   
  4128.  
  4129. </div><table class="source_code">
  4130.   <tr>
  4131.     <td>
  4132.       <pre class="lines">
  4133.  
  4134.  
  4135. 20
  4136. 21
  4137. 22
  4138. 23</pre>
  4139.     </td>
  4140.     <td>
  4141.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/labels.rb', line 20</span>
  4142.  
  4143. <span class='kw'>def</span> <span class='id identifier rubyid_create_label'>create_label</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='rparen'>)</span>
  4144.   <span class='id identifier rubyid_label'>label</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  4145.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>labels</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  4146. <span class='kw'>end</span></pre>
  4147.     </td>
  4148.   </tr>
  4149. </table>
  4150. </div>
  4151.     
  4152.       <div class="method_details ">
  4153.   <h3 class="signature " id="create_server-instance_method">
  4154.   
  4155.     - (<tt>Object</tt>) <strong>create_server</strong>(server) 
  4156.   
  4157.  
  4158.   
  4159.  
  4160.   
  4161. </h3><div class="docstring">
  4162.   <div class="discussion">
  4163.     
  4164. <p>Creates a new server in the system based on the Server instance</p>
  4165.  
  4166.  
  4167.   </div>
  4168. </div>
  4169. <div class="tags">
  4170.   
  4171.  
  4172. </div><table class="source_code">
  4173.   <tr>
  4174.     <td>
  4175.       <pre class="lines">
  4176.  
  4177.  
  4178. 19
  4179. 20
  4180. 21
  4181. 22</pre>
  4182.     </td>
  4183.     <td>
  4184.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/servers.rb', line 19</span>
  4185.  
  4186. <span class='kw'>def</span> <span class='id identifier rubyid_create_server'>create_server</span><span class='lparen'>(</span><span class='id identifier rubyid_server'>server</span><span class='rparen'>)</span>
  4187.   <span class='id identifier rubyid_server'>server</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_server'>server</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  4188.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>servers</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  4189. <span class='kw'>end</span></pre>
  4190.     </td>
  4191.   </tr>
  4192. </table>
  4193. </div>
  4194.     
  4195.       <div class="method_details ">
  4196.   <h3 class="signature " id="create_stream-instance_method">
  4197.   
  4198.     - (<tt>Object</tt>) <strong>create_stream</strong>(stream) 
  4199.   
  4200.  
  4201.   
  4202.  
  4203.   
  4204. </h3><div class="docstring">
  4205.   <div class="discussion">
  4206.     
  4207. <p>Creates a new stream in the system based on the Stream instance</p>
  4208.  
  4209.  
  4210.   </div>
  4211. </div>
  4212. <div class="tags">
  4213.   
  4214.  
  4215. </div><table class="source_code">
  4216.   <tr>
  4217.     <td>
  4218.       <pre class="lines">
  4219.  
  4220.  
  4221. 21
  4222. 22
  4223. 23
  4224. 24</pre>
  4225.     </td>
  4226.     <td>
  4227.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/streams.rb', line 21</span>
  4228.  
  4229. <span class='kw'>def</span> <span class='id identifier rubyid_create_stream'>create_stream</span><span class='lparen'>(</span><span class='id identifier rubyid_stream'>stream</span><span class='rparen'>)</span>
  4230.   <span class='id identifier rubyid_stream'>stream</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_stream'>stream</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_stream'>stream</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  4231.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>streams</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_stream'>stream</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  4232. <span class='kw'>end</span></pre>
  4233.     </td>
  4234.   </tr>
  4235. </table>
  4236. </div>
  4237.     
  4238.       <div class="method_details ">
  4239.   <h3 class="signature " id="create_user-instance_method">
  4240.   
  4241.     - (<tt>Object</tt>) <strong>create_user</strong>(user) 
  4242.   
  4243.  
  4244.   
  4245.  
  4246.   
  4247. </h3><div class="docstring">
  4248.   <div class="discussion">
  4249.     
  4250. <p>Creates a new user in the system based on the User instance</p>
  4251.  
  4252.  
  4253.   </div>
  4254. </div>
  4255. <div class="tags">
  4256.   
  4257.  
  4258. </div><table class="source_code">
  4259.   <tr>
  4260.     <td>
  4261.       <pre class="lines">
  4262.  
  4263.  
  4264. 19
  4265. 20
  4266. 21
  4267. 22</pre>
  4268.     </td>
  4269.     <td>
  4270.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/users.rb', line 19</span>
  4271.  
  4272. <span class='kw'>def</span> <span class='id identifier rubyid_create_user'>create_user</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
  4273.   <span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  4274.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>users</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  4275. <span class='kw'>end</span></pre>
  4276.     </td>
  4277.   </tr>
  4278. </table>
  4279. </div>
  4280.     
  4281.       <div class="method_details ">
  4282.   <h3 class="signature " id="delete_branch-instance_method">
  4283.   
  4284.     - (<tt>Object</tt>) <strong>delete_branch</strong>(branch) 
  4285.   
  4286.  
  4287.   
  4288.  
  4289.   
  4290. </h3><div class="docstring">
  4291.   <div class="discussion">
  4292.     
  4293. <p>Deletes the branch specification in the system.</p>
  4294.  
  4295.  
  4296.   </div>
  4297. </div>
  4298. <div class="tags">
  4299.   
  4300.  
  4301. </div><table class="source_code">
  4302.   <tr>
  4303.     <td>
  4304.       <pre class="lines">
  4305.  
  4306.  
  4307. 35
  4308. 36
  4309. 37
  4310. 38
  4311. 39</pre>
  4312.     </td>
  4313.     <td>
  4314.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/branches.rb', line 35</span>
  4315.  
  4316. <span class='kw'>def</span> <span class='id identifier rubyid_delete_branch'>delete_branch</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span>
  4317.   <span class='id identifier rubyid_branch'>branch</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_branch'>branch</span> <span class='kw'>unless</span> <span class='id identifier rubyid_branch'>branch</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
  4318.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>branches/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  4319.   <span class='kw'>true</span>
  4320. <span class='kw'>end</span></pre>
  4321.     </td>
  4322.   </tr>
  4323. </table>
  4324. </div>
  4325.     
  4326.       <div class="method_details ">
  4327.   <h3 class="signature " id="delete_client-instance_method">
  4328.   
  4329.     - (<tt>Object</tt>) <strong>delete_client</strong>(client) 
  4330.   
  4331.  
  4332.   
  4333.  
  4334.   
  4335. </h3><div class="docstring">
  4336.   <div class="discussion">
  4337.     
  4338. <p>Deletes the client specification in the system.</p>
  4339.  
  4340.  
  4341.   </div>
  4342. </div>
  4343. <div class="tags">
  4344.   
  4345.  
  4346. </div><table class="source_code">
  4347.   <tr>
  4348.     <td>
  4349.       <pre class="lines">
  4350.  
  4351.  
  4352. 34
  4353. 35
  4354. 36
  4355. 37
  4356. 38</pre>
  4357.     </td>
  4358.     <td>
  4359.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/clients.rb', line 34</span>
  4360.  
  4361. <span class='kw'>def</span> <span class='id identifier rubyid_delete_client'>delete_client</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span>
  4362.   <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span> <span class='kw'>unless</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
  4363.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>clients/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  4364.   <span class='kw'>true</span>
  4365. <span class='kw'>end</span></pre>
  4366.     </td>
  4367.   </tr>
  4368. </table>
  4369. </div>
  4370.     
  4371.       <div class="method_details ">
  4372.   <h3 class="signature " id="delete_counter-instance_method">
  4373.   
  4374.     - (<tt>Object</tt>) <strong>delete_counter</strong>(counter) 
  4375.   
  4376.  
  4377.   
  4378.  
  4379.   
  4380. </h3><div class="docstring">
  4381.   <div class="discussion">
  4382.     
  4383. <p>Delete the counter</p>
  4384.  
  4385.  
  4386.   </div>
  4387. </div>
  4388. <div class="tags">
  4389.   <p class="tag_title">Parameters:</p>
  4390. <ul class="param">
  4391.   
  4392.     <li>
  4393.       
  4394.         <span class='name'>counter</span>
  4395.       
  4396.       
  4397.         <span class='type'>(<tt>String</tt>)</span>
  4398.       
  4399.       
  4400.       
  4401.         &mdash;
  4402.         <div class='inline'>
  4403. <p>The counter ID</p>
  4404. </div>
  4405.       
  4406.     </li>
  4407.   
  4408. </ul>
  4409.  
  4410.  
  4411. </div><table class="source_code">
  4412.   <tr>
  4413.     <td>
  4414.       <pre class="lines">
  4415.  
  4416.  
  4417. 37
  4418. 38
  4419. 39</pre>
  4420.     </td>
  4421.     <td>
  4422.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/counters.rb', line 37</span>
  4423.  
  4424. <span class='kw'>def</span> <span class='id identifier rubyid_delete_counter'>delete_counter</span><span class='lparen'>(</span><span class='id identifier rubyid_counter'>counter</span><span class='rparen'>)</span>
  4425.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>counters/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_counter'>counter</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  4426. <span class='kw'>end</span></pre>
  4427.     </td>
  4428.   </tr>
  4429. </table>
  4430. </div>
  4431.     
  4432.       <div class="method_details ">
  4433.   <h3 class="signature " id="delete_depot-instance_method">
  4434.   
  4435.     - (<tt>Object</tt>) <strong>delete_depot</strong>(depot) 
  4436.   
  4437.  
  4438.   
  4439.  
  4440.   
  4441. </h3><div class="docstring">
  4442.   <div class="discussion">
  4443.     
  4444. <p>Deletes the depot specification in the system.</p>
  4445.  
  4446.  
  4447.   </div>
  4448. </div>
  4449. <div class="tags">
  4450.   
  4451.  
  4452. </div><table class="source_code">
  4453.   <tr>
  4454.     <td>
  4455.       <pre class="lines">
  4456.  
  4457.  
  4458. 33
  4459. 34
  4460. 35
  4461. 36</pre>
  4462.     </td>
  4463.     <td>
  4464.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/depots.rb', line 33</span>
  4465.  
  4466. <span class='kw'>def</span> <span class='id identifier rubyid_delete_depot'>delete_depot</span><span class='lparen'>(</span><span class='id identifier rubyid_depot'>depot</span><span class='rparen'>)</span>
  4467.   <span class='id identifier rubyid_depot'>depot</span> <span class='op'>=</span> <span class='id identifier rubyid_depot'>depot</span><span class='period'>.</span><span class='id identifier rubyid_depot'>depot</span> <span class='kw'>if</span> <span class='id identifier rubyid_depot'>depot</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  4468.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>depots/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_depot'>depot</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  4469. <span class='kw'>end</span></pre>
  4470.     </td>
  4471.   </tr>
  4472. </table>
  4473. </div>
  4474.     
  4475.       <div class="method_details ">
  4476.   <h3 class="signature " id="delete_file-instance_method">
  4477.   
  4478.     - (<tt>Object</tt>) <strong>delete_file</strong>(path) 
  4479.   
  4480.  
  4481.   
  4482.  
  4483.   
  4484. </h3><table class="source_code">
  4485.   <tr>
  4486.     <td>
  4487.       <pre class="lines">
  4488.  
  4489.  
  4490. 106
  4491. 107
  4492. 108
  4493. 109</pre>
  4494.     </td>
  4495.     <td>
  4496.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/files.rb', line 106</span>
  4497.  
  4498. <span class='kw'>def</span> <span class='id identifier rubyid_delete_file'>delete_file</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
  4499.   <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_encode_path'>encode_path</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
  4500.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>files/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  4501. <span class='kw'>end</span></pre>
  4502.     </td>
  4503.   </tr>
  4504. </table>
  4505. </div>
  4506.     
  4507.       <div class="method_details ">
  4508.   <h3 class="signature " id="delete_group-instance_method">
  4509.   
  4510.     - (<tt>Object</tt>) <strong>delete_group</strong>(group) 
  4511.   
  4512.  
  4513.   
  4514.  
  4515.   
  4516. </h3><div class="docstring">
  4517.   <div class="discussion">
  4518.     
  4519. <p>Deletes the group specification in the system.</p>
  4520.  
  4521.  
  4522.   </div>
  4523. </div>
  4524. <div class="tags">
  4525.   
  4526.  
  4527. </div><table class="source_code">
  4528.   <tr>
  4529.     <td>
  4530.       <pre class="lines">
  4531.  
  4532.  
  4533. 33
  4534. 34
  4535. 35
  4536. 36</pre>
  4537.     </td>
  4538.     <td>
  4539.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/groups.rb', line 33</span>
  4540.  
  4541. <span class='kw'>def</span> <span class='id identifier rubyid_delete_group'>delete_group</span><span class='lparen'>(</span><span class='id identifier rubyid_group'>group</span><span class='rparen'>)</span>
  4542.   <span class='id identifier rubyid_group'>group</span> <span class='op'>=</span> <span class='id identifier rubyid_group'>group</span><span class='period'>.</span><span class='id identifier rubyid_group'>group</span> <span class='kw'>if</span> <span class='id identifier rubyid_group'>group</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  4543.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>groups/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_group'>group</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  4544. <span class='kw'>end</span></pre>
  4545.     </td>
  4546.   </tr>
  4547. </table>
  4548. </div>
  4549.     
  4550.       <div class="method_details ">
  4551.   <h3 class="signature " id="delete_job-instance_method">
  4552.   
  4553.     - (<tt>Object</tt>) <strong>delete_job</strong>(job_id) 
  4554.   
  4555.  
  4556.   
  4557.  
  4558.   
  4559. </h3><div class="docstring">
  4560.   <div class="discussion">
  4561.     
  4562. <p>Deletes the job specification in the system.</p>
  4563.  
  4564.  
  4565.   </div>
  4566. </div>
  4567. <div class="tags">
  4568.   
  4569.  
  4570. </div><table class="source_code">
  4571.   <tr>
  4572.     <td>
  4573.       <pre class="lines">
  4574.  
  4575.  
  4576. 35
  4577. 36
  4578. 37</pre>
  4579.     </td>
  4580.     <td>
  4581.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/jobs.rb', line 35</span>
  4582.  
  4583. <span class='kw'>def</span> <span class='id identifier rubyid_delete_job'>delete_job</span><span class='lparen'>(</span><span class='id identifier rubyid_job_id'>job_id</span><span class='rparen'>)</span>
  4584.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>jobs/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_job_id'>job_id</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  4585. <span class='kw'>end</span></pre>
  4586.     </td>
  4587.   </tr>
  4588. </table>
  4589. </div>
  4590.     
  4591.       <div class="method_details ">
  4592.   <h3 class="signature " id="delete_label-instance_method">
  4593.   
  4594.     - (<tt>Object</tt>) <strong>delete_label</strong>(label) 
  4595.   
  4596.  
  4597.   
  4598.  
  4599.   
  4600. </h3><div class="docstring">
  4601.   <div class="discussion">
  4602.     
  4603. <p>Deletes the label specification in the system.</p>
  4604.  
  4605.  
  4606.   </div>
  4607. </div>
  4608. <div class="tags">
  4609.   
  4610.  
  4611. </div><table class="source_code">
  4612.   <tr>
  4613.     <td>
  4614.       <pre class="lines">
  4615.  
  4616.  
  4617. 33
  4618. 34
  4619. 35
  4620. 36</pre>
  4621.     </td>
  4622.     <td>
  4623.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/labels.rb', line 33</span>
  4624.  
  4625. <span class='kw'>def</span> <span class='id identifier rubyid_delete_label'>delete_label</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='rparen'>)</span>
  4626.   <span class='id identifier rubyid_label'>label</span> <span class='op'>=</span> <span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_label'>label</span> <span class='kw'>if</span> <span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  4627.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>labels/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  4628. <span class='kw'>end</span></pre>
  4629.     </td>
  4630.   </tr>
  4631. </table>
  4632. </div>
  4633.     
  4634.       <div class="method_details ">
  4635.   <h3 class="signature " id="delete_server-instance_method">
  4636.   
  4637.     - (<tt>Object</tt>) <strong>delete_server</strong>(server) 
  4638.   
  4639.  
  4640.   
  4641.  
  4642.   
  4643. </h3><table class="source_code">
  4644.   <tr>
  4645.     <td>
  4646.       <pre class="lines">
  4647.  
  4648.  
  4649. 31
  4650. 32
  4651. 33
  4652. 34</pre>
  4653.     </td>
  4654.     <td>
  4655.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/servers.rb', line 31</span>
  4656.  
  4657. <span class='kw'>def</span> <span class='id identifier rubyid_delete_server'>delete_server</span><span class='lparen'>(</span><span class='id identifier rubyid_server'>server</span><span class='rparen'>)</span>
  4658.   <span class='id identifier rubyid_server'>server</span> <span class='op'>=</span> <span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_server_id'>server_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  4659.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>servers/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_server'>server</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  4660. <span class='kw'>end</span></pre>
  4661.     </td>
  4662.   </tr>
  4663. </table>
  4664. </div>
  4665.     
  4666.       <div class="method_details ">
  4667.   <h3 class="signature " id="delete_stream-instance_method">
  4668.   
  4669.     - (<tt>Object</tt>) <strong>delete_stream</strong>(stream) 
  4670.   
  4671.  
  4672.   
  4673.  
  4674.   
  4675. </h3><table class="source_code">
  4676.   <tr>
  4677.     <td>
  4678.       <pre class="lines">
  4679.  
  4680.  
  4681. 32
  4682. 33
  4683. 34
  4684. 35</pre>
  4685.     </td>
  4686.     <td>
  4687.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/streams.rb', line 32</span>
  4688.  
  4689. <span class='kw'>def</span> <span class='id identifier rubyid_delete_stream'>delete_stream</span><span class='lparen'>(</span><span class='id identifier rubyid_stream'>stream</span><span class='rparen'>)</span>
  4690.   <span class='id identifier rubyid_stream'>stream</span> <span class='op'>=</span> <span class='id identifier rubyid_stream'>stream</span><span class='period'>.</span><span class='id identifier rubyid_stream'>stream</span> <span class='kw'>if</span> <span class='id identifier rubyid_stream'>stream</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  4691.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>streams/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_stream'>stream</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  4692. <span class='kw'>end</span></pre>
  4693.     </td>
  4694.   </tr>
  4695. </table>
  4696. </div>
  4697.     
  4698.       <div class="method_details ">
  4699.   <h3 class="signature " id="delete_user-instance_method">
  4700.   
  4701.     - (<tt>Object</tt>) <strong>delete_user</strong>(user) 
  4702.   
  4703.  
  4704.   
  4705.  
  4706.   
  4707. </h3><table class="source_code">
  4708.   <tr>
  4709.     <td>
  4710.       <pre class="lines">
  4711.  
  4712.  
  4713. 30
  4714. 31
  4715. 32
  4716. 33</pre>
  4717.     </td>
  4718.     <td>
  4719.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/users.rb', line 30</span>
  4720.  
  4721. <span class='kw'>def</span> <span class='id identifier rubyid_delete_user'>delete_user</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
  4722.   <span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span> <span class='kw'>if</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  4723.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>users/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  4724. <span class='kw'>end</span></pre>
  4725.     </td>
  4726.   </tr>
  4727. </table>
  4728. </div>
  4729.     
  4730.       <div class="method_details ">
  4731.   <h3 class="signature " id="depot-instance_method">
  4732.   
  4733.     - (<tt>Object</tt>) <strong>depot</strong>(depot) 
  4734.   
  4735.  
  4736.   
  4737.  
  4738.   
  4739. </h3><div class="docstring">
  4740.   <div class="discussion">
  4741.     
  4742. <p>Returns the depot instance indicated by the depot name (or depot object)</p>
  4743.  
  4744.  
  4745.   </div>
  4746. </div>
  4747. <div class="tags">
  4748.   
  4749.  
  4750. </div><table class="source_code">
  4751.   <tr>
  4752.     <td>
  4753.       <pre class="lines">
  4754.  
  4755.  
  4756. 13
  4757. 14
  4758. 15
  4759. 16
  4760. 17</pre>
  4761.     </td>
  4762.     <td>
  4763.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/depots.rb', line 13</span>
  4764.  
  4765. <span class='kw'>def</span> <span class='id identifier rubyid_depot'>depot</span><span class='lparen'>(</span><span class='id identifier rubyid_depot'>depot</span><span class='rparen'>)</span>
  4766.   <span class='id identifier rubyid_depot'>depot</span> <span class='op'>=</span> <span class='id identifier rubyid_depot'>depot</span><span class='period'>.</span><span class='id identifier rubyid_depot'>depot</span> <span class='kw'>if</span> <span class='id identifier rubyid_depot'>depot</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  4767.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>depots/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_depot'>depot</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  4768.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  4769. <span class='kw'>end</span></pre>
  4770.     </td>
  4771.   </tr>
  4772. </table>
  4773. </div>
  4774.     
  4775.       <div class="method_details ">
  4776.   <h3 class="signature " id="depots-instance_method">
  4777.   
  4778.     - (<tt>Object</tt>) <strong>depots</strong> 
  4779.   
  4780.  
  4781.   
  4782.  
  4783.   
  4784. </h3><div class="docstring">
  4785.   <div class="discussion">
  4786.     
  4787. <p>Array of Depot objects stored in the system. Not all fields will be filled
  4788. out (e.g., view).</p>
  4789.  
  4790.  
  4791.   </div>
  4792. </div>
  4793. <div class="tags">
  4794.   
  4795.  
  4796. </div><table class="source_code">
  4797.   <tr>
  4798.     <td>
  4799.       <pre class="lines">
  4800.  
  4801.  
  4802. 7
  4803. 8
  4804. 9
  4805. 10</pre>
  4806.     </td>
  4807.     <td>
  4808.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/depots.rb', line 7</span>
  4809.  
  4810. <span class='kw'>def</span> <span class='id identifier rubyid_depots'>depots</span>
  4811.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>depots</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  4812.   <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_a'>a</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  4813. <span class='kw'>end</span></pre>
  4814.     </td>
  4815.   </tr>
  4816. </table>
  4817. </div>
  4818.     
  4819.       <div class="method_details ">
  4820.   <h3 class="signature " id="execute_method_no_body-instance_method">
  4821.   
  4822.     - (<tt>Object</tt>) <strong>execute_method_no_body</strong>(method, path, params = nil) 
  4823.   
  4824.  
  4825.   
  4826.  
  4827.   
  4828. </h3><div class="docstring">
  4829.   <div class="discussion">
  4830.     
  4831. <p>Runs the method against Helix Web Services, checks for errors, then parses
  4832. the JSON response.</p>
  4833.  
  4834.  
  4835.   </div>
  4836. </div>
  4837. <div class="tags">
  4838.   <p class="tag_title">Parameters:</p>
  4839. <ul class="param">
  4840.   
  4841.     <li>
  4842.       
  4843.         <span class='name'>method</span>
  4844.       
  4845.       
  4846.         <span class='type'>(<tt>Symbol</tt>)</span>
  4847.       
  4848.       
  4849.       
  4850.         &mdash;
  4851.         <div class='inline'>
  4852. <p>HTTP method, for example, :get, :post, :delete</p>
  4853. </div>
  4854.       
  4855.     </li>
  4856.   
  4857.     <li>
  4858.       
  4859.         <span class='name'>path</span>
  4860.       
  4861.       
  4862.         <span class='type'>(<tt>String</tt>)</span>
  4863.       
  4864.       
  4865.       
  4866.         &mdash;
  4867.         <div class='inline'>
  4868. <p>URL path part (no URI parameters) for the method</p>
  4869. </div>
  4870.       
  4871.     </li>
  4872.   
  4873.     <li>
  4874.       
  4875.         <span class='name'>params</span>
  4876.       
  4877.       
  4878.         <span class='type'>(<tt>Hash</tt>)</span>
  4879.       
  4880.       
  4881.         <em class="default">(defaults to: <tt>nil</tt>)</em>
  4882.       
  4883.       
  4884.         &mdash;
  4885.         <div class='inline'>
  4886. <p>URI parameters to send in</p>
  4887. </div>
  4888.       
  4889.     </li>
  4890.   
  4891. </ul>
  4892.  
  4893.  
  4894. </div><table class="source_code">
  4895.   <tr>
  4896.     <td>
  4897.       <pre class="lines">
  4898.  
  4899.  
  4900. 148
  4901. 149
  4902. 150
  4903. 151</pre>
  4904.     </td>
  4905.     <td>
  4906.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 148</span>
  4907.  
  4908. <span class='kw'>def</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  4909.   <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_run_method_no_body'>run_method_no_body</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
  4910.   <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='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
  4911. <span class='kw'>end</span></pre>
  4912.     </td>
  4913.   </tr>
  4914. </table>
  4915. </div>
  4916.     
  4917.       <div class="method_details ">
  4918.   <h3 class="signature " id="execute_method_with_body-instance_method">
  4919.   
  4920.     - (<tt>Object</tt>) <strong>execute_method_with_body</strong>(method, path, params = nil, body = nil) 
  4921.   
  4922.  
  4923.   
  4924.  
  4925.   
  4926. </h3><div class="docstring">
  4927.   <div class="discussion">
  4928.     
  4929. <p>Runs the method against Helix Web Services, checks for errors, then parses
  4930. the JSON response.</p>
  4931.  
  4932. <p>This variation will send the body (expected to be a Hash) as JSON to the
  4933. server.</p>
  4934.  
  4935.  
  4936.   </div>
  4937. </div>
  4938. <div class="tags">
  4939.   <p class="tag_title">Parameters:</p>
  4940. <ul class="param">
  4941.   
  4942.     <li>
  4943.       
  4944.         <span class='name'>method</span>
  4945.       
  4946.       
  4947.         <span class='type'>(<tt>Symbol</tt>)</span>
  4948.       
  4949.       
  4950.       
  4951.         &mdash;
  4952.         <div class='inline'>
  4953. <p>HTTP method, for example, :get, :post, :delete</p>
  4954. </div>
  4955.       
  4956.     </li>
  4957.   
  4958.     <li>
  4959.       
  4960.         <span class='name'>path</span>
  4961.       
  4962.       
  4963.         <span class='type'>(<tt>String</tt>)</span>
  4964.       
  4965.       
  4966.       
  4967.         &mdash;
  4968.         <div class='inline'>
  4969. <p>URL path part (no URI parameters) for the method</p>
  4970. </div>
  4971.       
  4972.     </li>
  4973.   
  4974.     <li>
  4975.       
  4976.         <span class='name'>params</span>
  4977.       
  4978.       
  4979.         <span class='type'>(<tt>Hash</tt>)</span>
  4980.       
  4981.       
  4982.         <em class="default">(defaults to: <tt>nil</tt>)</em>
  4983.       
  4984.       
  4985.         &mdash;
  4986.         <div class='inline'>
  4987. <p>URI parameters to send in</p>
  4988. </div>
  4989.       
  4990.     </li>
  4991.   
  4992.     <li>
  4993.       
  4994.         <span class='name'>body</span>
  4995.       
  4996.       
  4997.         <span class='type'>(<tt>Hash</tt>)</span>
  4998.       
  4999.       
  5000.         <em class="default">(defaults to: <tt>nil</tt>)</em>
  5001.       
  5002.       
  5003.         &mdash;
  5004.         <div class='inline'>
  5005. <p>The Request content (which will be converted to JSON)</p>
  5006. </div>
  5007.       
  5008.     </li>
  5009.   
  5010. </ul>
  5011.  
  5012.  
  5013. </div><table class="source_code">
  5014.   <tr>
  5015.     <td>
  5016.       <pre class="lines">
  5017.  
  5018.  
  5019. 163
  5020. 164
  5021. 165
  5022. 166</pre>
  5023.     </td>
  5024.     <td>
  5025.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 163</span>
  5026.  
  5027. <span class='kw'>def</span> <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  5028.   <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_run_method_with_body'>run_method_with_body</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
  5029.   <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='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
  5030. <span class='kw'>end</span></pre>
  5031.     </td>
  5032.   </tr>
  5033. </table>
  5034. </div>
  5035.     
  5036.       <div class="method_details ">
  5037.   <h3 class="signature " id="fetch_helix_sync_latest_changelist-instance_method">
  5038.   
  5039.     - (<tt>Object</tt>) <strong>fetch_helix_sync_latest_changelist</strong>(project_id) 
  5040.   
  5041.  
  5042.   
  5043.  
  5044.   
  5045. </h3><div class="docstring">
  5046.   <div class="discussion">
  5047.     
  5048. <p>Retrieve the latest changelist.</p>
  5049.  
  5050. <p>If the change doesn&#39;t exist, you&#39;ll get a ResourceNotFound
  5051. exception.</p>
  5052.  
  5053.  
  5054.   </div>
  5055. </div>
  5056. <div class="tags">
  5057.   
  5058.  
  5059. </div><table class="source_code">
  5060.   <tr>
  5061.     <td>
  5062.       <pre class="lines">
  5063.  
  5064.  
  5065. 35
  5066. 36
  5067. 37
  5068. 38</pre>
  5069.     </td>
  5070.     <td>
  5071.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 35</span>
  5072.  
  5073. <span class='kw'>def</span> <span class='id identifier rubyid_fetch_helix_sync_latest_changelist'>fetch_helix_sync_latest_changelist</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span>
  5074.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/helix_sync/v1/changes/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  5075.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  5076. <span class='kw'>end</span></pre>
  5077.     </td>
  5078.   </tr>
  5079. </table>
  5080. </div>
  5081.     
  5082.       <div class="method_details ">
  5083.   <h3 class="signature " id="fetch_helix_sync_pending_changelist-instance_method">
  5084.   
  5085.     - (<tt>Object</tt>) <strong>fetch_helix_sync_pending_changelist</strong>(project_id) 
  5086.   
  5087.  
  5088.   
  5089.  
  5090.   
  5091. </h3><div class="docstring">
  5092.   <div class="discussion">
  5093.     
  5094. <p>Retrieve the pending changelist.</p>
  5095.  
  5096. <p>If the change doesn&#39;t exist, you&#39;ll get a ResourceNotFound
  5097. exception.</p>
  5098.  
  5099.  
  5100.   </div>
  5101. </div>
  5102. <div class="tags">
  5103.   
  5104.  
  5105. </div><table class="source_code">
  5106.   <tr>
  5107.     <td>
  5108.       <pre class="lines">
  5109.  
  5110.  
  5111. 43
  5112. 44
  5113. 45
  5114. 46</pre>
  5115.     </td>
  5116.     <td>
  5117.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 43</span>
  5118.  
  5119. <span class='kw'>def</span> <span class='id identifier rubyid_fetch_helix_sync_pending_changelist'>fetch_helix_sync_pending_changelist</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span>
  5120.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/helix_sync/v1/changes/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>/pending</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  5121.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  5122. <span class='kw'>end</span></pre>
  5123.     </td>
  5124.   </tr>
  5125. </table>
  5126. </div>
  5127.     
  5128.       <div class="method_details ">
  5129.   <h3 class="signature " id="file-instance_method">
  5130.   
  5131.     - (<tt>Object</tt>) <strong>file</strong>(path) 
  5132.   
  5133.  
  5134.   
  5135.  
  5136.   
  5137. </h3><div class="docstring">
  5138.   <div class="discussion">
  5139.     
  5140. <p>Returns the file metadata at this location, with the <code>content</code>
  5141. field filled out.</p>
  5142.  
  5143. <p>If path happens to be a directory, this method is synonymous with the
  5144. files() method.</p>
  5145.  
  5146.  
  5147.   </div>
  5148. </div>
  5149. <div class="tags">
  5150.   
  5151.  
  5152. </div><table class="source_code">
  5153.   <tr>
  5154.     <td>
  5155.       <pre class="lines">
  5156.  
  5157.  
  5158. 48
  5159. 49
  5160. 50</pre>
  5161.     </td>
  5162.     <td>
  5163.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/files.rb', line 48</span>
  5164.  
  5165. <span class='kw'>def</span> <span class='id identifier rubyid_file'>file</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
  5166.   <span class='id identifier rubyid_files'>files</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
  5167. <span class='kw'>end</span></pre>
  5168.     </td>
  5169.   </tr>
  5170. </table>
  5171. </div>
  5172.     
  5173.       <div class="method_details ">
  5174.   <h3 class="signature " id="files-instance_method">
  5175.   
  5176.     - (<tt>Object</tt>) <strong>files</strong>(path = &#39;&#39;) 
  5177.   
  5178.  
  5179.   
  5180.  
  5181.   
  5182. </h3><div class="docstring">
  5183.   <div class="discussion">
  5184.     
  5185. <p>General file browsing method.</p>
  5186.  
  5187. <p>The <code>path</code> parameter should be a directory location, starting
  5188. with a depot location, e.g., <code>my_depot/dir1</code>.</p>
  5189.  
  5190. <p>When path is empty, will return the list of depots.</p>
  5191.  
  5192. <p>Note: if path happens to be a file, instead of a directory, this is a
  5193. synonym with the file() method.</p>
  5194.  
  5195. <p>If the path contains wildcards, the return will only be the list of
  5196. HelixWebServicesClient::Models::File instances.</p>
  5197.  
  5198. <p>See also the HelixWebServicesClient::Models::File,
  5199. HelixWebServicesClient::Models::Dir, and
  5200. HelixWebServicesClient::Models::Depot for the output types.</p>
  5201.  
  5202.  
  5203.   </div>
  5204. </div>
  5205. <div class="tags">
  5206.   
  5207.  
  5208. </div><table class="source_code">
  5209.   <tr>
  5210.     <td>
  5211.       <pre class="lines">
  5212.  
  5213.  
  5214. 21
  5215. 22
  5216. 23
  5217. 24
  5218. 25
  5219. 26
  5220. 27
  5221. 28
  5222. 29
  5223. 30
  5224. 31
  5225. 32
  5226. 33
  5227. 34
  5228. 35
  5229. 36
  5230. 37
  5231. 38
  5232. 39
  5233. 40
  5234. 41</pre>
  5235.     </td>
  5236.     <td>
  5237.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/files.rb', line 21</span>
  5238.  
  5239. <span class='kw'>def</span> <span class='id identifier rubyid_files'>files</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  5240.   <span class='kw'>unless</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
  5241.     <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  5242.   <span class='kw'>end</span>
  5243.  
  5244.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='kw'>nil</span>
  5245.  
  5246.   <span class='kw'>if</span> <span class='id identifier rubyid_wildcards?'>wildcards?</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
  5247.     <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>files</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
  5248.   <span class='kw'>else</span>
  5249.     <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>files/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  5250.   <span class='kw'>end</span>
  5251.  
  5252.   <span class='kw'>if</span> <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span>
  5253.     <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  5254.   <span class='kw'>else</span>
  5255.     <span class='id identifier rubyid_m'>m</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_arr'>arr</span><span class='rparen'>)</span>
  5256.     <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='const'>Content</span> <span class='op'>=</span> <span class='const'>Base64</span><span class='period'>.</span><span class='id identifier rubyid_decode64'>decode64</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
  5257.     <span class='id identifier rubyid_m'>m</span>
  5258.   <span class='kw'>end</span>
  5259. <span class='kw'>end</span></pre>
  5260.     </td>
  5261.   </tr>
  5262. </table>
  5263. </div>
  5264.     
  5265.       <div class="method_details ">
  5266.   <h3 class="signature " id="group-instance_method">
  5267.   
  5268.     - (<tt>Object</tt>) <strong>group</strong>(group) 
  5269.   
  5270.  
  5271.   
  5272.  
  5273.   
  5274. </h3><div class="docstring">
  5275.   <div class="discussion">
  5276.     
  5277. <p>Returns the group instance indicated by the group name (or group object)</p>
  5278.  
  5279.  
  5280.   </div>
  5281. </div>
  5282. <div class="tags">
  5283.   
  5284.  
  5285. </div><table class="source_code">
  5286.   <tr>
  5287.     <td>
  5288.       <pre class="lines">
  5289.  
  5290.  
  5291. 13
  5292. 14
  5293. 15
  5294. 16
  5295. 17</pre>
  5296.     </td>
  5297.     <td>
  5298.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/groups.rb', line 13</span>
  5299.  
  5300. <span class='kw'>def</span> <span class='id identifier rubyid_group'>group</span><span class='lparen'>(</span><span class='id identifier rubyid_group'>group</span><span class='rparen'>)</span>
  5301.   <span class='id identifier rubyid_group'>group</span> <span class='op'>=</span> <span class='id identifier rubyid_group'>group</span><span class='period'>.</span><span class='id identifier rubyid_group'>group</span> <span class='kw'>if</span> <span class='id identifier rubyid_group'>group</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  5302.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>groups/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_group'>group</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  5303.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  5304. <span class='kw'>end</span></pre>
  5305.     </td>
  5306.   </tr>
  5307. </table>
  5308. </div>
  5309.     
  5310.       <div class="method_details ">
  5311.   <h3 class="signature " id="groups-instance_method">
  5312.   
  5313.     - (<tt>Object</tt>) <strong>groups</strong> 
  5314.   
  5315.  
  5316.   
  5317.  
  5318.   
  5319. </h3><div class="docstring">
  5320.   <div class="discussion">
  5321.     
  5322. <p>Array of Group objects stored in the system. Not all fields will be filled
  5323. out (e.g., view).</p>
  5324.  
  5325.  
  5326.   </div>
  5327. </div>
  5328. <div class="tags">
  5329.   
  5330.  
  5331. </div><table class="source_code">
  5332.   <tr>
  5333.     <td>
  5334.       <pre class="lines">
  5335.  
  5336.  
  5337. 7
  5338. 8
  5339. 9
  5340. 10</pre>
  5341.     </td>
  5342.     <td>
  5343.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/groups.rb', line 7</span>
  5344.  
  5345. <span class='kw'>def</span> <span class='id identifier rubyid_groups'>groups</span>
  5346.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>groups</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  5347.   <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  5348. <span class='kw'>end</span></pre>
  5349.     </td>
  5350.   </tr>
  5351. </table>
  5352. </div>
  5353.     
  5354.       <div class="method_details ">
  5355.   <h3 class="signature " id="hve_path-instance_method">
  5356.   
  5357.     - (<tt>Object</tt>) <strong>hve_path</strong>(subpath) 
  5358.   
  5359.  
  5360.   
  5361.  
  5362.   
  5363. </h3><table class="source_code">
  5364.   <tr>
  5365.     <td>
  5366.       <pre class="lines">
  5367.  
  5368.  
  5369. 228
  5370. 229
  5371. 230</pre>
  5372.     </td>
  5373.     <td>
  5374.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 228</span>
  5375.  
  5376. <span class='kw'>def</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='id identifier rubyid_subpath'>subpath</span><span class='rparen'>)</span>
  5377.   <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/helix_versioning_engine/v</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_api_level'>api_level</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_subpath'>subpath</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  5378. <span class='kw'>end</span></pre>
  5379.     </td>
  5380.   </tr>
  5381. </table>
  5382. </div>
  5383.     
  5384.       <div class="method_details ">
  5385.   <h3 class="signature " id="increment_counter-instance_method">
  5386.   
  5387.     - (<tt>Object</tt>) <strong>increment_counter</strong>(counter) 
  5388.   
  5389.  
  5390.   
  5391.  
  5392.   
  5393. </h3><div class="docstring">
  5394.   <div class="discussion">
  5395.     
  5396. <p>Increment the value of a numerical counter</p>
  5397.  
  5398.  
  5399.   </div>
  5400. </div>
  5401. <div class="tags">
  5402.   <p class="tag_title">Parameters:</p>
  5403. <ul class="param">
  5404.   
  5405.     <li>
  5406.       
  5407.         <span class='name'>counter</span>
  5408.       
  5409.       
  5410.         <span class='type'>(<tt>String</tt>)</span>
  5411.       
  5412.       
  5413.       
  5414.         &mdash;
  5415.         <div class='inline'>
  5416. <p>The counter ID</p>
  5417. </div>
  5418.       
  5419.     </li>
  5420.   
  5421. </ul>
  5422.  
  5423.  
  5424. </div><table class="source_code">
  5425.   <tr>
  5426.     <td>
  5427.       <pre class="lines">
  5428.  
  5429.  
  5430. 22
  5431. 23
  5432. 24</pre>
  5433.     </td>
  5434.     <td>
  5435.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/counters.rb', line 22</span>
  5436.  
  5437. <span class='kw'>def</span> <span class='id identifier rubyid_increment_counter'>increment_counter</span><span class='lparen'>(</span><span class='id identifier rubyid_counter'>counter</span><span class='rparen'>)</span>
  5438.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>counters/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_counter'>counter</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>/increment</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  5439. <span class='kw'>end</span></pre>
  5440.     </td>
  5441.   </tr>
  5442. </table>
  5443. </div>
  5444.     
  5445.       <div class="method_details ">
  5446.   <h3 class="signature " id="job-instance_method">
  5447.   
  5448.     - (<tt>Object</tt>) <strong>job</strong>(job_id) 
  5449.   
  5450.  
  5451.   
  5452.  
  5453.   
  5454. </h3><div class="docstring">
  5455.   <div class="discussion">
  5456.     
  5457. <p>Returns the array of jobs in the system. Each job model is simply a hash of
  5458. string -&gt; string values, since each system can very likely adjust job
  5459. output.</p>
  5460.  
  5461.  
  5462.   </div>
  5463. </div>
  5464. <div class="tags">
  5465.   
  5466.  
  5467. </div><table class="source_code">
  5468.   <tr>
  5469.     <td>
  5470.       <pre class="lines">
  5471.  
  5472.  
  5473. 13
  5474. 14
  5475. 15
  5476. 16</pre>
  5477.     </td>
  5478.     <td>
  5479.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/jobs.rb', line 13</span>
  5480.  
  5481. <span class='kw'>def</span> <span class='id identifier rubyid_job'>job</span><span class='lparen'>(</span><span class='id identifier rubyid_job_id'>job_id</span><span class='rparen'>)</span>
  5482.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>jobs/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_job_id'>job_id</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  5483.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  5484. <span class='kw'>end</span></pre>
  5485.     </td>
  5486.   </tr>
  5487. </table>
  5488. </div>
  5489.     
  5490.       <div class="method_details ">
  5491.   <h3 class="signature " id="jobs-instance_method">
  5492.   
  5493.     - (<tt>Object</tt>) <strong>jobs</strong> 
  5494.   
  5495.  
  5496.   
  5497.  
  5498.   
  5499. </h3><table class="source_code">
  5500.   <tr>
  5501.     <td>
  5502.       <pre class="lines">
  5503.  
  5504.  
  5505. 5
  5506. 6
  5507. 7
  5508. 8</pre>
  5509.     </td>
  5510.     <td>
  5511.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/jobs.rb', line 5</span>
  5512.  
  5513. <span class='kw'>def</span> <span class='id identifier rubyid_jobs'>jobs</span>
  5514.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>jobs</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  5515.   <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  5516. <span class='kw'>end</span></pre>
  5517.     </td>
  5518.   </tr>
  5519. </table>
  5520. </div>
  5521.     
  5522.       <div class="method_details ">
  5523.   <h3 class="signature " id="label-instance_method">
  5524.   
  5525.     - (<tt>Object</tt>) <strong>label</strong>(label) 
  5526.   
  5527.  
  5528.   
  5529.  
  5530.   
  5531. </h3><div class="docstring">
  5532.   <div class="discussion">
  5533.     
  5534. <p>Returns the label instance indicated by the label name (or label object)</p>
  5535.  
  5536.  
  5537.   </div>
  5538. </div>
  5539. <div class="tags">
  5540.   
  5541.  
  5542. </div><table class="source_code">
  5543.   <tr>
  5544.     <td>
  5545.       <pre class="lines">
  5546.  
  5547.  
  5548. 13
  5549. 14
  5550. 15
  5551. 16
  5552. 17</pre>
  5553.     </td>
  5554.     <td>
  5555.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/labels.rb', line 13</span>
  5556.  
  5557. <span class='kw'>def</span> <span class='id identifier rubyid_label'>label</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='rparen'>)</span>
  5558.   <span class='id identifier rubyid_label'>label</span> <span class='op'>=</span> <span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_label'>label</span> <span class='kw'>if</span> <span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  5559.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>labels/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  5560.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  5561. <span class='kw'>end</span></pre>
  5562.     </td>
  5563.   </tr>
  5564. </table>
  5565. </div>
  5566.     
  5567.       <div class="method_details ">
  5568.   <h3 class="signature " id="labels-instance_method">
  5569.   
  5570.     - (<tt>Object</tt>) <strong>labels</strong> 
  5571.   
  5572.  
  5573.   
  5574.  
  5575.   
  5576. </h3><div class="docstring">
  5577.   <div class="discussion">
  5578.     
  5579. <p>Array of Label objects stored in the system. Not all fields will be filled
  5580. out (e.g., view).</p>
  5581.  
  5582.  
  5583.   </div>
  5584. </div>
  5585. <div class="tags">
  5586.   
  5587.  
  5588. </div><table class="source_code">
  5589.   <tr>
  5590.     <td>
  5591.       <pre class="lines">
  5592.  
  5593.  
  5594. 7
  5595. 8
  5596. 9
  5597. 10</pre>
  5598.     </td>
  5599.     <td>
  5600.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/labels.rb', line 7</span>
  5601.  
  5602. <span class='kw'>def</span> <span class='id identifier rubyid_labels'>labels</span>
  5603.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>labels</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  5604.   <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_a'>a</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  5605. <span class='kw'>end</span></pre>
  5606.     </td>
  5607.   </tr>
  5608. </table>
  5609. </div>
  5610.     
  5611.       <div class="method_details ">
  5612.   <h3 class="signature " id="login-instance_method">
  5613.   
  5614.     - (<tt>Object</tt>) <strong>login</strong>(user, password) 
  5615.   
  5616.  
  5617.   
  5618.  
  5619.   
  5620. </h3><div class="docstring">
  5621.   <div class="discussion">
  5622.     
  5623. <p>Generates a host unlocked ticket for the user.</p>
  5624.  
  5625. <p>In some installations, such as Helix Cloud, the authentication source is
  5626. not the p4d instance used for connections. This allows you to generate p4
  5627. ticket which should then be passed along as the P4PASSWD per-request
  5628. header.</p>
  5629.  
  5630.  
  5631.   </div>
  5632. </div>
  5633. <div class="tags">
  5634.   <p class="tag_title">Parameters:</p>
  5635. <ul class="param">
  5636.   
  5637.     <li>
  5638.       
  5639.         <span class='name'>user</span>
  5640.       
  5641.       
  5642.         <span class='type'>(<tt>String</tt>)</span>
  5643.       
  5644.       
  5645.       
  5646.     </li>
  5647.   
  5648.     <li>
  5649.       
  5650.         <span class='name'>password</span>
  5651.       
  5652.       
  5653.         <span class='type'>(<tt>String</tt>)</span>
  5654.       
  5655.       
  5656.       
  5657.     </li>
  5658.   
  5659. </ul>
  5660.  
  5661.  
  5662. </div><table class="source_code">
  5663.   <tr>
  5664.     <td>
  5665.       <pre class="lines">
  5666.  
  5667.  
  5668. 11
  5669. 12
  5670. 13
  5671. 14
  5672. 15</pre>
  5673.     </td>
  5674.     <td>
  5675.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/login.rb', line 11</span>
  5676.  
  5677. <span class='kw'>def</span> <span class='id identifier rubyid_login'>login</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
  5678.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>login</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span>
  5679.                                  <span class='lbrace'>{</span><span class='label'>user:</span> <span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='label'>password:</span> <span class='id identifier rubyid_password'>password</span><span class='rbrace'>}</span><span class='rparen'>)</span>
  5680.   <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ticket</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  5681. <span class='kw'>end</span></pre>
  5682.     </td>
  5683.   </tr>
  5684. </table>
  5685. </div>
  5686.     
  5687.       <div class="method_details ">
  5688.   <h3 class="signature " id="p4_ticket?-instance_method">
  5689.   
  5690.     - (<tt>Boolean</tt>) <strong>p4_ticket?</strong>(str) 
  5691.   
  5692.  
  5693.   
  5694.  
  5695.   
  5696. </h3><div class="docstring">
  5697.   <div class="discussion">
  5698.     
  5699.  
  5700.   </div>
  5701. </div>
  5702. <div class="tags">
  5703.   
  5704. <p class="tag_title">Returns:</p>
  5705. <ul class="return">
  5706.   
  5707.     <li>
  5708.       
  5709.       
  5710.         <span class='type'>(<tt>Boolean</tt>)</span>
  5711.       
  5712.       
  5713.       
  5714.     </li>
  5715.   
  5716. </ul>
  5717.  
  5718. </div><table class="source_code">
  5719.   <tr>
  5720.     <td>
  5721.       <pre class="lines">
  5722.  
  5723.  
  5724. 138
  5725. 139
  5726. 140</pre>
  5727.     </td>
  5728.     <td>
  5729.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 138</span>
  5730.  
  5731. <span class='kw'>def</span> <span class='id identifier rubyid_p4_ticket?'>p4_ticket?</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
  5732.   <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^[a-zA-Z0-9]{32,}$</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span> <span class='op'>!=</span> <span class='kw'>nil</span>
  5733. <span class='kw'>end</span></pre>
  5734.     </td>
  5735.   </tr>
  5736. </table>
  5737. </div>
  5738.     
  5739.       <div class="method_details ">
  5740.   <h3 class="signature " id="path_for-instance_method">
  5741.   
  5742.     - (<tt>Object</tt>) <strong>path_for</strong>(subpath) 
  5743.   
  5744.  
  5745.   
  5746.  
  5747.   
  5748. </h3><div class="docstring">
  5749.   <div class="discussion">
  5750.     
  5751. <p>Basically just prepends the prefix to our subpath, typically,
  5752. &#39;/p4&#39;.</p>
  5753.  
  5754.  
  5755.   </div>
  5756. </div>
  5757. <div class="tags">
  5758.   
  5759.  
  5760. </div><table class="source_code">
  5761.   <tr>
  5762.     <td>
  5763.       <pre class="lines">
  5764.  
  5765.  
  5766. 196
  5767. 197
  5768. 198
  5769. 199
  5770. 200
  5771. 201
  5772. 202
  5773. 203
  5774. 204</pre>
  5775.     </td>
  5776.     <td>
  5777.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 196</span>
  5778.  
  5779. <span class='kw'>def</span> <span class='id identifier rubyid_path_for'>path_for</span><span class='lparen'>(</span><span class='id identifier rubyid_subpath'>subpath</span><span class='rparen'>)</span>
  5780.   <span class='kw'>if</span> <span class='ivar'>@prefix</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='ivar'>@prefix</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
  5781.     <span class='id identifier rubyid_subpath'>subpath</span>
  5782.   <span class='kw'>elsif</span> <span class='id identifier rubyid_subpath'>subpath</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_subpath'>subpath</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
  5783.     <span class='ivar'>@prefix</span>
  5784.   <span class='kw'>else</span>
  5785.     <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='ivar'>@prefix</span><span class='comma'>,</span> <span class='id identifier rubyid_subpath'>subpath</span><span class='rparen'>)</span>
  5786.   <span class='kw'>end</span>
  5787. <span class='kw'>end</span></pre>
  5788.     </td>
  5789.   </tr>
  5790. </table>
  5791. </div>
  5792.     
  5793.       <div class="method_details ">
  5794.   <h3 class="signature " id="project-instance_method">
  5795.   
  5796.     - (<tt>Object</tt>) <strong>project</strong>(project_id) 
  5797.   
  5798.  
  5799.   
  5800.  
  5801.   
  5802. </h3><div class="docstring">
  5803.   <div class="discussion">
  5804.     
  5805. <p>Return the project details</p>
  5806.  
  5807.  
  5808.   </div>
  5809. </div>
  5810. <div class="tags">
  5811.   <p class="tag_title">Parameters:</p>
  5812. <ul class="param">
  5813.   
  5814.     <li>
  5815.       
  5816.         <span class='name'>project_id</span>
  5817.       
  5818.       
  5819.         <span class='type'>(<tt>String</tt>)</span>
  5820.       
  5821.       
  5822.       
  5823.         &mdash;
  5824.         <div class='inline'>
  5825. <p>The project&#39;s String id</p>
  5826. </div>
  5827.       
  5828.     </li>
  5829.   
  5830. </ul>
  5831.  
  5832.  
  5833. </div><table class="source_code">
  5834.   <tr>
  5835.     <td>
  5836.       <pre class="lines">
  5837.  
  5838.  
  5839. 23
  5840. 24
  5841. 25
  5842. 26
  5843. 27</pre>
  5844.     </td>
  5845.     <td>
  5846.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/projects.rb', line 23</span>
  5847.  
  5848. <span class='kw'>def</span> <span class='id identifier rubyid_project'>project</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span>
  5849.   <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/projects/v1/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  5850.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
  5851.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  5852. <span class='kw'>end</span></pre>
  5853.     </td>
  5854.   </tr>
  5855. </table>
  5856. </div>
  5857.     
  5858.       <div class="method_details ">
  5859.   <h3 class="signature " id="projects-instance_method">
  5860.   
  5861.     - (<tt>Object</tt>) <strong>projects</strong>(details: nil, extension: nil) 
  5862.   
  5863.  
  5864.   
  5865.  
  5866.   
  5867. </h3><div class="docstring">
  5868.   <div class="discussion">
  5869.     
  5870. <p>Lists the projects available on the server for the user.</p>
  5871.  
  5872.  
  5873.   </div>
  5874. </div>
  5875. <div class="tags">
  5876.   <p class="tag_title">Parameters:</p>
  5877. <ul class="param">
  5878.   
  5879.     <li>
  5880.       
  5881.         <span class='name'>details</span>
  5882.       
  5883.       
  5884.         <span class='type'>(<tt>Boolean</tt>)</span>
  5885.       
  5886.       
  5887.       
  5888.         &mdash;
  5889.         <div class='inline'>
  5890. <p>Defaults to false, if true, output will be an array of project details. If
  5891. false, output will be an array of project IDs.</p>
  5892. </div>
  5893.       
  5894.     </li>
  5895.   
  5896.     <li>
  5897.       
  5898.         <span class='name'>extension</span>
  5899.       
  5900.       
  5901.         <span class='type'>(<tt>String</tt>)</span>
  5902.       
  5903.       
  5904.       
  5905.         &mdash;
  5906.         <div class='inline'>
  5907. <p>If set, will only return projects with the indicated extension ID.</p>
  5908. </div>
  5909.       
  5910.     </li>
  5911.   
  5912. </ul>
  5913.  
  5914.  
  5915. </div><table class="source_code">
  5916.   <tr>
  5917.     <td>
  5918.       <pre class="lines">
  5919.  
  5920.  
  5921. 11
  5922. 12
  5923. 13
  5924. 14
  5925. 15
  5926. 16
  5927. 17
  5928. 18</pre>
  5929.     </td>
  5930.     <td>
  5931.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/projects.rb', line 11</span>
  5932.  
  5933. <span class='kw'>def</span> <span class='id identifier rubyid_projects'>projects</span><span class='lparen'>(</span><span class='label'>details:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>extension:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  5934.   <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
  5935.   <span class='id identifier rubyid_query'>query</span><span class='lbracket'>[</span><span class='symbol'>:details</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_details'>details</span> <span class='kw'>if</span> <span class='id identifier rubyid_details'>details</span>
  5936.   <span class='id identifier rubyid_query'>query</span><span class='lbracket'>[</span><span class='symbol'>:extension</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_extension'>extension</span> <span class='kw'>if</span> <span class='id identifier rubyid_extension'>extension</span>
  5937.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/projects/v1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span>
  5938.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_a'>a</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='kw'>if</span> <span class='id identifier rubyid_details'>details</span>
  5939.   <span class='id identifier rubyid_arr'>arr</span>
  5940. <span class='kw'>end</span></pre>
  5941.     </td>
  5942.   </tr>
  5943. </table>
  5944. </div>
  5945.     
  5946.       <div class="method_details ">
  5947.   <h3 class="signature " id="protections-instance_method">
  5948.   
  5949.     - (<tt>Object</tt>) <strong>protections</strong> 
  5950.   
  5951.  
  5952.   
  5953.  
  5954.   
  5955. </h3><div class="docstring">
  5956.   <div class="discussion">
  5957.     
  5958. <p>Fetch all protections in the system. Returns a single Protections instance.</p>
  5959.  
  5960.  
  5961.   </div>
  5962. </div>
  5963. <div class="tags">
  5964.   
  5965.  
  5966. </div><table class="source_code">
  5967.   <tr>
  5968.     <td>
  5969.       <pre class="lines">
  5970.  
  5971.  
  5972. 6
  5973. 7
  5974. 8
  5975. 9</pre>
  5976.     </td>
  5977.     <td>
  5978.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/protections.rb', line 6</span>
  5979.  
  5980. <span class='kw'>def</span> <span class='id identifier rubyid_protections'>protections</span>
  5981.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>protections</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  5982.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  5983. <span class='kw'>end</span></pre>
  5984.     </td>
  5985.   </tr>
  5986. </table>
  5987. </div>
  5988.     
  5989.       <div class="method_details ">
  5990.   <h3 class="signature " id="remove_setting-instance_method">
  5991.   
  5992.     - (<tt>Object</tt>) <strong>remove_setting</strong>(key) 
  5993.   
  5994.  
  5995.   
  5996.  
  5997.   
  5998. </h3><div class="docstring">
  5999.   <div class="discussion">
  6000.     
  6001. <p>Remove a setting added via add_setting</p>
  6002.  
  6003.  
  6004.   </div>
  6005. </div>
  6006. <div class="tags">
  6007.   
  6008.  
  6009. </div><table class="source_code">
  6010.   <tr>
  6011.     <td>
  6012.       <pre class="lines">
  6013.  
  6014.  
  6015. 112
  6016. 113
  6017. 114</pre>
  6018.     </td>
  6019.     <td>
  6020.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 112</span>
  6021.  
  6022. <span class='kw'>def</span> <span class='id identifier rubyid_remove_setting'>remove_setting</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
  6023.   <span class='ivar'>@conn</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>X-Perforce-Helix-Web-Services-</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  6024. <span class='kw'>end</span></pre>
  6025.     </td>
  6026.   </tr>
  6027. </table>
  6028. </div>
  6029.     
  6030.       <div class="method_details ">
  6031.   <h3 class="signature " id="run_method_no_body-instance_method">
  6032.   
  6033.     - (<tt>Object</tt>) <strong>run_method_no_body</strong>(method, path, params = nil) 
  6034.   
  6035.  
  6036.   
  6037.  
  6038.   
  6039. </h3><table class="source_code">
  6040.   <tr>
  6041.     <td>
  6042.       <pre class="lines">
  6043.  
  6044.  
  6045. 168
  6046. 169
  6047. 170
  6048. 171
  6049. 172
  6050. 173
  6051. 174</pre>
  6052.     </td>
  6053.     <td>
  6054.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 168</span>
  6055.  
  6056. <span class='kw'>def</span> <span class='id identifier rubyid_run_method_no_body'>run_method_no_body</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  6057.   <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_path_for'>path_for</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
  6058.  
  6059.   <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='ivar'>@conn</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
  6060.   <span class='id identifier rubyid_assert_ok'>assert_ok</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
  6061.   <span class='id identifier rubyid_response'>response</span>
  6062. <span class='kw'>end</span></pre>
  6063.     </td>
  6064.   </tr>
  6065. </table>
  6066. </div>
  6067.     
  6068.       <div class="method_details ">
  6069.   <h3 class="signature " id="run_method_with_body-instance_method">
  6070.   
  6071.     - (<tt>Object</tt>) <strong>run_method_with_body</strong>(method, path, params = nil, body = nil) 
  6072.   
  6073.  
  6074.   
  6075.  
  6076.   
  6077. </h3><table class="source_code">
  6078.   <tr>
  6079.     <td>
  6080.       <pre class="lines">
  6081.  
  6082.  
  6083. 176
  6084. 177
  6085. 178
  6086. 179
  6087. 180
  6088. 181
  6089. 182
  6090. 183
  6091. 184
  6092. 185
  6093. 186
  6094. 187
  6095. 188
  6096. 189
  6097. 190
  6098. 191
  6099. 192
  6100. 193</pre>
  6101.     </td>
  6102.     <td>
  6103.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 176</span>
  6104.  
  6105. <span class='kw'>def</span> <span class='id identifier rubyid_run_method_with_body'>run_method_with_body</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  6106.   <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_body'>body</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_params'>params</span>
  6107.     <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span>
  6108.     <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='kw'>nil</span>
  6109.   <span class='kw'>end</span>
  6110.  
  6111.   <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_path_for'>path_for</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
  6112.  
  6113.   <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span>
  6114.     <span class='id identifier rubyid_params_hash'>params_hash</span> <span class='op'>=</span> <span class='const'>Faraday</span><span class='op'>::</span><span class='const'>Utils</span><span class='op'>::</span><span class='const'>ParamsHash</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
  6115.     <span class='id identifier rubyid_params_hash'>params_hash</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
  6116.     <span class='id identifier rubyid_path'>path</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>?</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params_hash'>params_hash</span><span class='period'>.</span><span class='id identifier rubyid_to_query'>to_query</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  6117.   <span class='kw'>end</span>
  6118.  
  6119.   <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='ivar'>@conn</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
  6120.   <span class='id identifier rubyid_assert_ok'>assert_ok</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
  6121.   <span class='id identifier rubyid_response'>response</span>
  6122. <span class='kw'>end</span></pre>
  6123.     </td>
  6124.   </tr>
  6125. </table>
  6126. </div>
  6127.     
  6128.       <div class="method_details ">
  6129.   <h3 class="signature " id="server-instance_method">
  6130.   
  6131.     - (<tt>Object</tt>) <strong>server</strong>(server) 
  6132.   
  6133.  
  6134.   
  6135.  
  6136.   
  6137. </h3><div class="docstring">
  6138.   <div class="discussion">
  6139.     
  6140. <p>Returns a HelixWebServicesClient::OpenModel for the login</p>
  6141.  
  6142.  
  6143.   </div>
  6144. </div>
  6145. <div class="tags">
  6146.   
  6147.  
  6148. </div><table class="source_code">
  6149.   <tr>
  6150.     <td>
  6151.       <pre class="lines">
  6152.  
  6153.  
  6154. 12
  6155. 13
  6156. 14
  6157. 15
  6158. 16</pre>
  6159.     </td>
  6160.     <td>
  6161.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/servers.rb', line 12</span>
  6162.  
  6163. <span class='kw'>def</span> <span class='id identifier rubyid_server'>server</span><span class='lparen'>(</span><span class='id identifier rubyid_server'>server</span><span class='rparen'>)</span>
  6164.   <span class='id identifier rubyid_server'>server</span> <span class='op'>=</span> <span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='const'>ServerID</span> <span class='kw'>if</span> <span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  6165.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>servers/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_server'>server</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  6166.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  6167. <span class='kw'>end</span></pre>
  6168.     </td>
  6169.   </tr>
  6170. </table>
  6171. </div>
  6172.     
  6173.       <div class="method_details ">
  6174.   <h3 class="signature " id="servers-instance_method">
  6175.   
  6176.     - (<tt>Object</tt>) <strong>servers</strong> 
  6177.   
  6178.  
  6179.   
  6180.  
  6181.   
  6182. </h3><div class="docstring">
  6183.   <div class="discussion">
  6184.     
  6185. <p>Returns an array of Server objects representing people in the system.</p>
  6186.  
  6187.  
  6188.   </div>
  6189. </div>
  6190. <div class="tags">
  6191.   
  6192.  
  6193. </div><table class="source_code">
  6194.   <tr>
  6195.     <td>
  6196.       <pre class="lines">
  6197.  
  6198.  
  6199. 6
  6200. 7
  6201. 8
  6202. 9</pre>
  6203.     </td>
  6204.     <td>
  6205.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/servers.rb', line 6</span>
  6206.  
  6207. <span class='kw'>def</span> <span class='id identifier rubyid_servers'>servers</span>
  6208.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>servers</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  6209.   <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_obj'>obj</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  6210. <span class='kw'>end</span></pre>
  6211.     </td>
  6212.   </tr>
  6213. </table>
  6214. </div>
  6215.     
  6216.       <div class="method_details ">
  6217.   <h3 class="signature " id="services-instance_method">
  6218.   
  6219.     - (<tt>Object</tt>) <strong>services</strong> 
  6220.   
  6221.  
  6222.   
  6223.  
  6224.   
  6225. </h3><div class="docstring">
  6226.   <div class="discussion">
  6227.     
  6228. <p>Returns an array of all service definitions in the system. Each definition
  6229. is a hash with <code>type</code> and <code>uri</code> values.</p>
  6230.  
  6231.  
  6232.   </div>
  6233. </div>
  6234. <div class="tags">
  6235.   
  6236.  
  6237. </div><table class="source_code">
  6238.   <tr>
  6239.     <td>
  6240.       <pre class="lines">
  6241.  
  6242.  
  6243. 8
  6244. 9
  6245. 10</pre>
  6246.     </td>
  6247.     <td>
  6248.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/config.rb', line 8</span>
  6249.  
  6250. <span class='kw'>def</span> <span class='id identifier rubyid_services'>services</span>
  6251.   <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/config/v1/services</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  6252. <span class='kw'>end</span></pre>
  6253.     </td>
  6254.   </tr>
  6255. </table>
  6256. </div>
  6257.     
  6258.       <div class="method_details ">
  6259.   <h3 class="signature " id="set_auth-instance_method">
  6260.   
  6261.     - (<tt>Object</tt>) <strong>set_auth</strong>(user, token) 
  6262.   
  6263.  
  6264.   
  6265.  
  6266.   
  6267. </h3><div class="docstring">
  6268.   <div class="discussion">
  6269.     
  6270. <p>Note: this class is really just common implementation. Methods are
  6271. generally defined in other files that reopen this class.</p>
  6272.  
  6273.  
  6274.   </div>
  6275. </div>
  6276. <div class="tags">
  6277.   
  6278.  
  6279. </div><table class="source_code">
  6280.   <tr>
  6281.     <td>
  6282.       <pre class="lines">
  6283.  
  6284.  
  6285. 134
  6286. 135
  6287. 136</pre>
  6288.     </td>
  6289.     <td>
  6290.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 134</span>
  6291.  
  6292. <span class='kw'>def</span> <span class='id identifier rubyid_set_auth'>set_auth</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='id identifier rubyid_token'>token</span><span class='rparen'>)</span>
  6293.   <span class='ivar'>@conn</span><span class='period'>.</span><span class='id identifier rubyid_basic_auth'>basic_auth</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='id identifier rubyid_token'>token</span><span class='rparen'>)</span>
  6294. <span class='kw'>end</span></pre>
  6295.     </td>
  6296.   </tr>
  6297. </table>
  6298. </div>
  6299.     
  6300.       <div class="method_details ">
  6301.   <h3 class="signature " id="set_counter-instance_method">
  6302.   
  6303.     - (<tt>Object</tt>) <strong>set_counter</strong>(counter) 
  6304.   
  6305.  
  6306.   
  6307.  
  6308.   
  6309. </h3><div class="docstring">
  6310.   <div class="discussion">
  6311.     
  6312. <p>Set the counter value</p>
  6313.  
  6314.  
  6315.   </div>
  6316. </div>
  6317. <div class="tags">
  6318.   <p class="tag_title">Parameters:</p>
  6319. <ul class="param">
  6320.   
  6321.     <li>
  6322.       
  6323.         <span class='name'>counter</span>
  6324.       
  6325.       
  6326.         <span class='type'>(<tt>Hash|<span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>)</span>
  6327.       
  6328.       
  6329.       
  6330.         &mdash;
  6331.         <div class='inline'>
  6332. <p>A has containing <code>counter</code> and <code>value</code> properties</p>
  6333. </div>
  6334.       
  6335.     </li>
  6336.   
  6337. </ul>
  6338.  
  6339.  
  6340. </div><table class="source_code">
  6341.   <tr>
  6342.     <td>
  6343.       <pre class="lines">
  6344.  
  6345.  
  6346. 29
  6347. 30
  6348. 31
  6349. 32</pre>
  6350.     </td>
  6351.     <td>
  6352.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/counters.rb', line 29</span>
  6353.  
  6354. <span class='kw'>def</span> <span class='id identifier rubyid_set_counter'>set_counter</span><span class='lparen'>(</span><span class='id identifier rubyid_counter'>counter</span><span class='rparen'>)</span>
  6355.   <span class='id identifier rubyid_counter'>counter</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_counter'>counter</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_counter'>counter</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  6356.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:put</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>counters/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_counter'>counter</span><span class='period'>.</span><span class='id identifier rubyid_counter'>counter</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_counter'>counter</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  6357. <span class='kw'>end</span></pre>
  6358.     </td>
  6359.   </tr>
  6360. </table>
  6361. </div>
  6362.     
  6363.       <div class="method_details ">
  6364.   <h3 class="signature " id="stream-instance_method">
  6365.   
  6366.     - (<tt>Object</tt>) <strong>stream</strong>(stream) 
  6367.   
  6368.  
  6369.   
  6370.  
  6371.   
  6372. </h3><div class="docstring">
  6373.   <div class="discussion">
  6374.     
  6375. <p>Fetch single stream details</p>
  6376.  
  6377.  
  6378.   </div>
  6379. </div>
  6380. <div class="tags">
  6381.   
  6382. <p class="tag_title">Returns:</p>
  6383. <ul class="return">
  6384.   
  6385.     <li>
  6386.       
  6387.       
  6388.         <span class='type'></span>
  6389.       
  6390.       
  6391.       
  6392.         
  6393.         <div class='inline'>
  6394. <p>An OpenModel wrapper around the stream data</p>
  6395. </div>
  6396.       
  6397.     </li>
  6398.   
  6399. </ul>
  6400.  
  6401. </div><table class="source_code">
  6402.   <tr>
  6403.     <td>
  6404.       <pre class="lines">
  6405.  
  6406.  
  6407. 14
  6408. 15
  6409. 16
  6410. 17
  6411. 18</pre>
  6412.     </td>
  6413.     <td>
  6414.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/streams.rb', line 14</span>
  6415.  
  6416. <span class='kw'>def</span> <span class='id identifier rubyid_stream'>stream</span><span class='lparen'>(</span><span class='id identifier rubyid_stream'>stream</span><span class='rparen'>)</span>
  6417.   <span class='id identifier rubyid_stream'>stream</span> <span class='op'>=</span> <span class='id identifier rubyid_stream'>stream</span><span class='period'>.</span><span class='id identifier rubyid_stream'>stream</span> <span class='kw'>if</span> <span class='id identifier rubyid_stream'>stream</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  6418.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>streams/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_stream'>stream</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  6419.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  6420. <span class='kw'>end</span></pre>
  6421.     </td>
  6422.   </tr>
  6423. </table>
  6424. </div>
  6425.     
  6426.       <div class="method_details ">
  6427.   <h3 class="signature " id="streams-instance_method">
  6428.   
  6429.     - (<tt>Object</tt>) <strong>streams</strong> 
  6430.   
  6431.  
  6432.   
  6433.  
  6434.   
  6435. </h3><div class="docstring">
  6436.   <div class="discussion">
  6437.     
  6438. <p>Returns an array of Stream objects representing people in the system.</p>
  6439.  
  6440.  
  6441.   </div>
  6442. </div>
  6443. <div class="tags">
  6444.   
  6445.  
  6446. </div><table class="source_code">
  6447.   <tr>
  6448.     <td>
  6449.       <pre class="lines">
  6450.  
  6451.  
  6452. 6
  6453. 7
  6454. 8
  6455. 9</pre>
  6456.     </td>
  6457.     <td>
  6458.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/streams.rb', line 6</span>
  6459.  
  6460. <span class='kw'>def</span> <span class='id identifier rubyid_streams'>streams</span>
  6461.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>streams</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  6462.   <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_obj'>obj</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  6463. <span class='kw'>end</span></pre>
  6464.     </td>
  6465.   </tr>
  6466. </table>
  6467. </div>
  6468.     
  6469.       <div class="method_details ">
  6470.   <h3 class="signature " id="submit_helix_sync_pending_change-instance_method">
  6471.   
  6472.     - (<tt>Object</tt>) <strong>submit_helix_sync_pending_change</strong>(project_id) 
  6473.   
  6474.  
  6475.   
  6476.  
  6477.   
  6478. </h3><div class="docstring">
  6479.   <div class="discussion">
  6480.     
  6481. <p>Submits the pending changelist for the helix sync project.</p>
  6482.  
  6483. <p>Currently this assumes that all files are shelved and nothing&#39;s open on
  6484. the client. This is likely not what we want … but it&#39;s a start.</p>
  6485.  
  6486.  
  6487.   </div>
  6488. </div>
  6489. <div class="tags">
  6490.   <p class="tag_title">Parameters:</p>
  6491. <ul class="param">
  6492.   
  6493.     <li>
  6494.       
  6495.         <span class='name'>project_id</span>
  6496.       
  6497.       
  6498.         <span class='type'>(<tt>String</tt>)</span>
  6499.       
  6500.       
  6501.       
  6502.     </li>
  6503.   
  6504. </ul>
  6505.  
  6506.  
  6507. </div><table class="source_code">
  6508.   <tr>
  6509.     <td>
  6510.       <pre class="lines">
  6511.  
  6512.  
  6513. 54
  6514. 55
  6515. 56
  6516. 57</pre>
  6517.     </td>
  6518.     <td>
  6519.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 54</span>
  6520.  
  6521. <span class='kw'>def</span> <span class='id identifier rubyid_submit_helix_sync_pending_change'>submit_helix_sync_pending_change</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span>
  6522.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/helix_sync/v1/changes/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>/pending</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  6523.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  6524. <span class='kw'>end</span></pre>
  6525.     </td>
  6526.   </tr>
  6527. </table>
  6528. </div>
  6529.     
  6530.       <div class="method_details ">
  6531.   <h3 class="signature " id="triggers-instance_method">
  6532.   
  6533.     - (<tt><span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>) <strong>triggers</strong> 
  6534.   
  6535.  
  6536.   
  6537.  
  6538.   
  6539. </h3><div class="docstring">
  6540.   <div class="discussion">
  6541.     
  6542. <p>Fetch the list of trigger lines in the system.</p>
  6543.  
  6544.  
  6545.   </div>
  6546. </div>
  6547. <div class="tags">
  6548.   
  6549. <p class="tag_title">Returns:</p>
  6550. <ul class="return">
  6551.   
  6552.     <li>
  6553.       
  6554.       
  6555.         <span class='type'>(<tt><span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>)</span>
  6556.       
  6557.       
  6558.       
  6559.         &mdash;
  6560.         <div class='inline'>
  6561. <p>A hash with a <code>Triggers</code> property that is an array of lines in
  6562. the triggers table.</p>
  6563. </div>
  6564.       
  6565.     </li>
  6566.   
  6567. </ul>
  6568.  
  6569. </div><table class="source_code">
  6570.   <tr>
  6571.     <td>
  6572.       <pre class="lines">
  6573.  
  6574.  
  6575. 8
  6576. 9
  6577. 10
  6578. 11</pre>
  6579.     </td>
  6580.     <td>
  6581.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/triggers.rb', line 8</span>
  6582.  
  6583. <span class='kw'>def</span> <span class='id identifier rubyid_triggers'>triggers</span>
  6584.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>triggers</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  6585.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  6586. <span class='kw'>end</span></pre>
  6587.     </td>
  6588.   </tr>
  6589. </table>
  6590. </div>
  6591.     
  6592.       <div class="method_details ">
  6593.   <h3 class="signature " id="update_branch-instance_method">
  6594.   
  6595.     - (<tt>Object</tt>) <strong>update_branch</strong>(branch) 
  6596.   
  6597.  
  6598.   
  6599.  
  6600.   
  6601. </h3><div class="docstring">
  6602.   <div class="discussion">
  6603.     
  6604. <p>Updates the branch specification.</p>
  6605.  
  6606.  
  6607.   </div>
  6608. </div>
  6609. <div class="tags">
  6610.   
  6611.  
  6612. </div><table class="source_code">
  6613.   <tr>
  6614.     <td>
  6615.       <pre class="lines">
  6616.  
  6617.  
  6618. 27
  6619. 28
  6620. 29
  6621. 30
  6622. 31
  6623. 32</pre>
  6624.     </td>
  6625.     <td>
  6626.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/branches.rb', line 27</span>
  6627.  
  6628. <span class='kw'>def</span> <span class='id identifier rubyid_update_branch'>update_branch</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span>
  6629.   <span class='id identifier rubyid_branch'>branch</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_branch'>branch</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  6630.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:patch</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>branches/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='period'>.</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  6631.                            <span class='id identifier rubyid_branch'>branch</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  6632.   <span class='kw'>true</span>
  6633. <span class='kw'>end</span></pre>
  6634.     </td>
  6635.   </tr>
  6636. </table>
  6637. </div>
  6638.     
  6639.       <div class="method_details ">
  6640.   <h3 class="signature " id="update_client-instance_method">
  6641.   
  6642.     - (<tt>Object</tt>) <strong>update_client</strong>(client) 
  6643.   
  6644.  
  6645.   
  6646.  
  6647.   
  6648. </h3><div class="docstring">
  6649.   <div class="discussion">
  6650.     
  6651. <p>Updates the client specification.</p>
  6652.  
  6653.  
  6654.   </div>
  6655. </div>
  6656. <div class="tags">
  6657.   
  6658.  
  6659. </div><table class="source_code">
  6660.   <tr>
  6661.     <td>
  6662.       <pre class="lines">
  6663.  
  6664.  
  6665. 26
  6666. 27
  6667. 28
  6668. 29
  6669. 30
  6670. 31</pre>
  6671.     </td>
  6672.     <td>
  6673.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/clients.rb', line 26</span>
  6674.  
  6675. <span class='kw'>def</span> <span class='id identifier rubyid_update_client'>update_client</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span>
  6676.   <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  6677.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:patch</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>clients/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  6678.                            <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  6679.   <span class='kw'>true</span>
  6680. <span class='kw'>end</span></pre>
  6681.     </td>
  6682.   </tr>
  6683. </table>
  6684. </div>
  6685.     
  6686.       <div class="method_details ">
  6687.   <h3 class="signature " id="update_depot-instance_method">
  6688.   
  6689.     - (<tt>Object</tt>) <strong>update_depot</strong>(depot) 
  6690.   
  6691.  
  6692.   
  6693.  
  6694.   
  6695. </h3><div class="docstring">
  6696.   <div class="discussion">
  6697.     
  6698. <p>Updates the depot specification.</p>
  6699.  
  6700.  
  6701.   </div>
  6702. </div>
  6703. <div class="tags">
  6704.   
  6705.  
  6706. </div><table class="source_code">
  6707.   <tr>
  6708.     <td>
  6709.       <pre class="lines">
  6710.  
  6711.  
  6712. 26
  6713. 27
  6714. 28
  6715. 29
  6716. 30</pre>
  6717.     </td>
  6718.     <td>
  6719.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/depots.rb', line 26</span>
  6720.  
  6721. <span class='kw'>def</span> <span class='id identifier rubyid_update_depot'>update_depot</span><span class='lparen'>(</span><span class='id identifier rubyid_depot'>depot</span><span class='rparen'>)</span>
  6722.   <span class='id identifier rubyid_depot'>depot</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_depot'>depot</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_depot'>depot</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  6723.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:patch</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>depots/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_depot'>depot</span><span class='period'>.</span><span class='id identifier rubyid_depot'>depot</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  6724.                            <span class='id identifier rubyid_depot'>depot</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  6725. <span class='kw'>end</span></pre>
  6726.     </td>
  6727.   </tr>
  6728. </table>
  6729. </div>
  6730.     
  6731.       <div class="method_details ">
  6732.   <h3 class="signature " id="update_group-instance_method">
  6733.   
  6734.     - (<tt>Object</tt>) <strong>update_group</strong>(group) 
  6735.   
  6736.  
  6737.   
  6738.  
  6739.   
  6740. </h3><div class="docstring">
  6741.   <div class="discussion">
  6742.     
  6743. <p>Updates the group specification.</p>
  6744.  
  6745.  
  6746.   </div>
  6747. </div>
  6748. <div class="tags">
  6749.   
  6750.  
  6751. </div><table class="source_code">
  6752.   <tr>
  6753.     <td>
  6754.       <pre class="lines">
  6755.  
  6756.  
  6757. 26
  6758. 27
  6759. 28
  6760. 29
  6761. 30</pre>
  6762.     </td>
  6763.     <td>
  6764.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/groups.rb', line 26</span>
  6765.  
  6766. <span class='kw'>def</span> <span class='id identifier rubyid_update_group'>update_group</span><span class='lparen'>(</span><span class='id identifier rubyid_group'>group</span><span class='rparen'>)</span>
  6767.   <span class='id identifier rubyid_group'>group</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_group'>group</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_group'>group</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  6768.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:patch</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>groups/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_group'>group</span><span class='period'>.</span><span class='id identifier rubyid_group'>group</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  6769.                            <span class='id identifier rubyid_group'>group</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  6770. <span class='kw'>end</span></pre>
  6771.     </td>
  6772.   </tr>
  6773. </table>
  6774. </div>
  6775.     
  6776.       <div class="method_details ">
  6777.   <h3 class="signature " id="update_job-instance_method">
  6778.   
  6779.     - (<tt>Object</tt>) <strong>update_job</strong>(job) 
  6780.   
  6781.  
  6782.   
  6783.  
  6784.   
  6785. </h3><div class="docstring">
  6786.   <div class="discussion">
  6787.     
  6788. <p>Updates the job specification.</p>
  6789.  
  6790.  
  6791.   </div>
  6792. </div>
  6793. <div class="tags">
  6794.   
  6795.  
  6796. </div><table class="source_code">
  6797.   <tr>
  6798.     <td>
  6799.       <pre class="lines">
  6800.  
  6801.  
  6802. 28
  6803. 29
  6804. 30
  6805. 31
  6806. 32</pre>
  6807.     </td>
  6808.     <td>
  6809.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/jobs.rb', line 28</span>
  6810.  
  6811. <span class='kw'>def</span> <span class='id identifier rubyid_update_job'>update_job</span><span class='lparen'>(</span><span class='id identifier rubyid_job'>job</span><span class='rparen'>)</span>
  6812.   <span class='id identifier rubyid_job'>job</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_job'>job</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_job'>job</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  6813.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:patch</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>jobs/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_job'>job</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Job</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  6814.                            <span class='id identifier rubyid_job'>job</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  6815. <span class='kw'>end</span></pre>
  6816.     </td>
  6817.   </tr>
  6818. </table>
  6819. </div>
  6820.     
  6821.       <div class="method_details ">
  6822.   <h3 class="signature " id="update_label-instance_method">
  6823.   
  6824.     - (<tt>Object</tt>) <strong>update_label</strong>(label) 
  6825.   
  6826.  
  6827.   
  6828.  
  6829.   
  6830. </h3><div class="docstring">
  6831.   <div class="discussion">
  6832.     
  6833. <p>Updates the label specification.</p>
  6834.  
  6835.  
  6836.   </div>
  6837. </div>
  6838. <div class="tags">
  6839.   
  6840.  
  6841. </div><table class="source_code">
  6842.   <tr>
  6843.     <td>
  6844.       <pre class="lines">
  6845.  
  6846.  
  6847. 26
  6848. 27
  6849. 28
  6850. 29
  6851. 30</pre>
  6852.     </td>
  6853.     <td>
  6854.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/labels.rb', line 26</span>
  6855.  
  6856. <span class='kw'>def</span> <span class='id identifier rubyid_update_label'>update_label</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='rparen'>)</span>
  6857.   <span class='id identifier rubyid_label'>label</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  6858.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:patch</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>labels/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_label'>label</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  6859.                            <span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  6860. <span class='kw'>end</span></pre>
  6861.     </td>
  6862.   </tr>
  6863. </table>
  6864. </div>
  6865.     
  6866.       <div class="method_details ">
  6867.   <h3 class="signature " id="update_protections-instance_method">
  6868.   
  6869.     - (<tt>Object</tt>) <strong>update_protections</strong>(protections) 
  6870.   
  6871.  
  6872.   
  6873.  
  6874.   
  6875. </h3><div class="docstring">
  6876.   <div class="discussion">
  6877.     
  6878. <p>Updates the protections table based on the Protections instance passed in</p>
  6879.  
  6880.  
  6881.   </div>
  6882. </div>
  6883. <div class="tags">
  6884.   <p class="tag_title">Parameters:</p>
  6885. <ul class="param">
  6886.   
  6887.     <li>
  6888.       
  6889.         <span class='name'>protections</span>
  6890.       
  6891.       
  6892.         <span class='type'>(<tt>Hash|<span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>)</span>
  6893.       
  6894.       
  6895.       
  6896.         &mdash;
  6897.         <div class='inline'>
  6898. <p>A hash with a <code>protections</code> property that is an Array of
  6899. protections entries</p>
  6900. </div>
  6901.       
  6902.     </li>
  6903.   
  6904. </ul>
  6905.  
  6906.  
  6907. </div><table class="source_code">
  6908.   <tr>
  6909.     <td>
  6910.       <pre class="lines">
  6911.  
  6912.  
  6913. 15
  6914. 16
  6915. 17
  6916. 18
  6917. 19</pre>
  6918.     </td>
  6919.     <td>
  6920.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/protections.rb', line 15</span>
  6921.  
  6922. <span class='kw'>def</span> <span class='id identifier rubyid_update_protections'>update_protections</span><span class='lparen'>(</span><span class='id identifier rubyid_protections'>protections</span><span class='rparen'>)</span>
  6923.   <span class='id identifier rubyid_protections'>protections</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_protections'>protections</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_protections'>protections</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  6924.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:put</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>protections</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  6925.                            <span class='id identifier rubyid_protections'>protections</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  6926. <span class='kw'>end</span></pre>
  6927.     </td>
  6928.   </tr>
  6929. </table>
  6930. </div>
  6931.     
  6932.       <div class="method_details ">
  6933.   <h3 class="signature " id="update_server-instance_method">
  6934.   
  6935.     - (<tt>Object</tt>) <strong>update_server</strong>(server) 
  6936.   
  6937.  
  6938.   
  6939.  
  6940.   
  6941. </h3><table class="source_code">
  6942.   <tr>
  6943.     <td>
  6944.       <pre class="lines">
  6945.  
  6946.  
  6947. 24
  6948. 25
  6949. 26
  6950. 27
  6951. 28
  6952. 29</pre>
  6953.     </td>
  6954.     <td>
  6955.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/servers.rb', line 24</span>
  6956.  
  6957. <span class='kw'>def</span> <span class='id identifier rubyid_update_server'>update_server</span><span class='lparen'>(</span><span class='id identifier rubyid_server'>server</span><span class='rparen'>)</span>
  6958.   <span class='id identifier rubyid_server'>server</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_server'>server</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  6959.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:patch</span><span class='comma'>,</span>
  6960.                            <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>servers/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='const'>ServerID</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  6961.                            <span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  6962. <span class='kw'>end</span></pre>
  6963.     </td>
  6964.   </tr>
  6965. </table>
  6966. </div>
  6967.     
  6968.       <div class="method_details ">
  6969.   <h3 class="signature " id="update_stream-instance_method">
  6970.   
  6971.     - (<tt>Object</tt>) <strong>update_stream</strong>(stream) 
  6972.   
  6973.  
  6974.   
  6975.  
  6976.   
  6977. </h3><table class="source_code">
  6978.   <tr>
  6979.     <td>
  6980.       <pre class="lines">
  6981.  
  6982.  
  6983. 26
  6984. 27
  6985. 28
  6986. 29
  6987. 30</pre>
  6988.     </td>
  6989.     <td>
  6990.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/streams.rb', line 26</span>
  6991.  
  6992. <span class='kw'>def</span> <span class='id identifier rubyid_update_stream'>update_stream</span><span class='lparen'>(</span><span class='id identifier rubyid_stream'>stream</span><span class='rparen'>)</span>
  6993.   <span class='id identifier rubyid_stream'>stream</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_stream'>stream</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_stream'>stream</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  6994.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:patch</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>streams/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_stream'>stream</span><span class='period'>.</span><span class='id identifier rubyid_stream'>stream</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  6995.                            <span class='id identifier rubyid_stream'>stream</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  6996. <span class='kw'>end</span></pre>
  6997.     </td>
  6998.   </tr>
  6999. </table>
  7000. </div>
  7001.     
  7002.       <div class="method_details ">
  7003.   <h3 class="signature " id="update_triggers-instance_method">
  7004.   
  7005.     - (<tt>Object</tt>) <strong>update_triggers</strong>(triggers) 
  7006.   
  7007.  
  7008.   
  7009.  
  7010.   
  7011. </h3><div class="docstring">
  7012.   <div class="discussion">
  7013.     
  7014. <p>Update the triggers table using the Triggers model instance</p>
  7015.  
  7016.  
  7017.   </div>
  7018. </div>
  7019. <div class="tags">
  7020.   <p class="tag_title">Parameters:</p>
  7021. <ul class="param">
  7022.   
  7023.     <li>
  7024.       
  7025.         <span class='name'>triggers</span>
  7026.       
  7027.       
  7028.         <span class='type'>(<tt>Hash|<span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>)</span>
  7029.       
  7030.       
  7031.       
  7032.         &mdash;
  7033.         <div class='inline'>
  7034. <p>A hash with a <code>Triggers</code> property</p>
  7035. </div>
  7036.       
  7037.     </li>
  7038.   
  7039. </ul>
  7040.  
  7041.  
  7042. </div><table class="source_code">
  7043.   <tr>
  7044.     <td>
  7045.       <pre class="lines">
  7046.  
  7047.  
  7048. 16
  7049. 17
  7050. 18
  7051. 19</pre>
  7052.     </td>
  7053.     <td>
  7054.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/triggers.rb', line 16</span>
  7055.  
  7056. <span class='kw'>def</span> <span class='id identifier rubyid_update_triggers'>update_triggers</span><span class='lparen'>(</span><span class='id identifier rubyid_triggers'>triggers</span><span class='rparen'>)</span>
  7057.   <span class='id identifier rubyid_triggers'>triggers</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_triggers'>triggers</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_triggers'>triggers</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  7058.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:put</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>triggers</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_triggers'>triggers</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  7059. <span class='kw'>end</span></pre>
  7060.     </td>
  7061.   </tr>
  7062. </table>
  7063. </div>
  7064.     
  7065.       <div class="method_details ">
  7066.   <h3 class="signature " id="update_user-instance_method">
  7067.   
  7068.     - (<tt>Object</tt>) <strong>update_user</strong>(user) 
  7069.   
  7070.  
  7071.   
  7072.  
  7073.   
  7074. </h3><table class="source_code">
  7075.   <tr>
  7076.     <td>
  7077.       <pre class="lines">
  7078.  
  7079.  
  7080. 24
  7081. 25
  7082. 26
  7083. 27
  7084. 28</pre>
  7085.     </td>
  7086.     <td>
  7087.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/users.rb', line 24</span>
  7088.  
  7089. <span class='kw'>def</span> <span class='id identifier rubyid_update_user'>update_user</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
  7090.   <span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  7091.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:patch</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>users/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  7092.                            <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_marshal_dump'>marshal_dump</span><span class='rparen'>)</span>
  7093. <span class='kw'>end</span></pre>
  7094.     </td>
  7095.   </tr>
  7096. </table>
  7097. </div>
  7098.     
  7099.       <div class="method_details ">
  7100.   <h3 class="signature " id="upload_file-instance_method">
  7101.   
  7102.     - (<tt>Object</tt>) <strong>upload_file</strong>(file) 
  7103.   
  7104.  
  7105.   
  7106.  
  7107.   
  7108. </h3><div class="docstring">
  7109.   <div class="discussion">
  7110.     
  7111. <p>Upload a single file&#39;s content.</p>
  7112.  
  7113. <p>The <code>file</code> hash should contain the following fields:</p>
  7114. <ul><li>
  7115. <p><code>DepotFile</code>: target depot path</p>
  7116. </li><li>
  7117. <p><code>Content</code>: file content</p>
  7118. </li></ul>
  7119.  
  7120.  
  7121.   </div>
  7122. </div>
  7123. <div class="tags">
  7124.   <p class="tag_title">Parameters:</p>
  7125. <ul class="param">
  7126.   
  7127.     <li>
  7128.       
  7129.         <span class='name'>file</span>
  7130.       
  7131.       
  7132.         <span class='type'>(<tt>Hash</tt>)</span>
  7133.       
  7134.       
  7135.       
  7136.         &mdash;
  7137.         <div class='inline'>
  7138. <p>See description</p>
  7139. </div>
  7140.       
  7141.     </li>
  7142.   
  7143. </ul>
  7144.  
  7145.  
  7146. </div><table class="source_code">
  7147.   <tr>
  7148.     <td>
  7149.       <pre class="lines">
  7150.  
  7151.  
  7152. 60
  7153. 61
  7154. 62
  7155. 63
  7156. 64
  7157. 65
  7158. 66
  7159. 67
  7160. 68
  7161. 69
  7162. 70
  7163. 71</pre>
  7164.     </td>
  7165.     <td>
  7166.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/files.rb', line 60</span>
  7167.  
  7168. <span class='kw'>def</span> <span class='id identifier rubyid_upload_file'>upload_file</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='rparen'>)</span>
  7169.   <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  7170.   <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_encode_path'>encode_path</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_depot_file'>depot_file</span><span class='rparen'>)</span>
  7171.   <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
  7172.       <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DepotFile</span><span class='label_end'>&#39;:</span> <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_depot_file'>depot_file</span><span class='comma'>,</span>
  7173.       <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content</span><span class='label_end'>&#39;:</span> <span class='const'>Base64</span><span class='period'>.</span><span class='id identifier rubyid_encode64'>encode64</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
  7174.   <span class='rbrace'>}</span>
  7175.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:patch</span><span class='comma'>,</span>
  7176.                            <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>files/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  7177.                            <span class='kw'>nil</span><span class='comma'>,</span>
  7178.                            <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
  7179. <span class='kw'>end</span></pre>
  7180.     </td>
  7181.   </tr>
  7182. </table>
  7183. </div>
  7184.     
  7185.       <div class="method_details ">
  7186.   <h3 class="signature " id="upload_files-instance_method">
  7187.   
  7188.     - (<tt>Object</tt>) <strong>upload_files</strong>(files: [], path: nil, description: nil) 
  7189.   
  7190.  
  7191.   
  7192.  
  7193.   
  7194. </h3><div class="docstring">
  7195.   <div class="discussion">
  7196.     
  7197. <p>Upload multiple files</p>
  7198.  
  7199. <p>Each file in the <code>Files</code> array should have two fields</p>
  7200. <ul><li>
  7201. <p><code>DepotFile</code>: target path, can be relative if <code>path</code>
  7202. is indicated</p>
  7203. </li><li>
  7204. <p><code>Content</code>: File content</p>
  7205. </li></ul>
  7206.  
  7207. <p>The optional <code>path</code> parameter can indicate the root directory
  7208. for all files.</p>
  7209.  
  7210.  
  7211.   </div>
  7212. </div>
  7213. <div class="tags">
  7214.   <p class="tag_title">Parameters:</p>
  7215. <ul class="param">
  7216.   
  7217.     <li>
  7218.       
  7219.         <span class='name'>files</span>
  7220.       
  7221.       
  7222.         <span class='type'>(<tt>Array</tt>)</span>
  7223.       
  7224.       
  7225.       
  7226.         &mdash;
  7227.         <div class='inline'>
  7228. <p>See description</p>
  7229. </div>
  7230.       
  7231.     </li>
  7232.   
  7233.     <li>
  7234.       
  7235.         <span class='name'>path</span>
  7236.       
  7237.       
  7238.         <span class='type'>(<tt>String</tt>)</span>
  7239.       
  7240.       
  7241.       
  7242.         &mdash;
  7243.         <div class='inline'>
  7244. <p>If set, the root directory for all files</p>
  7245. </div>
  7246.       
  7247.     </li>
  7248.   
  7249.     <li>
  7250.       
  7251.         <span class='name'>description</span>
  7252.       
  7253.       
  7254.         <span class='type'>(<tt>String</tt>)</span>
  7255.       
  7256.       
  7257.       
  7258.         &mdash;
  7259.         <div class='inline'>
  7260. <p>Informative message about the change</p>
  7261. </div>
  7262.       
  7263.     </li>
  7264.   
  7265. </ul>
  7266.  
  7267.  
  7268. </div><table class="source_code">
  7269.   <tr>
  7270.     <td>
  7271.       <pre class="lines">
  7272.  
  7273.  
  7274. 86
  7275. 87
  7276. 88
  7277. 89
  7278. 90
  7279. 91
  7280. 92
  7281. 93
  7282. 94
  7283. 95
  7284. 96
  7285. 97
  7286. 98
  7287. 99
  7288. 100
  7289. 101
  7290. 102
  7291. 103
  7292. 104</pre>
  7293.     </td>
  7294.     <td>
  7295.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/files.rb', line 86</span>
  7296.  
  7297. <span class='kw'>def</span> <span class='id identifier rubyid_upload_files'>upload_files</span><span class='lparen'>(</span><span class='label'>files:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  7298.   <span class='id identifier rubyid_files'>files</span> <span class='op'>=</span> <span class='id identifier rubyid_files'>files</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span>
  7299.     <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_f'>f</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  7300.   <span class='kw'>end</span>
  7301.  
  7302.   <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span> <span class='op'>?</span> <span class='id identifier rubyid_encode_path'>encode_path</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
  7303.  
  7304.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='lbrace'>{</span>
  7305.       <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Files</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_files'>files</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span>
  7306.         <span class='lbrace'>{</span>
  7307.             <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DepotFile</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_depot_file'>depot_file</span><span class='comma'>,</span>
  7308.             <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='const'>Base64</span><span class='period'>.</span><span class='id identifier rubyid_encode64'>encode64</span><span class='lparen'>(</span><span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
  7309.         <span class='rbrace'>}</span>
  7310.       <span class='kw'>end</span>
  7311.   <span class='rbrace'>}</span>
  7312.   <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Description</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
  7313.  
  7314.   <span class='id identifier rubyid_execute_method_with_body'>execute_method_with_body</span><span class='lparen'>(</span><span class='symbol'>:patch</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>files/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  7315. <span class='kw'>end</span></pre>
  7316.     </td>
  7317.   </tr>
  7318. </table>
  7319. </div>
  7320.     
  7321.       <div class="method_details ">
  7322.   <h3 class="signature " id="user_details-instance_method">
  7323.   
  7324.     - (<tt>Object</tt>) <strong>user_details</strong>(user) 
  7325.   
  7326.  
  7327.   
  7328.  
  7329.   
  7330. </h3><div class="docstring">
  7331.   <div class="discussion">
  7332.     
  7333. <p>Returns a HelixWebServicesClient::OpenModel for the login</p>
  7334.  
  7335.  
  7336.   </div>
  7337. </div>
  7338. <div class="tags">
  7339.   
  7340.  
  7341. </div><table class="source_code">
  7342.   <tr>
  7343.     <td>
  7344.       <pre class="lines">
  7345.  
  7346.  
  7347. 12
  7348. 13
  7349. 14
  7350. 15
  7351. 16</pre>
  7352.     </td>
  7353.     <td>
  7354.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/users.rb', line 12</span>
  7355.  
  7356. <span class='kw'>def</span> <span class='id identifier rubyid_user_details'>user_details</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
  7357.   <span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span> <span class='kw'>if</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='rparen'>)</span>
  7358.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>users/</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  7359.   <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  7360. <span class='kw'>end</span></pre>
  7361.     </td>
  7362.   </tr>
  7363. </table>
  7364. </div>
  7365.     
  7366.       <div class="method_details ">
  7367.   <h3 class="signature " id="users-instance_method">
  7368.   
  7369.     - (<tt>Object</tt>) <strong>users</strong> 
  7370.   
  7371.  
  7372.   
  7373.  
  7374.   
  7375. </h3><div class="docstring">
  7376.   <div class="discussion">
  7377.     
  7378. <p>Returns an array of User objects representing people in the system.</p>
  7379.  
  7380.  
  7381.   </div>
  7382. </div>
  7383. <div class="tags">
  7384.   
  7385.  
  7386. </div><table class="source_code">
  7387.   <tr>
  7388.     <td>
  7389.       <pre class="lines">
  7390.  
  7391.  
  7392. 6
  7393. 7
  7394. 8
  7395. 9</pre>
  7396.     </td>
  7397.     <td>
  7398.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/users.rb', line 6</span>
  7399.  
  7400. <span class='kw'>def</span> <span class='id identifier rubyid_users'>users</span>
  7401.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='id identifier rubyid_execute_method_no_body'>execute_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_hve_path'>hve_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>users</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  7402.   <span class='id identifier rubyid_arr'>arr</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_obj'>obj</span><span class='op'>|</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  7403. <span class='kw'>end</span></pre>
  7404.     </td>
  7405.   </tr>
  7406. </table>
  7407. </div>
  7408.     
  7409.       <div class="method_details ">
  7410.   <h3 class="signature " id="version-instance_method">
  7411.   
  7412.     - (<tt>Object</tt>) <strong>version</strong> 
  7413.   
  7414.  
  7415.   
  7416.  
  7417.   
  7418. </h3><div class="docstring">
  7419.   <div class="discussion">
  7420.     
  7421. <p>Return the product version ID of the Helix Web Services instance</p>
  7422.  
  7423.  
  7424.   </div>
  7425. </div>
  7426. <div class="tags">
  7427.   
  7428.  
  7429. </div><table class="source_code">
  7430.   <tr>
  7431.     <td>
  7432.       <pre class="lines">
  7433.  
  7434.  
  7435. 233
  7436. 234
  7437. 235
  7438. 236</pre>
  7439.     </td>
  7440.     <td>
  7441.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 233</span>
  7442.  
  7443. <span class='kw'>def</span> <span class='id identifier rubyid_version'>version</span>
  7444.   <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_run_method_no_body'>run_method_no_body</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/status</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  7445.   <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>X-Helix-Web-Services-Version</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  7446. <span class='kw'>end</span></pre>
  7447.     </td>
  7448.   </tr>
  7449. </table>
  7450. </div>
  7451.     
  7452.   </div>
  7453.  
  7454. </div>
  7455.  
  7456.     <div id="footer">
  7457.   Generated on Tue Sep 15 01:20:25 2015 by
  7458.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  7459.   0.8.7.6 (ruby-2.2.3).
  7460. </div>
  7461.  
  7462.   </body>
  7463. </html>
# Change User Description Committed
#1 15741 ptomiak Branch HWS for my use. 10 years ago