RubyGems - czech_post_b2b_client - Versions diffs - 1.0.0 - Mend

czech_post_b2b_client 1.0.0

Files changed (397) hide show

data/doc/CzechPostB2bClient/Configuration.html ADDED

@@ -0,0 +1,1005 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: CzechPostB2bClient::Configuration
+    &mdash; Documentation by YARD 0.9.19
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "CzechPostB2bClient::Configuration";
+  relpath = '../';
+</script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="../_index.html">Index (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../CzechPostB2bClient.html" title="CzechPostB2bClient (module)">CzechPostB2bClient</a></span></span>
+     &raquo;
+    <span class="title">Configuration</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Class: CzechPostB2bClient::Configuration
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">CzechPostB2bClient::Configuration</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/czech_post_b2b_client/configuration.rb</dd>
+  </dl>
+</div>
+  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#b2b_api_base_uri-instance_method" title="#b2b_api_base_uri (instance method)">#<strong>b2b_api_base_uri</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute b2b_api_base_uri.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#certificate_path-instance_method" title="#certificate_path (instance method)">#<strong>certificate_path</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute certificate_path.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#contract_id-instance_method" title="#contract_id (instance method)">#<strong>contract_id</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute contract_id.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#customer_id-instance_method" title="#customer_id (instance method)">#<strong>customer_id</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute customer_id.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#language-instance_method" title="#language (instance method)">#<strong>language</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute language.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#logger-instance_method" title="#logger (instance method)">#<strong>logger</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute logger.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#namespaces-instance_method" title="#namespaces (instance method)">#<strong>namespaces</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute namespaces.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#private_key_password-instance_method" title="#private_key_password (instance method)">#<strong>private_key_password</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute private_key_password.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#private_key_path-instance_method" title="#private_key_path (instance method)">#<strong>private_key_path</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute private_key_path.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#sending_post_office_code-instance_method" title="#sending_post_office_code (instance method)">#<strong>sending_post_office_code</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute sending_post_office_code.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#sending_post_office_location_number-instance_method" title="#sending_post_office_location_number (instance method)">#<strong>sending_post_office_location_number</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute sending_post_office_location_number.</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>  &#x21d2; Configuration </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of Configuration.</p>
+</div></span>
+</li>
+    </ul>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    #<strong>initialize</strong>  &#x21d2; <tt><span class='object_link'><a href="" title="CzechPostB2bClient::Configuration (class)">Configuration</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a new instance of Configuration</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/configuration.rb', line 19</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
+  <span class='comment'># set defaults here
+</span>
+  <span class='comment'># ours, accessible, but maybe oout of date
+</span>  <span class='ivar'>@namespaces</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>xmlns</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://raw.githubusercontent.com/foton/czech_post_b2b_client/master/doc/20181023/B2BCommon-v1.1.xsd</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'>xmlns:ns2</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://raw.githubusercontent.com/foton/czech_post_b2b_client/master/doc/20181023/B2B-POLServices-v1.6.xsd</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
+  <span class='comment'># original, not functioning
+</span>  <span class='ivar'>@namespaces</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>xmlns</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://b2b.postaonline.cz/schema/B2BCommon-v1</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'>xmlns:ns2</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://b2b.postaonline.cz/schema/POLServices-v1</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
+  <span class='ivar'>@language</span> <span class='op'>=</span> <span class='symbol'>:cs</span>
+  <span class='ivar'>@logger</span> <span class='op'>=</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='const'>Rails</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='op'>::</span><span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span> <span class='op'>:</span> <span class='op'>::</span><span class='const'>Logger</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>STDOUT</span><span class='rparen'>)</span>
+  <span class='ivar'>@b2b_api_base_uri</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://b2b.postaonline.cz/services/POLService/v1</span><span class='tstring_end'>&#39;</span></span>
+  <span class='ivar'>@sending_post_office_location_number</span> <span class='op'>=</span> <span class='int'>1</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id="b2b_api_base_uri=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="b2b_api_base_uri-instance_method">
+    #<strong>b2b_api_base_uri</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute b2b_api_base_uri</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/configuration.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_b2b_api_base_uri'>b2b_api_base_uri</span>
+  <span class='ivar'>@b2b_api_base_uri</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="certificate_path=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="certificate_path-instance_method">
+    #<strong>certificate_path</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute certificate_path</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/configuration.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_certificate_path'>certificate_path</span>
+  <span class='ivar'>@certificate_path</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="contract_id=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="contract_id-instance_method">
+    #<strong>contract_id</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute contract_id</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/configuration.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_contract_id'>contract_id</span>
+  <span class='ivar'>@contract_id</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="customer_id=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="customer_id-instance_method">
+    #<strong>customer_id</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute customer_id</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/configuration.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_customer_id'>customer_id</span>
+  <span class='ivar'>@customer_id</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="language=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="language-instance_method">
+    #<strong>language</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute language</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/configuration.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_language'>language</span>
+  <span class='ivar'>@language</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="logger=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="logger-instance_method">
+    #<strong>logger</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute logger</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/configuration.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_logger'>logger</span>
+  <span class='ivar'>@logger</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="namespaces=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="namespaces-instance_method">
+    #<strong>namespaces</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute namespaces</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/configuration.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_namespaces'>namespaces</span>
+  <span class='ivar'>@namespaces</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="private_key_password=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="private_key_password-instance_method">
+    #<strong>private_key_password</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute private_key_password</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/configuration.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_private_key_password'>private_key_password</span>
+  <span class='ivar'>@private_key_password</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="private_key_path=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="private_key_path-instance_method">
+    #<strong>private_key_path</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute private_key_path</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/configuration.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_private_key_path'>private_key_path</span>
+  <span class='ivar'>@private_key_path</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="sending_post_office_code=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="sending_post_office_code-instance_method">
+    #<strong>sending_post_office_code</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute sending_post_office_code</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/configuration.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_sending_post_office_code'>sending_post_office_code</span>
+  <span class='ivar'>@sending_post_office_code</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="sending_post_office_location_number=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="sending_post_office_location_number-instance_method">
+    #<strong>sending_post_office_location_number</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute sending_post_office_location_number</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/configuration.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_sending_post_office_location_number'>sending_post_office_location_number</span>
+  <span class='ivar'>@sending_post_office_location_number</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Fri Mar 20 17:49:05 2020 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.19 (ruby-2.4.1).
+</div>
+    </div>
+  </body>
+</html>