files/HelixWebServicesClient.html

HelixWebServicesClient.html 

  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,<br /> lib/helix_web_services_client/git_fusion_keys.rb,<br /> lib/helix_web_services_client/git_fusion_repo.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_key-instance_method" title="#add_key (instance method)">- (Object) <strong>add_key</strong>(user, key_name, key) </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>Add a key for a specified user.</p>
  329. </div></span>
  330.   
  331. </li>
  332.  
  333.       
  334.         <li class="public ">
  335.   <span class="summary_signature">
  336.     
  337.       <a href="#add_setting-instance_method" title="#add_setting (instance method)">- (Object) <strong>add_setting</strong>(key, value) </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>Set an override for all requests.</p>
  353. </div></span>
  354.   
  355. </li>
  356.  
  357.       
  358.         <li class="public ">
  359.   <span class="summary_signature">
  360.     
  361.       <a href="#arg_params-instance_method" title="#arg_params (instance method)">- (Object) <strong>arg_params</strong>(arg_values) </a>
  362.     
  363.  
  364.     
  365.   </span>
  366.   
  367.   
  368.   
  369.   
  370.   
  371.   
  372.   
  373.  
  374.   
  375.     <span class="summary_desc"><div class='inline'>
  376. <p>Creates a hash and creates keys &#39;arg1&#39;, &#39;arg2&#39;, etc that
  377. points to the values in the arg_values array.</p>
  378. </div></span>
  379.   
  380. </li>
  381.  
  382.       
  383.         <li class="public ">
  384.   <span class="summary_signature">
  385.     
  386.       <a href="#assert_ok-instance_method" title="#assert_ok (instance method)">- (Object) <strong>assert_ok</strong>(response) </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>Raises an error when the response is not 200.</p>
  402. </div></span>
  403.   
  404. </li>
  405.  
  406.       
  407.         <li class="public ">
  408.   <span class="summary_signature">
  409.     
  410.       <a href="#branch-instance_method" title="#branch (instance method)">- (Object) <strong>branch</strong>(branch) </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>Returns the branch instance indicated by the branch name (or model).</p>
  426. </div></span>
  427.   
  428. </li>
  429.  
  430.       
  431.         <li class="public ">
  432.   <span class="summary_signature">
  433.     
  434.       <a href="#branches-instance_method" title="#branches (instance method)">- (Object) <strong>branches</strong> </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>Array of Branch objects stored in the system.</p>
  450. </div></span>
  451.   
  452. </li>
  453.  
  454.       
  455.         <li class="public ">
  456.   <span class="summary_signature">
  457.     
  458.       <a href="#change-instance_method" title="#change (instance method)">- (Object) <strong>change</strong>(change) </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>Returns the Change indicated by the change number or model.</p>
  474. </div></span>
  475.   
  476. </li>
  477.  
  478.       
  479.         <li class="public ">
  480.   <span class="summary_signature">
  481.     
  482.       <a href="#changes-instance_method" title="#changes (instance method)">- (Object) <strong>changes</strong>(options = nil) </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>List changelists in the system.</p>
  498. </div></span>
  499.   
  500. </li>
  501.  
  502.       
  503.         <li class="public ">
  504.   <span class="summary_signature">
  505.     
  506.       <a href="#client-instance_method" title="#client (instance method)">- (Object) <strong>client</strong>(client) </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>Returns the client instance indicated by the client name or model.</p>
  522. </div></span>
  523.   
  524. </li>
  525.  
  526.       
  527.         <li class="public ">
  528.   <span class="summary_signature">
  529.     
  530.       <a href="#clients-instance_method" title="#clients (instance method)">- (Object) <strong>clients</strong> </a>
  531.     
  532.  
  533.     
  534.   </span>
  535.   
  536.   
  537.   
  538.   
  539.   
  540.   
  541.   
  542.  
  543.   
  544.     <span class="summary_desc"><div class='inline'>
  545. <p>Array of Client objects stored in the system.</p>
  546. </div></span>
  547.   
  548. </li>
  549.  
  550.       
  551.         <li class="public ">
  552.   <span class="summary_signature">
  553.     
  554.       <a href="#close-instance_method" title="#close (instance method)">- (Object) <strong>close</strong> </a>
  555.     
  556.  
  557.     
  558.   </span>
  559.   
  560.   
  561.   
  562.   
  563.   
  564.   
  565.   
  566.  
  567.   
  568.     <span class="summary_desc"><div class='inline'></div></span>
  569.   
  570. </li>
  571.  
  572.       
  573.         <li class="public ">
  574.   <span class="summary_signature">
  575.     
  576.       <a href="#command-instance_method" title="#command (instance method)">- (OpenModel) <strong>command</strong>(cmd, *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>Execute a Perforce command.</p>
  592. </div></span>
  593.   
  594. </li>
  595.  
  596.       
  597.         <li class="public ">
  598.   <span class="summary_signature">
  599.     
  600.       <a href="#command_with_input-instance_method" title="#command_with_input (instance method)">- (Object) <strong>command_with_input</strong>(cmd, input, *args) </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>Generic run command with and input body.</p>
  616. </div></span>
  617.   
  618. </li>
  619.  
  620.       
  621.         <li class="public ">
  622.   <span class="summary_signature">
  623.     
  624.       <a href="#commit_change-instance_method" title="#commit_change (instance method)">- (Object) <strong>commit_change</strong>(change) </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>Submits the shelved changelist.</p>
  640. </div></span>
  641.   
  642. </li>
  643.  
  644.       
  645.         <li class="public ">
  646.   <span class="summary_signature">
  647.     
  648.       <a href="#counter-instance_method" title="#counter (instance method)">- (Object) <strong>counter</strong>(counter) </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>Return the counter hash for a particular counter key.</p>
  664. </div></span>
  665.   
  666. </li>
  667.  
  668.       
  669.         <li class="public ">
  670.   <span class="summary_signature">
  671.     
  672.       <a href="#counters-instance_method" title="#counters (instance method)">- (Object) <strong>counters</strong> </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>List all counters 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_branch-instance_method" title="#create_branch (instance method)">- (Object) <strong>create_branch</strong>(branch) </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 branch in the system.</p>
  712. </div></span>
  713.   
  714. </li>
  715.  
  716.       
  717.         <li class="public ">
  718.   <span class="summary_signature">
  719.     
  720.       <a href="#create_change-instance_method" title="#create_change (instance method)">- (Object) <strong>create_change</strong>(change) </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 changelist, that can be used for a few different tasks.</p>
  736. </div></span>
  737.   
  738. </li>
  739.  
  740.       
  741.         <li class="public ">
  742.   <span class="summary_signature">
  743.     
  744.       <a href="#create_client-instance_method" title="#create_client (instance method)">- (Object) <strong>create_client</strong>(client) </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 client 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_depot-instance_method" title="#create_depot (instance method)">- (Object) <strong>create_depot</strong>(depot) </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 depot 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_group-instance_method" title="#create_group (instance method)">- (Object) <strong>create_group</strong>(group) </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>Creates a new group in the system.</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_device_client-instance_method" title="#create_helix_sync_device_client (instance method)">- (Object) <strong>create_helix_sync_device_client</strong>(project_id, device, root) </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>Create a new client workspace specification for a 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_helix_sync_shelf_client-instance_method" title="#create_helix_sync_shelf_client (instance method)">- (Object) <strong>create_helix_sync_shelf_client</strong>(project_id) </a>
  841.     
  842.  
  843.     
  844.   </span>
  845.   
  846.   
  847.   
  848.   
  849.   
  850.   
  851.   
  852.  
  853.   
  854.     <span class="summary_desc"><div class='inline'></div></span>
  855.   
  856. </li>
  857.  
  858.       
  859.         <li class="public ">
  860.   <span class="summary_signature">
  861.     
  862.       <a href="#create_job-instance_method" title="#create_job (instance method)">- (Object) <strong>create_job</strong>(job) </a>
  863.     
  864.  
  865.     
  866.   </span>
  867.   
  868.   
  869.   
  870.   
  871.   
  872.   
  873.   
  874.  
  875.   
  876.     <span class="summary_desc"><div class='inline'>
  877. <p>Creates a new job in the system.</p>
  878. </div></span>
  879.   
  880. </li>
  881.  
  882.       
  883.         <li class="public ">
  884.   <span class="summary_signature">
  885.     
  886.       <a href="#create_label-instance_method" title="#create_label (instance method)">- (Object) <strong>create_label</strong>(label) </a>
  887.     
  888.  
  889.     
  890.   </span>
  891.   
  892.   
  893.   
  894.   
  895.   
  896.   
  897.   
  898.  
  899.   
  900.     <span class="summary_desc"><div class='inline'>
  901. <p>Creates a new label in the system.</p>
  902. </div></span>
  903.   
  904. </li>
  905.  
  906.       
  907.         <li class="public ">
  908.   <span class="summary_signature">
  909.     
  910.       <a href="#create_server-instance_method" title="#create_server (instance method)">- (Object) <strong>create_server</strong>(server) </a>
  911.     
  912.  
  913.     
  914.   </span>
  915.   
  916.   
  917.   
  918.   
  919.   
  920.   
  921.   
  922.  
  923.   
  924.     <span class="summary_desc"><div class='inline'>
  925. <p>Creates a new server in the system based on the Server instance.</p>
  926. </div></span>
  927.   
  928. </li>
  929.  
  930.       
  931.         <li class="public ">
  932.   <span class="summary_signature">
  933.     
  934.       <a href="#create_stream-instance_method" title="#create_stream (instance method)">- (Object) <strong>create_stream</strong>(stream) </a>
  935.     
  936.  
  937.     
  938.   </span>
  939.   
  940.   
  941.   
  942.   
  943.   
  944.   
  945.   
  946.  
  947.   
  948.     <span class="summary_desc"><div class='inline'>
  949. <p>Creates a new stream in the system based on the Stream instance.</p>
  950. </div></span>
  951.   
  952. </li>
  953.  
  954.       
  955.         <li class="public ">
  956.   <span class="summary_signature">
  957.     
  958.       <a href="#create_user-instance_method" title="#create_user (instance method)">- (Object) <strong>create_user</strong>(user) </a>
  959.     
  960.  
  961.     
  962.   </span>
  963.   
  964.   
  965.   
  966.   
  967.   
  968.   
  969.   
  970.  
  971.   
  972.     <span class="summary_desc"><div class='inline'>
  973. <p>Creates a new user in the system based on the User instance.</p>
  974. </div></span>
  975.   
  976. </li>
  977.  
  978.       
  979.         <li class="public ">
  980.   <span class="summary_signature">
  981.     
  982.       <a href="#delete_branch-instance_method" title="#delete_branch (instance method)">- (Object) <strong>delete_branch</strong>(branch) </a>
  983.     
  984.  
  985.     
  986.   </span>
  987.   
  988.   
  989.   
  990.   
  991.   
  992.   
  993.   
  994.  
  995.   
  996.     <span class="summary_desc"><div class='inline'>
  997. <p>Deletes the branch specification in the system.</p>
  998. </div></span>
  999.   
  1000. </li>
  1001.  
  1002.       
  1003.         <li class="public ">
  1004.   <span class="summary_signature">
  1005.     
  1006.       <a href="#delete_client-instance_method" title="#delete_client (instance method)">- (Object) <strong>delete_client</strong>(client) </a>
  1007.     
  1008.  
  1009.     
  1010.   </span>
  1011.   
  1012.   
  1013.   
  1014.   
  1015.   
  1016.   
  1017.   
  1018.  
  1019.   
  1020.     <span class="summary_desc"><div class='inline'>
  1021. <p>Deletes the client specification in the system.</p>
  1022. </div></span>
  1023.   
  1024. </li>
  1025.  
  1026.       
  1027.         <li class="public ">
  1028.   <span class="summary_signature">
  1029.     
  1030.       <a href="#delete_counter-instance_method" title="#delete_counter (instance method)">- (Object) <strong>delete_counter</strong>(counter) </a>
  1031.     
  1032.  
  1033.     
  1034.   </span>
  1035.   
  1036.   
  1037.   
  1038.   
  1039.   
  1040.   
  1041.   
  1042.  
  1043.   
  1044.     <span class="summary_desc"><div class='inline'>
  1045. <p>Delete the counter.</p>
  1046. </div></span>
  1047.   
  1048. </li>
  1049.  
  1050.       
  1051.         <li class="public ">
  1052.   <span class="summary_signature">
  1053.     
  1054.       <a href="#delete_depot-instance_method" title="#delete_depot (instance method)">- (Object) <strong>delete_depot</strong>(depot) </a>
  1055.     
  1056.  
  1057.     
  1058.   </span>
  1059.   
  1060.   
  1061.   
  1062.   
  1063.   
  1064.   
  1065.   
  1066.  
  1067.   
  1068.     <span class="summary_desc"><div class='inline'>
  1069. <p>Deletes the depot specification in the system.</p>
  1070. </div></span>
  1071.   
  1072. </li>
  1073.  
  1074.       
  1075.         <li class="public ">
  1076.   <span class="summary_signature">
  1077.     
  1078.       <a href="#delete_file-instance_method" title="#delete_file (instance method)">- (Object) <strong>delete_file</strong>(path) </a>
  1079.     
  1080.  
  1081.     
  1082.   </span>
  1083.   
  1084.   
  1085.   
  1086.   
  1087.   
  1088.   
  1089.   
  1090.  
  1091.   
  1092.     <span class="summary_desc"><div class='inline'></div></span>
  1093.   
  1094. </li>
  1095.  
  1096.       
  1097.         <li class="public ">
  1098.   <span class="summary_signature">
  1099.     
  1100.       <a href="#delete_group-instance_method" title="#delete_group (instance method)">- (Object) <strong>delete_group</strong>(group) </a>
  1101.     
  1102.  
  1103.     
  1104.   </span>
  1105.   
  1106.   
  1107.   
  1108.   
  1109.   
  1110.   
  1111.   
  1112.  
  1113.   
  1114.     <span class="summary_desc"><div class='inline'>
  1115. <p>Deletes the group specification in the system.</p>
  1116. </div></span>
  1117.   
  1118. </li>
  1119.  
  1120.       
  1121.         <li class="public ">
  1122.   <span class="summary_signature">
  1123.     
  1124.       <a href="#delete_helix_sync_device_client-instance_method" title="#delete_helix_sync_device_client (instance method)">- (Object) <strong>delete_helix_sync_device_client</strong>(project_id, device) </a>
  1125.     
  1126.  
  1127.     
  1128.   </span>
  1129.   
  1130.   
  1131.   
  1132.   
  1133.   
  1134.   
  1135.   
  1136.  
  1137.   
  1138.     <span class="summary_desc"><div class='inline'></div></span>
  1139.   
  1140. </li>
  1141.  
  1142.       
  1143.         <li class="public ">
  1144.   <span class="summary_signature">
  1145.     
  1146.       <a href="#delete_helix_sync_pending_changelist-instance_method" title="#delete_helix_sync_pending_changelist (instance method)">- (Object) <strong>delete_helix_sync_pending_changelist</strong>(project_id) </a>
  1147.     
  1148.  
  1149.     
  1150.   </span>
  1151.   
  1152.   
  1153.   
  1154.   
  1155.   
  1156.   
  1157.   
  1158.  
  1159.   
  1160.     <span class="summary_desc"><div class='inline'>
  1161. <p>Remove the pending changelist used for a Helix Sync project.</p>
  1162. </div></span>
  1163.   
  1164. </li>
  1165.  
  1166.       
  1167.         <li class="public ">
  1168.   <span class="summary_signature">
  1169.     
  1170.       <a href="#delete_helix_sync_shelf_client-instance_method" title="#delete_helix_sync_shelf_client (instance method)">- (Object) <strong>delete_helix_sync_shelf_client</strong>(project_id) </a>
  1171.     
  1172.  
  1173.     
  1174.   </span>
  1175.   
  1176.   
  1177.   
  1178.   
  1179.   
  1180.   
  1181.   
  1182.  
  1183.   
  1184.     <span class="summary_desc"><div class='inline'></div></span>
  1185.   
  1186. </li>
  1187.  
  1188.       
  1189.         <li class="public ">
  1190.   <span class="summary_signature">
  1191.     
  1192.       <a href="#delete_job-instance_method" title="#delete_job (instance method)">- (Object) <strong>delete_job</strong>(job_id) </a>
  1193.     
  1194.  
  1195.     
  1196.   </span>
  1197.   
  1198.   
  1199.   
  1200.   
  1201.   
  1202.   
  1203.   
  1204.  
  1205.   
  1206.     <span class="summary_desc"><div class='inline'>
  1207. <p>Deletes the job specification in the system.</p>
  1208. </div></span>
  1209.   
  1210. </li>
  1211.  
  1212.       
  1213.         <li class="public ">
  1214.   <span class="summary_signature">
  1215.     
  1216.       <a href="#delete_key-instance_method" title="#delete_key (instance method)">- (Object) <strong>delete_key</strong>(user, key_name) </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>Delete a specific SSH key.</p>
  1232. </div></span>
  1233.   
  1234. </li>
  1235.  
  1236.       
  1237.         <li class="public ">
  1238.   <span class="summary_signature">
  1239.     
  1240.       <a href="#delete_keys-instance_method" title="#delete_keys (instance method)">- (Object) <strong>delete_keys</strong>(user) </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>Delete all keys for a user.</p>
  1256. </div></span>
  1257.   
  1258. </li>
  1259.  
  1260.       
  1261.         <li class="public ">
  1262.   <span class="summary_signature">
  1263.     
  1264.       <a href="#delete_label-instance_method" title="#delete_label (instance method)">- (Object) <strong>delete_label</strong>(label) </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>Deletes the label specification in the system.</p>
  1280. </div></span>
  1281.   
  1282. </li>
  1283.  
  1284.       
  1285.         <li class="public ">
  1286.   <span class="summary_signature">
  1287.     
  1288.       <a href="#delete_repo-instance_method" title="#delete_repo (instance method)">- (Object) <strong>delete_repo</strong>(repo_name) </a>
  1289.     
  1290.  
  1291.     
  1292.   </span>
  1293.   
  1294.   
  1295.   
  1296.   
  1297.   
  1298.   
  1299.   
  1300.  
  1301.   
  1302.     <span class="summary_desc"><div class='inline'>
  1303. <p>Delete a repository.</p>
  1304. </div></span>
  1305.   
  1306. </li>
  1307.  
  1308.       
  1309.         <li class="public ">
  1310.   <span class="summary_signature">
  1311.     
  1312.       <a href="#delete_server-instance_method" title="#delete_server (instance method)">- (Object) <strong>delete_server</strong>(server) </a>
  1313.     
  1314.  
  1315.     
  1316.   </span>
  1317.   
  1318.   
  1319.   
  1320.   
  1321.   
  1322.   
  1323.   
  1324.  
  1325.   
  1326.     <span class="summary_desc"><div class='inline'></div></span>
  1327.   
  1328. </li>
  1329.  
  1330.       
  1331.         <li class="public ">
  1332.   <span class="summary_signature">
  1333.     
  1334.       <a href="#delete_stream-instance_method" title="#delete_stream (instance method)">- (Object) <strong>delete_stream</strong>(stream) </a>
  1335.     
  1336.  
  1337.     
  1338.   </span>
  1339.   
  1340.   
  1341.   
  1342.   
  1343.   
  1344.   
  1345.   
  1346.  
  1347.   
  1348.     <span class="summary_desc"><div class='inline'></div></span>
  1349.   
  1350. </li>
  1351.  
  1352.       
  1353.         <li class="public ">
  1354.   <span class="summary_signature">
  1355.     
  1356.       <a href="#delete_user-instance_method" title="#delete_user (instance method)">- (Object) <strong>delete_user</strong>(user) </a>
  1357.     
  1358.  
  1359.     
  1360.   </span>
  1361.   
  1362.   
  1363.   
  1364.   
  1365.   
  1366.   
  1367.   
  1368.  
  1369.   
  1370.     <span class="summary_desc"><div class='inline'></div></span>
  1371.   
  1372. </li>
  1373.  
  1374.       
  1375.         <li class="public ">
  1376.   <span class="summary_signature">
  1377.     
  1378.       <a href="#depot-instance_method" title="#depot (instance method)">- (Object) <strong>depot</strong>(depot) </a>
  1379.     
  1380.  
  1381.     
  1382.   </span>
  1383.   
  1384.   
  1385.   
  1386.   
  1387.   
  1388.   
  1389.   
  1390.  
  1391.   
  1392.     <span class="summary_desc"><div class='inline'>
  1393. <p>Returns the depot instance indicated by the depot name (or depot object).</p>
  1394. </div></span>
  1395.   
  1396. </li>
  1397.  
  1398.       
  1399.         <li class="public ">
  1400.   <span class="summary_signature">
  1401.     
  1402.       <a href="#depots-instance_method" title="#depots (instance method)">- (Object) <strong>depots</strong> </a>
  1403.     
  1404.  
  1405.     
  1406.   </span>
  1407.   
  1408.   
  1409.   
  1410.   
  1411.   
  1412.   
  1413.   
  1414.  
  1415.   
  1416.     <span class="summary_desc"><div class='inline'>
  1417. <p>Array of Depot objects stored in the system.</p>
  1418. </div></span>
  1419.   
  1420. </li>
  1421.  
  1422.       
  1423.         <li class="public ">
  1424.   <span class="summary_signature">
  1425.     
  1426.       <a href="#encode_component-instance_method" title="#encode_component (instance method)">- (Object) <strong>encode_component</strong>(str) </a>
  1427.     
  1428.  
  1429.     
  1430.   </span>
  1431.   
  1432.   
  1433.   
  1434.   
  1435.   
  1436.   
  1437.   
  1438.  
  1439.   
  1440.     <span class="summary_desc"><div class='inline'></div></span>
  1441.   
  1442. </li>
  1443.  
  1444.       
  1445.         <li class="public ">
  1446.   <span class="summary_signature">
  1447.     
  1448.       <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>
  1449.     
  1450.  
  1451.     
  1452.   </span>
  1453.   
  1454.   
  1455.   
  1456.   
  1457.   
  1458.   
  1459.   
  1460.  
  1461.   
  1462.     <span class="summary_desc"><div class='inline'>
  1463. <p>Runs the method against Helix Web Services, checks for errors, then parses
  1464. the JSON response.</p>
  1465. </div></span>
  1466.   
  1467. </li>
  1468.  
  1469.       
  1470.         <li class="public ">
  1471.   <span class="summary_signature">
  1472.     
  1473.       <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>
  1474.     
  1475.  
  1476.     
  1477.   </span>
  1478.   
  1479.   
  1480.   
  1481.   
  1482.   
  1483.   
  1484.   
  1485.  
  1486.   
  1487.     <span class="summary_desc"><div class='inline'>
  1488. <p>Runs the method against Helix Web Services, checks for errors, then parses
  1489. the JSON response.</p>
  1490. </div></span>
  1491.   
  1492. </li>
  1493.  
  1494.       
  1495.         <li class="public ">
  1496.   <span class="summary_signature">
  1497.     
  1498.       <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>
  1499.     
  1500.  
  1501.     
  1502.   </span>
  1503.   
  1504.   
  1505.   
  1506.   
  1507.   
  1508.   
  1509.   
  1510.  
  1511.   
  1512.     <span class="summary_desc"><div class='inline'>
  1513. <p>Retrieve the latest changelist.</p>
  1514. </div></span>
  1515.   
  1516. </li>
  1517.  
  1518.       
  1519.         <li class="public ">
  1520.   <span class="summary_signature">
  1521.     
  1522.       <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>
  1523.     
  1524.  
  1525.     
  1526.   </span>
  1527.   
  1528.   
  1529.   
  1530.   
  1531.   
  1532.   
  1533.   
  1534.  
  1535.   
  1536.     <span class="summary_desc"><div class='inline'>
  1537. <p>Retrieve the pending changelist.</p>
  1538. </div></span>
  1539.   
  1540. </li>
  1541.  
  1542.       
  1543.         <li class="public ">
  1544.   <span class="summary_signature">
  1545.     
  1546.       <a href="#file-instance_method" title="#file (instance method)">- (Object) <strong>file</strong>(path) </a>
  1547.     
  1548.  
  1549.     
  1550.   </span>
  1551.   
  1552.   
  1553.   
  1554.   
  1555.   
  1556.   
  1557.   
  1558.  
  1559.   
  1560.     <span class="summary_desc"><div class='inline'>
  1561. <p>Returns the file metadata at this location, with the <code>content</code>
  1562. field filled out.</p>
  1563. </div></span>
  1564.   
  1565. </li>
  1566.  
  1567.       
  1568.         <li class="public ">
  1569.   <span class="summary_signature">
  1570.     
  1571.       <a href="#files-instance_method" title="#files (instance method)">- (Object) <strong>files</strong>(path = &#39;&#39;) </a>
  1572.     
  1573.  
  1574.     
  1575.   </span>
  1576.   
  1577.   
  1578.   
  1579.   
  1580.   
  1581.   
  1582.   
  1583.  
  1584.   
  1585.     <span class="summary_desc"><div class='inline'>
  1586. <p>General file browsing method.</p>
  1587. </div></span>
  1588.   
  1589. </li>
  1590.  
  1591.       
  1592.         <li class="public ">
  1593.   <span class="summary_signature">
  1594.     
  1595.       <a href="#group-instance_method" title="#group (instance method)">- (Object) <strong>group</strong>(group) </a>
  1596.     
  1597.  
  1598.     
  1599.   </span>
  1600.   
  1601.   
  1602.   
  1603.   
  1604.   
  1605.   
  1606.   
  1607.  
  1608.   
  1609.     <span class="summary_desc"><div class='inline'>
  1610. <p>Returns the group instance indicated by the group name (or group object).</p>
  1611. </div></span>
  1612.   
  1613. </li>
  1614.  
  1615.       
  1616.         <li class="public ">
  1617.   <span class="summary_signature">
  1618.     
  1619.       <a href="#groups-instance_method" title="#groups (instance method)">- (Object) <strong>groups</strong> </a>
  1620.     
  1621.  
  1622.     
  1623.   </span>
  1624.   
  1625.   
  1626.   
  1627.   
  1628.   
  1629.   
  1630.   
  1631.  
  1632.   
  1633.     <span class="summary_desc"><div class='inline'>
  1634. <p>Array of Group objects stored in the system.</p>
  1635. </div></span>
  1636.   
  1637. </li>
  1638.  
  1639.       
  1640.         <li class="public ">
  1641.   <span class="summary_signature">
  1642.     
  1643.       <a href="#hve_path-instance_method" title="#hve_path (instance method)">- (Object) <strong>hve_path</strong>(subpath) </a>
  1644.     
  1645.  
  1646.     
  1647.   </span>
  1648.   
  1649.   
  1650.   
  1651.   
  1652.   
  1653.   
  1654.   
  1655.  
  1656.   
  1657.     <span class="summary_desc"><div class='inline'></div></span>
  1658.   
  1659. </li>
  1660.  
  1661.       
  1662.         <li class="public ">
  1663.   <span class="summary_signature">
  1664.     
  1665.       <a href="#increment_counter-instance_method" title="#increment_counter (instance method)">- (Object) <strong>increment_counter</strong>(counter) </a>
  1666.     
  1667.  
  1668.     
  1669.   </span>
  1670.   
  1671.   
  1672.   
  1673.   
  1674.   
  1675.   
  1676.   
  1677.  
  1678.   
  1679.     <span class="summary_desc"><div class='inline'>
  1680. <p>Increment the value of a numerical counter.</p>
  1681. </div></span>
  1682.   
  1683. </li>
  1684.  
  1685.       
  1686.         <li class="public ">
  1687.   <span class="summary_signature">
  1688.     
  1689.       <a href="#initialize-instance_method" title="#initialize (instance method)">- (HelixWebServicesClient) <strong>initialize</strong>(options) </a>
  1690.     
  1691.  
  1692.     
  1693.   </span>
  1694.   
  1695.   
  1696.     <span class="note title constructor">constructor</span>
  1697.   
  1698.   
  1699.   
  1700.   
  1701.   
  1702.   
  1703.  
  1704.   
  1705.     <span class="summary_desc"><div class='inline'>
  1706. <p>Client initialization can handle ensuring a valid security token to the
  1707. server.</p>
  1708. </div></span>
  1709.   
  1710. </li>
  1711.  
  1712.       
  1713.         <li class="public ">
  1714.   <span class="summary_signature">
  1715.     
  1716.       <a href="#job-instance_method" title="#job (instance method)">- (Object) <strong>job</strong>(job_id) </a>
  1717.     
  1718.  
  1719.     
  1720.   </span>
  1721.   
  1722.   
  1723.   
  1724.   
  1725.   
  1726.   
  1727.   
  1728.  
  1729.   
  1730.     <span class="summary_desc"><div class='inline'>
  1731. <p>Returns the array of jobs in the system.</p>
  1732. </div></span>
  1733.   
  1734. </li>
  1735.  
  1736.       
  1737.         <li class="public ">
  1738.   <span class="summary_signature">
  1739.     
  1740.       <a href="#jobs-instance_method" title="#jobs (instance method)">- (Object) <strong>jobs</strong> </a>
  1741.     
  1742.  
  1743.     
  1744.   </span>
  1745.   
  1746.   
  1747.   
  1748.   
  1749.   
  1750.   
  1751.   
  1752.  
  1753.   
  1754.     <span class="summary_desc"><div class='inline'></div></span>
  1755.   
  1756. </li>
  1757.  
  1758.       
  1759.         <li class="public ">
  1760.   <span class="summary_signature">
  1761.     
  1762.       <a href="#keys-instance_method" title="#keys (instance method)">- (Object) <strong>keys</strong>(user) </a>
  1763.     
  1764.  
  1765.     
  1766.   </span>
  1767.   
  1768.   
  1769.   
  1770.   
  1771.   
  1772.   
  1773.   
  1774.  
  1775.   
  1776.     <span class="summary_desc"><div class='inline'>
  1777. <p>Return all keys for specified user.</p>
  1778. </div></span>
  1779.   
  1780. </li>
  1781.  
  1782.       
  1783.         <li class="public ">
  1784.   <span class="summary_signature">
  1785.     
  1786.       <a href="#label-instance_method" title="#label (instance method)">- (Object) <strong>label</strong>(label) </a>
  1787.     
  1788.  
  1789.     
  1790.   </span>
  1791.   
  1792.   
  1793.   
  1794.   
  1795.   
  1796.   
  1797.   
  1798.  
  1799.   
  1800.     <span class="summary_desc"><div class='inline'>
  1801. <p>Returns the label instance indicated by the label name (or label object).</p>
  1802. </div></span>
  1803.   
  1804. </li>
  1805.  
  1806.       
  1807.         <li class="public ">
  1808.   <span class="summary_signature">
  1809.     
  1810.       <a href="#labels-instance_method" title="#labels (instance method)">- (Object) <strong>labels</strong> </a>
  1811.     
  1812.  
  1813.     
  1814.   </span>
  1815.   
  1816.   
  1817.   
  1818.   
  1819.   
  1820.   
  1821.   
  1822.  
  1823.   
  1824.     <span class="summary_desc"><div class='inline'>
  1825. <p>Array of Label objects stored in the system.</p>
  1826. </div></span>
  1827.   
  1828. </li>
  1829.  
  1830.       
  1831.         <li class="public ">
  1832.   <span class="summary_signature">
  1833.     
  1834.       <a href="#list_repos-instance_method" title="#list_repos (instance method)">- (Object) <strong>list_repos</strong> </a>
  1835.     
  1836.  
  1837.     
  1838.   </span>
  1839.   
  1840.   
  1841.   
  1842.   
  1843.   
  1844.   
  1845.   
  1846.  
  1847.   
  1848.     <span class="summary_desc"><div class='inline'>
  1849. <p>Return list of configured repositories.</p>
  1850. </div></span>
  1851.   
  1852. </li>
  1853.  
  1854.       
  1855.         <li class="public ">
  1856.   <span class="summary_signature">
  1857.     
  1858.       <a href="#login-instance_method" title="#login (instance method)">- (Object) <strong>login</strong>(user, password) </a>
  1859.     
  1860.  
  1861.     
  1862.   </span>
  1863.   
  1864.   
  1865.   
  1866.   
  1867.   
  1868.   
  1869.   
  1870.  
  1871.   
  1872.     <span class="summary_desc"><div class='inline'>
  1873. <p>Generates a host unlocked ticket for the user.</p>
  1874. </div></span>
  1875.   
  1876. </li>
  1877.  
  1878.       
  1879.         <li class="public ">
  1880.   <span class="summary_signature">
  1881.     
  1882.       <a href="#p4_ticket%3F-instance_method" title="#p4_ticket? (instance method)">- (Boolean) <strong>p4_ticket?</strong>(str) </a>
  1883.     
  1884.  
  1885.     
  1886.   </span>
  1887.   
  1888.   
  1889.   
  1890.   
  1891.   
  1892.   
  1893.   
  1894.  
  1895.   
  1896.     <span class="summary_desc"><div class='inline'></div></span>
  1897.   
  1898. </li>
  1899.  
  1900.       
  1901.         <li class="public ">
  1902.   <span class="summary_signature">
  1903.     
  1904.       <a href="#path_for-instance_method" title="#path_for (instance method)">- (Object) <strong>path_for</strong>(subpath) </a>
  1905.     
  1906.  
  1907.     
  1908.   </span>
  1909.   
  1910.   
  1911.   
  1912.   
  1913.   
  1914.   
  1915.   
  1916.  
  1917.   
  1918.     <span class="summary_desc"><div class='inline'>
  1919. <p>Basically just prepends the prefix to our subpath, typically,
  1920. &#39;/p4&#39;.</p>
  1921. </div></span>
  1922.   
  1923. </li>
  1924.  
  1925.       
  1926.         <li class="public ">
  1927.   <span class="summary_signature">
  1928.     
  1929.       <a href="#preview_helix_sync_pending_change-instance_method" title="#preview_helix_sync_pending_change (instance method)">- (Object) <strong>preview_helix_sync_pending_change</strong>(project_id) </a>
  1930.     
  1931.  
  1932.     
  1933.   </span>
  1934.   
  1935.   
  1936.   
  1937.   
  1938.   
  1939.   
  1940.   
  1941.  
  1942.   
  1943.     <span class="summary_desc"><div class='inline'>
  1944. <p>“Preview”, or generate the resolve plan, for the pending changelist.</p>
  1945. </div></span>
  1946.   
  1947. </li>
  1948.  
  1949.       
  1950.         <li class="public ">
  1951.   <span class="summary_signature">
  1952.     
  1953.       <a href="#project-instance_method" title="#project (instance method)">- (Object) <strong>project</strong>(project_id) </a>
  1954.     
  1955.  
  1956.     
  1957.   </span>
  1958.   
  1959.   
  1960.   
  1961.   
  1962.   
  1963.   
  1964.   
  1965.  
  1966.   
  1967.     <span class="summary_desc"><div class='inline'>
  1968. <p>Return the project details.</p>
  1969. </div></span>
  1970.   
  1971. </li>
  1972.  
  1973.       
  1974.         <li class="public ">
  1975.   <span class="summary_signature">
  1976.     
  1977.       <a href="#projects-instance_method" title="#projects (instance method)">- (Object) <strong>projects</strong>(details: nil, extension: nil) </a>
  1978.     
  1979.  
  1980.     
  1981.   </span>
  1982.   
  1983.   
  1984.   
  1985.   
  1986.   
  1987.   
  1988.   
  1989.  
  1990.   
  1991.     <span class="summary_desc"><div class='inline'>
  1992. <p>Lists the projects available on the server for the user.</p>
  1993. </div></span>
  1994.   
  1995. </li>
  1996.  
  1997.       
  1998.         <li class="public ">
  1999.   <span class="summary_signature">
  2000.     
  2001.       <a href="#protections-instance_method" title="#protections (instance method)">- (Object) <strong>protections</strong> </a>
  2002.     
  2003.  
  2004.     
  2005.   </span>
  2006.   
  2007.   
  2008.   
  2009.   
  2010.   
  2011.   
  2012.   
  2013.  
  2014.   
  2015.     <span class="summary_desc"><div class='inline'>
  2016. <p>Fetch all protections in the system.</p>
  2017. </div></span>
  2018.   
  2019. </li>
  2020.  
  2021.       
  2022.         <li class="public ">
  2023.   <span class="summary_signature">
  2024.     
  2025.       <a href="#remove_setting-instance_method" title="#remove_setting (instance method)">- (Object) <strong>remove_setting</strong>(key) </a>
  2026.     
  2027.  
  2028.     
  2029.   </span>
  2030.   
  2031.   
  2032.   
  2033.   
  2034.   
  2035.   
  2036.   
  2037.  
  2038.   
  2039.     <span class="summary_desc"><div class='inline'>
  2040. <p>Remove a setting added via add_setting.</p>
  2041. </div></span>
  2042.   
  2043. </li>
  2044.  
  2045.       
  2046.         <li class="public ">
  2047.   <span class="summary_signature">
  2048.     
  2049.       <a href="#repo-instance_method" title="#repo (instance method)">- (Object) <strong>repo</strong>(repo_name) </a>
  2050.     
  2051.  
  2052.     
  2053.   </span>
  2054.   
  2055.   
  2056.   
  2057.   
  2058.   
  2059.   
  2060.   
  2061.  
  2062.   
  2063.     <span class="summary_desc"><div class='inline'>
  2064. <p>Return the repository details.</p>
  2065. </div></span>
  2066.   
  2067. </li>
  2068.  
  2069.       
  2070.         <li class="public ">
  2071.   <span class="summary_signature">
  2072.     
  2073.       <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>
  2074.     
  2075.  
  2076.     
  2077.   </span>
  2078.   
  2079.   
  2080.   
  2081.   
  2082.   
  2083.   
  2084.   
  2085.  
  2086.   
  2087.     <span class="summary_desc"><div class='inline'></div></span>
  2088.   
  2089. </li>
  2090.  
  2091.       
  2092.         <li class="public ">
  2093.   <span class="summary_signature">
  2094.     
  2095.       <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>
  2096.     
  2097.  
  2098.     
  2099.   </span>
  2100.   
  2101.   
  2102.   
  2103.   
  2104.   
  2105.   
  2106.   
  2107.  
  2108.   
  2109.     <span class="summary_desc"><div class='inline'></div></span>
  2110.   
  2111. </li>
  2112.  
  2113.       
  2114.         <li class="public ">
  2115.   <span class="summary_signature">
  2116.     
  2117.       <a href="#server-instance_method" title="#server (instance method)">- (Object) <strong>server</strong>(server) </a>
  2118.     
  2119.  
  2120.     
  2121.   </span>
  2122.   
  2123.   
  2124.   
  2125.   
  2126.   
  2127.   
  2128.   
  2129.  
  2130.   
  2131.     <span class="summary_desc"><div class='inline'>
  2132. <p>Returns a HelixWebServicesClient::OpenModel for the login.</p>
  2133. </div></span>
  2134.   
  2135. </li>
  2136.  
  2137.       
  2138.         <li class="public ">
  2139.   <span class="summary_signature">
  2140.     
  2141.       <a href="#servers-instance_method" title="#servers (instance method)">- (Object) <strong>servers</strong> </a>
  2142.     
  2143.  
  2144.     
  2145.   </span>
  2146.   
  2147.   
  2148.   
  2149.   
  2150.   
  2151.   
  2152.   
  2153.  
  2154.   
  2155.     <span class="summary_desc"><div class='inline'>
  2156. <p>Returns an array of Server objects representing people in the system.</p>
  2157. </div></span>
  2158.   
  2159. </li>
  2160.  
  2161.       
  2162.         <li class="public ">
  2163.   <span class="summary_signature">
  2164.     
  2165.       <a href="#services-instance_method" title="#services (instance method)">- (Object) <strong>services</strong> </a>
  2166.     
  2167.  
  2168.     
  2169.   </span>
  2170.   
  2171.   
  2172.   
  2173.   
  2174.   
  2175.   
  2176.   
  2177.  
  2178.   
  2179.     <span class="summary_desc"><div class='inline'>
  2180. <p>Returns an array of all service definitions in the system.</p>
  2181. </div></span>
  2182.   
  2183. </li>
  2184.  
  2185.       
  2186.         <li class="public ">
  2187.   <span class="summary_signature">
  2188.     
  2189.       <a href="#set_auth-instance_method" title="#set_auth (instance method)">- (Object) <strong>set_auth</strong>(user, token) </a>
  2190.     
  2191.  
  2192.     
  2193.   </span>
  2194.   
  2195.   
  2196.   
  2197.   
  2198.   
  2199.   
  2200.   
  2201.  
  2202.   
  2203.     <span class="summary_desc"><div class='inline'>
  2204. <p>Note: this class is really just common implementation.</p>
  2205. </div></span>
  2206.   
  2207. </li>
  2208.  
  2209.       
  2210.         <li class="public ">
  2211.   <span class="summary_signature">
  2212.     
  2213.       <a href="#set_counter-instance_method" title="#set_counter (instance method)">- (Object) <strong>set_counter</strong>(counter) </a>
  2214.     
  2215.  
  2216.     
  2217.   </span>
  2218.   
  2219.   
  2220.   
  2221.   
  2222.   
  2223.   
  2224.   
  2225.  
  2226.   
  2227.     <span class="summary_desc"><div class='inline'>
  2228. <p>Set the counter value.</p>
  2229. </div></span>
  2230.   
  2231. </li>
  2232.  
  2233.       
  2234.         <li class="public ">
  2235.   <span class="summary_signature">
  2236.     
  2237.       <a href="#stream-instance_method" title="#stream (instance method)">- (Object) <strong>stream</strong>(stream) </a>
  2238.     
  2239.  
  2240.     
  2241.   </span>
  2242.   
  2243.   
  2244.   
  2245.   
  2246.   
  2247.   
  2248.   
  2249.  
  2250.   
  2251.     <span class="summary_desc"><div class='inline'>
  2252. <p>Fetch single stream details.</p>
  2253. </div></span>
  2254.   
  2255. </li>
  2256.  
  2257.       
  2258.         <li class="public ">
  2259.   <span class="summary_signature">
  2260.     
  2261.       <a href="#streams-instance_method" title="#streams (instance method)">- (Object) <strong>streams</strong> </a>
  2262.     
  2263.  
  2264.     
  2265.   </span>
  2266.   
  2267.   
  2268.   
  2269.   
  2270.   
  2271.   
  2272.   
  2273.  
  2274.   
  2275.     <span class="summary_desc"><div class='inline'>
  2276. <p>Returns an array of Stream objects representing people in the system.</p>
  2277. </div></span>
  2278.   
  2279. </li>
  2280.  
  2281.       
  2282.         <li class="public ">
  2283.   <span class="summary_signature">
  2284.     
  2285.       <a href="#submit_config-instance_method" title="#submit_config (instance method)">- (Object) <strong>submit_config</strong>(repo_name, config) </a>
  2286.     
  2287.  
  2288.     
  2289.   </span>
  2290.   
  2291.   
  2292.   
  2293.   
  2294.   
  2295.   
  2296.   
  2297.  
  2298.   
  2299.     <span class="summary_desc"><div class='inline'>
  2300. <p>Replace config for a specified repository.</p>
  2301. </div></span>
  2302.   
  2303. </li>
  2304.  
  2305.       
  2306.         <li class="public ">
  2307.   <span class="summary_signature">
  2308.     
  2309.       <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>
  2310.     
  2311.  
  2312.     
  2313.   </span>
  2314.   
  2315.   
  2316.   
  2317.   
  2318.   
  2319.   
  2320.   
  2321.  
  2322.   
  2323.     <span class="summary_desc"><div class='inline'>
  2324. <p>Submits the pending changelist for the helix sync project.</p>
  2325. </div></span>
  2326.   
  2327. </li>
  2328.  
  2329.       
  2330.         <li class="public ">
  2331.   <span class="summary_signature">
  2332.     
  2333.       <a href="#triggers-instance_method" title="#triggers (instance method)">- (OpenModel) <strong>triggers</strong> </a>
  2334.     
  2335.  
  2336.     
  2337.   </span>
  2338.   
  2339.   
  2340.   
  2341.   
  2342.   
  2343.   
  2344.   
  2345.  
  2346.   
  2347.     <span class="summary_desc"><div class='inline'>
  2348. <p>Fetch the list of trigger lines in the system.</p>
  2349. </div></span>
  2350.   
  2351. </li>
  2352.  
  2353.       
  2354.         <li class="public ">
  2355.   <span class="summary_signature">
  2356.     
  2357.       <a href="#update_branch-instance_method" title="#update_branch (instance method)">- (Object) <strong>update_branch</strong>(branch) </a>
  2358.     
  2359.  
  2360.     
  2361.   </span>
  2362.   
  2363.   
  2364.   
  2365.   
  2366.   
  2367.   
  2368.   
  2369.  
  2370.   
  2371.     <span class="summary_desc"><div class='inline'>
  2372. <p>Updates the branch specification.</p>
  2373. </div></span>
  2374.   
  2375. </li>
  2376.  
  2377.       
  2378.         <li class="public ">
  2379.   <span class="summary_signature">
  2380.     
  2381.       <a href="#update_client-instance_method" title="#update_client (instance method)">- (Object) <strong>update_client</strong>(client) </a>
  2382.     
  2383.  
  2384.     
  2385.   </span>
  2386.   
  2387.   
  2388.   
  2389.   
  2390.   
  2391.   
  2392.   
  2393.  
  2394.   
  2395.     <span class="summary_desc"><div class='inline'>
  2396. <p>Updates the client specification.</p>
  2397. </div></span>
  2398.   
  2399. </li>
  2400.  
  2401.       
  2402.         <li class="public ">
  2403.   <span class="summary_signature">
  2404.     
  2405.       <a href="#update_config-instance_method" title="#update_config (instance method)">- (Object) <strong>update_config</strong>(repo_name, config) </a>
  2406.     
  2407.  
  2408.     
  2409.   </span>
  2410.   
  2411.   
  2412.   
  2413.   
  2414.   
  2415.   
  2416.   
  2417.  
  2418.   
  2419.     <span class="summary_desc"><div class='inline'>
  2420. <p>Modify config for a specified repository.</p>
  2421. </div></span>
  2422.   
  2423. </li>
  2424.  
  2425.       
  2426.         <li class="public ">
  2427.   <span class="summary_signature">
  2428.     
  2429.       <a href="#update_depot-instance_method" title="#update_depot (instance method)">- (Object) <strong>update_depot</strong>(depot) </a>
  2430.     
  2431.  
  2432.     
  2433.   </span>
  2434.   
  2435.   
  2436.   
  2437.   
  2438.   
  2439.   
  2440.   
  2441.  
  2442.   
  2443.     <span class="summary_desc"><div class='inline'>
  2444. <p>Updates the depot specification.</p>
  2445. </div></span>
  2446.   
  2447. </li>
  2448.  
  2449.       
  2450.         <li class="public ">
  2451.   <span class="summary_signature">
  2452.     
  2453.       <a href="#update_group-instance_method" title="#update_group (instance method)">- (Object) <strong>update_group</strong>(group) </a>
  2454.     
  2455.  
  2456.     
  2457.   </span>
  2458.   
  2459.   
  2460.   
  2461.   
  2462.   
  2463.   
  2464.   
  2465.  
  2466.   
  2467.     <span class="summary_desc"><div class='inline'>
  2468. <p>Updates the group specification.</p>
  2469. </div></span>
  2470.   
  2471. </li>
  2472.  
  2473.       
  2474.         <li class="public ">
  2475.   <span class="summary_signature">
  2476.     
  2477.       <a href="#update_job-instance_method" title="#update_job (instance method)">- (Object) <strong>update_job</strong>(job) </a>
  2478.     
  2479.  
  2480.     
  2481.   </span>
  2482.   
  2483.   
  2484.   
  2485.   
  2486.   
  2487.   
  2488.   
  2489.  
  2490.   
  2491.     <span class="summary_desc"><div class='inline'>
  2492. <p>Updates the job specification.</p>
  2493. </div></span>
  2494.   
  2495. </li>
  2496.  
  2497.       
  2498.         <li class="public ">
  2499.   <span class="summary_signature">
  2500.     
  2501.       <a href="#update_label-instance_method" title="#update_label (instance method)">- (Object) <strong>update_label</strong>(label) </a>
  2502.     
  2503.  
  2504.     
  2505.   </span>
  2506.   
  2507.   
  2508.   
  2509.   
  2510.   
  2511.   
  2512.   
  2513.  
  2514.   
  2515.     <span class="summary_desc"><div class='inline'>
  2516. <p>Updates the label specification.</p>
  2517. </div></span>
  2518.   
  2519. </li>
  2520.  
  2521.       
  2522.         <li class="public ">
  2523.   <span class="summary_signature">
  2524.     
  2525.       <a href="#update_protections-instance_method" title="#update_protections (instance method)">- (Object) <strong>update_protections</strong>(protections) </a>
  2526.     
  2527.  
  2528.     
  2529.   </span>
  2530.   
  2531.   
  2532.   
  2533.   
  2534.   
  2535.   
  2536.   
  2537.  
  2538.   
  2539.     <span class="summary_desc"><div class='inline'>
  2540. <p>Updates the protections table based on the Protections instance passed in.</p>
  2541. </div></span>
  2542.   
  2543. </li>
  2544.  
  2545.       
  2546.         <li class="public ">
  2547.   <span class="summary_signature">
  2548.     
  2549.       <a href="#update_server-instance_method" title="#update_server (instance method)">- (Object) <strong>update_server</strong>(server) </a>
  2550.     
  2551.  
  2552.     
  2553.   </span>
  2554.   
  2555.   
  2556.   
  2557.   
  2558.   
  2559.   
  2560.   
  2561.  
  2562.   
  2563.     <span class="summary_desc"><div class='inline'></div></span>
  2564.   
  2565. </li>
  2566.  
  2567.       
  2568.         <li class="public ">
  2569.   <span class="summary_signature">
  2570.     
  2571.       <a href="#update_stream-instance_method" title="#update_stream (instance method)">- (Object) <strong>update_stream</strong>(stream) </a>
  2572.     
  2573.  
  2574.     
  2575.   </span>
  2576.   
  2577.   
  2578.   
  2579.   
  2580.   
  2581.   
  2582.   
  2583.  
  2584.   
  2585.     <span class="summary_desc"><div class='inline'></div></span>
  2586.   
  2587. </li>
  2588.  
  2589.       
  2590.         <li class="public ">
  2591.   <span class="summary_signature">
  2592.     
  2593.       <a href="#update_triggers-instance_method" title="#update_triggers (instance method)">- (Object) <strong>update_triggers</strong>(triggers) </a>
  2594.     
  2595.  
  2596.     
  2597.   </span>
  2598.   
  2599.   
  2600.   
  2601.   
  2602.   
  2603.   
  2604.   
  2605.  
  2606.   
  2607.     <span class="summary_desc"><div class='inline'>
  2608. <p>Update the triggers table using the Triggers model instance.</p>
  2609. </div></span>
  2610.   
  2611. </li>
  2612.  
  2613.       
  2614.         <li class="public ">
  2615.   <span class="summary_signature">
  2616.     
  2617.       <a href="#update_user-instance_method" title="#update_user (instance method)">- (Object) <strong>update_user</strong>(user) </a>
  2618.     
  2619.  
  2620.     
  2621.   </span>
  2622.   
  2623.   
  2624.   
  2625.   
  2626.   
  2627.   
  2628.   
  2629.  
  2630.   
  2631.     <span class="summary_desc"><div class='inline'></div></span>
  2632.   
  2633. </li>
  2634.  
  2635.       
  2636.         <li class="public ">
  2637.   <span class="summary_signature">
  2638.     
  2639.       <a href="#upload_file-instance_method" title="#upload_file (instance method)">- (Object) <strong>upload_file</strong>(file) </a>
  2640.     
  2641.  
  2642.     
  2643.   </span>
  2644.   
  2645.   
  2646.   
  2647.   
  2648.   
  2649.   
  2650.   
  2651.  
  2652.   
  2653.     <span class="summary_desc"><div class='inline'>
  2654. <p>Upload a single file&#39;s content.</p>
  2655. </div></span>
  2656.   
  2657. </li>
  2658.  
  2659.       
  2660.         <li class="public ">
  2661.   <span class="summary_signature">
  2662.     
  2663.       <a href="#upload_files-instance_method" title="#upload_files (instance method)">- (Object) <strong>upload_files</strong>(files: [], path: nil, description: nil) </a>
  2664.     
  2665.  
  2666.     
  2667.   </span>
  2668.   
  2669.   
  2670.   
  2671.   
  2672.   
  2673.   
  2674.   
  2675.  
  2676.   
  2677.     <span class="summary_desc"><div class='inline'>
  2678. <p>Upload multiple files.</p>
  2679. </div></span>
  2680.   
  2681. </li>
  2682.  
  2683.       
  2684.         <li class="public ">
  2685.   <span class="summary_signature">
  2686.     
  2687.       <a href="#user_details-instance_method" title="#user_details (instance method)">- (Object) <strong>user_details</strong>(user) </a>
  2688.     
  2689.  
  2690.     
  2691.   </span>
  2692.   
  2693.   
  2694.   
  2695.   
  2696.   
  2697.   
  2698.   
  2699.  
  2700.   
  2701.     <span class="summary_desc"><div class='inline'>
  2702. <p>Returns a HelixWebServicesClient::OpenModel for the login.</p>
  2703. </div></span>
  2704.   
  2705. </li>
  2706.  
  2707.       
  2708.         <li class="public ">
  2709.   <span class="summary_signature">
  2710.     
  2711.       <a href="#users-instance_method" title="#users (instance method)">- (Object) <strong>users</strong> </a>
  2712.     
  2713.  
  2714.     
  2715.   </span>
  2716.   
  2717.   
  2718.   
  2719.   
  2720.   
  2721.   
  2722.   
  2723.  
  2724.   
  2725.     <span class="summary_desc"><div class='inline'>
  2726. <p>Returns an array of User objects representing people in the system.</p>
  2727. </div></span>
  2728.   
  2729. </li>
  2730.  
  2731.       
  2732.         <li class="public ">
  2733.   <span class="summary_signature">
  2734.     
  2735.       <a href="#version-instance_method" title="#version (instance method)">- (Object) <strong>version</strong> </a>
  2736.     
  2737.  
  2738.     
  2739.   </span>
  2740.   
  2741.   
  2742.   
  2743.   
  2744.   
  2745.   
  2746.   
  2747.  
  2748.   
  2749.     <span class="summary_desc"><div class='inline'>
  2750. <p>Return the product version ID of the Helix Web Services instance.</p>
  2751. </div></span>
  2752.   
  2753. </li>
  2754.  
  2755.       
  2756.     </ul>
  2757.   
  2758.  
  2759. <div id="constructor_details" class="method_details_list">
  2760.   <h2>Constructor Details</h2>
  2761.   
  2762.     <div class="method_details first">
  2763.   <h3 class="signature first" id="initialize-instance_method">
  2764.   
  2765.     - (<tt><span class='object_link'><a href="" title="HelixWebServicesClient (class)">HelixWebServicesClient</a></span></tt>) <strong>initialize</strong>(options) 
  2766.   
  2767.  
  2768.   
  2769.  
  2770.   
  2771. </h3><div class="docstring">
  2772.   <div class="discussion">
  2773.     
  2774. <p>Client initialization can handle ensuring a valid security token to the
  2775. server.</p>
  2776.  
  2777. <p>Any client created via new should take care to call <code>close()</code>.</p>
  2778.  
  2779. <h2 id="label-Available+Options">Available Options</h2>
  2780.  
  2781. <p>These options are used to configure the underlying Faraday connection:</p>
  2782. <ul><li>
  2783. <p><code>:url</code> - String base URL.</p>
  2784. </li><li>
  2785. <p><code>:params</code> - Hash of URI query unencoded key/value pairs.</p>
  2786. </li><li>
  2787. <p><code>:header</code> - Hash of unencoded HTTP header key/value pairs.</p>
  2788. </li><li>
  2789. <p><code>:request</code> - Hash of request options.</p>
  2790. </li><li>
  2791. <p><code>:ssl</code> - Hash of SSL options.</p>
  2792. </li><li>
  2793. <p><code>:proxy</code> - Hash of Proxy options.</p>
  2794. </li></ul>
  2795.  
  2796. <p>These options are specific to Helix Web Services:</p>
  2797. <ul><li>
  2798. <p><code>:user</code> - The Helix Versioning Engine login</p>
  2799. </li><li>
  2800. <p><code>:password</code> - If set, we will generate a ticket using this
  2801. password during initialization</p>
  2802. </li><li>
  2803. <p><code>:ticket</code> - If not nil, we will use this ticket as our
  2804. authentication password</p>
  2805. </li><li>
  2806. <p><code>:debug</code> - Add response logging if set to true</p>
  2807. </li></ul>
  2808.  
  2809.  
  2810.   </div>
  2811. </div>
  2812. <div class="tags">
  2813.   <p class="tag_title">Parameters:</p>
  2814. <ul class="param">
  2815.   
  2816.     <li>
  2817.       
  2818.         <span class='name'>options</span>
  2819.       
  2820.       
  2821.         <span class='type'>(<tt>Hash</tt>)</span>
  2822.       
  2823.       
  2824.       
  2825.         &mdash;
  2826.         <div class='inline'>
  2827. <p>See the section available options above</p>
  2828. </div>
  2829.       
  2830.     </li>
  2831.   
  2832. </ul>
  2833.  
  2834.  
  2835. </div><table class="source_code">
  2836.   <tr>
  2837.     <td>
  2838.       <pre class="lines">
  2839.  
  2840.  
  2841. 56
  2842. 57
  2843. 58
  2844. 59
  2845. 60
  2846. 61
  2847. 62
  2848. 63
  2849. 64
  2850. 65
  2851. 66
  2852. 67
  2853. 68
  2854. 69
  2855. 70
  2856. 71
  2857. 72
  2858. 73
  2859. 74
  2860. 75
  2861. 76
  2862. 77
  2863. 78
  2864. 79
  2865. 80
  2866. 81
  2867. 82
  2868. 83
  2869. 84
  2870. 85
  2871. 86
  2872. 87
  2873. 88
  2874. 89
  2875. 90
  2876. 91
  2877. 92
  2878. 93
  2879. 94</pre>
  2880.     </td>
  2881.     <td>
  2882.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 56</span>
  2883.  
  2884. <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>
  2885.   <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>
  2886.  
  2887.   <span class='comment'># Filter out options we pass to Faraday
  2888. </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>
  2889.  
  2890.   <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>
  2891.     <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>
  2892.     <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>
  2893.     <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>
  2894.     <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>
  2895.   <span class='kw'>end</span>
  2896.  
  2897.   <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'>&#39;</span><span class='tstring_content'>Accept</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span>
  2898.  
  2899.   <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>
  2900.     <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>
  2901.     <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>
  2902.   <span class='kw'>end</span>
  2903.  
  2904.   <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>
  2905.  
  2906.   <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>
  2907.  
  2908.   <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>
  2909.     <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>
  2910.       <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>
  2911.     <span class='kw'>end</span>
  2912.   <span class='kw'>end</span>
  2913.  
  2914.   <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>
  2915.     <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'>/projects/v1/login</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
  2916.                           <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>
  2917.     <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>
  2918.     <span class='ivar'>@ticket</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><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>
  2919.   <span class='kw'>end</span>
  2920.  
  2921.   <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>
  2922. <span class='kw'>end</span></pre>
  2923.     </td>
  2924.   </tr>
  2925. </table>
  2926. </div>
  2927.   
  2928. </div>
  2929.  
  2930.   <div id="instance_attr_details" class="attr_details">
  2931.     <h2>Instance Attribute Details</h2>
  2932.     
  2933.       
  2934.       <span id="api_level=-instance_method"></span>
  2935.       <div class="method_details first">
  2936.   <h3 class="signature first" id="api_level-instance_method">
  2937.   
  2938.     - (<tt>Object</tt>) <strong>api_level</strong> 
  2939.   
  2940.  
  2941.   
  2942.  
  2943.   
  2944. </h3><div class="docstring">
  2945.   <div class="discussion">
  2946.     
  2947. <p>The API level to use. Defaults to 78 (2015.1)</p>
  2948.  
  2949.  
  2950.   </div>
  2951. </div>
  2952. <div class="tags">
  2953.   
  2954.  
  2955. </div><table class="source_code">
  2956.   <tr>
  2957.     <td>
  2958.       <pre class="lines">
  2959.  
  2960.  
  2961. 26
  2962. 27
  2963. 28</pre>
  2964.     </td>
  2965.     <td>
  2966.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 26</span>
  2967.  
  2968. <span class='kw'>def</span> <span class='id identifier rubyid_api_level'>api_level</span>
  2969.   <span class='ivar'>@api_level</span>
  2970. <span class='kw'>end</span></pre>
  2971.     </td>
  2972.   </tr>
  2973. </table>
  2974. </div>
  2975.     
  2976.       
  2977.       <span id="prefix=-instance_method"></span>
  2978.       <div class="method_details ">
  2979.   <h3 class="signature " id="prefix-instance_method">
  2980.   
  2981.     - (<tt>Object</tt>) <strong>prefix</strong> 
  2982.   
  2983.  
  2984.   
  2985.  
  2986.   
  2987. </h3><div class="docstring">
  2988.   <div class="discussion">
  2989.     
  2990. <p>Typically, Helix Web Services is mounted under /hws behind a reverse proxy.
  2991. If a path is specified in the originating URL, we save the prefix here, and
  2992. preprend it to every request.</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. 23
  3007. 24
  3008. 25</pre>
  3009.     </td>
  3010.     <td>
  3011.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 23</span>
  3012.  
  3013. <span class='kw'>def</span> <span class='id identifier rubyid_prefix'>prefix</span>
  3014.   <span class='ivar'>@prefix</span>
  3015. <span class='kw'>end</span></pre>
  3016.     </td>
  3017.   </tr>
  3018. </table>
  3019. </div>
  3020.     
  3021.       
  3022.       <span id="ticket=-instance_method"></span>
  3023.       <div class="method_details ">
  3024.   <h3 class="signature " id="ticket-instance_method">
  3025.   
  3026.     - (<tt>Object</tt>) <strong>ticket</strong> 
  3027.   
  3028.  
  3029.   
  3030.  
  3031.   
  3032. </h3><div class="docstring">
  3033.   <div class="discussion">
  3034.     
  3035. <p>Upon successful login, we store the P4 ticket return value here.</p>
  3036.  
  3037.  
  3038.   </div>
  3039. </div>
  3040. <div class="tags">
  3041.   
  3042.  
  3043. </div><table class="source_code">
  3044.   <tr>
  3045.     <td>
  3046.       <pre class="lines">
  3047.  
  3048.  
  3049. 18
  3050. 19
  3051. 20</pre>
  3052.     </td>
  3053.     <td>
  3054.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 18</span>
  3055.  
  3056. <span class='kw'>def</span> <span class='id identifier rubyid_ticket'>ticket</span>
  3057.   <span class='ivar'>@ticket</span>
  3058. <span class='kw'>end</span></pre>
  3059.     </td>
  3060.   </tr>
  3061. </table>
  3062. </div>
  3063.     
  3064.       
  3065.       <span id="user=-instance_method"></span>
  3066.       <div class="method_details ">
  3067.   <h3 class="signature " id="user-instance_method">
  3068.   
  3069.     - (<tt>Object</tt>) <strong>user</strong> 
  3070.   
  3071.  
  3072.   
  3073.  
  3074.   
  3075. </h3><div class="docstring">
  3076.   <div class="discussion">
  3077.     
  3078. <p>The Helix Versioning Engine login</p>
  3079.  
  3080.  
  3081.   </div>
  3082. </div>
  3083. <div class="tags">
  3084.   
  3085.  
  3086. </div><table class="source_code">
  3087.   <tr>
  3088.     <td>
  3089.       <pre class="lines">
  3090.  
  3091.  
  3092. 15
  3093. 16
  3094. 17</pre>
  3095.     </td>
  3096.     <td>
  3097.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 15</span>
  3098.  
  3099. <span class='kw'>def</span> <span class='id identifier rubyid_user'>user</span>
  3100.   <span class='ivar'>@user</span>
  3101. <span class='kw'>end</span></pre>
  3102.     </td>
  3103.   </tr>
  3104. </table>
  3105. </div>
  3106.     
  3107.   </div>
  3108.  
  3109.  
  3110.   <div id="class_method_details" class="method_details_list">
  3111.     <h2>Class Method Details</h2>
  3112.  
  3113.     
  3114.       <div class="method_details first">
  3115.   <h3 class="signature first" id="open-class_method">
  3116.   
  3117.     + (<tt>Object</tt>) <strong>open</strong>(connection) 
  3118.   
  3119.  
  3120.   
  3121.  
  3122.   
  3123. </h3><div class="docstring">
  3124.   <div class="discussion">
  3125.     
  3126. <p>Provides standard I/O style interface, where when called in a block, will
  3127. automatically close() the client when done. Otherwise, your code should
  3128. call client.close() manually.</p>
  3129.  
  3130.  
  3131.   </div>
  3132. </div>
  3133. <div class="tags">
  3134.   
  3135.  
  3136. </div><table class="source_code">
  3137.   <tr>
  3138.     <td>
  3139.       <pre class="lines">
  3140.  
  3141.  
  3142. 121
  3143. 122
  3144. 123
  3145. 124
  3146. 125
  3147. 126
  3148. 127
  3149. 128
  3150. 129
  3151. 130
  3152. 131</pre>
  3153.     </td>
  3154.     <td>
  3155.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 121</span>
  3156.  
  3157. <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>
  3158.   <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>
  3159.  
  3160.   <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
  3161.     <span class='kw'>yield</span> <span class='id identifier rubyid_client'>client</span>
  3162.   <span class='kw'>else</span>
  3163.     <span class='kw'>return</span> <span class='id identifier rubyid_client'>client</span>
  3164.   <span class='kw'>end</span>
  3165. <span class='kw'>ensure</span>
  3166.   <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>
  3167. <span class='kw'>end</span></pre>
  3168.     </td>
  3169.   </tr>
  3170. </table>
  3171. </div>
  3172.     
  3173.   </div>
  3174.  
  3175.   <div id="instance_method_details" class="method_details_list">
  3176.     <h2>Instance Method Details</h2>
  3177.  
  3178.     
  3179.       <div class="method_details first">
  3180.   <h3 class="signature first" id="add_key-instance_method">
  3181.   
  3182.     - (<tt>Object</tt>) <strong>add_key</strong>(user, key_name, key) 
  3183.   
  3184.  
  3185.   
  3186.  
  3187.   
  3188. </h3><div class="docstring">
  3189.   <div class="discussion">
  3190.     
  3191. <p>Add a key for a specified user. It will try to add a new SSH key for
  3192. specified user under a specific name. It will fail if the same key belongs
  3193. to a different user, if the same key is under a different name and if there
  3194. is already a key under the specified name. In case key with the same
  3195. content is present for specified user under the same name - it will skip
  3196. re-submission.</p>
  3197.  
  3198.  
  3199.   </div>
  3200. </div>
  3201. <div class="tags">
  3202.   <p class="tag_title">Parameters:</p>
  3203. <ul class="param">
  3204.   
  3205.     <li>
  3206.       
  3207.         <span class='name'>user</span>
  3208.       
  3209.       
  3210.         <span class='type'>(<tt>String</tt>)</span>
  3211.       
  3212.       
  3213.       
  3214.         &mdash;
  3215.         <div class='inline'>
  3216. <p>Username to assign SSH key to</p>
  3217. </div>
  3218.       
  3219.     </li>
  3220.   
  3221.     <li>
  3222.       
  3223.         <span class='name'>key_name</span>
  3224.       
  3225.       
  3226.         <span class='type'>(<tt>String</tt>)</span>
  3227.       
  3228.       
  3229.       
  3230.         &mdash;
  3231.         <div class='inline'>
  3232. <p>File name to save the key under</p>
  3233. </div>
  3234.       
  3235.     </li>
  3236.   
  3237.     <li>
  3238.       
  3239.         <span class='name'>key</span>
  3240.       
  3241.       
  3242.         <span class='type'>(<tt>String</tt>)</span>
  3243.       
  3244.       
  3245.       
  3246.         &mdash;
  3247.         <div class='inline'>
  3248. <p>Content of SSH key</p>
  3249. </div>
  3250.       
  3251.     </li>
  3252.   
  3253. </ul>
  3254.  
  3255.  
  3256. </div><table class="source_code">
  3257.   <tr>
  3258.     <td>
  3259.       <pre class="lines">
  3260.  
  3261.  
  3262. 27
  3263. 28
  3264. 29
  3265. 30</pre>
  3266.     </td>
  3267.     <td>
  3268.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/git_fusion_keys.rb', line 27</span>
  3269.  
  3270. <span class='kw'>def</span> <span class='id identifier rubyid_add_key'>add_key</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='id identifier rubyid_key_name'>key_name</span><span class='comma'>,</span> <span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
  3271.   <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'>/git-fusion/v1/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user'>user</span><span class='embexpr_end'>}</span><span class='tstring_content'>/keys/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key_name'>key_name</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  3272.   <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_path'>path</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>key</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_key'>key</span><span class='rbrace'>}</span><span class='rparen'>)</span>
  3273. <span class='kw'>end</span></pre>
  3274.     </td>
  3275.   </tr>
  3276. </table>
  3277. </div>
  3278.     
  3279.       <div class="method_details ">
  3280.   <h3 class="signature " id="add_setting-instance_method">
  3281.   
  3282.     - (<tt>Object</tt>) <strong>add_setting</strong>(key, value) 
  3283.   
  3284.  
  3285.   
  3286.  
  3287.   
  3288. </h3><div class="docstring">
  3289.   <div class="discussion">
  3290.     
  3291. <p>Set an override for all requests.</p>
  3292.  
  3293. <p>See “configuration” in HWS documentation.</p>
  3294.  
  3295. <p>This will automatically add the right prefix for overriding an HWS setting.</p>
  3296.  
  3297.  
  3298.   </div>
  3299. </div>
  3300. <div class="tags">
  3301.   <p class="tag_title">Parameters:</p>
  3302. <ul class="param">
  3303.   
  3304.     <li>
  3305.       
  3306.         <span class='name'>key</span>
  3307.       
  3308.       
  3309.         <span class='type'>(<tt>String</tt>)</span>
  3310.       
  3311.       
  3312.       
  3313.         &mdash;
  3314.         <div class='inline'>
  3315. <p>The setting value as indicated in documentation, e.g., <code>P4PORT</code></p>
  3316. </div>
  3317.       
  3318.     </li>
  3319.   
  3320.     <li>
  3321.       
  3322.         <span class='name'>value</span>
  3323.       
  3324.       
  3325.         <span class='type'>(<tt>String</tt>)</span>
  3326.       
  3327.       
  3328.       
  3329.         &mdash;
  3330.         <div class='inline'>
  3331. <p>The value to set</p>
  3332. </div>
  3333.       
  3334.     </li>
  3335.   
  3336. </ul>
  3337.  
  3338.  
  3339. </div><table class="source_code">
  3340.   <tr>
  3341.     <td>
  3342.       <pre class="lines">
  3343.  
  3344.  
  3345. 107
  3346. 108
  3347. 109
  3348. 110
  3349. 111</pre>
  3350.     </td>
  3351.     <td>
  3352.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 107</span>
  3353.  
  3354. <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>
  3355.   <span class='comment'># Note: Rack will automatically convert all hyphens to underscores...
  3356. </span>  <span class='comment'># but Nginx will (by default) block all underscores. Find a happy middle.
  3357. </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>
  3358. <span class='kw'>end</span></pre>
  3359.     </td>
  3360.   </tr>
  3361. </table>
  3362. </div>
  3363.     
  3364.       <div class="method_details ">
  3365.   <h3 class="signature " id="arg_params-instance_method">
  3366.   
  3367.     - (<tt>Object</tt>) <strong>arg_params</strong>(arg_values) 
  3368.   
  3369.  
  3370.   
  3371.  
  3372.   
  3373. </h3><div class="docstring">
  3374.   <div class="discussion">
  3375.     
  3376. <p>Creates a hash and creates keys &#39;arg1&#39;, &#39;arg2&#39;, etc that
  3377. points to the values in the arg_values array. This is basically only used
  3378. by the run methods</p>
  3379.  
  3380.  
  3381.   </div>
  3382. </div>
  3383. <div class="tags">
  3384.   
  3385.  
  3386. </div><table class="source_code">
  3387.   <tr>
  3388.     <td>
  3389.       <pre class="lines">
  3390.  
  3391.  
  3392. 45
  3393. 46
  3394. 47
  3395. 48
  3396. 49</pre>
  3397.     </td>
  3398.     <td>
  3399.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/commands.rb', line 45</span>
  3400.  
  3401. <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>
  3402.   <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
  3403.   <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>
  3404.   <span class='id identifier rubyid_params'>params</span>
  3405. <span class='kw'>end</span></pre>
  3406.     </td>
  3407.   </tr>
  3408. </table>
  3409. </div>
  3410.     
  3411.       <div class="method_details ">
  3412.   <h3 class="signature " id="assert_ok-instance_method">
  3413.   
  3414.     - (<tt>Object</tt>) <strong>assert_ok</strong>(response) 
  3415.   
  3416.  
  3417.   
  3418.  
  3419.   
  3420. </h3><div class="docstring">
  3421.   <div class="discussion">
  3422.     
  3423. <p>Raises an error when the response is not 200. Some errors may have
  3424. diagnostic information in the response body, so we pass that on as well</p>
  3425.  
  3426.  
  3427.   </div>
  3428. </div>
  3429. <div class="tags">
  3430.   
  3431.  
  3432. </div><table class="source_code">
  3433.   <tr>
  3434.     <td>
  3435.       <pre class="lines">
  3436.  
  3437.  
  3438. 210
  3439. 211
  3440. 212
  3441. 213
  3442. 214
  3443. 215
  3444. 216
  3445. 217
  3446. 218
  3447. 219
  3448. 220
  3449. 221
  3450. 222
  3451. 223
  3452. 224
  3453. 225
  3454. 226
  3455. 227
  3456. 228
  3457. 229
  3458. 230
  3459. 231
  3460. 232
  3461. 233
  3462. 234
  3463. 235</pre>
  3464.     </td>
  3465.     <td>
  3466.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 210</span>
  3467.  
  3468. <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>
  3469.   <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>
  3470.   <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'>400</span>
  3471.     <span class='kw'>begin</span>
  3472.       <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>
  3473.     <span class='kw'>rescue</span> <span class='const'>Exception</span>
  3474.       <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>
  3475.     <span class='kw'>end</span>
  3476.     <span class='id identifier rubyid_fail'>fail</span> <span class='const'>Errors</span><span class='op'>::</span><span class='const'>BadRequest</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>
  3477.   <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'>403</span>
  3478.     <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>
  3479.   <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>
  3480.     <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>
  3481.   <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>
  3482.     <span class='id identifier rubyid_messages'>messages</span> <span class='op'>=</span> <span class='kw'>nil</span>
  3483.     <span class='kw'>begin</span>
  3484.       <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>
  3485.     <span class='kw'>rescue</span> <span class='const'>Exception</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
  3486.       <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>
  3487.     <span class='kw'>end</span>
  3488.     <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>
  3489.          <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>
  3490.   <span class='kw'>else</span>
  3491.     <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>
  3492.   <span class='kw'>end</span>
  3493. <span class='kw'>end</span></pre>
  3494.     </td>
  3495.   </tr>
  3496. </table>
  3497. </div>
  3498.     
  3499.       <div class="method_details ">
  3500.   <h3 class="signature " id="branch-instance_method">
  3501.   
  3502.     - (<tt>Object</tt>) <strong>branch</strong>(branch) 
  3503.   
  3504.  
  3505.   
  3506.  
  3507.   
  3508. </h3><div class="docstring">
  3509.   <div class="discussion">
  3510.     
  3511. <p>Returns the branch instance indicated by the branch name (or model)</p>
  3512.  
  3513.  
  3514.   </div>
  3515. </div>
  3516. <div class="tags">
  3517.   
  3518.  
  3519. </div><table class="source_code">
  3520.   <tr>
  3521.     <td>
  3522.       <pre class="lines">
  3523.  
  3524.  
  3525. 14
  3526. 15
  3527. 16
  3528. 17
  3529. 18</pre>
  3530.     </td>
  3531.     <td>
  3532.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/branches.rb', line 14</span>
  3533.  
  3534. <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>
  3535.   <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>
  3536.   <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>
  3537.   <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>
  3538. <span class='kw'>end</span></pre>
  3539.     </td>
  3540.   </tr>
  3541. </table>
  3542. </div>
  3543.     
  3544.       <div class="method_details ">
  3545.   <h3 class="signature " id="branches-instance_method">
  3546.   
  3547.     - (<tt>Object</tt>) <strong>branches</strong> 
  3548.   
  3549.  
  3550.   
  3551.  
  3552.   
  3553. </h3><div class="docstring">
  3554.   <div class="discussion">
  3555.     
  3556. <p>Array of Branch objects stored in the system. Not all fields will be filled
  3557. out (e.g., view).</p>
  3558.  
  3559.  
  3560.   </div>
  3561. </div>
  3562. <div class="tags">
  3563.   
  3564.  
  3565. </div><table class="source_code">
  3566.   <tr>
  3567.     <td>
  3568.       <pre class="lines">
  3569.  
  3570.  
  3571. 8
  3572. 9
  3573. 10
  3574. 11</pre>
  3575.     </td>
  3576.     <td>
  3577.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/branches.rb', line 8</span>
  3578.  
  3579. <span class='kw'>def</span> <span class='id identifier rubyid_branches'>branches</span>
  3580.   <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>
  3581.   <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>
  3582. <span class='kw'>end</span></pre>
  3583.     </td>
  3584.   </tr>
  3585. </table>
  3586. </div>
  3587.     
  3588.       <div class="method_details ">
  3589.   <h3 class="signature " id="change-instance_method">
  3590.   
  3591.     - (<tt>Object</tt>) <strong>change</strong>(change) 
  3592.   
  3593.  
  3594.   
  3595.  
  3596.   
  3597. </h3><div class="docstring">
  3598.   <div class="discussion">
  3599.     
  3600. <p>Returns the Change indicated by the change number or model.</p>
  3601.  
  3602. <p>If there are files submitted with the change, the change.files field should
  3603. be filled out.</p>
  3604.  
  3605.  
  3606.   </div>
  3607. </div>
  3608. <div class="tags">
  3609.   
  3610.  
  3611. </div><table class="source_code">
  3612.   <tr>
  3613.     <td>
  3614.       <pre class="lines">
  3615.  
  3616.  
  3617. 21
  3618. 22
  3619. 23
  3620. 24
  3621. 25</pre>
  3622.     </td>
  3623.     <td>
  3624.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/changes.rb', line 21</span>
  3625.  
  3626. <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>
  3627.   <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>
  3628.   <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>
  3629.   <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>
  3630. <span class='kw'>end</span></pre>
  3631.     </td>
  3632.   </tr>
  3633. </table>
  3634. </div>
  3635.     
  3636.       <div class="method_details ">
  3637.   <h3 class="signature " id="changes-instance_method">
  3638.   
  3639.     - (<tt>Object</tt>) <strong>changes</strong>(options = nil) 
  3640.   
  3641.  
  3642.   
  3643.  
  3644.   
  3645. </h3><div class="docstring">
  3646.   <div class="discussion">
  3647.     
  3648. <p>List changelists in the system</p>
  3649.  
  3650. <p>options: - :max - cap the number of results - :status - :pending,
  3651. :submitted, or :shelved (see Change) - :user - The perforce login to check
  3652. out - :files - Depot path pattern to restrict changes to</p>
  3653.  
  3654.  
  3655.   </div>
  3656. </div>
  3657. <div class="tags">
  3658.   
  3659.  
  3660. </div><table class="source_code">
  3661.   <tr>
  3662.     <td>
  3663.       <pre class="lines">
  3664.  
  3665.  
  3666. 12
  3667. 13
  3668. 14
  3669. 15</pre>
  3670.     </td>
  3671.     <td>
  3672.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/changes.rb', line 12</span>
  3673.  
  3674. <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>
  3675.   <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>
  3676.   <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>
  3677. <span class='kw'>end</span></pre>
  3678.     </td>
  3679.   </tr>
  3680. </table>
  3681. </div>
  3682.     
  3683.       <div class="method_details ">
  3684.   <h3 class="signature " id="client-instance_method">
  3685.   
  3686.     - (<tt>Object</tt>) <strong>client</strong>(client) 
  3687.   
  3688.  
  3689.   
  3690.  
  3691.   
  3692. </h3><div class="docstring">
  3693.   <div class="discussion">
  3694.     
  3695. <p>Returns the client instance indicated by the client name or model</p>
  3696.  
  3697.  
  3698.   </div>
  3699. </div>
  3700. <div class="tags">
  3701.   
  3702.  
  3703. </div><table class="source_code">
  3704.   <tr>
  3705.     <td>
  3706.       <pre class="lines">
  3707.  
  3708.  
  3709. 12
  3710. 13
  3711. 14
  3712. 15
  3713. 16</pre>
  3714.     </td>
  3715.     <td>
  3716.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/clients.rb', line 12</span>
  3717.  
  3718. <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>
  3719.   <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>
  3720.   <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>
  3721.   <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>
  3722. <span class='kw'>end</span></pre>
  3723.     </td>
  3724.   </tr>
  3725. </table>
  3726. </div>
  3727.     
  3728.       <div class="method_details ">
  3729.   <h3 class="signature " id="clients-instance_method">
  3730.   
  3731.     - (<tt>Object</tt>) <strong>clients</strong> 
  3732.   
  3733.  
  3734.   
  3735.  
  3736.   
  3737. </h3><div class="docstring">
  3738.   <div class="discussion">
  3739.     
  3740. <p>Array of Client objects stored in the system. Not all fields will be filled
  3741. out (e.g., view).</p>
  3742.  
  3743.  
  3744.   </div>
  3745. </div>
  3746. <div class="tags">
  3747.   
  3748.  
  3749. </div><table class="source_code">
  3750.   <tr>
  3751.     <td>
  3752.       <pre class="lines">
  3753.  
  3754.  
  3755. 6
  3756. 7
  3757. 8
  3758. 9</pre>
  3759.     </td>
  3760.     <td>
  3761.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/clients.rb', line 6</span>
  3762.  
  3763. <span class='kw'>def</span> <span class='id identifier rubyid_clients'>clients</span>
  3764.   <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>
  3765.   <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>
  3766. <span class='kw'>end</span></pre>
  3767.     </td>
  3768.   </tr>
  3769. </table>
  3770. </div>
  3771.     
  3772.       <div class="method_details ">
  3773.   <h3 class="signature " id="close-instance_method">
  3774.   
  3775.     - (<tt>Object</tt>) <strong>close</strong> 
  3776.   
  3777.  
  3778.   
  3779.  
  3780.   
  3781. </h3><table class="source_code">
  3782.   <tr>
  3783.     <td>
  3784.       <pre class="lines">
  3785.  
  3786.  
  3787. 96
  3788. 97</pre>
  3789.     </td>
  3790.     <td>
  3791.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 96</span>
  3792.  
  3793. <span class='kw'>def</span> <span class='id identifier rubyid_close'>close</span>
  3794. <span class='kw'>end</span></pre>
  3795.     </td>
  3796.   </tr>
  3797. </table>
  3798. </div>
  3799.     
  3800.       <div class="method_details ">
  3801.   <h3 class="signature " id="command-instance_method">
  3802.   
  3803.     - (<tt><span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>) <strong>command</strong>(cmd, *args) 
  3804.   
  3805.  
  3806.   
  3807.  
  3808.   
  3809. </h3><div class="docstring">
  3810.   <div class="discussion">
  3811.     
  3812. <p>Execute a Perforce command.</p>
  3813.  
  3814. <p>First argument should always be the command, followed by command line
  3815. arguments.</p>
  3816.  
  3817. <p>Expect to always have an array of hashes as output.</p>
  3818.  
  3819. <p>Not all commands are allowed, since the command will be executed on the web
  3820. server. In general, if your command requires a client workspace, it will
  3821. likely fail, or be blocked.</p>
  3822.  
  3823.  
  3824.   </div>
  3825. </div>
  3826. <div class="tags">
  3827.   
  3828. <p class="tag_title">Returns:</p>
  3829. <ul class="return">
  3830.   
  3831.     <li>
  3832.       
  3833.       
  3834.         <span class='type'>(<tt><span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>)</span>
  3835.       
  3836.       
  3837.       
  3838.         &mdash;
  3839.         <div class='inline'>
  3840. <p>wraps the output in an OpenModel instance</p>
  3841. </div>
  3842.       
  3843.     </li>
  3844.   
  3845. </ul>
  3846.  
  3847. </div><table class="source_code">
  3848.   <tr>
  3849.     <td>
  3850.       <pre class="lines">
  3851.  
  3852.  
  3853. 18
  3854. 19
  3855. 20
  3856. 21
  3857. 22</pre>
  3858.     </td>
  3859.     <td>
  3860.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/commands.rb', line 18</span>
  3861.  
  3862. <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>
  3863.   <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>
  3864.   <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>
  3865.   <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>
  3866. <span class='kw'>end</span></pre>
  3867.     </td>
  3868.   </tr>
  3869. </table>
  3870. </div>
  3871.     
  3872.       <div class="method_details ">
  3873.   <h3 class="signature " id="command_with_input-instance_method">
  3874.   
  3875.     - (<tt>Object</tt>) <strong>command_with_input</strong>(cmd, input, *args) 
  3876.   
  3877.  
  3878.   
  3879.  
  3880.   
  3881. </h3><div class="docstring">
  3882.   <div class="discussion">
  3883.     
  3884. <p>Generic run command with and input body.</p>
  3885.  
  3886. <p>The first argument is the general command, followed by the input data, then
  3887. followed by additional command line arguments.</p>
  3888.  
  3889. <p>Expect the output to always be an array of hashes.</p>
  3890.  
  3891. <p>Not all commands are allowed, since the command will be executed on the web
  3892. server. In general, if your command requires a client workspace, it will
  3893. likely fail, or be blocked.</p>
  3894.  
  3895.  
  3896.   </div>
  3897. </div>
  3898. <div class="tags">
  3899.   
  3900.  
  3901. </div><table class="source_code">
  3902.   <tr>
  3903.     <td>
  3904.       <pre class="lines">
  3905.  
  3906.  
  3907. 34
  3908. 35
  3909. 36
  3910. 37
  3911. 38
  3912. 39
  3913. 40</pre>
  3914.     </td>
  3915.     <td>
  3916.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/commands.rb', line 34</span>
  3917.  
  3918. <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>
  3919.   <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>
  3920.   <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>
  3921.   <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>
  3922.   <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>
  3923.   <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>
  3924. <span class='kw'>end</span></pre>
  3925.     </td>
  3926.   </tr>
  3927. </table>
  3928. </div>
  3929.     
  3930.       <div class="method_details ">
  3931.   <h3 class="signature " id="commit_change-instance_method">
  3932.   
  3933.     - (<tt>Object</tt>) <strong>commit_change</strong>(change) 
  3934.   
  3935.  
  3936.   
  3937.  
  3938.   
  3939. </h3><div class="docstring">
  3940.   <div class="discussion">
  3941.     
  3942. <p>Submits the shelved changelist.</p>
  3943.  
  3944. <p>This changelist should be pending, with no open files, and list of shelved
  3945. changes. If you require resolves, this method will fail.</p>
  3946.  
  3947.  
  3948.   </div>
  3949. </div>
  3950. <div class="tags">
  3951.   <p class="tag_title">Parameters:</p>
  3952. <ul class="param">
  3953.   
  3954.     <li>
  3955.       
  3956.         <span class='name'>change</span>
  3957.       
  3958.       
  3959.         <span class='type'>(<tt>String</tt>)</span>
  3960.       
  3961.       
  3962.       
  3963.         &mdash;
  3964.         <div class='inline'>
  3965. <p>The changelist number</p>
  3966. </div>
  3967.       
  3968.     </li>
  3969.   
  3970. </ul>
  3971.  
  3972.  
  3973. </div><table class="source_code">
  3974.   <tr>
  3975.     <td>
  3976.       <pre class="lines">
  3977.  
  3978.  
  3979. 61
  3980. 62
  3981. 63
  3982. 64</pre>
  3983.     </td>
  3984.     <td>
  3985.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/changes.rb', line 61</span>
  3986.  
  3987. <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>
  3988.   <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>
  3989.   <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>
  3990. <span class='kw'>end</span></pre>
  3991.     </td>
  3992.   </tr>
  3993. </table>
  3994. </div>
  3995.     
  3996.       <div class="method_details ">
  3997.   <h3 class="signature " id="counter-instance_method">
  3998.   
  3999.     - (<tt>Object</tt>) <strong>counter</strong>(counter) 
  4000.   
  4001.  
  4002.   
  4003.  
  4004.   
  4005. </h3><div class="docstring">
  4006.   <div class="discussion">
  4007.     
  4008. <p>Return the counter hash for a particular counter key.</p>
  4009.  
  4010.  
  4011.   </div>
  4012. </div>
  4013. <div class="tags">
  4014.   <p class="tag_title">Parameters:</p>
  4015. <ul class="param">
  4016.   
  4017.     <li>
  4018.       
  4019.         <span class='name'>counter</span>
  4020.       
  4021.       
  4022.         <span class='type'>(<tt>String</tt>)</span>
  4023.       
  4024.       
  4025.       
  4026.         &mdash;
  4027.         <div class='inline'>
  4028. <p>The counter ID</p>
  4029. </div>
  4030.       
  4031.     </li>
  4032.   
  4033. </ul>
  4034.  
  4035.  
  4036. </div><table class="source_code">
  4037.   <tr>
  4038.     <td>
  4039.       <pre class="lines">
  4040.  
  4041.  
  4042. 14
  4043. 15
  4044. 16
  4045. 17</pre>
  4046.     </td>
  4047.     <td>
  4048.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/counters.rb', line 14</span>
  4049.  
  4050. <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>
  4051.   <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>
  4052.   <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>
  4053. <span class='kw'>end</span></pre>
  4054.     </td>
  4055.   </tr>
  4056. </table>
  4057. </div>
  4058.     
  4059.       <div class="method_details ">
  4060.   <h3 class="signature " id="counters-instance_method">
  4061.   
  4062.     - (<tt>Object</tt>) <strong>counters</strong> 
  4063.   
  4064.  
  4065.   
  4066.  
  4067.   
  4068. </h3><div class="docstring">
  4069.   <div class="discussion">
  4070.     
  4071. <p>List all counters in the system. Each counter typically has a
  4072. <code>counter</code> and <code>value</code> attribute.</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. 6
  4087. 7
  4088. 8
  4089. 9</pre>
  4090.     </td>
  4091.     <td>
  4092.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/counters.rb', line 6</span>
  4093.  
  4094. <span class='kw'>def</span> <span class='id identifier rubyid_counters'>counters</span>
  4095.   <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>
  4096.   <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>
  4097. <span class='kw'>end</span></pre>
  4098.     </td>
  4099.   </tr>
  4100. </table>
  4101. </div>
  4102.     
  4103.       <div class="method_details ">
  4104.   <h3 class="signature " id="create_branch-instance_method">
  4105.   
  4106.     - (<tt>Object</tt>) <strong>create_branch</strong>(branch) 
  4107.   
  4108.  
  4109.   
  4110.  
  4111.   
  4112. </h3><div class="docstring">
  4113.   <div class="discussion">
  4114.     
  4115. <p>Creates a new branch in the system.</p>
  4116.  
  4117.  
  4118.   </div>
  4119. </div>
  4120. <div class="tags">
  4121.   
  4122.  
  4123. </div><table class="source_code">
  4124.   <tr>
  4125.     <td>
  4126.       <pre class="lines">
  4127.  
  4128.  
  4129. 21
  4130. 22
  4131. 23
  4132. 24</pre>
  4133.     </td>
  4134.     <td>
  4135.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/branches.rb', line 21</span>
  4136.  
  4137. <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>
  4138.   <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>
  4139.   <span class='kw'>true</span>
  4140. <span class='kw'>end</span></pre>
  4141.     </td>
  4142.   </tr>
  4143. </table>
  4144. </div>
  4145.     
  4146.       <div class="method_details ">
  4147.   <h3 class="signature " id="create_change-instance_method">
  4148.   
  4149.     - (<tt>Object</tt>) <strong>create_change</strong>(change) 
  4150.   
  4151.  
  4152.   
  4153.  
  4154.   
  4155. </h3><div class="docstring">
  4156.   <div class="discussion">
  4157.     
  4158. <p>Creates a new changelist, that can be used for a few different tasks.</p>
  4159.  
  4160. <p>The change should be a hash with the following top-level keys:</p>
  4161. <ul><li>
  4162. <p><code>Description</code>: The change description (optional)</p>
  4163. </li><li>
  4164. <p><code>Files</code>: An array of Hashes</p>
  4165. </li></ul>
  4166.  
  4167. <p>Each hash in the <code>Files</code> array can contain these keys:</p>
  4168. <ul><li>
  4169. <p><code>DepotFile</code>: The depot path</p>
  4170. </li><li>
  4171. <p><code>Action</code>: One of &#39;upload&#39;, &#39;move&#39;, or
  4172. &#39;branch&#39;</p>
  4173. </li><li>
  4174. <p><code>FromDepotFile</code>: if action is &#39;move&#39; or
  4175. &#39;branch&#39;, the source file</p>
  4176. </li><li>
  4177. <p><code>Content</code>: Base64-encoded file content for &#39;upload&#39;
  4178. actions</p>
  4179. </li><li>
  4180. <p><code>RequireVersion</code>: Optional value for &#39;upload&#39; actions,
  4181. if set, will  fail the upload if the current file version is not  this
  4182. version.</p>
  4183. </li></ul>
  4184.  
  4185.  
  4186.   </div>
  4187. </div>
  4188. <div class="tags">
  4189.   <p class="tag_title">Parameters:</p>
  4190. <ul class="param">
  4191.   
  4192.     <li>
  4193.       
  4194.         <span class='name'>change</span>
  4195.       
  4196.       
  4197.         <span class='type'>(<tt>Hash</tt>)</span>
  4198.       
  4199.       
  4200.       
  4201.         &mdash;
  4202.         <div class='inline'>
  4203. <p>See method description</p>
  4204. </div>
  4205.       
  4206.     </li>
  4207.   
  4208. </ul>
  4209.  
  4210.  
  4211. </div><table class="source_code">
  4212.   <tr>
  4213.     <td>
  4214.       <pre class="lines">
  4215.  
  4216.  
  4217. 50
  4218. 51
  4219. 52
  4220. 53</pre>
  4221.     </td>
  4222.     <td>
  4223.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/changes.rb', line 50</span>
  4224.  
  4225. <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>
  4226.   <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>
  4227.   <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>
  4228. <span class='kw'>end</span></pre>
  4229.     </td>
  4230.   </tr>
  4231. </table>
  4232. </div>
  4233.     
  4234.       <div class="method_details ">
  4235.   <h3 class="signature " id="create_client-instance_method">
  4236.   
  4237.     - (<tt>Object</tt>) <strong>create_client</strong>(client) 
  4238.   
  4239.  
  4240.   
  4241.  
  4242.   
  4243. </h3><div class="docstring">
  4244.   <div class="discussion">
  4245.     
  4246. <p>Creates a new client in the system.</p>
  4247.  
  4248.  
  4249.   </div>
  4250. </div>
  4251. <div class="tags">
  4252.   
  4253.  
  4254. </div><table class="source_code">
  4255.   <tr>
  4256.     <td>
  4257.       <pre class="lines">
  4258.  
  4259.  
  4260. 19
  4261. 20
  4262. 21
  4263. 22
  4264. 23</pre>
  4265.     </td>
  4266.     <td>
  4267.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/clients.rb', line 19</span>
  4268.  
  4269. <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>
  4270.   <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>
  4271.   <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>
  4272.   <span class='kw'>true</span>
  4273. <span class='kw'>end</span></pre>
  4274.     </td>
  4275.   </tr>
  4276. </table>
  4277. </div>
  4278.     
  4279.       <div class="method_details ">
  4280.   <h3 class="signature " id="create_depot-instance_method">
  4281.   
  4282.     - (<tt>Object</tt>) <strong>create_depot</strong>(depot) 
  4283.   
  4284.  
  4285.   
  4286.  
  4287.   
  4288. </h3><div class="docstring">
  4289.   <div class="discussion">
  4290.     
  4291. <p>Creates a new depot in the system.</p>
  4292.  
  4293.  
  4294.   </div>
  4295. </div>
  4296. <div class="tags">
  4297.   
  4298.  
  4299. </div><table class="source_code">
  4300.   <tr>
  4301.     <td>
  4302.       <pre class="lines">
  4303.  
  4304.  
  4305. 20
  4306. 21
  4307. 22
  4308. 23</pre>
  4309.     </td>
  4310.     <td>
  4311.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/depots.rb', line 20</span>
  4312.  
  4313. <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>
  4314.   <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>
  4315.   <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>
  4316. <span class='kw'>end</span></pre>
  4317.     </td>
  4318.   </tr>
  4319. </table>
  4320. </div>
  4321.     
  4322.       <div class="method_details ">
  4323.   <h3 class="signature " id="create_group-instance_method">
  4324.   
  4325.     - (<tt>Object</tt>) <strong>create_group</strong>(group) 
  4326.   
  4327.  
  4328.   
  4329.  
  4330.   
  4331. </h3><div class="docstring">
  4332.   <div class="discussion">
  4333.     
  4334. <p>Creates a new group in the system.</p>
  4335.  
  4336.  
  4337.   </div>
  4338. </div>
  4339. <div class="tags">
  4340.   
  4341.  
  4342. </div><table class="source_code">
  4343.   <tr>
  4344.     <td>
  4345.       <pre class="lines">
  4346.  
  4347.  
  4348. 20
  4349. 21
  4350. 22
  4351. 23</pre>
  4352.     </td>
  4353.     <td>
  4354.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/groups.rb', line 20</span>
  4355.  
  4356. <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>
  4357.   <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>
  4358.   <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>
  4359. <span class='kw'>end</span></pre>
  4360.     </td>
  4361.   </tr>
  4362. </table>
  4363. </div>
  4364.     
  4365.       <div class="method_details ">
  4366.   <h3 class="signature " id="create_helix_sync_device_client-instance_method">
  4367.   
  4368.     - (<tt>Object</tt>) <strong>create_helix_sync_device_client</strong>(project_id, device, root) 
  4369.   
  4370.  
  4371.   
  4372.  
  4373.   
  4374. </h3><div class="docstring">
  4375.   <div class="discussion">
  4376.     
  4377. <p>Create a new client workspace specification for a Helix Sync project.</p>
  4378.  
  4379. <p>Returns a simple object with a &#39;client&#39; property.</p>
  4380.  
  4381.  
  4382.   </div>
  4383. </div>
  4384. <div class="tags">
  4385.   
  4386.  
  4387. </div><table class="source_code">
  4388.   <tr>
  4389.     <td>
  4390.       <pre class="lines">
  4391.  
  4392.  
  4393. 8
  4394. 9
  4395. 10
  4396. 11
  4397. 12
  4398. 13
  4399. 14
  4400. 15</pre>
  4401.     </td>
  4402.     <td>
  4403.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 8</span>
  4404.  
  4405. <span class='kw'>def</span> <span class='id identifier rubyid_create_helix_sync_device_client'>create_helix_sync_device_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>
  4406.   <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span>
  4407.       <span class='label'>device:</span> <span class='id identifier rubyid_device'>device</span><span class='comma'>,</span>
  4408.       <span class='label'>root:</span> <span class='id identifier rubyid_root'>root</span>
  4409.   <span class='rbrace'>}</span>
  4410.   <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'>&quot;</span><span class='tstring_content'>/helix-sync/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_content'>/clients/device</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
  4411.   <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>
  4412. <span class='kw'>end</span></pre>
  4413.     </td>
  4414.   </tr>
  4415. </table>
  4416. </div>
  4417.     
  4418.       <div class="method_details ">
  4419.   <h3 class="signature " id="create_helix_sync_shelf_client-instance_method">
  4420.   
  4421.     - (<tt>Object</tt>) <strong>create_helix_sync_shelf_client</strong>(project_id) 
  4422.   
  4423.  
  4424.   
  4425.  
  4426.   
  4427. </h3><table class="source_code">
  4428.   <tr>
  4429.     <td>
  4430.       <pre class="lines">
  4431.  
  4432.  
  4433. 17
  4434. 18
  4435. 19
  4436. 20</pre>
  4437.     </td>
  4438.     <td>
  4439.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 17</span>
  4440.  
  4441. <span class='kw'>def</span> <span class='id identifier rubyid_create_helix_sync_shelf_client'>create_helix_sync_shelf_client</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span>
  4442.   <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/</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'>/clients/shelf</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  4443.   <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>
  4444. <span class='kw'>end</span></pre>
  4445.     </td>
  4446.   </tr>
  4447. </table>
  4448. </div>
  4449.     
  4450.       <div class="method_details ">
  4451.   <h3 class="signature " id="create_job-instance_method">
  4452.   
  4453.     - (<tt>Object</tt>) <strong>create_job</strong>(job) 
  4454.   
  4455.  
  4456.   
  4457.  
  4458.   
  4459. </h3><div class="docstring">
  4460.   <div class="discussion">
  4461.     
  4462. <p>Creates a new job in the system.</p>
  4463.  
  4464.  
  4465.   </div>
  4466. </div>
  4467. <div class="tags">
  4468.   
  4469.  
  4470. </div><table class="source_code">
  4471.   <tr>
  4472.     <td>
  4473.       <pre class="lines">
  4474.  
  4475.  
  4476. 19
  4477. 20
  4478. 21
  4479. 22
  4480. 23
  4481. 24
  4482. 25</pre>
  4483.     </td>
  4484.     <td>
  4485.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/jobs.rb', line 19</span>
  4486.  
  4487. <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>
  4488.   <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>
  4489.   <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>
  4490.   <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>
  4491.   <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>
  4492.                            <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>
  4493. <span class='kw'>end</span></pre>
  4494.     </td>
  4495.   </tr>
  4496. </table>
  4497. </div>
  4498.     
  4499.       <div class="method_details ">
  4500.   <h3 class="signature " id="create_label-instance_method">
  4501.   
  4502.     - (<tt>Object</tt>) <strong>create_label</strong>(label) 
  4503.   
  4504.  
  4505.   
  4506.  
  4507.   
  4508. </h3><div class="docstring">
  4509.   <div class="discussion">
  4510.     
  4511. <p>Creates a new label in the system.</p>
  4512.  
  4513.  
  4514.   </div>
  4515. </div>
  4516. <div class="tags">
  4517.   
  4518.  
  4519. </div><table class="source_code">
  4520.   <tr>
  4521.     <td>
  4522.       <pre class="lines">
  4523.  
  4524.  
  4525. 20
  4526. 21
  4527. 22
  4528. 23</pre>
  4529.     </td>
  4530.     <td>
  4531.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/labels.rb', line 20</span>
  4532.  
  4533. <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>
  4534.   <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>
  4535.   <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>
  4536. <span class='kw'>end</span></pre>
  4537.     </td>
  4538.   </tr>
  4539. </table>
  4540. </div>
  4541.     
  4542.       <div class="method_details ">
  4543.   <h3 class="signature " id="create_server-instance_method">
  4544.   
  4545.     - (<tt>Object</tt>) <strong>create_server</strong>(server) 
  4546.   
  4547.  
  4548.   
  4549.  
  4550.   
  4551. </h3><div class="docstring">
  4552.   <div class="discussion">
  4553.     
  4554. <p>Creates a new server in the system based on the Server instance</p>
  4555.  
  4556.  
  4557.   </div>
  4558. </div>
  4559. <div class="tags">
  4560.   
  4561.  
  4562. </div><table class="source_code">
  4563.   <tr>
  4564.     <td>
  4565.       <pre class="lines">
  4566.  
  4567.  
  4568. 19
  4569. 20
  4570. 21
  4571. 22</pre>
  4572.     </td>
  4573.     <td>
  4574.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/servers.rb', line 19</span>
  4575.  
  4576. <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>
  4577.   <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>
  4578.   <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>
  4579. <span class='kw'>end</span></pre>
  4580.     </td>
  4581.   </tr>
  4582. </table>
  4583. </div>
  4584.     
  4585.       <div class="method_details ">
  4586.   <h3 class="signature " id="create_stream-instance_method">
  4587.   
  4588.     - (<tt>Object</tt>) <strong>create_stream</strong>(stream) 
  4589.   
  4590.  
  4591.   
  4592.  
  4593.   
  4594. </h3><div class="docstring">
  4595.   <div class="discussion">
  4596.     
  4597. <p>Creates a new stream in the system based on the Stream instance</p>
  4598.  
  4599.  
  4600.   </div>
  4601. </div>
  4602. <div class="tags">
  4603.   
  4604.  
  4605. </div><table class="source_code">
  4606.   <tr>
  4607.     <td>
  4608.       <pre class="lines">
  4609.  
  4610.  
  4611. 21
  4612. 22
  4613. 23
  4614. 24</pre>
  4615.     </td>
  4616.     <td>
  4617.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/streams.rb', line 21</span>
  4618.  
  4619. <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>
  4620.   <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>
  4621.   <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>
  4622. <span class='kw'>end</span></pre>
  4623.     </td>
  4624.   </tr>
  4625. </table>
  4626. </div>
  4627.     
  4628.       <div class="method_details ">
  4629.   <h3 class="signature " id="create_user-instance_method">
  4630.   
  4631.     - (<tt>Object</tt>) <strong>create_user</strong>(user) 
  4632.   
  4633.  
  4634.   
  4635.  
  4636.   
  4637. </h3><div class="docstring">
  4638.   <div class="discussion">
  4639.     
  4640. <p>Creates a new user in the system based on the User instance</p>
  4641.  
  4642.  
  4643.   </div>
  4644. </div>
  4645. <div class="tags">
  4646.   
  4647.  
  4648. </div><table class="source_code">
  4649.   <tr>
  4650.     <td>
  4651.       <pre class="lines">
  4652.  
  4653.  
  4654. 19
  4655. 20
  4656. 21
  4657. 22</pre>
  4658.     </td>
  4659.     <td>
  4660.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/users.rb', line 19</span>
  4661.  
  4662. <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>
  4663.   <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>
  4664.   <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>
  4665. <span class='kw'>end</span></pre>
  4666.     </td>
  4667.   </tr>
  4668. </table>
  4669. </div>
  4670.     
  4671.       <div class="method_details ">
  4672.   <h3 class="signature " id="delete_branch-instance_method">
  4673.   
  4674.     - (<tt>Object</tt>) <strong>delete_branch</strong>(branch) 
  4675.   
  4676.  
  4677.   
  4678.  
  4679.   
  4680. </h3><div class="docstring">
  4681.   <div class="discussion">
  4682.     
  4683. <p>Deletes the branch specification in the system.</p>
  4684.  
  4685.  
  4686.   </div>
  4687. </div>
  4688. <div class="tags">
  4689.   
  4690.  
  4691. </div><table class="source_code">
  4692.   <tr>
  4693.     <td>
  4694.       <pre class="lines">
  4695.  
  4696.  
  4697. 35
  4698. 36
  4699. 37
  4700. 38
  4701. 39</pre>
  4702.     </td>
  4703.     <td>
  4704.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/branches.rb', line 35</span>
  4705.  
  4706. <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>
  4707.   <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>
  4708.   <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>
  4709.   <span class='kw'>true</span>
  4710. <span class='kw'>end</span></pre>
  4711.     </td>
  4712.   </tr>
  4713. </table>
  4714. </div>
  4715.     
  4716.       <div class="method_details ">
  4717.   <h3 class="signature " id="delete_client-instance_method">
  4718.   
  4719.     - (<tt>Object</tt>) <strong>delete_client</strong>(client) 
  4720.   
  4721.  
  4722.   
  4723.  
  4724.   
  4725. </h3><div class="docstring">
  4726.   <div class="discussion">
  4727.     
  4728. <p>Deletes the client specification in the system.</p>
  4729.  
  4730.  
  4731.   </div>
  4732. </div>
  4733. <div class="tags">
  4734.   
  4735.  
  4736. </div><table class="source_code">
  4737.   <tr>
  4738.     <td>
  4739.       <pre class="lines">
  4740.  
  4741.  
  4742. 34
  4743. 35
  4744. 36
  4745. 37
  4746. 38</pre>
  4747.     </td>
  4748.     <td>
  4749.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/clients.rb', line 34</span>
  4750.  
  4751. <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>
  4752.   <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>
  4753.   <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>
  4754.   <span class='kw'>true</span>
  4755. <span class='kw'>end</span></pre>
  4756.     </td>
  4757.   </tr>
  4758. </table>
  4759. </div>
  4760.     
  4761.       <div class="method_details ">
  4762.   <h3 class="signature " id="delete_counter-instance_method">
  4763.   
  4764.     - (<tt>Object</tt>) <strong>delete_counter</strong>(counter) 
  4765.   
  4766.  
  4767.   
  4768.  
  4769.   
  4770. </h3><div class="docstring">
  4771.   <div class="discussion">
  4772.     
  4773. <p>Delete the counter</p>
  4774.  
  4775.  
  4776.   </div>
  4777. </div>
  4778. <div class="tags">
  4779.   <p class="tag_title">Parameters:</p>
  4780. <ul class="param">
  4781.   
  4782.     <li>
  4783.       
  4784.         <span class='name'>counter</span>
  4785.       
  4786.       
  4787.         <span class='type'>(<tt>String</tt>)</span>
  4788.       
  4789.       
  4790.       
  4791.         &mdash;
  4792.         <div class='inline'>
  4793. <p>The counter ID</p>
  4794. </div>
  4795.       
  4796.     </li>
  4797.   
  4798. </ul>
  4799.  
  4800.  
  4801. </div><table class="source_code">
  4802.   <tr>
  4803.     <td>
  4804.       <pre class="lines">
  4805.  
  4806.  
  4807. 37
  4808. 38
  4809. 39</pre>
  4810.     </td>
  4811.     <td>
  4812.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/counters.rb', line 37</span>
  4813.  
  4814. <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>
  4815.   <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>
  4816. <span class='kw'>end</span></pre>
  4817.     </td>
  4818.   </tr>
  4819. </table>
  4820. </div>
  4821.     
  4822.       <div class="method_details ">
  4823.   <h3 class="signature " id="delete_depot-instance_method">
  4824.   
  4825.     - (<tt>Object</tt>) <strong>delete_depot</strong>(depot) 
  4826.   
  4827.  
  4828.   
  4829.  
  4830.   
  4831. </h3><div class="docstring">
  4832.   <div class="discussion">
  4833.     
  4834. <p>Deletes the depot specification in the system.</p>
  4835.  
  4836.  
  4837.   </div>
  4838. </div>
  4839. <div class="tags">
  4840.   
  4841.  
  4842. </div><table class="source_code">
  4843.   <tr>
  4844.     <td>
  4845.       <pre class="lines">
  4846.  
  4847.  
  4848. 33
  4849. 34
  4850. 35
  4851. 36</pre>
  4852.     </td>
  4853.     <td>
  4854.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/depots.rb', line 33</span>
  4855.  
  4856. <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>
  4857.   <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>
  4858.   <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>
  4859. <span class='kw'>end</span></pre>
  4860.     </td>
  4861.   </tr>
  4862. </table>
  4863. </div>
  4864.     
  4865.       <div class="method_details ">
  4866.   <h3 class="signature " id="delete_file-instance_method">
  4867.   
  4868.     - (<tt>Object</tt>) <strong>delete_file</strong>(path) 
  4869.   
  4870.  
  4871.   
  4872.  
  4873.   
  4874. </h3><table class="source_code">
  4875.   <tr>
  4876.     <td>
  4877.       <pre class="lines">
  4878.  
  4879.  
  4880. 106
  4881. 107
  4882. 108
  4883. 109</pre>
  4884.     </td>
  4885.     <td>
  4886.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/files.rb', line 106</span>
  4887.  
  4888. <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>
  4889.   <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>
  4890.   <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>
  4891. <span class='kw'>end</span></pre>
  4892.     </td>
  4893.   </tr>
  4894. </table>
  4895. </div>
  4896.     
  4897.       <div class="method_details ">
  4898.   <h3 class="signature " id="delete_group-instance_method">
  4899.   
  4900.     - (<tt>Object</tt>) <strong>delete_group</strong>(group) 
  4901.   
  4902.  
  4903.   
  4904.  
  4905.   
  4906. </h3><div class="docstring">
  4907.   <div class="discussion">
  4908.     
  4909. <p>Deletes the group specification in the system.</p>
  4910.  
  4911.  
  4912.   </div>
  4913. </div>
  4914. <div class="tags">
  4915.   
  4916.  
  4917. </div><table class="source_code">
  4918.   <tr>
  4919.     <td>
  4920.       <pre class="lines">
  4921.  
  4922.  
  4923. 33
  4924. 34
  4925. 35
  4926. 36</pre>
  4927.     </td>
  4928.     <td>
  4929.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/groups.rb', line 33</span>
  4930.  
  4931. <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>
  4932.   <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>
  4933.   <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>
  4934. <span class='kw'>end</span></pre>
  4935.     </td>
  4936.   </tr>
  4937. </table>
  4938. </div>
  4939.     
  4940.       <div class="method_details ">
  4941.   <h3 class="signature " id="delete_helix_sync_device_client-instance_method">
  4942.   
  4943.     - (<tt>Object</tt>) <strong>delete_helix_sync_device_client</strong>(project_id, device) 
  4944.   
  4945.  
  4946.   
  4947.  
  4948.   
  4949. </h3><table class="source_code">
  4950.   <tr>
  4951.     <td>
  4952.       <pre class="lines">
  4953.  
  4954.  
  4955. 22
  4956. 23
  4957. 24
  4958. 25</pre>
  4959.     </td>
  4960.     <td>
  4961.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 22</span>
  4962.  
  4963. <span class='kw'>def</span> <span class='id identifier rubyid_delete_helix_sync_device_client'>delete_helix_sync_device_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='rparen'>)</span>
  4964.   <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'>:delete</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/helix-sync/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_content'>/clients/device/</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_device'>device</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  4965.   <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>
  4966. <span class='kw'>end</span></pre>
  4967.     </td>
  4968.   </tr>
  4969. </table>
  4970. </div>
  4971.     
  4972.       <div class="method_details ">
  4973.   <h3 class="signature " id="delete_helix_sync_pending_changelist-instance_method">
  4974.   
  4975.     - (<tt>Object</tt>) <strong>delete_helix_sync_pending_changelist</strong>(project_id) 
  4976.   
  4977.  
  4978.   
  4979.  
  4980.   
  4981. </h3><div class="docstring">
  4982.   <div class="discussion">
  4983.     
  4984. <p>Remove the pending changelist used for a Helix Sync project.</p>
  4985.  
  4986.  
  4987.   </div>
  4988. </div>
  4989. <div class="tags">
  4990.   
  4991.  
  4992. </div><table class="source_code">
  4993.   <tr>
  4994.     <td>
  4995.       <pre class="lines">
  4996.  
  4997.  
  4998. 49
  4999. 50
  5000. 51
  5001. 52</pre>
  5002.     </td>
  5003.     <td>
  5004.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 49</span>
  5005.  
  5006. <span class='kw'>def</span> <span class='id identifier rubyid_delete_helix_sync_pending_changelist'>delete_helix_sync_pending_changelist</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span>
  5007.   <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'>:delete</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/helix-sync/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_content'>/pending</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  5008.   <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>
  5009. <span class='kw'>end</span></pre>
  5010.     </td>
  5011.   </tr>
  5012. </table>
  5013. </div>
  5014.     
  5015.       <div class="method_details ">
  5016.   <h3 class="signature " id="delete_helix_sync_shelf_client-instance_method">
  5017.   
  5018.     - (<tt>Object</tt>) <strong>delete_helix_sync_shelf_client</strong>(project_id) 
  5019.   
  5020.  
  5021.   
  5022.  
  5023.   
  5024. </h3><table class="source_code">
  5025.   <tr>
  5026.     <td>
  5027.       <pre class="lines">
  5028.  
  5029.  
  5030. 27
  5031. 28
  5032. 29
  5033. 30</pre>
  5034.     </td>
  5035.     <td>
  5036.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 27</span>
  5037.  
  5038. <span class='kw'>def</span> <span class='id identifier rubyid_delete_helix_sync_shelf_client'>delete_helix_sync_shelf_client</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span>
  5039.   <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'>:delete</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/helix-sync/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_content'>/clients/shelf</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  5040.   <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>
  5041. <span class='kw'>end</span></pre>
  5042.     </td>
  5043.   </tr>
  5044. </table>
  5045. </div>
  5046.     
  5047.       <div class="method_details ">
  5048.   <h3 class="signature " id="delete_job-instance_method">
  5049.   
  5050.     - (<tt>Object</tt>) <strong>delete_job</strong>(job_id) 
  5051.   
  5052.  
  5053.   
  5054.  
  5055.   
  5056. </h3><div class="docstring">
  5057.   <div class="discussion">
  5058.     
  5059. <p>Deletes the job specification in the system.</p>
  5060.  
  5061.  
  5062.   </div>
  5063. </div>
  5064. <div class="tags">
  5065.   
  5066.  
  5067. </div><table class="source_code">
  5068.   <tr>
  5069.     <td>
  5070.       <pre class="lines">
  5071.  
  5072.  
  5073. 35
  5074. 36
  5075. 37</pre>
  5076.     </td>
  5077.     <td>
  5078.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/jobs.rb', line 35</span>
  5079.  
  5080. <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>
  5081.   <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>
  5082. <span class='kw'>end</span></pre>
  5083.     </td>
  5084.   </tr>
  5085. </table>
  5086. </div>
  5087.     
  5088.       <div class="method_details ">
  5089.   <h3 class="signature " id="delete_key-instance_method">
  5090.   
  5091.     - (<tt>Object</tt>) <strong>delete_key</strong>(user, key_name) 
  5092.   
  5093.  
  5094.   
  5095.  
  5096.   
  5097. </h3><div class="docstring">
  5098.   <div class="discussion">
  5099.     
  5100. <p>Delete a specific SSH key. It accepts an SSH key looks up the owner and
  5101. then proceeds to remove it.</p>
  5102.  
  5103.  
  5104.   </div>
  5105. </div>
  5106. <div class="tags">
  5107.   <p class="tag_title">Parameters:</p>
  5108. <ul class="param">
  5109.   
  5110.     <li>
  5111.       
  5112.         <span class='name'>key</span>
  5113.       
  5114.       
  5115.         <span class='type'>(<tt>String</tt>)</span>
  5116.       
  5117.       
  5118.       
  5119.         &mdash;
  5120.         <div class='inline'>
  5121. <p>SSH key string to be removed</p>
  5122. </div>
  5123.       
  5124.     </li>
  5125.   
  5126. </ul>
  5127.  
  5128.  
  5129. </div><table class="source_code">
  5130.   <tr>
  5131.     <td>
  5132.       <pre class="lines">
  5133.  
  5134.  
  5135. 35
  5136. 36
  5137. 37
  5138. 38</pre>
  5139.     </td>
  5140.     <td>
  5141.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/git_fusion_keys.rb', line 35</span>
  5142.  
  5143. <span class='kw'>def</span> <span class='id identifier rubyid_delete_key'>delete_key</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='id identifier rubyid_key_name'>key_name</span><span class='rparen'>)</span>
  5144.   <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'>/git-fusion/v1/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user'>user</span><span class='embexpr_end'>}</span><span class='tstring_content'>/keys/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key_name'>key_name</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  5145.   <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_path'>path</span><span class='rparen'>)</span>
  5146. <span class='kw'>end</span></pre>
  5147.     </td>
  5148.   </tr>
  5149. </table>
  5150. </div>
  5151.     
  5152.       <div class="method_details ">
  5153.   <h3 class="signature " id="delete_keys-instance_method">
  5154.   
  5155.     - (<tt>Object</tt>) <strong>delete_keys</strong>(user) 
  5156.   
  5157.  
  5158.   
  5159.  
  5160.   
  5161. </h3><div class="docstring">
  5162.   <div class="discussion">
  5163.     
  5164. <p>Delete all keys for a user. All keys for specified user will be deleted
  5165. from perforce.</p>
  5166.  
  5167.  
  5168.   </div>
  5169. </div>
  5170. <div class="tags">
  5171.   <p class="tag_title">Parameters:</p>
  5172. <ul class="param">
  5173.   
  5174.     <li>
  5175.       
  5176.         <span class='name'>user</span>
  5177.       
  5178.       
  5179.         <span class='type'>(<tt>String</tt>)</span>
  5180.       
  5181.       
  5182.       
  5183.         &mdash;
  5184.         <div class='inline'>
  5185. <p>Chosen user to remove all keys for</p>
  5186. </div>
  5187.       
  5188.     </li>
  5189.   
  5190. </ul>
  5191.  
  5192.  
  5193. </div><table class="source_code">
  5194.   <tr>
  5195.     <td>
  5196.       <pre class="lines">
  5197.  
  5198.  
  5199. 43
  5200. 44
  5201. 45
  5202. 46</pre>
  5203.     </td>
  5204.     <td>
  5205.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/git_fusion_keys.rb', line 43</span>
  5206.  
  5207. <span class='kw'>def</span> <span class='id identifier rubyid_delete_keys'>delete_keys</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
  5208.   <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'>/git-fusion/v1/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user'>user</span><span class='embexpr_end'>}</span><span class='tstring_content'>/keys</span><span class='tstring_end'>&quot;</span></span>
  5209.   <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_path'>path</span><span class='rparen'>)</span>
  5210. <span class='kw'>end</span></pre>
  5211.     </td>
  5212.   </tr>
  5213. </table>
  5214. </div>
  5215.     
  5216.       <div class="method_details ">
  5217.   <h3 class="signature " id="delete_label-instance_method">
  5218.   
  5219.     - (<tt>Object</tt>) <strong>delete_label</strong>(label) 
  5220.   
  5221.  
  5222.   
  5223.  
  5224.   
  5225. </h3><div class="docstring">
  5226.   <div class="discussion">
  5227.     
  5228. <p>Deletes the label specification in the system.</p>
  5229.  
  5230.  
  5231.   </div>
  5232. </div>
  5233. <div class="tags">
  5234.   
  5235.  
  5236. </div><table class="source_code">
  5237.   <tr>
  5238.     <td>
  5239.       <pre class="lines">
  5240.  
  5241.  
  5242. 33
  5243. 34
  5244. 35
  5245. 36</pre>
  5246.     </td>
  5247.     <td>
  5248.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/labels.rb', line 33</span>
  5249.  
  5250. <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>
  5251.   <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>
  5252.   <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>
  5253. <span class='kw'>end</span></pre>
  5254.     </td>
  5255.   </tr>
  5256. </table>
  5257. </div>
  5258.     
  5259.       <div class="method_details ">
  5260.   <h3 class="signature " id="delete_repo-instance_method">
  5261.   
  5262.     - (<tt>Object</tt>) <strong>delete_repo</strong>(repo_name) 
  5263.   
  5264.  
  5265.   
  5266.  
  5267.   
  5268. </h3><div class="docstring">
  5269.   <div class="discussion">
  5270.     
  5271. <p>Delete a repository. This will remove config file for specified repository,
  5272. removing it in result.</p>
  5273.  
  5274.  
  5275.   </div>
  5276. </div>
  5277. <div class="tags">
  5278.   <p class="tag_title">Parameters:</p>
  5279. <ul class="param">
  5280.   
  5281.     <li>
  5282.       
  5283.         <span class='name'>repo_name</span>
  5284.       
  5285.       
  5286.         <span class='type'>(<tt>String</tt>)</span>
  5287.       
  5288.       
  5289.       
  5290.         &mdash;
  5291.         <div class='inline'>
  5292. <p>Repository name to be encoded to git_fusion standards</p>
  5293. </div>
  5294.       
  5295.     </li>
  5296.   
  5297. </ul>
  5298.  
  5299.  
  5300. </div><table class="source_code">
  5301.   <tr>
  5302.     <td>
  5303.       <pre class="lines">
  5304.  
  5305.  
  5306. 57
  5307. 58
  5308. 59
  5309. 60</pre>
  5310.     </td>
  5311.     <td>
  5312.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/git_fusion_repo.rb', line 57</span>
  5313.  
  5314. <span class='kw'>def</span> <span class='id identifier rubyid_delete_repo'>delete_repo</span><span class='lparen'>(</span><span class='id identifier rubyid_repo_name'>repo_name</span><span class='rparen'>)</span>
  5315.   <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'>/git-fusion/v1/repos/</span><span class='embexpr_beg'>#{</span><span class='const'>GitFusionStrings</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_repo_name'>repo_name</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  5316.   <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_path'>path</span><span class='rparen'>)</span>
  5317. <span class='kw'>end</span></pre>
  5318.     </td>
  5319.   </tr>
  5320. </table>
  5321. </div>
  5322.     
  5323.       <div class="method_details ">
  5324.   <h3 class="signature " id="delete_server-instance_method">
  5325.   
  5326.     - (<tt>Object</tt>) <strong>delete_server</strong>(server) 
  5327.   
  5328.  
  5329.   
  5330.  
  5331.   
  5332. </h3><table class="source_code">
  5333.   <tr>
  5334.     <td>
  5335.       <pre class="lines">
  5336.  
  5337.  
  5338. 31
  5339. 32
  5340. 33
  5341. 34</pre>
  5342.     </td>
  5343.     <td>
  5344.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/servers.rb', line 31</span>
  5345.  
  5346. <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>
  5347.   <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>
  5348.   <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>
  5349. <span class='kw'>end</span></pre>
  5350.     </td>
  5351.   </tr>
  5352. </table>
  5353. </div>
  5354.     
  5355.       <div class="method_details ">
  5356.   <h3 class="signature " id="delete_stream-instance_method">
  5357.   
  5358.     - (<tt>Object</tt>) <strong>delete_stream</strong>(stream) 
  5359.   
  5360.  
  5361.   
  5362.  
  5363.   
  5364. </h3><table class="source_code">
  5365.   <tr>
  5366.     <td>
  5367.       <pre class="lines">
  5368.  
  5369.  
  5370. 32
  5371. 33
  5372. 34
  5373. 35</pre>
  5374.     </td>
  5375.     <td>
  5376.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/streams.rb', line 32</span>
  5377.  
  5378. <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>
  5379.   <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>
  5380.   <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>
  5381. <span class='kw'>end</span></pre>
  5382.     </td>
  5383.   </tr>
  5384. </table>
  5385. </div>
  5386.     
  5387.       <div class="method_details ">
  5388.   <h3 class="signature " id="delete_user-instance_method">
  5389.   
  5390.     - (<tt>Object</tt>) <strong>delete_user</strong>(user) 
  5391.   
  5392.  
  5393.   
  5394.  
  5395.   
  5396. </h3><table class="source_code">
  5397.   <tr>
  5398.     <td>
  5399.       <pre class="lines">
  5400.  
  5401.  
  5402. 30
  5403. 31
  5404. 32
  5405. 33</pre>
  5406.     </td>
  5407.     <td>
  5408.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/users.rb', line 30</span>
  5409.  
  5410. <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>
  5411.   <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>
  5412.   <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>
  5413. <span class='kw'>end</span></pre>
  5414.     </td>
  5415.   </tr>
  5416. </table>
  5417. </div>
  5418.     
  5419.       <div class="method_details ">
  5420.   <h3 class="signature " id="depot-instance_method">
  5421.   
  5422.     - (<tt>Object</tt>) <strong>depot</strong>(depot) 
  5423.   
  5424.  
  5425.   
  5426.  
  5427.   
  5428. </h3><div class="docstring">
  5429.   <div class="discussion">
  5430.     
  5431. <p>Returns the depot instance indicated by the depot name (or depot object)</p>
  5432.  
  5433.  
  5434.   </div>
  5435. </div>
  5436. <div class="tags">
  5437.   
  5438.  
  5439. </div><table class="source_code">
  5440.   <tr>
  5441.     <td>
  5442.       <pre class="lines">
  5443.  
  5444.  
  5445. 13
  5446. 14
  5447. 15
  5448. 16
  5449. 17</pre>
  5450.     </td>
  5451.     <td>
  5452.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/depots.rb', line 13</span>
  5453.  
  5454. <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>
  5455.   <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>
  5456.   <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>
  5457.   <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>
  5458. <span class='kw'>end</span></pre>
  5459.     </td>
  5460.   </tr>
  5461. </table>
  5462. </div>
  5463.     
  5464.       <div class="method_details ">
  5465.   <h3 class="signature " id="depots-instance_method">
  5466.   
  5467.     - (<tt>Object</tt>) <strong>depots</strong> 
  5468.   
  5469.  
  5470.   
  5471.  
  5472.   
  5473. </h3><div class="docstring">
  5474.   <div class="discussion">
  5475.     
  5476. <p>Array of Depot objects stored in the system. Not all fields will be filled
  5477. out (e.g., view).</p>
  5478.  
  5479.  
  5480.   </div>
  5481. </div>
  5482. <div class="tags">
  5483.   
  5484.  
  5485. </div><table class="source_code">
  5486.   <tr>
  5487.     <td>
  5488.       <pre class="lines">
  5489.  
  5490.  
  5491. 7
  5492. 8
  5493. 9
  5494. 10</pre>
  5495.     </td>
  5496.     <td>
  5497.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/depots.rb', line 7</span>
  5498.  
  5499. <span class='kw'>def</span> <span class='id identifier rubyid_depots'>depots</span>
  5500.   <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>
  5501.   <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>
  5502. <span class='kw'>end</span></pre>
  5503.     </td>
  5504.   </tr>
  5505. </table>
  5506. </div>
  5507.     
  5508.       <div class="method_details ">
  5509.   <h3 class="signature " id="encode_component-instance_method">
  5510.   
  5511.     - (<tt>Object</tt>) <strong>encode_component</strong>(str) 
  5512.   
  5513.  
  5514.   
  5515.  
  5516.   
  5517. </h3><div class="docstring">
  5518.   <div class="discussion">
  5519.     
  5520.  
  5521.   </div>
  5522. </div>
  5523. <div class="tags">
  5524.   <p class="tag_title">Parameters:</p>
  5525. <ul class="param">
  5526.   
  5527.     <li>
  5528.       
  5529.         <span class='name'>str</span>
  5530.       
  5531.       
  5532.         <span class='type'>(<tt>String</tt>)</span>
  5533.       
  5534.       
  5535.       
  5536.         &mdash;
  5537.         <div class='inline'>
  5538. <p>Component to be URI escaped</p>
  5539. </div>
  5540.       
  5541.     </li>
  5542.   
  5543. </ul>
  5544.  
  5545.  
  5546. </div><table class="source_code">
  5547.   <tr>
  5548.     <td>
  5549.       <pre class="lines">
  5550.  
  5551.  
  5552. 52
  5553. 53
  5554. 54
  5555. 55
  5556. 56
  5557. 57
  5558. 58
  5559. 59
  5560. 60</pre>
  5561.     </td>
  5562.     <td>
  5563.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/git_fusion_keys.rb', line 52</span>
  5564.  
  5565. <span class='kw'>def</span> <span class='id identifier rubyid_encode_component'>encode_component</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
  5566.   <span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_chars'>chars</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_ch'>ch</span><span class='op'>|</span>
  5567.     <span class='kw'>if</span> <span class='const'>GitFusionStrings</span><span class='op'>::</span><span class='const'>URI_RESERVED_CHARACTERS</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_ch'>ch</span><span class='rparen'>)</span>
  5568.       <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='id identifier rubyid_ch'>ch</span><span class='period'>.</span><span class='id identifier rubyid_ord'>ord</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='lparen'>(</span><span class='int'>16</span><span class='rparen'>)</span>
  5569.     <span class='kw'>else</span>
  5570.       <span class='id identifier rubyid_ch'>ch</span>
  5571.     <span class='kw'>end</span>
  5572.   <span class='kw'>end</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_end'>&#39;</span></span><span class='rparen'>)</span>
  5573. <span class='kw'>end</span></pre>
  5574.     </td>
  5575.   </tr>
  5576. </table>
  5577. </div>
  5578.     
  5579.       <div class="method_details ">
  5580.   <h3 class="signature " id="execute_method_no_body-instance_method">
  5581.   
  5582.     - (<tt>Object</tt>) <strong>execute_method_no_body</strong>(method, path, params = nil) 
  5583.   
  5584.  
  5585.   
  5586.  
  5587.   
  5588. </h3><div class="docstring">
  5589.   <div class="discussion">
  5590.     
  5591. <p>Runs the method against Helix Web Services, checks for errors, then parses
  5592. the JSON response.</p>
  5593.  
  5594.  
  5595.   </div>
  5596. </div>
  5597. <div class="tags">
  5598.   <p class="tag_title">Parameters:</p>
  5599. <ul class="param">
  5600.   
  5601.     <li>
  5602.       
  5603.         <span class='name'>method</span>
  5604.       
  5605.       
  5606.         <span class='type'>(<tt>Symbol</tt>)</span>
  5607.       
  5608.       
  5609.       
  5610.         &mdash;
  5611.         <div class='inline'>
  5612. <p>HTTP method, for example, :get, :post, :delete</p>
  5613. </div>
  5614.       
  5615.     </li>
  5616.   
  5617.     <li>
  5618.       
  5619.         <span class='name'>path</span>
  5620.       
  5621.       
  5622.         <span class='type'>(<tt>String</tt>)</span>
  5623.       
  5624.       
  5625.       
  5626.         &mdash;
  5627.         <div class='inline'>
  5628. <p>URL path part (no URI parameters) for the method</p>
  5629. </div>
  5630.       
  5631.     </li>
  5632.   
  5633.     <li>
  5634.       
  5635.         <span class='name'>params</span>
  5636.       
  5637.       
  5638.         <span class='type'>(<tt>Hash</tt>)</span>
  5639.       
  5640.       
  5641.         <em class="default">(defaults to: <tt>nil</tt>)</em>
  5642.       
  5643.       
  5644.         &mdash;
  5645.         <div class='inline'>
  5646. <p>URI parameters to send in</p>
  5647. </div>
  5648.       
  5649.     </li>
  5650.   
  5651. </ul>
  5652.  
  5653.  
  5654. </div><table class="source_code">
  5655.   <tr>
  5656.     <td>
  5657.       <pre class="lines">
  5658.  
  5659.  
  5660. 150
  5661. 151
  5662. 152
  5663. 153</pre>
  5664.     </td>
  5665.     <td>
  5666.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 150</span>
  5667.  
  5668. <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>
  5669.   <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>
  5670.   <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>
  5671. <span class='kw'>end</span></pre>
  5672.     </td>
  5673.   </tr>
  5674. </table>
  5675. </div>
  5676.     
  5677.       <div class="method_details ">
  5678.   <h3 class="signature " id="execute_method_with_body-instance_method">
  5679.   
  5680.     - (<tt>Object</tt>) <strong>execute_method_with_body</strong>(method, path, params = nil, body = nil) 
  5681.   
  5682.  
  5683.   
  5684.  
  5685.   
  5686. </h3><div class="docstring">
  5687.   <div class="discussion">
  5688.     
  5689. <p>Runs the method against Helix Web Services, checks for errors, then parses
  5690. the JSON response.</p>
  5691.  
  5692. <p>This variation will send the body (expected to be a Hash) as JSON to the
  5693. server.</p>
  5694.  
  5695.  
  5696.   </div>
  5697. </div>
  5698. <div class="tags">
  5699.   <p class="tag_title">Parameters:</p>
  5700. <ul class="param">
  5701.   
  5702.     <li>
  5703.       
  5704.         <span class='name'>method</span>
  5705.       
  5706.       
  5707.         <span class='type'>(<tt>Symbol</tt>)</span>
  5708.       
  5709.       
  5710.       
  5711.         &mdash;
  5712.         <div class='inline'>
  5713. <p>HTTP method, for example, :get, :post, :delete</p>
  5714. </div>
  5715.       
  5716.     </li>
  5717.   
  5718.     <li>
  5719.       
  5720.         <span class='name'>path</span>
  5721.       
  5722.       
  5723.         <span class='type'>(<tt>String</tt>)</span>
  5724.       
  5725.       
  5726.       
  5727.         &mdash;
  5728.         <div class='inline'>
  5729. <p>URL path part (no URI parameters) for the method</p>
  5730. </div>
  5731.       
  5732.     </li>
  5733.   
  5734.     <li>
  5735.       
  5736.         <span class='name'>params</span>
  5737.       
  5738.       
  5739.         <span class='type'>(<tt>Hash</tt>)</span>
  5740.       
  5741.       
  5742.         <em class="default">(defaults to: <tt>nil</tt>)</em>
  5743.       
  5744.       
  5745.         &mdash;
  5746.         <div class='inline'>
  5747. <p>URI parameters to send in</p>
  5748. </div>
  5749.       
  5750.     </li>
  5751.   
  5752.     <li>
  5753.       
  5754.         <span class='name'>body</span>
  5755.       
  5756.       
  5757.         <span class='type'>(<tt>Hash</tt>)</span>
  5758.       
  5759.       
  5760.         <em class="default">(defaults to: <tt>nil</tt>)</em>
  5761.       
  5762.       
  5763.         &mdash;
  5764.         <div class='inline'>
  5765. <p>The Request content (which will be converted to JSON)</p>
  5766. </div>
  5767.       
  5768.     </li>
  5769.   
  5770. </ul>
  5771.  
  5772.  
  5773. </div><table class="source_code">
  5774.   <tr>
  5775.     <td>
  5776.       <pre class="lines">
  5777.  
  5778.  
  5779. 165
  5780. 166
  5781. 167
  5782. 168</pre>
  5783.     </td>
  5784.     <td>
  5785.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 165</span>
  5786.  
  5787. <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>
  5788.   <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>
  5789.   <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>
  5790. <span class='kw'>end</span></pre>
  5791.     </td>
  5792.   </tr>
  5793. </table>
  5794. </div>
  5795.     
  5796.       <div class="method_details ">
  5797.   <h3 class="signature " id="fetch_helix_sync_latest_changelist-instance_method">
  5798.   
  5799.     - (<tt>Object</tt>) <strong>fetch_helix_sync_latest_changelist</strong>(project_id) 
  5800.   
  5801.  
  5802.   
  5803.  
  5804.   
  5805. </h3><div class="docstring">
  5806.   <div class="discussion">
  5807.     
  5808. <p>Retrieve the latest changelist.</p>
  5809.  
  5810. <p>If the change doesn&#39;t exist, you&#39;ll get a ResourceNotFound
  5811. exception.</p>
  5812.  
  5813.  
  5814.   </div>
  5815. </div>
  5816. <div class="tags">
  5817.   
  5818.  
  5819. </div><table class="source_code">
  5820.   <tr>
  5821.     <td>
  5822.       <pre class="lines">
  5823.  
  5824.  
  5825. 35
  5826. 36
  5827. 37
  5828. 38</pre>
  5829.     </td>
  5830.     <td>
  5831.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 35</span>
  5832.  
  5833. <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>
  5834.   <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/</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'>/last-change</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  5835.   <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>
  5836. <span class='kw'>end</span></pre>
  5837.     </td>
  5838.   </tr>
  5839. </table>
  5840. </div>
  5841.     
  5842.       <div class="method_details ">
  5843.   <h3 class="signature " id="fetch_helix_sync_pending_changelist-instance_method">
  5844.   
  5845.     - (<tt>Object</tt>) <strong>fetch_helix_sync_pending_changelist</strong>(project_id) 
  5846.   
  5847.  
  5848.   
  5849.  
  5850.   
  5851. </h3><div class="docstring">
  5852.   <div class="discussion">
  5853.     
  5854. <p>Retrieve the pending changelist.</p>
  5855.  
  5856. <p>If the change doesn&#39;t exist, you&#39;ll get a ResourceNotFound
  5857. exception.</p>
  5858.  
  5859.  
  5860.   </div>
  5861. </div>
  5862. <div class="tags">
  5863.   
  5864.  
  5865. </div><table class="source_code">
  5866.   <tr>
  5867.     <td>
  5868.       <pre class="lines">
  5869.  
  5870.  
  5871. 43
  5872. 44
  5873. 45
  5874. 46</pre>
  5875.     </td>
  5876.     <td>
  5877.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 43</span>
  5878.  
  5879. <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>
  5880.   <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/</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>
  5881.   <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>
  5882. <span class='kw'>end</span></pre>
  5883.     </td>
  5884.   </tr>
  5885. </table>
  5886. </div>
  5887.     
  5888.       <div class="method_details ">
  5889.   <h3 class="signature " id="file-instance_method">
  5890.   
  5891.     - (<tt>Object</tt>) <strong>file</strong>(path) 
  5892.   
  5893.  
  5894.   
  5895.  
  5896.   
  5897. </h3><div class="docstring">
  5898.   <div class="discussion">
  5899.     
  5900. <p>Returns the file metadata at this location, with the <code>content</code>
  5901. field filled out.</p>
  5902.  
  5903. <p>If path happens to be a directory, this method is synonymous with the
  5904. files() method.</p>
  5905.  
  5906.  
  5907.   </div>
  5908. </div>
  5909. <div class="tags">
  5910.   
  5911.  
  5912. </div><table class="source_code">
  5913.   <tr>
  5914.     <td>
  5915.       <pre class="lines">
  5916.  
  5917.  
  5918. 48
  5919. 49
  5920. 50</pre>
  5921.     </td>
  5922.     <td>
  5923.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/files.rb', line 48</span>
  5924.  
  5925. <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>
  5926.   <span class='id identifier rubyid_files'>files</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
  5927. <span class='kw'>end</span></pre>
  5928.     </td>
  5929.   </tr>
  5930. </table>
  5931. </div>
  5932.     
  5933.       <div class="method_details ">
  5934.   <h3 class="signature " id="files-instance_method">
  5935.   
  5936.     - (<tt>Object</tt>) <strong>files</strong>(path = &#39;&#39;) 
  5937.   
  5938.  
  5939.   
  5940.  
  5941.   
  5942. </h3><div class="docstring">
  5943.   <div class="discussion">
  5944.     
  5945. <p>General file browsing method.</p>
  5946.  
  5947. <p>The <code>path</code> parameter should be a directory location, starting
  5948. with a depot location, e.g., <code>my_depot/dir1</code>.</p>
  5949.  
  5950. <p>When path is empty, will return the list of depots.</p>
  5951.  
  5952. <p>Note: if path happens to be a file, instead of a directory, this is a
  5953. synonym with the file() method.</p>
  5954.  
  5955. <p>If the path contains wildcards, the return will only be the list of
  5956. HelixWebServicesClient::Models::File instances.</p>
  5957.  
  5958. <p>See also the HelixWebServicesClient::Models::File,
  5959. HelixWebServicesClient::Models::Dir, and
  5960. HelixWebServicesClient::Models::Depot for the output types.</p>
  5961.  
  5962.  
  5963.   </div>
  5964. </div>
  5965. <div class="tags">
  5966.   
  5967.  
  5968. </div><table class="source_code">
  5969.   <tr>
  5970.     <td>
  5971.       <pre class="lines">
  5972.  
  5973.  
  5974. 21
  5975. 22
  5976. 23
  5977. 24
  5978. 25
  5979. 26
  5980. 27
  5981. 28
  5982. 29
  5983. 30
  5984. 31
  5985. 32
  5986. 33
  5987. 34
  5988. 35
  5989. 36
  5990. 37
  5991. 38
  5992. 39
  5993. 40
  5994. 41</pre>
  5995.     </td>
  5996.     <td>
  5997.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/files.rb', line 21</span>
  5998.  
  5999. <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>
  6000.   <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>
  6001.     <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>
  6002.   <span class='kw'>end</span>
  6003.  
  6004.   <span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='kw'>nil</span>
  6005.  
  6006.   <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>
  6007.     <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>
  6008.   <span class='kw'>else</span>
  6009.     <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>
  6010.   <span class='kw'>end</span>
  6011.  
  6012.   <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>
  6013.     <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>
  6014.   <span class='kw'>else</span>
  6015.     <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>
  6016.     <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>
  6017.     <span class='id identifier rubyid_m'>m</span>
  6018.   <span class='kw'>end</span>
  6019. <span class='kw'>end</span></pre>
  6020.     </td>
  6021.   </tr>
  6022. </table>
  6023. </div>
  6024.     
  6025.       <div class="method_details ">
  6026.   <h3 class="signature " id="group-instance_method">
  6027.   
  6028.     - (<tt>Object</tt>) <strong>group</strong>(group) 
  6029.   
  6030.  
  6031.   
  6032.  
  6033.   
  6034. </h3><div class="docstring">
  6035.   <div class="discussion">
  6036.     
  6037. <p>Returns the group instance indicated by the group name (or group object)</p>
  6038.  
  6039.  
  6040.   </div>
  6041. </div>
  6042. <div class="tags">
  6043.   
  6044.  
  6045. </div><table class="source_code">
  6046.   <tr>
  6047.     <td>
  6048.       <pre class="lines">
  6049.  
  6050.  
  6051. 13
  6052. 14
  6053. 15
  6054. 16
  6055. 17</pre>
  6056.     </td>
  6057.     <td>
  6058.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/groups.rb', line 13</span>
  6059.  
  6060. <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>
  6061.   <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>
  6062.   <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>
  6063.   <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>
  6064. <span class='kw'>end</span></pre>
  6065.     </td>
  6066.   </tr>
  6067. </table>
  6068. </div>
  6069.     
  6070.       <div class="method_details ">
  6071.   <h3 class="signature " id="groups-instance_method">
  6072.   
  6073.     - (<tt>Object</tt>) <strong>groups</strong> 
  6074.   
  6075.  
  6076.   
  6077.  
  6078.   
  6079. </h3><div class="docstring">
  6080.   <div class="discussion">
  6081.     
  6082. <p>Array of Group objects stored in the system. Not all fields will be filled
  6083. out (e.g., view).</p>
  6084.  
  6085.  
  6086.   </div>
  6087. </div>
  6088. <div class="tags">
  6089.   
  6090.  
  6091. </div><table class="source_code">
  6092.   <tr>
  6093.     <td>
  6094.       <pre class="lines">
  6095.  
  6096.  
  6097. 7
  6098. 8
  6099. 9
  6100. 10</pre>
  6101.     </td>
  6102.     <td>
  6103.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/groups.rb', line 7</span>
  6104.  
  6105. <span class='kw'>def</span> <span class='id identifier rubyid_groups'>groups</span>
  6106.   <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>
  6107.   <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>
  6108. <span class='kw'>end</span></pre>
  6109.     </td>
  6110.   </tr>
  6111. </table>
  6112. </div>
  6113.     
  6114.       <div class="method_details ">
  6115.   <h3 class="signature " id="hve_path-instance_method">
  6116.   
  6117.     - (<tt>Object</tt>) <strong>hve_path</strong>(subpath) 
  6118.   
  6119.  
  6120.   
  6121.  
  6122.   
  6123. </h3><table class="source_code">
  6124.   <tr>
  6125.     <td>
  6126.       <pre class="lines">
  6127.  
  6128.  
  6129. 237
  6130. 238
  6131. 239</pre>
  6132.     </td>
  6133.     <td>
  6134.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 237</span>
  6135.  
  6136. <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>
  6137.   <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/p4/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>
  6138. <span class='kw'>end</span></pre>
  6139.     </td>
  6140.   </tr>
  6141. </table>
  6142. </div>
  6143.     
  6144.       <div class="method_details ">
  6145.   <h3 class="signature " id="increment_counter-instance_method">
  6146.   
  6147.     - (<tt>Object</tt>) <strong>increment_counter</strong>(counter) 
  6148.   
  6149.  
  6150.   
  6151.  
  6152.   
  6153. </h3><div class="docstring">
  6154.   <div class="discussion">
  6155.     
  6156. <p>Increment the value of a numerical counter</p>
  6157.  
  6158.  
  6159.   </div>
  6160. </div>
  6161. <div class="tags">
  6162.   <p class="tag_title">Parameters:</p>
  6163. <ul class="param">
  6164.   
  6165.     <li>
  6166.       
  6167.         <span class='name'>counter</span>
  6168.       
  6169.       
  6170.         <span class='type'>(<tt>String</tt>)</span>
  6171.       
  6172.       
  6173.       
  6174.         &mdash;
  6175.         <div class='inline'>
  6176. <p>The counter ID</p>
  6177. </div>
  6178.       
  6179.     </li>
  6180.   
  6181. </ul>
  6182.  
  6183.  
  6184. </div><table class="source_code">
  6185.   <tr>
  6186.     <td>
  6187.       <pre class="lines">
  6188.  
  6189.  
  6190. 22
  6191. 23
  6192. 24</pre>
  6193.     </td>
  6194.     <td>
  6195.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/counters.rb', line 22</span>
  6196.  
  6197. <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>
  6198.   <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>
  6199. <span class='kw'>end</span></pre>
  6200.     </td>
  6201.   </tr>
  6202. </table>
  6203. </div>
  6204.     
  6205.       <div class="method_details ">
  6206.   <h3 class="signature " id="job-instance_method">
  6207.   
  6208.     - (<tt>Object</tt>) <strong>job</strong>(job_id) 
  6209.   
  6210.  
  6211.   
  6212.  
  6213.   
  6214. </h3><div class="docstring">
  6215.   <div class="discussion">
  6216.     
  6217. <p>Returns the array of jobs in the system. Each job model is simply a hash of
  6218. string -&gt; string values, since each system can very likely adjust job
  6219. output.</p>
  6220.  
  6221.  
  6222.   </div>
  6223. </div>
  6224. <div class="tags">
  6225.   
  6226.  
  6227. </div><table class="source_code">
  6228.   <tr>
  6229.     <td>
  6230.       <pre class="lines">
  6231.  
  6232.  
  6233. 13
  6234. 14
  6235. 15
  6236. 16</pre>
  6237.     </td>
  6238.     <td>
  6239.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/jobs.rb', line 13</span>
  6240.  
  6241. <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>
  6242.   <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>
  6243.   <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>
  6244. <span class='kw'>end</span></pre>
  6245.     </td>
  6246.   </tr>
  6247. </table>
  6248. </div>
  6249.     
  6250.       <div class="method_details ">
  6251.   <h3 class="signature " id="jobs-instance_method">
  6252.   
  6253.     - (<tt>Object</tt>) <strong>jobs</strong> 
  6254.   
  6255.  
  6256.   
  6257.  
  6258.   
  6259. </h3><table class="source_code">
  6260.   <tr>
  6261.     <td>
  6262.       <pre class="lines">
  6263.  
  6264.  
  6265. 5
  6266. 6
  6267. 7
  6268. 8</pre>
  6269.     </td>
  6270.     <td>
  6271.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/jobs.rb', line 5</span>
  6272.  
  6273. <span class='kw'>def</span> <span class='id identifier rubyid_jobs'>jobs</span>
  6274.   <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>
  6275.   <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>
  6276. <span class='kw'>end</span></pre>
  6277.     </td>
  6278.   </tr>
  6279. </table>
  6280. </div>
  6281.     
  6282.       <div class="method_details ">
  6283.   <h3 class="signature " id="keys-instance_method">
  6284.   
  6285.     - (<tt>Object</tt>) <strong>keys</strong>(user) 
  6286.   
  6287.  
  6288.   
  6289.  
  6290.   
  6291. </h3><div class="docstring">
  6292.   <div class="discussion">
  6293.     
  6294. <p>Return all keys for specified user. Every entry contains key name and its
  6295. contents.</p>
  6296.  
  6297.  
  6298.   </div>
  6299. </div>
  6300. <div class="tags">
  6301.   <p class="tag_title">Parameters:</p>
  6302. <ul class="param">
  6303.   
  6304.     <li>
  6305.       
  6306.         <span class='name'>user</span>
  6307.       
  6308.       
  6309.         <span class='type'>(<tt>String</tt>)</span>
  6310.       
  6311.       
  6312.       
  6313.         &mdash;
  6314.         <div class='inline'>
  6315. <p>Username for which keys will be fetched</p>
  6316. </div>
  6317.       
  6318.     </li>
  6319.   
  6320. </ul>
  6321.  
  6322.  
  6323. </div><table class="source_code">
  6324.   <tr>
  6325.     <td>
  6326.       <pre class="lines">
  6327.  
  6328.  
  6329. 13
  6330. 14
  6331. 15
  6332. 16</pre>
  6333.     </td>
  6334.     <td>
  6335.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/git_fusion_keys.rb', line 13</span>
  6336.  
  6337. <span class='kw'>def</span> <span class='id identifier rubyid_keys'>keys</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
  6338.   <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'>/git-fusion/v1/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user'>user</span><span class='embexpr_end'>}</span><span class='tstring_content'>/keys</span><span class='tstring_end'>&quot;</span></span>
  6339.   <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>
  6340. <span class='kw'>end</span></pre>
  6341.     </td>
  6342.   </tr>
  6343. </table>
  6344. </div>
  6345.     
  6346.       <div class="method_details ">
  6347.   <h3 class="signature " id="label-instance_method">
  6348.   
  6349.     - (<tt>Object</tt>) <strong>label</strong>(label) 
  6350.   
  6351.  
  6352.   
  6353.  
  6354.   
  6355. </h3><div class="docstring">
  6356.   <div class="discussion">
  6357.     
  6358. <p>Returns the label instance indicated by the label name (or label object)</p>
  6359.  
  6360.  
  6361.   </div>
  6362. </div>
  6363. <div class="tags">
  6364.   
  6365.  
  6366. </div><table class="source_code">
  6367.   <tr>
  6368.     <td>
  6369.       <pre class="lines">
  6370.  
  6371.  
  6372. 13
  6373. 14
  6374. 15
  6375. 16
  6376. 17</pre>
  6377.     </td>
  6378.     <td>
  6379.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/labels.rb', line 13</span>
  6380.  
  6381. <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>
  6382.   <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>
  6383.   <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>
  6384.   <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>
  6385. <span class='kw'>end</span></pre>
  6386.     </td>
  6387.   </tr>
  6388. </table>
  6389. </div>
  6390.     
  6391.       <div class="method_details ">
  6392.   <h3 class="signature " id="labels-instance_method">
  6393.   
  6394.     - (<tt>Object</tt>) <strong>labels</strong> 
  6395.   
  6396.  
  6397.   
  6398.  
  6399.   
  6400. </h3><div class="docstring">
  6401.   <div class="discussion">
  6402.     
  6403. <p>Array of Label objects stored in the system. Not all fields will be filled
  6404. out (e.g., view).</p>
  6405.  
  6406.  
  6407.   </div>
  6408. </div>
  6409. <div class="tags">
  6410.   
  6411.  
  6412. </div><table class="source_code">
  6413.   <tr>
  6414.     <td>
  6415.       <pre class="lines">
  6416.  
  6417.  
  6418. 7
  6419. 8
  6420. 9
  6421. 10</pre>
  6422.     </td>
  6423.     <td>
  6424.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/labels.rb', line 7</span>
  6425.  
  6426. <span class='kw'>def</span> <span class='id identifier rubyid_labels'>labels</span>
  6427.   <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>
  6428.   <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>
  6429. <span class='kw'>end</span></pre>
  6430.     </td>
  6431.   </tr>
  6432. </table>
  6433. </div>
  6434.     
  6435.       <div class="method_details ">
  6436.   <h3 class="signature " id="list_repos-instance_method">
  6437.   
  6438.     - (<tt>Object</tt>) <strong>list_repos</strong> 
  6439.   
  6440.  
  6441.   
  6442.  
  6443.   
  6444. </h3><div class="docstring">
  6445.   <div class="discussion">
  6446.     
  6447. <p>Return list of configured repositories. It will fetch all configured
  6448. repositories returning a list of hashes with id and name of the repository,
  6449. where id is a git-fusion encoded name, and name is a full human-readable
  6450. string.</p>
  6451.  
  6452.  
  6453.   </div>
  6454. </div>
  6455. <div class="tags">
  6456.   
  6457.  
  6458. </div><table class="source_code">
  6459.   <tr>
  6460.     <td>
  6461.       <pre class="lines">
  6462.  
  6463.  
  6464. 14
  6465. 15
  6466. 16</pre>
  6467.     </td>
  6468.     <td>
  6469.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/git_fusion_repo.rb', line 14</span>
  6470.  
  6471. <span class='kw'>def</span> <span class='id identifier rubyid_list_repos'>list_repos</span>
  6472.   <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'>/git-fusion/v1/repos</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  6473. <span class='kw'>end</span></pre>
  6474.     </td>
  6475.   </tr>
  6476. </table>
  6477. </div>
  6478.     
  6479.       <div class="method_details ">
  6480.   <h3 class="signature " id="login-instance_method">
  6481.   
  6482.     - (<tt>Object</tt>) <strong>login</strong>(user, password) 
  6483.   
  6484.  
  6485.   
  6486.  
  6487.   
  6488. </h3><div class="docstring">
  6489.   <div class="discussion">
  6490.     
  6491. <p>Generates a host unlocked ticket for the user.</p>
  6492.  
  6493. <p>In some installations, such as Helix Cloud, the authentication source is
  6494. not the p4d instance used for connections. This allows you to generate p4
  6495. ticket which should then be passed along as the P4PASSWD per-request
  6496. header.</p>
  6497.  
  6498.  
  6499.   </div>
  6500. </div>
  6501. <div class="tags">
  6502.   <p class="tag_title">Parameters:</p>
  6503. <ul class="param">
  6504.   
  6505.     <li>
  6506.       
  6507.         <span class='name'>user</span>
  6508.       
  6509.       
  6510.         <span class='type'>(<tt>String</tt>)</span>
  6511.       
  6512.       
  6513.       
  6514.     </li>
  6515.   
  6516.     <li>
  6517.       
  6518.         <span class='name'>password</span>
  6519.       
  6520.       
  6521.         <span class='type'>(<tt>String</tt>)</span>
  6522.       
  6523.       
  6524.       
  6525.     </li>
  6526.   
  6527. </ul>
  6528.  
  6529.  
  6530. </div><table class="source_code">
  6531.   <tr>
  6532.     <td>
  6533.       <pre class="lines">
  6534.  
  6535.  
  6536. 11
  6537. 12
  6538. 13
  6539. 14
  6540. 15</pre>
  6541.     </td>
  6542.     <td>
  6543.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/login.rb', line 11</span>
  6544.  
  6545. <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>
  6546.   <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>
  6547.                                  <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>
  6548.   <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>
  6549. <span class='kw'>end</span></pre>
  6550.     </td>
  6551.   </tr>
  6552. </table>
  6553. </div>
  6554.     
  6555.       <div class="method_details ">
  6556.   <h3 class="signature " id="p4_ticket?-instance_method">
  6557.   
  6558.     - (<tt>Boolean</tt>) <strong>p4_ticket?</strong>(str) 
  6559.   
  6560.  
  6561.   
  6562.  
  6563.   
  6564. </h3><div class="docstring">
  6565.   <div class="discussion">
  6566.     
  6567.  
  6568.   </div>
  6569. </div>
  6570. <div class="tags">
  6571.   
  6572. <p class="tag_title">Returns:</p>
  6573. <ul class="return">
  6574.   
  6575.     <li>
  6576.       
  6577.       
  6578.         <span class='type'>(<tt>Boolean</tt>)</span>
  6579.       
  6580.       
  6581.       
  6582.     </li>
  6583.   
  6584. </ul>
  6585.  
  6586. </div><table class="source_code">
  6587.   <tr>
  6588.     <td>
  6589.       <pre class="lines">
  6590.  
  6591.  
  6592. 140
  6593. 141
  6594. 142</pre>
  6595.     </td>
  6596.     <td>
  6597.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 140</span>
  6598.  
  6599. <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>
  6600.   <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>
  6601. <span class='kw'>end</span></pre>
  6602.     </td>
  6603.   </tr>
  6604. </table>
  6605. </div>
  6606.     
  6607.       <div class="method_details ">
  6608.   <h3 class="signature " id="path_for-instance_method">
  6609.   
  6610.     - (<tt>Object</tt>) <strong>path_for</strong>(subpath) 
  6611.   
  6612.  
  6613.   
  6614.  
  6615.   
  6616. </h3><div class="docstring">
  6617.   <div class="discussion">
  6618.     
  6619. <p>Basically just prepends the prefix to our subpath, typically,
  6620. &#39;/p4&#39;.</p>
  6621.  
  6622.  
  6623.   </div>
  6624. </div>
  6625. <div class="tags">
  6626.   
  6627.  
  6628. </div><table class="source_code">
  6629.   <tr>
  6630.     <td>
  6631.       <pre class="lines">
  6632.  
  6633.  
  6634. 198
  6635. 199
  6636. 200
  6637. 201
  6638. 202
  6639. 203
  6640. 204
  6641. 205
  6642. 206</pre>
  6643.     </td>
  6644.     <td>
  6645.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 198</span>
  6646.  
  6647. <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>
  6648.   <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>
  6649.     <span class='id identifier rubyid_subpath'>subpath</span>
  6650.   <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>
  6651.     <span class='ivar'>@prefix</span>
  6652.   <span class='kw'>else</span>
  6653.     <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>
  6654.   <span class='kw'>end</span>
  6655. <span class='kw'>end</span></pre>
  6656.     </td>
  6657.   </tr>
  6658. </table>
  6659. </div>
  6660.     
  6661.       <div class="method_details ">
  6662.   <h3 class="signature " id="preview_helix_sync_pending_change-instance_method">
  6663.   
  6664.     - (<tt>Object</tt>) <strong>preview_helix_sync_pending_change</strong>(project_id) 
  6665.   
  6666.  
  6667.   
  6668.  
  6669.   
  6670. </h3><div class="docstring">
  6671.   <div class="discussion">
  6672.     
  6673. <p>“Preview”, or generate the resolve plan, for the pending changelist.</p>
  6674.  
  6675. <p>If the change doesn&#39;t exist, you&#39;ll get a ResourceNotFound
  6676. exception.</p>
  6677.  
  6678.  
  6679.   </div>
  6680. </div>
  6681. <div class="tags">
  6682.   
  6683.  
  6684. </div><table class="source_code">
  6685.   <tr>
  6686.     <td>
  6687.       <pre class="lines">
  6688.  
  6689.  
  6690. 57
  6691. 58
  6692. 59
  6693. 60</pre>
  6694.     </td>
  6695.     <td>
  6696.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 57</span>
  6697.  
  6698. <span class='kw'>def</span> <span class='id identifier rubyid_preview_helix_sync_pending_change'>preview_helix_sync_pending_change</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span>
  6699.   <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'>&quot;</span><span class='tstring_content'>/helix-sync/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_content'>/preview</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  6700.   <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_o'>o</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_o'>o</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  6701. <span class='kw'>end</span></pre>
  6702.     </td>
  6703.   </tr>
  6704. </table>
  6705. </div>
  6706.     
  6707.       <div class="method_details ">
  6708.   <h3 class="signature " id="project-instance_method">
  6709.   
  6710.     - (<tt>Object</tt>) <strong>project</strong>(project_id) 
  6711.   
  6712.  
  6713.   
  6714.  
  6715.   
  6716. </h3><div class="docstring">
  6717.   <div class="discussion">
  6718.     
  6719. <p>Return the project details</p>
  6720.  
  6721.  
  6722.   </div>
  6723. </div>
  6724. <div class="tags">
  6725.   <p class="tag_title">Parameters:</p>
  6726. <ul class="param">
  6727.   
  6728.     <li>
  6729.       
  6730.         <span class='name'>project_id</span>
  6731.       
  6732.       
  6733.         <span class='type'>(<tt>String</tt>)</span>
  6734.       
  6735.       
  6736.       
  6737.         &mdash;
  6738.         <div class='inline'>
  6739. <p>The project&#39;s String id</p>
  6740. </div>
  6741.       
  6742.     </li>
  6743.   
  6744. </ul>
  6745.  
  6746.  
  6747. </div><table class="source_code">
  6748.   <tr>
  6749.     <td>
  6750.       <pre class="lines">
  6751.  
  6752.  
  6753. 23
  6754. 24
  6755. 25
  6756. 26
  6757. 27</pre>
  6758.     </td>
  6759.     <td>
  6760.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/projects.rb', line 23</span>
  6761.  
  6762. <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>
  6763.   <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>
  6764.   <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>
  6765.   <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>
  6766. <span class='kw'>end</span></pre>
  6767.     </td>
  6768.   </tr>
  6769. </table>
  6770. </div>
  6771.     
  6772.       <div class="method_details ">
  6773.   <h3 class="signature " id="projects-instance_method">
  6774.   
  6775.     - (<tt>Object</tt>) <strong>projects</strong>(details: nil, extension: nil) 
  6776.   
  6777.  
  6778.   
  6779.  
  6780.   
  6781. </h3><div class="docstring">
  6782.   <div class="discussion">
  6783.     
  6784. <p>Lists the projects available on the server for the user.</p>
  6785.  
  6786.  
  6787.   </div>
  6788. </div>
  6789. <div class="tags">
  6790.   <p class="tag_title">Parameters:</p>
  6791. <ul class="param">
  6792.   
  6793.     <li>
  6794.       
  6795.         <span class='name'>details</span>
  6796.       
  6797.       
  6798.         <span class='type'>(<tt>Boolean</tt>)</span>
  6799.       
  6800.       
  6801.       
  6802.         &mdash;
  6803.         <div class='inline'>
  6804. <p>Defaults to false, if true, output will be an array of project details. If
  6805. false, output will be an array of project IDs.</p>
  6806. </div>
  6807.       
  6808.     </li>
  6809.   
  6810.     <li>
  6811.       
  6812.         <span class='name'>extension</span>
  6813.       
  6814.       
  6815.         <span class='type'>(<tt>String</tt>)</span>
  6816.       
  6817.       
  6818.       
  6819.         &mdash;
  6820.         <div class='inline'>
  6821. <p>If set, will only return projects with the indicated extension ID.</p>
  6822. </div>
  6823.       
  6824.     </li>
  6825.   
  6826. </ul>
  6827.  
  6828.  
  6829. </div><table class="source_code">
  6830.   <tr>
  6831.     <td>
  6832.       <pre class="lines">
  6833.  
  6834.  
  6835. 11
  6836. 12
  6837. 13
  6838. 14
  6839. 15
  6840. 16
  6841. 17
  6842. 18</pre>
  6843.     </td>
  6844.     <td>
  6845.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/projects.rb', line 11</span>
  6846.  
  6847. <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>
  6848.   <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
  6849.   <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>
  6850.   <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>
  6851.   <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>
  6852.   <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>
  6853.   <span class='id identifier rubyid_arr'>arr</span>
  6854. <span class='kw'>end</span></pre>
  6855.     </td>
  6856.   </tr>
  6857. </table>
  6858. </div>
  6859.     
  6860.       <div class="method_details ">
  6861.   <h3 class="signature " id="protections-instance_method">
  6862.   
  6863.     - (<tt>Object</tt>) <strong>protections</strong> 
  6864.   
  6865.  
  6866.   
  6867.  
  6868.   
  6869. </h3><div class="docstring">
  6870.   <div class="discussion">
  6871.     
  6872. <p>Fetch all protections in the system. Returns a single Protections instance.</p>
  6873.  
  6874.  
  6875.   </div>
  6876. </div>
  6877. <div class="tags">
  6878.   
  6879.  
  6880. </div><table class="source_code">
  6881.   <tr>
  6882.     <td>
  6883.       <pre class="lines">
  6884.  
  6885.  
  6886. 6
  6887. 7
  6888. 8
  6889. 9</pre>
  6890.     </td>
  6891.     <td>
  6892.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/protections.rb', line 6</span>
  6893.  
  6894. <span class='kw'>def</span> <span class='id identifier rubyid_protections'>protections</span>
  6895.   <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>
  6896.   <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>
  6897. <span class='kw'>end</span></pre>
  6898.     </td>
  6899.   </tr>
  6900. </table>
  6901. </div>
  6902.     
  6903.       <div class="method_details ">
  6904.   <h3 class="signature " id="remove_setting-instance_method">
  6905.   
  6906.     - (<tt>Object</tt>) <strong>remove_setting</strong>(key) 
  6907.   
  6908.  
  6909.   
  6910.  
  6911.   
  6912. </h3><div class="docstring">
  6913.   <div class="discussion">
  6914.     
  6915. <p>Remove a setting added via add_setting</p>
  6916.  
  6917.  
  6918.   </div>
  6919. </div>
  6920. <div class="tags">
  6921.   
  6922.  
  6923. </div><table class="source_code">
  6924.   <tr>
  6925.     <td>
  6926.       <pre class="lines">
  6927.  
  6928.  
  6929. 114
  6930. 115
  6931. 116</pre>
  6932.     </td>
  6933.     <td>
  6934.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 114</span>
  6935.  
  6936. <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>
  6937.   <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>
  6938. <span class='kw'>end</span></pre>
  6939.     </td>
  6940.   </tr>
  6941. </table>
  6942. </div>
  6943.     
  6944.       <div class="method_details ">
  6945.   <h3 class="signature " id="repo-instance_method">
  6946.   
  6947.     - (<tt>Object</tt>) <strong>repo</strong>(repo_name) 
  6948.   
  6949.  
  6950.   
  6951.  
  6952.   
  6953. </h3><div class="docstring">
  6954.   <div class="discussion">
  6955.     
  6956. <p>Return the repository details. For specified repository it will fetch and
  6957. return currently submitted configuration.</p>
  6958.  
  6959.  
  6960.   </div>
  6961. </div>
  6962. <div class="tags">
  6963.   <p class="tag_title">Parameters:</p>
  6964. <ul class="param">
  6965.   
  6966.     <li>
  6967.       
  6968.         <span class='name'>repo_name</span>
  6969.       
  6970.       
  6971.         <span class='type'>(<tt>String</tt>)</span>
  6972.       
  6973.       
  6974.       
  6975.         &mdash;
  6976.         <div class='inline'>
  6977. <p>Repository name to be encoded to git-fusion standards</p>
  6978. </div>
  6979.       
  6980.     </li>
  6981.   
  6982. </ul>
  6983.  
  6984.  
  6985. </div><table class="source_code">
  6986.   <tr>
  6987.     <td>
  6988.       <pre class="lines">
  6989.  
  6990.  
  6991. 22
  6992. 23
  6993. 24
  6994. 25</pre>
  6995.     </td>
  6996.     <td>
  6997.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/git_fusion_repo.rb', line 22</span>
  6998.  
  6999. <span class='kw'>def</span> <span class='id identifier rubyid_repo'>repo</span><span class='lparen'>(</span><span class='id identifier rubyid_repo_name'>repo_name</span><span class='rparen'>)</span>
  7000.   <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'>/git-fusion/v1/repos/</span><span class='embexpr_beg'>#{</span><span class='const'>GitFusionStrings</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_repo_name'>repo_name</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  7001.   <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>
  7002. <span class='kw'>end</span></pre>
  7003.     </td>
  7004.   </tr>
  7005. </table>
  7006. </div>
  7007.     
  7008.       <div class="method_details ">
  7009.   <h3 class="signature " id="run_method_no_body-instance_method">
  7010.   
  7011.     - (<tt>Object</tt>) <strong>run_method_no_body</strong>(method, path, params = nil) 
  7012.   
  7013.  
  7014.   
  7015.  
  7016.   
  7017. </h3><table class="source_code">
  7018.   <tr>
  7019.     <td>
  7020.       <pre class="lines">
  7021.  
  7022.  
  7023. 170
  7024. 171
  7025. 172
  7026. 173
  7027. 174
  7028. 175
  7029. 176</pre>
  7030.     </td>
  7031.     <td>
  7032.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 170</span>
  7033.  
  7034. <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>
  7035.   <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>
  7036.  
  7037.   <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>
  7038.   <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>
  7039.   <span class='id identifier rubyid_response'>response</span>
  7040. <span class='kw'>end</span></pre>
  7041.     </td>
  7042.   </tr>
  7043. </table>
  7044. </div>
  7045.     
  7046.       <div class="method_details ">
  7047.   <h3 class="signature " id="run_method_with_body-instance_method">
  7048.   
  7049.     - (<tt>Object</tt>) <strong>run_method_with_body</strong>(method, path, params = nil, body = nil) 
  7050.   
  7051.  
  7052.   
  7053.  
  7054.   
  7055. </h3><table class="source_code">
  7056.   <tr>
  7057.     <td>
  7058.       <pre class="lines">
  7059.  
  7060.  
  7061. 178
  7062. 179
  7063. 180
  7064. 181
  7065. 182
  7066. 183
  7067. 184
  7068. 185
  7069. 186
  7070. 187
  7071. 188
  7072. 189
  7073. 190
  7074. 191
  7075. 192
  7076. 193
  7077. 194
  7078. 195</pre>
  7079.     </td>
  7080.     <td>
  7081.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 178</span>
  7082.  
  7083. <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>
  7084.   <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>
  7085.     <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span>
  7086.     <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='kw'>nil</span>
  7087.   <span class='kw'>end</span>
  7088.  
  7089.   <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>
  7090.  
  7091.   <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span>
  7092.     <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>
  7093.     <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>
  7094.     <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>
  7095.   <span class='kw'>end</span>
  7096.  
  7097.   <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>
  7098.   <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>
  7099.   <span class='id identifier rubyid_response'>response</span>
  7100. <span class='kw'>end</span></pre>
  7101.     </td>
  7102.   </tr>
  7103. </table>
  7104. </div>
  7105.     
  7106.       <div class="method_details ">
  7107.   <h3 class="signature " id="server-instance_method">
  7108.   
  7109.     - (<tt>Object</tt>) <strong>server</strong>(server) 
  7110.   
  7111.  
  7112.   
  7113.  
  7114.   
  7115. </h3><div class="docstring">
  7116.   <div class="discussion">
  7117.     
  7118. <p>Returns a HelixWebServicesClient::OpenModel for the login</p>
  7119.  
  7120.  
  7121.   </div>
  7122. </div>
  7123. <div class="tags">
  7124.   
  7125.  
  7126. </div><table class="source_code">
  7127.   <tr>
  7128.     <td>
  7129.       <pre class="lines">
  7130.  
  7131.  
  7132. 12
  7133. 13
  7134. 14
  7135. 15
  7136. 16</pre>
  7137.     </td>
  7138.     <td>
  7139.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/servers.rb', line 12</span>
  7140.  
  7141. <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>
  7142.   <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>
  7143.   <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>
  7144.   <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>
  7145. <span class='kw'>end</span></pre>
  7146.     </td>
  7147.   </tr>
  7148. </table>
  7149. </div>
  7150.     
  7151.       <div class="method_details ">
  7152.   <h3 class="signature " id="servers-instance_method">
  7153.   
  7154.     - (<tt>Object</tt>) <strong>servers</strong> 
  7155.   
  7156.  
  7157.   
  7158.  
  7159.   
  7160. </h3><div class="docstring">
  7161.   <div class="discussion">
  7162.     
  7163. <p>Returns an array of Server objects representing people in the system.</p>
  7164.  
  7165.  
  7166.   </div>
  7167. </div>
  7168. <div class="tags">
  7169.   
  7170.  
  7171. </div><table class="source_code">
  7172.   <tr>
  7173.     <td>
  7174.       <pre class="lines">
  7175.  
  7176.  
  7177. 6
  7178. 7
  7179. 8
  7180. 9</pre>
  7181.     </td>
  7182.     <td>
  7183.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/servers.rb', line 6</span>
  7184.  
  7185. <span class='kw'>def</span> <span class='id identifier rubyid_servers'>servers</span>
  7186.   <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>
  7187.   <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>
  7188. <span class='kw'>end</span></pre>
  7189.     </td>
  7190.   </tr>
  7191. </table>
  7192. </div>
  7193.     
  7194.       <div class="method_details ">
  7195.   <h3 class="signature " id="services-instance_method">
  7196.   
  7197.     - (<tt>Object</tt>) <strong>services</strong> 
  7198.   
  7199.  
  7200.   
  7201.  
  7202.   
  7203. </h3><div class="docstring">
  7204.   <div class="discussion">
  7205.     
  7206. <p>Returns an array of all service definitions in the system. Each definition
  7207. is a hash with <code>type</code> and <code>uri</code> values.</p>
  7208.  
  7209.  
  7210.   </div>
  7211. </div>
  7212. <div class="tags">
  7213.   
  7214.  
  7215. </div><table class="source_code">
  7216.   <tr>
  7217.     <td>
  7218.       <pre class="lines">
  7219.  
  7220.  
  7221. 8
  7222. 9
  7223. 10</pre>
  7224.     </td>
  7225.     <td>
  7226.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/config.rb', line 8</span>
  7227.  
  7228. <span class='kw'>def</span> <span class='id identifier rubyid_services'>services</span>
  7229.   <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>
  7230. <span class='kw'>end</span></pre>
  7231.     </td>
  7232.   </tr>
  7233. </table>
  7234. </div>
  7235.     
  7236.       <div class="method_details ">
  7237.   <h3 class="signature " id="set_auth-instance_method">
  7238.   
  7239.     - (<tt>Object</tt>) <strong>set_auth</strong>(user, token) 
  7240.   
  7241.  
  7242.   
  7243.  
  7244.   
  7245. </h3><div class="docstring">
  7246.   <div class="discussion">
  7247.     
  7248. <p>Note: this class is really just common implementation. Methods are
  7249. generally defined in other files that reopen this class.</p>
  7250.  
  7251.  
  7252.   </div>
  7253. </div>
  7254. <div class="tags">
  7255.   
  7256.  
  7257. </div><table class="source_code">
  7258.   <tr>
  7259.     <td>
  7260.       <pre class="lines">
  7261.  
  7262.  
  7263. 136
  7264. 137
  7265. 138</pre>
  7266.     </td>
  7267.     <td>
  7268.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 136</span>
  7269.  
  7270. <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>
  7271.   <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>
  7272. <span class='kw'>end</span></pre>
  7273.     </td>
  7274.   </tr>
  7275. </table>
  7276. </div>
  7277.     
  7278.       <div class="method_details ">
  7279.   <h3 class="signature " id="set_counter-instance_method">
  7280.   
  7281.     - (<tt>Object</tt>) <strong>set_counter</strong>(counter) 
  7282.   
  7283.  
  7284.   
  7285.  
  7286.   
  7287. </h3><div class="docstring">
  7288.   <div class="discussion">
  7289.     
  7290. <p>Set the counter value</p>
  7291.  
  7292.  
  7293.   </div>
  7294. </div>
  7295. <div class="tags">
  7296.   <p class="tag_title">Parameters:</p>
  7297. <ul class="param">
  7298.   
  7299.     <li>
  7300.       
  7301.         <span class='name'>counter</span>
  7302.       
  7303.       
  7304.         <span class='type'>(<tt>Hash|<span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>)</span>
  7305.       
  7306.       
  7307.       
  7308.         &mdash;
  7309.         <div class='inline'>
  7310. <p>A has containing <code>counter</code> and <code>value</code> properties</p>
  7311. </div>
  7312.       
  7313.     </li>
  7314.   
  7315. </ul>
  7316.  
  7317.  
  7318. </div><table class="source_code">
  7319.   <tr>
  7320.     <td>
  7321.       <pre class="lines">
  7322.  
  7323.  
  7324. 29
  7325. 30
  7326. 31
  7327. 32</pre>
  7328.     </td>
  7329.     <td>
  7330.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/counters.rb', line 29</span>
  7331.  
  7332. <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>
  7333.   <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>
  7334.   <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>
  7335. <span class='kw'>end</span></pre>
  7336.     </td>
  7337.   </tr>
  7338. </table>
  7339. </div>
  7340.     
  7341.       <div class="method_details ">
  7342.   <h3 class="signature " id="stream-instance_method">
  7343.   
  7344.     - (<tt>Object</tt>) <strong>stream</strong>(stream) 
  7345.   
  7346.  
  7347.   
  7348.  
  7349.   
  7350. </h3><div class="docstring">
  7351.   <div class="discussion">
  7352.     
  7353. <p>Fetch single stream details</p>
  7354.  
  7355.  
  7356.   </div>
  7357. </div>
  7358. <div class="tags">
  7359.   
  7360. <p class="tag_title">Returns:</p>
  7361. <ul class="return">
  7362.   
  7363.     <li>
  7364.       
  7365.       
  7366.         <span class='type'></span>
  7367.       
  7368.       
  7369.       
  7370.         
  7371.         <div class='inline'>
  7372. <p>An OpenModel wrapper around the stream data</p>
  7373. </div>
  7374.       
  7375.     </li>
  7376.   
  7377. </ul>
  7378.  
  7379. </div><table class="source_code">
  7380.   <tr>
  7381.     <td>
  7382.       <pre class="lines">
  7383.  
  7384.  
  7385. 14
  7386. 15
  7387. 16
  7388. 17
  7389. 18</pre>
  7390.     </td>
  7391.     <td>
  7392.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/streams.rb', line 14</span>
  7393.  
  7394. <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>
  7395.   <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>
  7396.   <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>
  7397.   <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>
  7398. <span class='kw'>end</span></pre>
  7399.     </td>
  7400.   </tr>
  7401. </table>
  7402. </div>
  7403.     
  7404.       <div class="method_details ">
  7405.   <h3 class="signature " id="streams-instance_method">
  7406.   
  7407.     - (<tt>Object</tt>) <strong>streams</strong> 
  7408.   
  7409.  
  7410.   
  7411.  
  7412.   
  7413. </h3><div class="docstring">
  7414.   <div class="discussion">
  7415.     
  7416. <p>Returns an array of Stream objects representing people in the system.</p>
  7417.  
  7418.  
  7419.   </div>
  7420. </div>
  7421. <div class="tags">
  7422.   
  7423.  
  7424. </div><table class="source_code">
  7425.   <tr>
  7426.     <td>
  7427.       <pre class="lines">
  7428.  
  7429.  
  7430. 6
  7431. 7
  7432. 8
  7433. 9</pre>
  7434.     </td>
  7435.     <td>
  7436.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/streams.rb', line 6</span>
  7437.  
  7438. <span class='kw'>def</span> <span class='id identifier rubyid_streams'>streams</span>
  7439.   <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>
  7440.   <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>
  7441. <span class='kw'>end</span></pre>
  7442.     </td>
  7443.   </tr>
  7444. </table>
  7445. </div>
  7446.     
  7447.       <div class="method_details ">
  7448.   <h3 class="signature " id="submit_config-instance_method">
  7449.   
  7450.     - (<tt>Object</tt>) <strong>submit_config</strong>(repo_name, config) 
  7451.   
  7452.  
  7453.   
  7454.  
  7455.   
  7456. </h3><div class="docstring">
  7457.   <div class="discussion">
  7458.     
  7459. <p>Replace config for a specified repository. This will replace current config
  7460. for a Git Fusion repo with a new one under the same name, for the same
  7461. path.</p>
  7462.  
  7463.  
  7464.   </div>
  7465. </div>
  7466. <div class="tags">
  7467.   <p class="tag_title">Parameters:</p>
  7468. <ul class="param">
  7469.   
  7470.     <li>
  7471.       
  7472.         <span class='name'>repo_name</span>
  7473.       
  7474.       
  7475.         <span class='type'>(<tt>String</tt>)</span>
  7476.       
  7477.       
  7478.       
  7479.         &mdash;
  7480.         <div class='inline'>
  7481. <p>Repository name to be encoded to git-fusion standards</p>
  7482. </div>
  7483.       
  7484.     </li>
  7485.   
  7486.     <li>
  7487.       
  7488.         <span class='name'>config</span>
  7489.       
  7490.       
  7491.         <span class='type'>(<tt>String</tt>)</span>
  7492.       
  7493.       
  7494.       
  7495.         &mdash;
  7496.         <div class='inline'>
  7497. <p>GitFusion config file</p>
  7498. </div>
  7499.       
  7500.     </li>
  7501.   
  7502. </ul>
  7503.  
  7504.  
  7505. </div><table class="source_code">
  7506.   <tr>
  7507.     <td>
  7508.       <pre class="lines">
  7509.  
  7510.  
  7511. 40
  7512. 41
  7513. 42
  7514. 43</pre>
  7515.     </td>
  7516.     <td>
  7517.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/git_fusion_repo.rb', line 40</span>
  7518.  
  7519. <span class='kw'>def</span> <span class='id identifier rubyid_submit_config'>submit_config</span><span class='lparen'>(</span><span class='id identifier rubyid_repo_name'>repo_name</span><span class='comma'>,</span> <span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
  7520.   <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'>/git-fusion/v1/repos/</span><span class='embexpr_beg'>#{</span><span class='const'>GitFusionStrings</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_repo_name'>repo_name</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  7521.   <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_path'>path</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>config</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_config'>config</span><span class='rbrace'>}</span><span class='rparen'>)</span>
  7522. <span class='kw'>end</span></pre>
  7523.     </td>
  7524.   </tr>
  7525. </table>
  7526. </div>
  7527.     
  7528.       <div class="method_details ">
  7529.   <h3 class="signature " id="submit_helix_sync_pending_change-instance_method">
  7530.   
  7531.     - (<tt>Object</tt>) <strong>submit_helix_sync_pending_change</strong>(project_id) 
  7532.   
  7533.  
  7534.   
  7535.  
  7536.   
  7537. </h3><div class="docstring">
  7538.   <div class="discussion">
  7539.     
  7540. <p>Submits the pending changelist for the helix sync project.</p>
  7541.  
  7542. <p>Currently this assumes that all files are shelved and nothing&#39;s open on
  7543. the client. This is likely not what we want … but it&#39;s a start.</p>
  7544.  
  7545.  
  7546.   </div>
  7547. </div>
  7548. <div class="tags">
  7549.   <p class="tag_title">Parameters:</p>
  7550. <ul class="param">
  7551.   
  7552.     <li>
  7553.       
  7554.         <span class='name'>project_id</span>
  7555.       
  7556.       
  7557.         <span class='type'>(<tt>String</tt>)</span>
  7558.       
  7559.       
  7560.       
  7561.     </li>
  7562.   
  7563. </ul>
  7564.  
  7565.  
  7566. </div><table class="source_code">
  7567.   <tr>
  7568.     <td>
  7569.       <pre class="lines">
  7570.  
  7571.  
  7572. 68
  7573. 69
  7574. 70
  7575. 71</pre>
  7576.     </td>
  7577.     <td>
  7578.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/helix_sync.rb', line 68</span>
  7579.  
  7580. <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>
  7581.   <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/</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'>/submit</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  7582.   <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>
  7583. <span class='kw'>end</span></pre>
  7584.     </td>
  7585.   </tr>
  7586. </table>
  7587. </div>
  7588.     
  7589.       <div class="method_details ">
  7590.   <h3 class="signature " id="triggers-instance_method">
  7591.   
  7592.     - (<tt><span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>) <strong>triggers</strong> 
  7593.   
  7594.  
  7595.   
  7596.  
  7597.   
  7598. </h3><div class="docstring">
  7599.   <div class="discussion">
  7600.     
  7601. <p>Fetch the list of trigger lines in the system.</p>
  7602.  
  7603.  
  7604.   </div>
  7605. </div>
  7606. <div class="tags">
  7607.   
  7608. <p class="tag_title">Returns:</p>
  7609. <ul class="return">
  7610.   
  7611.     <li>
  7612.       
  7613.       
  7614.         <span class='type'>(<tt><span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>)</span>
  7615.       
  7616.       
  7617.       
  7618.         &mdash;
  7619.         <div class='inline'>
  7620. <p>A hash with a <code>Triggers</code> property that is an array of lines in
  7621. the triggers table.</p>
  7622. </div>
  7623.       
  7624.     </li>
  7625.   
  7626. </ul>
  7627.  
  7628. </div><table class="source_code">
  7629.   <tr>
  7630.     <td>
  7631.       <pre class="lines">
  7632.  
  7633.  
  7634. 8
  7635. 9
  7636. 10
  7637. 11</pre>
  7638.     </td>
  7639.     <td>
  7640.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/triggers.rb', line 8</span>
  7641.  
  7642. <span class='kw'>def</span> <span class='id identifier rubyid_triggers'>triggers</span>
  7643.   <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>
  7644.   <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>
  7645. <span class='kw'>end</span></pre>
  7646.     </td>
  7647.   </tr>
  7648. </table>
  7649. </div>
  7650.     
  7651.       <div class="method_details ">
  7652.   <h3 class="signature " id="update_branch-instance_method">
  7653.   
  7654.     - (<tt>Object</tt>) <strong>update_branch</strong>(branch) 
  7655.   
  7656.  
  7657.   
  7658.  
  7659.   
  7660. </h3><div class="docstring">
  7661.   <div class="discussion">
  7662.     
  7663. <p>Updates the branch specification.</p>
  7664.  
  7665.  
  7666.   </div>
  7667. </div>
  7668. <div class="tags">
  7669.   
  7670.  
  7671. </div><table class="source_code">
  7672.   <tr>
  7673.     <td>
  7674.       <pre class="lines">
  7675.  
  7676.  
  7677. 27
  7678. 28
  7679. 29
  7680. 30
  7681. 31
  7682. 32</pre>
  7683.     </td>
  7684.     <td>
  7685.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/branches.rb', line 27</span>
  7686.  
  7687. <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>
  7688.   <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>
  7689.   <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>
  7690.                            <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>
  7691.   <span class='kw'>true</span>
  7692. <span class='kw'>end</span></pre>
  7693.     </td>
  7694.   </tr>
  7695. </table>
  7696. </div>
  7697.     
  7698.       <div class="method_details ">
  7699.   <h3 class="signature " id="update_client-instance_method">
  7700.   
  7701.     - (<tt>Object</tt>) <strong>update_client</strong>(client) 
  7702.   
  7703.  
  7704.   
  7705.  
  7706.   
  7707. </h3><div class="docstring">
  7708.   <div class="discussion">
  7709.     
  7710. <p>Updates the client specification.</p>
  7711.  
  7712.  
  7713.   </div>
  7714. </div>
  7715. <div class="tags">
  7716.   
  7717.  
  7718. </div><table class="source_code">
  7719.   <tr>
  7720.     <td>
  7721.       <pre class="lines">
  7722.  
  7723.  
  7724. 26
  7725. 27
  7726. 28
  7727. 29
  7728. 30
  7729. 31</pre>
  7730.     </td>
  7731.     <td>
  7732.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/clients.rb', line 26</span>
  7733.  
  7734. <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>
  7735.   <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>
  7736.   <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>
  7737.                            <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>
  7738.   <span class='kw'>true</span>
  7739. <span class='kw'>end</span></pre>
  7740.     </td>
  7741.   </tr>
  7742. </table>
  7743. </div>
  7744.     
  7745.       <div class="method_details ">
  7746.   <h3 class="signature " id="update_config-instance_method">
  7747.   
  7748.     - (<tt>Object</tt>) <strong>update_config</strong>(repo_name, config) 
  7749.   
  7750.  
  7751.   
  7752.  
  7753.   
  7754. </h3><div class="docstring">
  7755.   <div class="discussion">
  7756.     
  7757. <p>Modify config for a specified repository. This will update chosen parts of
  7758. p4gf_file.</p>
  7759.  
  7760.  
  7761.   </div>
  7762. </div>
  7763. <div class="tags">
  7764.   <p class="tag_title">Parameters:</p>
  7765. <ul class="param">
  7766.   
  7767.     <li>
  7768.       
  7769.         <span class='name'>repo_name</span>
  7770.       
  7771.       
  7772.         <span class='type'>(<tt>String</tt>)</span>
  7773.       
  7774.       
  7775.       
  7776.         &mdash;
  7777.         <div class='inline'>
  7778. <p>Repository name to be encoded to git-fusion standards</p>
  7779. </div>
  7780.       
  7781.     </li>
  7782.   
  7783.     <li>
  7784.       
  7785.         <span class='name'>config</span>
  7786.       
  7787.       
  7788.         <span class='type'>(<tt>String</tt>)</span>
  7789.       
  7790.       
  7791.       
  7792.         &mdash;
  7793.         <div class='inline'>
  7794. <p>String to update in current p4gf_config file</p>
  7795. </div>
  7796.       
  7797.     </li>
  7798.   
  7799. </ul>
  7800.  
  7801.  
  7802. </div><table class="source_code">
  7803.   <tr>
  7804.     <td>
  7805.       <pre class="lines">
  7806.  
  7807.  
  7808. 49
  7809. 50
  7810. 51</pre>
  7811.     </td>
  7812.     <td>
  7813.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/git_fusion_repo.rb', line 49</span>
  7814.  
  7815. <span class='kw'>def</span> <span class='id identifier rubyid_update_config'>update_config</span><span class='lparen'>(</span><span class='id identifier rubyid_repo_name'>repo_name</span><span class='comma'>,</span> <span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
  7816.   <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='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/git-fusion/v1/repos/</span><span class='embexpr_beg'>#{</span><span class='const'>GitFusionStrings</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_repo_name'>repo_name</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>config</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_config'>config</span><span class='rbrace'>}</span><span class='rparen'>)</span>
  7817. <span class='kw'>end</span></pre>
  7818.     </td>
  7819.   </tr>
  7820. </table>
  7821. </div>
  7822.     
  7823.       <div class="method_details ">
  7824.   <h3 class="signature " id="update_depot-instance_method">
  7825.   
  7826.     - (<tt>Object</tt>) <strong>update_depot</strong>(depot) 
  7827.   
  7828.  
  7829.   
  7830.  
  7831.   
  7832. </h3><div class="docstring">
  7833.   <div class="discussion">
  7834.     
  7835. <p>Updates the depot specification.</p>
  7836.  
  7837.  
  7838.   </div>
  7839. </div>
  7840. <div class="tags">
  7841.   
  7842.  
  7843. </div><table class="source_code">
  7844.   <tr>
  7845.     <td>
  7846.       <pre class="lines">
  7847.  
  7848.  
  7849. 26
  7850. 27
  7851. 28
  7852. 29
  7853. 30</pre>
  7854.     </td>
  7855.     <td>
  7856.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/depots.rb', line 26</span>
  7857.  
  7858. <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>
  7859.   <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>
  7860.   <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>
  7861.                            <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>
  7862. <span class='kw'>end</span></pre>
  7863.     </td>
  7864.   </tr>
  7865. </table>
  7866. </div>
  7867.     
  7868.       <div class="method_details ">
  7869.   <h3 class="signature " id="update_group-instance_method">
  7870.   
  7871.     - (<tt>Object</tt>) <strong>update_group</strong>(group) 
  7872.   
  7873.  
  7874.   
  7875.  
  7876.   
  7877. </h3><div class="docstring">
  7878.   <div class="discussion">
  7879.     
  7880. <p>Updates the group specification.</p>
  7881.  
  7882.  
  7883.   </div>
  7884. </div>
  7885. <div class="tags">
  7886.   
  7887.  
  7888. </div><table class="source_code">
  7889.   <tr>
  7890.     <td>
  7891.       <pre class="lines">
  7892.  
  7893.  
  7894. 26
  7895. 27
  7896. 28
  7897. 29
  7898. 30</pre>
  7899.     </td>
  7900.     <td>
  7901.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/groups.rb', line 26</span>
  7902.  
  7903. <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>
  7904.   <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>
  7905.   <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>
  7906.                            <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>
  7907. <span class='kw'>end</span></pre>
  7908.     </td>
  7909.   </tr>
  7910. </table>
  7911. </div>
  7912.     
  7913.       <div class="method_details ">
  7914.   <h3 class="signature " id="update_job-instance_method">
  7915.   
  7916.     - (<tt>Object</tt>) <strong>update_job</strong>(job) 
  7917.   
  7918.  
  7919.   
  7920.  
  7921.   
  7922. </h3><div class="docstring">
  7923.   <div class="discussion">
  7924.     
  7925. <p>Updates the job specification.</p>
  7926.  
  7927.  
  7928.   </div>
  7929. </div>
  7930. <div class="tags">
  7931.   
  7932.  
  7933. </div><table class="source_code">
  7934.   <tr>
  7935.     <td>
  7936.       <pre class="lines">
  7937.  
  7938.  
  7939. 28
  7940. 29
  7941. 30
  7942. 31
  7943. 32</pre>
  7944.     </td>
  7945.     <td>
  7946.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/jobs.rb', line 28</span>
  7947.  
  7948. <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>
  7949.   <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>
  7950.   <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>
  7951.                            <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>
  7952. <span class='kw'>end</span></pre>
  7953.     </td>
  7954.   </tr>
  7955. </table>
  7956. </div>
  7957.     
  7958.       <div class="method_details ">
  7959.   <h3 class="signature " id="update_label-instance_method">
  7960.   
  7961.     - (<tt>Object</tt>) <strong>update_label</strong>(label) 
  7962.   
  7963.  
  7964.   
  7965.  
  7966.   
  7967. </h3><div class="docstring">
  7968.   <div class="discussion">
  7969.     
  7970. <p>Updates the label specification.</p>
  7971.  
  7972.  
  7973.   </div>
  7974. </div>
  7975. <div class="tags">
  7976.   
  7977.  
  7978. </div><table class="source_code">
  7979.   <tr>
  7980.     <td>
  7981.       <pre class="lines">
  7982.  
  7983.  
  7984. 26
  7985. 27
  7986. 28
  7987. 29
  7988. 30</pre>
  7989.     </td>
  7990.     <td>
  7991.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/labels.rb', line 26</span>
  7992.  
  7993. <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>
  7994.   <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>
  7995.   <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>
  7996.                            <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>
  7997. <span class='kw'>end</span></pre>
  7998.     </td>
  7999.   </tr>
  8000. </table>
  8001. </div>
  8002.     
  8003.       <div class="method_details ">
  8004.   <h3 class="signature " id="update_protections-instance_method">
  8005.   
  8006.     - (<tt>Object</tt>) <strong>update_protections</strong>(protections) 
  8007.   
  8008.  
  8009.   
  8010.  
  8011.   
  8012. </h3><div class="docstring">
  8013.   <div class="discussion">
  8014.     
  8015. <p>Updates the protections table based on the Protections instance passed in</p>
  8016.  
  8017.  
  8018.   </div>
  8019. </div>
  8020. <div class="tags">
  8021.   <p class="tag_title">Parameters:</p>
  8022. <ul class="param">
  8023.   
  8024.     <li>
  8025.       
  8026.         <span class='name'>protections</span>
  8027.       
  8028.       
  8029.         <span class='type'>(<tt>Hash|<span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>)</span>
  8030.       
  8031.       
  8032.       
  8033.         &mdash;
  8034.         <div class='inline'>
  8035. <p>A hash with a <code>protections</code> property that is an Array of
  8036. protections entries</p>
  8037. </div>
  8038.       
  8039.     </li>
  8040.   
  8041. </ul>
  8042.  
  8043.  
  8044. </div><table class="source_code">
  8045.   <tr>
  8046.     <td>
  8047.       <pre class="lines">
  8048.  
  8049.  
  8050. 15
  8051. 16
  8052. 17
  8053. 18
  8054. 19</pre>
  8055.     </td>
  8056.     <td>
  8057.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/protections.rb', line 15</span>
  8058.  
  8059. <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>
  8060.   <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>
  8061.   <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>
  8062.                            <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>
  8063. <span class='kw'>end</span></pre>
  8064.     </td>
  8065.   </tr>
  8066. </table>
  8067. </div>
  8068.     
  8069.       <div class="method_details ">
  8070.   <h3 class="signature " id="update_server-instance_method">
  8071.   
  8072.     - (<tt>Object</tt>) <strong>update_server</strong>(server) 
  8073.   
  8074.  
  8075.   
  8076.  
  8077.   
  8078. </h3><table class="source_code">
  8079.   <tr>
  8080.     <td>
  8081.       <pre class="lines">
  8082.  
  8083.  
  8084. 24
  8085. 25
  8086. 26
  8087. 27
  8088. 28
  8089. 29</pre>
  8090.     </td>
  8091.     <td>
  8092.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/servers.rb', line 24</span>
  8093.  
  8094. <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>
  8095.   <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>
  8096.   <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>
  8097.                            <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>
  8098.                            <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>
  8099. <span class='kw'>end</span></pre>
  8100.     </td>
  8101.   </tr>
  8102. </table>
  8103. </div>
  8104.     
  8105.       <div class="method_details ">
  8106.   <h3 class="signature " id="update_stream-instance_method">
  8107.   
  8108.     - (<tt>Object</tt>) <strong>update_stream</strong>(stream) 
  8109.   
  8110.  
  8111.   
  8112.  
  8113.   
  8114. </h3><table class="source_code">
  8115.   <tr>
  8116.     <td>
  8117.       <pre class="lines">
  8118.  
  8119.  
  8120. 26
  8121. 27
  8122. 28
  8123. 29
  8124. 30</pre>
  8125.     </td>
  8126.     <td>
  8127.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/streams.rb', line 26</span>
  8128.  
  8129. <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>
  8130.   <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>
  8131.   <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>
  8132.                            <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>
  8133. <span class='kw'>end</span></pre>
  8134.     </td>
  8135.   </tr>
  8136. </table>
  8137. </div>
  8138.     
  8139.       <div class="method_details ">
  8140.   <h3 class="signature " id="update_triggers-instance_method">
  8141.   
  8142.     - (<tt>Object</tt>) <strong>update_triggers</strong>(triggers) 
  8143.   
  8144.  
  8145.   
  8146.  
  8147.   
  8148. </h3><div class="docstring">
  8149.   <div class="discussion">
  8150.     
  8151. <p>Update the triggers table using the Triggers model instance</p>
  8152.  
  8153.  
  8154.   </div>
  8155. </div>
  8156. <div class="tags">
  8157.   <p class="tag_title">Parameters:</p>
  8158. <ul class="param">
  8159.   
  8160.     <li>
  8161.       
  8162.         <span class='name'>triggers</span>
  8163.       
  8164.       
  8165.         <span class='type'>(<tt>Hash|<span class='object_link'><a href="OpenModel.html" title="OpenModel (class)">OpenModel</a></span></tt>)</span>
  8166.       
  8167.       
  8168.       
  8169.         &mdash;
  8170.         <div class='inline'>
  8171. <p>A hash with a <code>Triggers</code> property</p>
  8172. </div>
  8173.       
  8174.     </li>
  8175.   
  8176. </ul>
  8177.  
  8178.  
  8179. </div><table class="source_code">
  8180.   <tr>
  8181.     <td>
  8182.       <pre class="lines">
  8183.  
  8184.  
  8185. 16
  8186. 17
  8187. 18
  8188. 19</pre>
  8189.     </td>
  8190.     <td>
  8191.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/triggers.rb', line 16</span>
  8192.  
  8193. <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>
  8194.   <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>
  8195.   <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>
  8196. <span class='kw'>end</span></pre>
  8197.     </td>
  8198.   </tr>
  8199. </table>
  8200. </div>
  8201.     
  8202.       <div class="method_details ">
  8203.   <h3 class="signature " id="update_user-instance_method">
  8204.   
  8205.     - (<tt>Object</tt>) <strong>update_user</strong>(user) 
  8206.   
  8207.  
  8208.   
  8209.  
  8210.   
  8211. </h3><table class="source_code">
  8212.   <tr>
  8213.     <td>
  8214.       <pre class="lines">
  8215.  
  8216.  
  8217. 24
  8218. 25
  8219. 26
  8220. 27
  8221. 28</pre>
  8222.     </td>
  8223.     <td>
  8224.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/users.rb', line 24</span>
  8225.  
  8226. <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>
  8227.   <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>
  8228.   <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>
  8229.                            <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>
  8230. <span class='kw'>end</span></pre>
  8231.     </td>
  8232.   </tr>
  8233. </table>
  8234. </div>
  8235.     
  8236.       <div class="method_details ">
  8237.   <h3 class="signature " id="upload_file-instance_method">
  8238.   
  8239.     - (<tt>Object</tt>) <strong>upload_file</strong>(file) 
  8240.   
  8241.  
  8242.   
  8243.  
  8244.   
  8245. </h3><div class="docstring">
  8246.   <div class="discussion">
  8247.     
  8248. <p>Upload a single file&#39;s content.</p>
  8249.  
  8250. <p>The <code>file</code> hash should contain the following fields:</p>
  8251. <ul><li>
  8252. <p><code>DepotFile</code>: target depot path</p>
  8253. </li><li>
  8254. <p><code>Content</code>: file content</p>
  8255. </li></ul>
  8256.  
  8257.  
  8258.   </div>
  8259. </div>
  8260. <div class="tags">
  8261.   <p class="tag_title">Parameters:</p>
  8262. <ul class="param">
  8263.   
  8264.     <li>
  8265.       
  8266.         <span class='name'>file</span>
  8267.       
  8268.       
  8269.         <span class='type'>(<tt>Hash</tt>)</span>
  8270.       
  8271.       
  8272.       
  8273.         &mdash;
  8274.         <div class='inline'>
  8275. <p>See description</p>
  8276. </div>
  8277.       
  8278.     </li>
  8279.   
  8280. </ul>
  8281.  
  8282.  
  8283. </div><table class="source_code">
  8284.   <tr>
  8285.     <td>
  8286.       <pre class="lines">
  8287.  
  8288.  
  8289. 60
  8290. 61
  8291. 62
  8292. 63
  8293. 64
  8294. 65
  8295. 66
  8296. 67
  8297. 68
  8298. 69
  8299. 70
  8300. 71</pre>
  8301.     </td>
  8302.     <td>
  8303.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/files.rb', line 60</span>
  8304.  
  8305. <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>
  8306.   <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>
  8307.   <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>
  8308.   <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
  8309.       <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_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_depot_file'>depot_file</span><span class='comma'>,</span>
  8310.       <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_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
  8311.   <span class='rbrace'>}</span>
  8312.   <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>
  8313.                            <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>
  8314.                            <span class='kw'>nil</span><span class='comma'>,</span>
  8315.                            <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
  8316. <span class='kw'>end</span></pre>
  8317.     </td>
  8318.   </tr>
  8319. </table>
  8320. </div>
  8321.     
  8322.       <div class="method_details ">
  8323.   <h3 class="signature " id="upload_files-instance_method">
  8324.   
  8325.     - (<tt>Object</tt>) <strong>upload_files</strong>(files: [], path: nil, description: nil) 
  8326.   
  8327.  
  8328.   
  8329.  
  8330.   
  8331. </h3><div class="docstring">
  8332.   <div class="discussion">
  8333.     
  8334. <p>Upload multiple files</p>
  8335.  
  8336. <p>Each file in the <code>Files</code> array should have two fields</p>
  8337. <ul><li>
  8338. <p><code>DepotFile</code>: target path, can be relative if <code>path</code>
  8339. is indicated</p>
  8340. </li><li>
  8341. <p><code>Content</code>: File content</p>
  8342. </li></ul>
  8343.  
  8344. <p>The optional <code>path</code> parameter can indicate the root directory
  8345. for all files.</p>
  8346.  
  8347.  
  8348.   </div>
  8349. </div>
  8350. <div class="tags">
  8351.   <p class="tag_title">Parameters:</p>
  8352. <ul class="param">
  8353.   
  8354.     <li>
  8355.       
  8356.         <span class='name'>files</span>
  8357.       
  8358.       
  8359.         <span class='type'>(<tt>Array</tt>)</span>
  8360.       
  8361.       
  8362.       
  8363.         &mdash;
  8364.         <div class='inline'>
  8365. <p>See description</p>
  8366. </div>
  8367.       
  8368.     </li>
  8369.   
  8370.     <li>
  8371.       
  8372.         <span class='name'>path</span>
  8373.       
  8374.       
  8375.         <span class='type'>(<tt>String</tt>)</span>
  8376.       
  8377.       
  8378.       
  8379.         &mdash;
  8380.         <div class='inline'>
  8381. <p>If set, the root directory for all files</p>
  8382. </div>
  8383.       
  8384.     </li>
  8385.   
  8386.     <li>
  8387.       
  8388.         <span class='name'>description</span>
  8389.       
  8390.       
  8391.         <span class='type'>(<tt>String</tt>)</span>
  8392.       
  8393.       
  8394.       
  8395.         &mdash;
  8396.         <div class='inline'>
  8397. <p>Informative message about the change</p>
  8398. </div>
  8399.       
  8400.     </li>
  8401.   
  8402. </ul>
  8403.  
  8404.  
  8405. </div><table class="source_code">
  8406.   <tr>
  8407.     <td>
  8408.       <pre class="lines">
  8409.  
  8410.  
  8411. 86
  8412. 87
  8413. 88
  8414. 89
  8415. 90
  8416. 91
  8417. 92
  8418. 93
  8419. 94
  8420. 95
  8421. 96
  8422. 97
  8423. 98
  8424. 99
  8425. 100
  8426. 101
  8427. 102
  8428. 103
  8429. 104</pre>
  8430.     </td>
  8431.     <td>
  8432.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/files.rb', line 86</span>
  8433.  
  8434. <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>
  8435.   <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>
  8436.     <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>
  8437.   <span class='kw'>end</span>
  8438.  
  8439.   <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>
  8440.  
  8441.   <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='lbrace'>{</span>
  8442.       <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>
  8443.         <span class='lbrace'>{</span>
  8444.             <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>
  8445.             <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>
  8446.         <span class='rbrace'>}</span>
  8447.       <span class='kw'>end</span>
  8448.   <span class='rbrace'>}</span>
  8449.   <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>
  8450.  
  8451.   <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>
  8452. <span class='kw'>end</span></pre>
  8453.     </td>
  8454.   </tr>
  8455. </table>
  8456. </div>
  8457.     
  8458.       <div class="method_details ">
  8459.   <h3 class="signature " id="user_details-instance_method">
  8460.   
  8461.     - (<tt>Object</tt>) <strong>user_details</strong>(user) 
  8462.   
  8463.  
  8464.   
  8465.  
  8466.   
  8467. </h3><div class="docstring">
  8468.   <div class="discussion">
  8469.     
  8470. <p>Returns a HelixWebServicesClient::OpenModel for the login</p>
  8471.  
  8472.  
  8473.   </div>
  8474. </div>
  8475. <div class="tags">
  8476.   
  8477.  
  8478. </div><table class="source_code">
  8479.   <tr>
  8480.     <td>
  8481.       <pre class="lines">
  8482.  
  8483.  
  8484. 12
  8485. 13
  8486. 14
  8487. 15
  8488. 16</pre>
  8489.     </td>
  8490.     <td>
  8491.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/users.rb', line 12</span>
  8492.  
  8493. <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>
  8494.   <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>
  8495.   <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>
  8496.   <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>
  8497. <span class='kw'>end</span></pre>
  8498.     </td>
  8499.   </tr>
  8500. </table>
  8501. </div>
  8502.     
  8503.       <div class="method_details ">
  8504.   <h3 class="signature " id="users-instance_method">
  8505.   
  8506.     - (<tt>Object</tt>) <strong>users</strong> 
  8507.   
  8508.  
  8509.   
  8510.  
  8511.   
  8512. </h3><div class="docstring">
  8513.   <div class="discussion">
  8514.     
  8515. <p>Returns an array of User objects representing people in the system.</p>
  8516.  
  8517.  
  8518.   </div>
  8519. </div>
  8520. <div class="tags">
  8521.   
  8522.  
  8523. </div><table class="source_code">
  8524.   <tr>
  8525.     <td>
  8526.       <pre class="lines">
  8527.  
  8528.  
  8529. 6
  8530. 7
  8531. 8
  8532. 9</pre>
  8533.     </td>
  8534.     <td>
  8535.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/users.rb', line 6</span>
  8536.  
  8537. <span class='kw'>def</span> <span class='id identifier rubyid_users'>users</span>
  8538.   <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>
  8539.   <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>
  8540. <span class='kw'>end</span></pre>
  8541.     </td>
  8542.   </tr>
  8543. </table>
  8544. </div>
  8545.     
  8546.       <div class="method_details ">
  8547.   <h3 class="signature " id="version-instance_method">
  8548.   
  8549.     - (<tt>Object</tt>) <strong>version</strong> 
  8550.   
  8551.  
  8552.   
  8553.  
  8554.   
  8555. </h3><div class="docstring">
  8556.   <div class="discussion">
  8557.     
  8558. <p>Return the product version ID of the Helix Web Services instance</p>
  8559.  
  8560.  
  8561.   </div>
  8562. </div>
  8563. <div class="tags">
  8564.   
  8565.  
  8566. </div><table class="source_code">
  8567.   <tr>
  8568.     <td>
  8569.       <pre class="lines">
  8570.  
  8571.  
  8572. 242
  8573. 243
  8574. 244
  8575. 245</pre>
  8576.     </td>
  8577.     <td>
  8578.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 242</span>
  8579.  
  8580. <span class='kw'>def</span> <span class='id identifier rubyid_version'>version</span>
  8581.   <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>
  8582.   <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>
  8583. <span class='kw'>end</span></pre>
  8584.     </td>
  8585.   </tr>
  8586. </table>
  8587. </div>
  8588.     
  8589.   </div>
  8590.  
  8591. </div>
  8592.  
  8593.     <div id="footer">
  8594.   Generated on Mon Oct 12 22:20:47 2015 by
  8595.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  8596.   0.8.7.6 (ruby-2.2.3).
  8597. </div>
  8598.  
  8599.   </body>
  8600. </html>
# Change User Description Committed
#11 16275 Doug Scheirer Merge from main 9 years ago
#10 16196 Doug Scheirer Merge from main 9 years ago
#9 16148 Doug Scheirer Merge from main 9 years ago
#8 16114 Doug Scheirer Merge from main 9 years ago
#7 16079 Doug Scheirer Merge from main 9 years ago
#6 16014 Doug Scheirer Merge down from main 9 years ago
#5 15884 Doug Scheirer Merge from main 9 years ago
#4 15868 Doug Scheirer Merge from main 9 years ago
#3 15845 Doug Scheirer Integ from main 9 years ago
#2 15715 Doug Scheirer merge changes from main 10 years ago
#1 15688 Doug Scheirer 10 years ago
//guest/perforce_software/helix-web-services/main/build/doc/helix_web_services_client_ruby/HelixWebServicesClient.html
#33 15676 tjuricek HWS/NOARCH/2015.1.main/201509092205 10 years ago
#32 15589 tjuricek Update path to test output and update docs. 10 years ago
#31 15542 tjuricek 10 years ago
#30 15517 tjuricek Do not require changelist ID for submitting Helix Sync pending changelists. 10 years ago
#29 15499 tjuricek Naive implementation of helix sync project submit for "helix versioning engine projects". 10 years ago
#28 15487 tjuricek Add basic ability to create pending changelists for helix sync projects. 10 years ago
#27 15479 tjuricek Added a basic "HVE project" implementation for creating clients. 10 years ago
#26 15447 tjuricek 10 years ago
#25 15240 tjuricek 10 years ago
#24 15228 tjuricek Revise triggers implementation, tests, and documentation. 10 years ago
#23 15227 tjuricek 10 years ago
#22 15225 tjuricek 10 years ago
#21 15222 tjuricek 10 years ago
#20 15211 tjuricek Implement tests and documentation for label spec management. 10 years ago
#19 15210 tjuricek Implement tests and documentation for job spec management. 10 years ago
#18 15209 tjuricek Implement tests and documentation for group spec management. 10 years ago
#17 15208 tjuricek 10 years ago
#16 15205 tjuricek Implemented tests and documentation for depot spec editing. 10 years ago
#15 15189 tjuricek Update files implementation, testing, and documentation. 10 years ago
#14 15185 tjuricek Update user spec management implementation, tests, and documentation. 10 years ago
#13 15144 tjuricek 10 years ago
#12 15132 tjuricek Provde a basic submit -e mechanism on classic perforce workspaces. 10 years ago
#11 15110 tjuricek 10 years ago
#10 15099 tjuricek Revise project services to be our simple 'container' for other systems. 10 years ago
#9 15098 tjuricek 10 years ago
#8 15090 tjuricek 10 years ago
#7 15078 tjuricek clients spec method revisions

Updated some other documentation. 		10 years ago
#6 15077 tjuricek 10 years ago
#5 15073 tjuricek Update Auth::Middleware and add spec 10 years ago
#4 15053 tjuricek 10 years ago
#3 15038 tjuricek Document 'login' auth method and client programming overview. 10 years ago
#2 15032 tjuricek 10 years ago
#1 14049 tjuricek 10 years ago