updated documentation

CHANGELOG.md

@@ -2,11 +2,16 @@
 
 All changes to the gem are documented here.
 
+## [1.1.0] - 2020-05-28
+
+ - Introducing new API documentation from Czech Post
+ - Added service `ParcelSyncSender` service which uses newly discovered `parcelsServiceSync` API endpoint
+ - Renamed `ParcelSender` to `ParcelAsyncSender` . And created deprecating clone `ParcelSender`, so no Breaking change! If You usit it calls `ParcelAsyncSender` and displays deprecation message.
 
 ## [1.0.3] - 2020-05-20
 
  - Added Czech Post service  DiscountForOnlinePosting.
- - **Breaking**: Renamed Post service size classes `CzechPostB2bClient::PostServices::Size???` to `CzechPostB2bClient::PostServices::ParcelSize???` (eg. : `CzechPostB2bClient::PostServices::ParcelSizeXL`)
+ - **Breaking**: Renamed Post service "Size" classes `CzechPostB2bClient::PostServices::Size???` to `CzechPostB2bClient::PostServices::ParcelSize???` (eg. : `CzechPostB2bClient::PostServices::ParcelSizeXL`)
   I know, that I have **breaking** in every new version, I hope You are not fast enough.
 
 ## [1.0.2] - 2020-05-08

doc/CzechPostB2bClient.html

@@ -6,15 +6,15 @@
 <title>
   Module: CzechPostB2bClient
 
-    &mdash; Documentation by YARD 0.9.19
+    &mdash; Documentation by YARD 0.9.24
 
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "CzechPostB2bClient";
   relpath = '';
 </script>
@@ -79,7 +79,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/czech_post_b2b_client/b2b_errors.rb<span class="defines">,<br />
-  lib/czech_post_b2b_client.rb,<br /> lib/czech_post_b2b_client/version.rb,<br /> lib/czech_post_b2b_client/configuration.rb,<br /> lib/czech_post_b2b_client/response_codes.rb,<br /> lib/czech_post_b2b_client/printing_templates.rb,<br /> lib/czech_post_b2b_client/services/api_caller.rb,<br /> lib/czech_post_b2b_client/services/communicator.rb,<br /> lib/czech_post_b2b_client/services/orchestrator.rb,<br /> lib/czech_post_b2b_client/services/parcels_sender.rb,<br /> lib/czech_post_b2b_client/response_parsers/base_parser.rb,<br /> lib/czech_post_b2b_client/request_builders/base_builder.rb,<br /> lib/czech_post_b2b_client/services/delivering_inspector.rb,<br /> lib/czech_post_b2b_client/response_parsers/get_stats_parser.rb,<br /> lib/czech_post_b2b_client/services/address_sheets_generator.rb,<br /> lib/czech_post_b2b_client/request_builders/get_stats_builder.rb,<br /> lib/czech_post_b2b_client/services/parcels_submission_closer.rb,<br /> lib/czech_post_b2b_client/services/time_period_statisticator.rb,<br /> lib/czech_post_b2b_client/response_parsers/send_parcels_parser.rb,<br /> lib/czech_post_b2b_client/request_builders/send_parcels_builder.rb,<br /> lib/czech_post_b2b_client/services/parcels_send_process_updater.rb,<br /> lib/czech_post_b2b_client/response_parsers/get_parcel_state_parser.rb,<br /> lib/czech_post_b2b_client/request_builders/get_parcel_state_builder.rb,<br /> lib/czech_post_b2b_client/response_parsers/get_result_parcels_parser.rb,<br /> lib/czech_post_b2b_client/request_builders/get_result_parcels_builder.rb,<br /> lib/czech_post_b2b_client/response_parsers/get_parcels_printing_parser.rb,<br /> lib/czech_post_b2b_client/request_builders/get_parcels_printing_builder.rb</span>
+  lib/czech_post_b2b_client.rb,<br /> lib/czech_post_b2b_client/version.rb,<br /> lib/czech_post_b2b_client/configuration.rb,<br /> lib/czech_post_b2b_client/post_services.rb,<br /> lib/czech_post_b2b_client/response_codes.rb,<br /> lib/czech_post_b2b_client/printing_templates.rb,<br /> lib/czech_post_b2b_client/services/api_caller.rb,<br /> lib/czech_post_b2b_client/services/communicator.rb,<br /> lib/czech_post_b2b_client/services/orchestrator.rb,<br /> lib/czech_post_b2b_client/services/parcels_sender.rb,<br /> lib/czech_post_b2b_client/services/xsds_downloader.rb,<br /> lib/czech_post_b2b_client/response_parsers/base_parser.rb,<br /> lib/czech_post_b2b_client/services/parcels_sync_sender.rb,<br /> lib/czech_post_b2b_client/request_builders/base_builder.rb,<br /> lib/czech_post_b2b_client/services/delivering_inspector.rb,<br /> lib/czech_post_b2b_client/services/parcels_async_sender.rb,<br /> lib/czech_post_b2b_client/response_parsers/get_stats_parser.rb,<br /> lib/czech_post_b2b_client/services/address_sheets_generator.rb,<br /> lib/czech_post_b2b_client/request_builders/get_stats_builder.rb,<br /> lib/czech_post_b2b_client/services/parcels_submission_closer.rb,<br /> lib/czech_post_b2b_client/services/time_period_statisticator.rb,<br /> lib/czech_post_b2b_client/response_parsers/send_parcels_parser.rb,<br /> lib/czech_post_b2b_client/request_builders/send_parcels_builder.rb,<br /> lib/czech_post_b2b_client/services/parcels_send_process_updater.rb,<br /> lib/czech_post_b2b_client/response_parsers/get_parcel_state_parser.rb,<br /> lib/czech_post_b2b_client/request_builders/get_parcel_state_builder.rb,<br /> lib/czech_post_b2b_client/response_parsers/get_result_parcels_parser.rb,<br /> lib/czech_post_b2b_client/request_builders/get_result_parcels_builder.rb,<br /> lib/czech_post_b2b_client/response_parsers/parcel_service_sync_parser.rb,<br /> lib/czech_post_b2b_client/request_builders/parcel_service_sync_builder.rb,<br /> lib/czech_post_b2b_client/response_parsers/get_parcels_printing_parser.rb,<br /> lib/czech_post_b2b_client/request_builders/get_parcels_printing_builder.rb</span>
 </dd>
   </dl>
 
@@ -88,11 +88,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
 
-<p>Available printing templates, which can be used in AdressSheetsGenerator
-`<a href=":template_id">options</a>`</p>
-
-<p>Do not miss `CzechPostB2bClient::PrintingTemplate.all_template_classes`
-method, it has to be at end of module to work properly</p>
+<p>rubocop:disable Layout/LineLength</p>
 
 
   </div>
@@ -104,7 +100,7 @@ <h2>Overview</h2><div class="docstring">
 <p class="children">
 
 
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="CzechPostB2bClient/B2BErrors.html" title="CzechPostB2bClient::B2BErrors (module)">B2BErrors</a></span>, <span class='object_link'><a href="CzechPostB2bClient/PrintingTemplates.html" title="CzechPostB2bClient::PrintingTemplates (module)">PrintingTemplates</a></span>, <span class='object_link'><a href="CzechPostB2bClient/RequestBuilders.html" title="CzechPostB2bClient::RequestBuilders (module)">RequestBuilders</a></span>, <span class='object_link'><a href="CzechPostB2bClient/ResponseCodes.html" title="CzechPostB2bClient::ResponseCodes (module)">ResponseCodes</a></span>, <span class='object_link'><a href="CzechPostB2bClient/ResponseParsers.html" title="CzechPostB2bClient::ResponseParsers (module)">ResponseParsers</a></span>, <span class='object_link'><a href="CzechPostB2bClient/Services.html" title="CzechPostB2bClient::Services (module)">Services</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="CzechPostB2bClient/B2BErrors.html" title="CzechPostB2bClient::B2BErrors (module)">B2BErrors</a></span>, <span class='object_link'><a href="CzechPostB2bClient/PostServices.html" title="CzechPostB2bClient::PostServices (module)">PostServices</a></span>, <span class='object_link'><a href="CzechPostB2bClient/PrintingTemplates.html" title="CzechPostB2bClient::PrintingTemplates (module)">PrintingTemplates</a></span>, <span class='object_link'><a href="CzechPostB2bClient/RequestBuilders.html" title="CzechPostB2bClient::RequestBuilders (module)">RequestBuilders</a></span>, <span class='object_link'><a href="CzechPostB2bClient/ResponseCodes.html" title="CzechPostB2bClient::ResponseCodes (module)">ResponseCodes</a></span>, <span class='object_link'><a href="CzechPostB2bClient/ResponseParsers.html" title="CzechPostB2bClient::ResponseParsers (module)">ResponseParsers</a></span>, <span class='object_link'><a href="CzechPostB2bClient/Services.html" title="CzechPostB2bClient::Services (module)">Services</a></span>
 
 
 
@@ -124,7 +120,7 @@ <h2>
         <dt id="VERSION-constant" class="">VERSION =
 
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.0.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.1.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
 
     </dl>
 
@@ -284,7 +280,7 @@ <h3 class="signature first" id="configuration-class_method">
 </h3><div class="docstring">
   <div class="discussion">
 
-<p>Returns the value of attribute configuration</p>
+<p>Returns the value of attribute configuration.</p>
 
 
   </div>
@@ -298,12 +294,12 @@ <h3 class="signature first" id="configuration-class_method">
       <pre class="lines">
 
 
-18
-19
-20</pre>
+20
+21
+22</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client.rb', line 18</span>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client.rb', line 20</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_configuration'>configuration</span>
   <span class='ivar'>@configuration</span>
@@ -335,12 +331,12 @@ <h3 class="signature first" id="certs_path-class_method">
       <pre class="lines">
 
 
-34
-35
-36</pre>
+36
+37
+38</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client.rb', line 34</span>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client.rb', line 36</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_certs_path'>certs_path</span>
   <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="" title="CzechPostB2bClient (module)">CzechPostB2bClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_root'><span class='object_link'><a href="#root-class_method" title="CzechPostB2bClient.root (method)">root</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>certs</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
@@ -387,13 +383,13 @@ <h3 class="signature " id="configure-class_method">
       <pre class="lines">
 
 
-21
-22
 23
-24</pre>
+24
+25
+26</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client.rb', line 21</span>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client.rb', line 23</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span>
   <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configuration'>configuration</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="CzechPostB2bClient/Configuration.html" title="CzechPostB2bClient::Configuration (class)">Configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="CzechPostB2bClient/Configuration.html#initialize-instance_method" title="CzechPostB2bClient::Configuration#initialize (method)">new</a></span></span>
@@ -419,12 +415,12 @@ <h3 class="signature " id="logger-class_method">
       <pre class="lines">
 
 
-26
-27
-28</pre>
+28
+29
+30</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client.rb', line 26</span>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client.rb', line 28</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span>
   <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span>
@@ -449,12 +445,12 @@ <h3 class="signature " id="root-class_method">
       <pre class="lines">
 
 
-30
-31
-32</pre>
+32
+33
+34</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client.rb', line 30</span>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client.rb', line 32</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_root'><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">root</a></span></span>
   <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span> <span class='id identifier rubyid___dir__'>__dir__</span>
@@ -469,9 +465,9 @@ <h3 class="signature " id="root-class_method">
 </div>
 
       <div id="footer">
-  Generated on Fri Mar 20 17:49:05 2020 by
+  Generated on Thu May 28 17:06:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.19 (ruby-2.4.1).
+  0.9.24 (ruby-2.4.1).
 </div>
 
     </div>

doc/CzechPostB2bClient/B2BErrors.html

@@ -6,15 +6,15 @@
 <title>
   Module: CzechPostB2bClient::B2BErrors
 
-    &mdash; Documentation by YARD 0.9.19
+    &mdash; Documentation by YARD 0.9.24
 
 </title>
 
-  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "CzechPostB2bClient::B2BErrors";
   relpath = '../';
 </script>
@@ -125,7 +125,9 @@ <h2>
 
 
 
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>have t be at end of file, to collect all classes defined before.</p>
+</div></span>
 
 </li>
 
@@ -170,20 +172,31 @@ <h3 class="signature first" id="all_error_classes-class_method">
 
 
 
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+
+<p>have t be at end of file, to collect all classes defined before</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-92
 93
-94</pre>
+94
+95</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/b2b_errors.rb', line 92</span>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/b2b_errors.rb', line 93</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_all_error_classes'>all_error_classes</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_all_error_classes'>all_error_classes</span>
   <span class='const'>ObjectSpace</span><span class='period'>.</span><span class='id identifier rubyid_each_object'>each_object</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../CzechPostB2bClient.html" title="CzechPostB2bClient (module)">CzechPostB2bClient</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="CzechPostB2bClient::B2BErrors (module)">B2BErrors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="B2BErrors/BaseError.html" title="CzechPostB2bClient::B2BErrors::BaseError (class)">BaseError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_singleton_class'>singleton_class</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -216,7 +229,7 @@ <h3 class="signature " id="new_by_code-class_method">
     <td>
       <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/b2b_errors.rb', line 97</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_new_by_code'>new_by_code</span><span class='lparen'>(</span><span class='id identifier rubyid_code'>code</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new_by_code'>new_by_code</span><span class='lparen'>(</span><span class='id identifier rubyid_code'>code</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_klass'>klass</span> <span class='op'>=</span> <span class='id identifier rubyid_all_error_classes'>all_error_classes</span><span class='period'>.</span><span class='id identifier rubyid_detect'>detect</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='op'>|</span> <span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='id identifier rubyid_code'>code</span> <span class='rbrace'>}</span>
   <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>B2BError with code: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_code'>code</span><span class='embexpr_end'>}</span><span class='tstring_content'> is unknown!</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_klass'>klass</span>
 
@@ -232,9 +245,9 @@ <h3 class="signature " id="new_by_code-class_method">
 </div>
 
       <div id="footer">
-  Generated on Fri Mar 20 17:49:05 2020 by
+  Generated on Thu May 28 17:06:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.19 (ruby-2.4.1).
+  0.9.24 (ruby-2.4.1).
 </div>
 
     </div>