RubyGems - czech_post_b2b_client - Versions diffs - 1.0.2 → 1.2.3 - Mend

czech_post_b2b_client 1.0.2 → 1.2.3

Files changed (478) hide show

@@ -4,9 +4,9 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta charset="utf-8" />
-      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
-      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />

data/doc/frames.html CHANGED

@@ -2,9 +2,9 @@
 <html>
 <head>
   <meta charset="utf-8">
-	<title>Documentation by YARD 0.9.19</title>
+	<title>Documentation by YARD 0.9.24</title>
 </head>
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   var match = unescape(window.location.hash).match(/^#!(.+)/);
   var name = match ? match[1] : 'index.html';
   name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');

data/doc/index.html CHANGED

@@ -6,15 +6,15 @@
 <title>
   File: README
-    &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 = "README";
   relpath = '';
 </script>
@@ -57,39 +57,51 @@
         <div class="clear"></div>
       </div>
-      <div id="content"><div id='filecontents'><h1 id="czechpostb2bclient">CzechPostB2bClient</h1>
-<p>Accessing B2B API of Czech Post for bulk processing of parcels (“B2B - WS PodáníOnline”).</p>
+      <div id="content"><div id='filecontents'><h1>CzechPostB2bClient</h1>
-<p>There are these supported operations of API:
-- <em>sendParcels</em> - stores data of parcels for async processing [HTTP POST - async response]
-- <em>getResultParcels</em> - return results of such processing [HTTP GET - sync response]
-- <em>getStats</em> - returns statistics of parcels sent in time period [HTTP GET - sync response]
-- <em>getParcelState</em> - returns all known states for listed parcels [HTTP GET - sync response]
-- <em>getParcelsPrinting</em> - returns PDF with address labels/stickers for listed parcels [HTTP GET - sync response]</p>
+<p>Accessing B2B API of Czech Post for bulk processing of parcels (&quot;B2B - WS PodáníOnline&quot;).</p>
-<h2 id="installation">Installation</h2>
-<p>### 1) Registration at Czech Post (CP)
-The longterm and hardest part.
-- Connect Czech Post representative and make a contract with them.
-- Ask them for ALL documentation!(I have to ask 3 times to collect enough of it). They like to put files into DOCX file, so click on file icons!
-- You have to obtain “komerční certifikát PostSignum”.</p>
+<p>There are these supported operations of API:</p>
-<p>Instructions (in czech) are in <a href="./documents/Postup_pro_zavedení_API_služeb_České_pošty.docx"><code>documents/Postup_pro_zavedení_API_služeb_České_pošty.docx</code></a></p>
+<ul>
+<li><em>parcelServiceSync</em> - stores data of one parcel and return package_code and optional PDF adress sheet [HTTP POST - sync response]
+                    Seems to me, that there are is no place extensive Cash On Delivery data, just <code>amount</code> and <code>currency</code></li>
+<li><em>sendParcels</em> - stores data of parcels for async processing [HTTP POST - async response]</li>
+<li><em>getResultParcels</em> - return results of such processing [HTTP GET - sync response]</li>
+<li><em>getStats</em> - returns statistics of parcels sent in time period [HTTP GET - sync response]</li>
+<li><em>getParcelState</em> - returns all known states for listed parcels [HTTP GET - sync response]</li>
+<li><em>getParcelsPrinting</em> - returns PDF with address labels/stickers for listed parcels [HTTP GET - sync response]</li>
+</ul>
+<h2>Installation</h2>
+<h3>1) Registration at Czech Post (CP)</h3>
+<p>The longterm and hardest part.</p>
+<ul>
+<li>Connect Czech Post representative and make a contract with them.</li>
+<li>Ask them for ALL documentation!(I have to ask 3 times to collect enough of it). They like to put files into DOCX file, so click on file icons!</li>
+<li>You have to obtain &quot;komerční certifikát PostSignum&quot;.</li>
+</ul>
+<p>Instructions (in czech) are in <a href="./documents/Postup_pro_zaveden%C3%AD_API_slu%C5%BEeb_%C4%8Cesk%C3%A9_po%C5%A1ty.docx"><code>documents/Postup_pro_zavedení_API_služeb_České_pošty.docx</code></a></p>
+<h3>2) Preparations on PodaniOnline app</h3>
-<h3 id="preparations-on-podanionline-app">2) Preparations on PodaniOnline app</h3>
 <p>1) Sign in to <a href="https://www.postaonline.cz/rap/prihlaseni">PostaOnline</a>
-2) Go to <a href="https://www.postaonline.cz/klientskazona?p_p_id=clientzone_WAR_clientZoneportlet&amp;p_p_lifecycle=0&amp;_clientzone_WAR_clientZoneportlet_action=showPol&amp;_clientzone_WAR_clientZoneportlet_implicitModel=true">“Podání Online”</a>
+2) Go to <a href="https://www.postaonline.cz/klientskazona?p_p_id=clientzone_WAR_clientZoneportlet&p_p_lifecycle=0&_clientzone_WAR_clientZoneportlet_action=showPol&_clientzone_WAR_clientZoneportlet_implicitModel=true">&quot;Podání Online&quot;</a>
 3) When You are in, select tab <strong>Nastavení</strong> and menu <strong>Podací místa</strong>
-4) Add <em>Podací místo</em> and write down it’s ID (will be used in <code>sending_post_office_location_number</code>)
+4) Add <em>Podací místo</em> and write down it&#39;s ID (will be used in <code>sending_post_office_location_number</code>)
 5) Switch tab to <strong>Zásilky</strong> and go to menu <strong>Zásilky =&gt; Přednastavení údajů</strong>
 6) Write down value(s) in <em>Výběr technologického čísla</em> (it will be used as <code>customer_id</code>).</p>
-<h3 id="gem-installation">3) Gem installation</h3>
-<p>Add this line to your application’s Gemfile:</p>
+<h3>3) Gem installation</h3>
-<p><code>ruby
-gem 'czech_post_b2b_client'
-</code></p>
+<p>Add this line to your application&#39;s Gemfile:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>czech_post_b2b_client</span><span class='tstring_end'>&#39;</span></span>
+</code></pre>
 <p>And then execute:</p>
@@ -101,63 +113,65 @@ gem 'czech_post_b2b_client'
 <pre class="code ruby"><code class="ruby">$ gem install czech_post_b2b_client
 </code></pre>
-<h3 id="setting-up-gem">4) Setting up gem</h3>
-<p>Set up your <code>contract_id</code>, <code>customer_id</code> (both from CP signed contract), <code>certificate_path</code>, <code>private_key_path</code> and <code>private_key_password</code> in configuration:
-   ```
-    CzechPostB2bClient.configure do |config|
-      config.contract_id = ‘contract_id’
-      config.customer_id = ‘customer_id’
-      config.certificate_path = ‘full_path/to/your/postsignum_certificate.pem’
-      config.private_key_path = ‘full_path/to/your/postsignum_private.key’
-      config.private_key_password = ‘your_password or nil’</p>
-<pre class="code ruby"><code class="ruby">  # this actually do not work, I have to use `sending_post_office_location_number`. But it is REQUIRED!
-  config.sending_post_office_code = 12_345 # PSC of post office where parcels will be physically delivered and submitted
-  # and You can override defaults
-  # config.sending_post_office_location_number =&gt; 1
-  # config.namespaces #XML namespaces
-  # config.language =&gt; :cs # other languages are not supported now
-  # config.logger =&gt; ::Rails.logger or ::Logger.new(STDOUT),
-  # config.b2b_api_base_uri =&gt; &#39;https://b2b.postaonline.cz/services/POLService/v1&#39;
-end    ```
+<h3>4) Setting up gem</h3>
+<p>Set up your <code>contract_id</code>, <code>customer_id</code> (both from CP signed contract), <code>certificate_path</code>, <code>private_key_path</code> and <code>private_key_password</code> in configuration:</p>
+<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="CzechPostB2bClient.html" title="CzechPostB2bClient (module)">CzechPostB2bClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="CzechPostB2bClient.html#configure-class_method" title="CzechPostB2bClient.configure (method)">configure</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_contract_id'>contract_id</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>contract_id</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_customer_id'>customer_id</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>customer_id</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_certificate_path'>certificate_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>full_path/to/your/postsignum_certificate.pem</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_private_key_path'>private_key_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>full_path/to/your/postsignum_private.key</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_private_key_password'>private_key_password</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>your_password or nil</span><span class='tstring_end'>&#39;</span></span>
+  <span class='comment'># this actually do not work, I have to use `sending_post_office_location_number`. But it is REQUIRED!
+</span>  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_sending_post_office_code'>sending_post_office_code</span> <span class='op'>=</span> <span class='int'>12_345</span> <span class='comment'># PSC of post office where parcels will be physically delivered and submitted
+</span>
+  <span class='comment'># and You can override defaults
+</span>  <span class='comment'># config.sending_post_office_location_number =&gt; 1
+</span>  <span class='comment'># config.namespaces #XML namespaces
+</span>  <span class='comment'># config.language =&gt; :cs # other languages are not supported now
+</span>  <span class='comment'># config.logger =&gt; ::Rails.logger or ::Logger.new(STDOUT),
+</span>  <span class='comment'># config.b2b_api_base_uri =&gt; &#39;https://b2b.postaonline.cz/services/POLService/v1&#39;
+</span><span class='kw'>end</span>
 </code></pre>
 <ul>
-  <li><code>contract_id</code> is <em>“ID CČK”</em> (can be found in contract; eg.: <em>“2511327004”</em>)</li>
-  <li><code>customer_id</code> is <em>“Technologické číslo”</em> (can be found in contract; eg.: <em>“U123”</em> or <em>“L03022”</em>; also is visible at <a href="https://www.postaonline.cz/podanionline/PrednastaveniUdajuZasilky.action">PodaníOnline</a></li>
+<li><code>contract_id</code> is <em>&quot;ID CČK&quot;</em> (can be found in contract; eg.: <em>&quot;2511327004&quot;</em>)</li>
+<li><code>customer_id</code> is <em>&quot;Technologické číslo&quot;</em> (can be found in contract; eg.: <em>&quot;U123&quot;</em> or <em>&quot;L03022&quot;</em>; also is visible at <a href="https://www.postaonline.cz/podanionline/PrednastaveniUdajuZasilky.action">PodaníOnline</a></li>
 </ul>
 <p>Because PostSignum Certificate Authority is not trusted by default, correct certificate chain is in <code>certs/</code> folder. If You have problem with them, create a issue here. Maybe they are outdated now.</p>
-<h2 id="usage">Usage</h2>
-<p><strong>You have to know which parcel type (according to CP) you sending!</strong> Eg. ‘BA’ or ‘RR’. See <a href="./documents/parcel_types.md"><code>documents/parcel_types.md</code></a>.</p>
+<h2>Usage</h2>
+<p><strong>You have to know which parcel type (according to CP) you sending!</strong> Eg. &#39;BA&#39; or &#39;RR&#39;. See <a href="./documents/parcel_types.md"><code>documents/parcel_types.md</code></a>.</p>
 <p><strong>And what services You will use for each parcel</strong>, see <a href="./documents/services_list.md"><code>documents/services_list.md</code></a> and <a href="./documents/parcels_type_and_services_restrictions.md"><code>documents/parcels_type_and_services_restrictions.md</code></a>.</p>
-<p>Hashes used is service calls bellow:
-  ```
-    short_sender_data = { address: {
-                            company_name: ‘Oriflame’,
-                            addition_to_name: ‘perfume’, # optional
-                            street: ‘V olšinách’,
-                            house_number: ‘16’,
-                            city_part: ‘Strašnice’,
-                            city: ‘Praha’,
-                            post_code: 10_000,
-                          },
-                          mobile_phone: ‘+420777888999’,
-                          email: ‘rehor.jan@cpost.cz’ }
-    sending_data = { contract_id: configuration.contract_id,
-                     parcels_sending_date: Date.today,
-                     sending_post_office_location_number: 1,
-                     sender: short_sender_data,
-                     cash_on_delivery: {
-                       address: short_sender_data[:address]
-                       bank_account: ‘123456-1234567890/1234’
-                     } }</p>
-<pre class="code ruby"><code class="ruby">short_addressee_data = { address: {
+<p>Hashes used is service calls bellow:</p>
+<pre class="code ruby"><code class="ruby">short_sender_data = { address: {
+                        company_name: &#39;Oriflame&#39;,
+                        addition_to_name: &#39;perfume&#39;, # optional
+                        street: &#39;V olšinách&#39;,
+                        house_number: &#39;16&#39;,
+                        city_part: &#39;Strašnice&#39;,
+                        city: &#39;Praha&#39;,
+                        post_code: 10_000,
+                      },
+                      mobile_phone: &#39;+420777888999&#39;,
+                      email: &#39;rehor.jan@cpost.cz&#39; }
+sending_data = { contract_id: configuration.contract_id,
+                  parcels_sending_date: Date.today,
+                  sending_post_office_location_number: 1,
+                  sender: short_sender_data,
+                  cash_on_delivery: {
+                    address: short_sender_data[:address]
+                    bank_account: &#39;123456-1234567890/1234&#39;
+                  } }
+short_addressee_data = { address: {
                           first_name: &#39;Petr&#39;,
                           last_name: &#39;Foton&#39;,
                           street: &#39;Fischerova&#39;,
@@ -196,160 +210,171 @@ parcels = [
               weight_in_kg: 1.9 },
     services: [7,&#39;M&#39;]
   }
-] ```
+]
+</code></pre>
+<p>1 ) Pack your parcel(s)</p>
+<p>2 ) If you have many parcels and treats them as bulk, use ASYNC registration process (steps 3a - 7a)[15 000 calls per day allowed]. If You want to register parcel and get  parcel_code and address sheet immediatelly (3 sec), use SYNC process (step 3b)[1 000 calls per day allowed]</p>
+<p>3a) Call <code>ParcelsAsyncSender</code>, this will setup <code>transmission_id</code> and expected time to ask for results.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_psender'>psender</span> <span class='op'>=</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="CzechPostB2bClient/Services.html" title="CzechPostB2bClient::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="CzechPostB2bClient/Services/ParcelsAsyncSender.html" title="CzechPostB2bClient::Services::ParcelsAsyncSender (class)">ParcelsAsyncSender</a></span></span><span class='period'>.</span><span class='id identifier rubyid_call'><span class='object_link'><a href="SteppedService/Base.html#call-class_method" title="SteppedService::Base.call (method)">call</a></span></span><span class='lparen'>(</span><span class='label'>sending_data:</span> <span class='id identifier rubyid_sending_data'>sending_data</span><span class='comma'>,</span> <span class='label'>parcels:</span> <span class='id identifier rubyid_parcels'>parcels</span><span class='rparen'>)</span>
+<span class='kw'>if</span> <span class='id identifier rubyid_psender'>psender</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
+  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_psender'>psender</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
+  <span class='id identifier rubyid_processing_end_time_utc'>processing_end_time_utc</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_processing_end_expected_at'>processing_end_expected_at</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='int'>60</span> <span class='op'>*</span><span class='int'>60</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_utc'>utc</span> <span class='comment'># API returns time in CET but marked as UTC
+</span>  <span class='id identifier rubyid_transaction_id'>transaction_id</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_transaction_id'>transaction_id</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_psender'>psender</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_full_messages'>full_messages</span>
+<span class='kw'>end</span>
+</code></pre>
+<p>For now, <code>parcels</code> is array of complicated hashes; each parcel must have <code>parcel_id</code> key (your ID of parcel).</p>
+<p>4a) When such expected time pass, ask for results by calling <code>ParcelsSendProcessUpdater</code>. You can get error <code>Processing is not yet finished</code> or hash based on <code>parcel_id</code> keys.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_pudater'>pudater</span> <span class='op'>=</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="CzechPostB2bClient/Services.html" title="CzechPostB2bClient::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="CzechPostB2bClient/Services/ParcelsSendProcessUpdater.html" title="CzechPostB2bClient::Services::ParcelsSendProcessUpdater (class)">ParcelsSendProcessUpdater</a></span></span><span class='period'>.</span><span class='id identifier rubyid_call'><span class='object_link'><a href="SteppedService/Base.html#call-class_method" title="SteppedService::Base.call (method)">call</a></span></span><span class='lparen'>(</span><span class='label'>transmission_id:</span> <span class='id identifier rubyid_transmission_id'>transmission_id</span><span class='rparen'>)</span>
+<span class='kw'>if</span> <span class='id identifier rubyid_pupdater'>pupdater</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
+  <span class='id identifier rubyid_update_my_parcels_with'>update_my_parcels_with</span><span class='lparen'>(</span><span class='id identifier rubyid_pupdater'>pupdater</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span> <span class='comment'># =&gt; { &#39;parcel_1of2&#39; =&gt; { parcel_code: &#39;BA12354678&#39;, states: [{ code: 1, text: &#39;OK&#39; }]},
+</span>                                          <span class='comment'>#      &#39;parcel_2of2&#39; =&gt; { parcel_code: &#39;BA12354679&#39;, states: [{ code: 1, text: &#39;OK&#39; }]},
+</span>                                          <span class='comment'>#      &#39;parcel_3&#39; =&gt; { parcel_code: &#39;BA12354680&#39;, states: [{ code: 1, text: &#39;OK&#39; }]}
+</span><span class='kw'>else</span>
+  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_psender'>psender</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_full_messages'>full_messages</span> <span class='comment'># =&gt; &quot;response_state: ResponseCode[19 BATCH_INVALID] V dávce se vyskytují chybné záznamy&quot;
+</span>                                    <span class='comment'>#    &quot;parcels: Parcel[parcel_2of2] =&gt; ResponseCode[104 INVALID_WEIGHT] Hmotnost mimo povolený rozsah&quot;
+</span>                                    <span class='comment'>#    &quot;parcels: Parcel[parcel_2of2] =&gt; ResponseCode[261 MISSING_SIZE_CATEGORY] Neuvedena rozměrová kategorie zásilky&quot;
+</span>                                    <span class='comment'>#    &quot;parcels: Parcel[parcel_3] =&gt; ResponseCode[310 INVALID_PREFIX] Neplatný typ zásilky&quot;
+</span><span class='kw'>end</span>
 </code></pre>
-<p>1) Pack your parcel(s)</p>
-<p>2) Call <code>ParcelsSender</code>, this will store in <code>result</code> <code>transmission_id</code> and expected time to ask for results.
-      ```
-        psender = ParcelsSender.call(sending_data: sending_data, parcels: parcels)</p>
-<pre class="code ruby"><code class="ruby">    if psender.success?
-      result = psender.result
-      processing_end_time_utc = (result.processing_end_expected_at - (60 *60)).utc # API returns time in CET but marked as UTC
-      transaction_id = result.transaction_id
-    else
-      puts psender.errors.full_messages
-    end
-  ```
- For now, `parcels` is array of complicated hashes; each parcel must have `parcel_id` key (your ID of parcel).
+<p><code>parcel_code</code> is CzechPost Tracking number of parcel and is used in following calls.</p>
+<p>5a) Print address sheets of parcel(s) by calling <code>AddressSheetsGenerator</code>.
+See <a href="./lib/czech_post_b2b_client/printing_templates.rb">template_classes</a> for available templates.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_parcel_codes'>parcel_codes</span> <span class='op'>=</span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>RA123456789</span><span class='words_sep'> </span><span class='tstring_content'>RR123456789F</span><span class='words_sep'> </span><span class='tstring_content'>RR123456789G</span><span class='words_sep'>]</span> <span class='comment'># beware of parcel_id!
+</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
+    <span class='label'>customer_id:</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_customer_id'>customer_id</span><span class='comma'>,</span> <span class='comment'># required
+</span>    <span class='label'>contract_number:</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_contract_id'>contract_id</span><span class='comma'>,</span> <span class='comment'># not required
+</span>    <span class='label'>template_id:</span> <span class='int'>24</span><span class='comma'>,</span> <span class='comment'># &#39;obalka 3 - B4&#39;  #
+</span>    <span class='label'>margin_in_mm:</span> <span class='lbrace'>{</span> <span class='label'>top:</span> <span class='int'>5</span><span class='comma'>,</span> <span class='label'>left:</span> <span class='int'>3</span> <span class='rbrace'>}</span> <span class='comment'># required
+</span>  <span class='rbrace'>}</span>
+<span class='id identifier rubyid_adrprinter'>adrprinter</span> <span class='op'>=</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="CzechPostB2bClient/Services.html" title="CzechPostB2bClient::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="CzechPostB2bClient/Services/AddressSheetsGenerator.html" title="CzechPostB2bClient::Services::AddressSheetsGenerator (class)">AddressSheetsGenerator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_call'><span class='object_link'><a href="SteppedService/Base.html#call-class_method" title="SteppedService::Base.call (method)">call</a></span></span><span class='lparen'>(</span><span class='label'>parcel_codes:</span> <span class='id identifier rubyid_parcel_codes'>parcel_codes</span><span class='comma'>,</span> <span class='label'>options:</span> <span class='id identifier rubyid_options'>options</span> <span class='rparen'>)</span>
+<span class='kw'>if</span> <span class='id identifier rubyid_adrprinter'>adrprinter</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
+  <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>adrsheet.pdf</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_adrprinter'>adrprinter</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_pdf_content'>pdf_content</span><span class='rparen'>)</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_adrprinter'>adrprinter</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_full_messages'>full_messages</span><span class='rparen'>)</span>
+<span class='kw'>end</span>
 </code></pre>
-<p>3) When such expected time pass, ask for results by calling <code>ParcelsSendProcessUpdater</code>.</p>
-<pre class="code ruby"><code class="ruby"> You can get error `Processing is not yet finished` or hash based on `parcel_id` keys.
- Eg. :
- ```
-    pudater = ParcelsSendProcessUpdater.call(transmission_id: transmission_id)
-    if pupdater.success?
-      update_my_parcels_with(pupdater.result) # =&gt; { &#39;parcel_1of2&#39; =&gt; { parcel_code: &#39;BA12354678&#39;, states: [{ code: 1, text: &#39;OK&#39; }]},
-                                              #      &#39;parcel_2of2&#39; =&gt; { parcel_code: &#39;BA12354679&#39;, states: [{ code: 1, text: &#39;OK&#39; }]},
-                                              #      &#39;parcel_3&#39; =&gt; { parcel_code: &#39;BA12354680&#39;, states: [{ code: 1, text: &#39;OK&#39; }]}
-    else
-      puts psender.errors.full_messages # =&gt; &quot;response_state: ResponseCode[19 BATCH_INVALID] V dávce se vyskytují chybné záznamy&quot;
-                                        #    &quot;parcels: Parcel[parcel_2of2] =&gt; ResponseCode[104 INVALID_WEIGHT] Hmotnost mimo povolený rozsah&quot;
-                                        #    &quot;parcels: Parcel[parcel_2of2] =&gt; ResponseCode[261 MISSING_SIZE_CATEGORY] Neuvedena rozměrová kategorie zásilky&quot;
-                                        #    &quot;parcels: Parcel[parcel_3] =&gt; ResponseCode[310 INVALID_PREFIX] Neplatný typ zásilky&quot;
-    end
- ```
- `parcel_code` is CzechPost ID of parcel and is used in following calls.
+<p>6a) Repeat steps 1-4 until You decide to deliver packages to post office.</p>
+<p>7a) Close your parcels submission with call <code>ParcelsSubmissionCloser.call(sending_data: sender_data)</code>.</p>
+<p>3b) For immediate (one) parcel registering call <code>ParcelsSyncSender</code>. You can optionally request address sheet pdf in response (see step 5a for info)</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_s_data'>s_data</span> <span class='op'>=</span> <span class='id identifier rubyid_sending_data'>sending_data</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>print_params:</span> <span class='lbrace'>{</span> <span class='label'>template_id:</span> <span class='int'>40</span><span class='comma'>,</span> <span class='label'>margin_in_mm:</span> <span class='lbrace'>{</span> <span class='label'>top:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>left:</span> <span class='int'>1</span> <span class='rbrace'>}</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_psender'>psender</span> <span class='op'>=</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="CzechPostB2bClient/Services.html" title="CzechPostB2bClient::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="CzechPostB2bClient/Services/ParcelsSyncSender.html" title="CzechPostB2bClient::Services::ParcelsSyncSender (class)">ParcelsSyncSender</a></span></span><span class='period'>.</span><span class='id identifier rubyid_call'><span class='object_link'><a href="SteppedService/Base.html#call-class_method" title="SteppedService::Base.call (method)">call</a></span></span><span class='lparen'>(</span><span class='label'>sending_data:</span> <span class='id identifier rubyid_s_data'>s_data</span><span class='comma'>,</span> <span class='label'>parcels:</span> <span class='lbracket'>[</span><span class='id identifier rubyid_parcels'>parcels</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+<span class='kw'>if</span> <span class='id identifier rubyid_psender'>psender</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
+  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_psender'>psender</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
+  <span class='id identifier rubyid_update_my_parcels_with'>update_my_parcels_with</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span> <span class='comment'># =&gt; { &#39;parcel_1of2&#39; =&gt; { parcel_code: &#39;BA12354678&#39;, states: [{ code: 1, text: &#39;OK&#39; }]},
+</span>  <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>adrsheet.pdf</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_pdf_content'>pdf_content</span><span class='rparen'>)</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_psender'>psender</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_full_messages'>full_messages</span>
+<span class='kw'>end</span>
 </code></pre>
-<p>4) Print address sheets of parcels(s) by calling <code>AddressSheetsGenerator</code>.
-     See <a href="./lib/czech_post_b2b_client/printing_templates.rb">template_classes</a> for available templates.
-     Eg. :
-     ```
-     parcel_codes = %w[RA123456789 RR123456789F RR123456789G] # beware of parcel_id!
-     options = {
-          customer_id: configuration.customer_id, # required
-          contract_number: configuration.contract_id, # not required
-          template_id: 24, # ‘obalka 3 - B4’  #
-          margin_in_mm: { top: 5, left: 3 } # required
-        }</p>
-<pre class="code ruby"><code class="ruby">  adrprinter = AddressSheetsGenerator.call(parcel_codes: parcel_codes, options: options )
-  if adrprinter.success?
-    File.write(&quot;adrsheet.pdf&quot;, adrprinter.result.pdf_content)
-  else
-    puts(adrprinter.errors.full_messages)
-  end
- ```
+<p><code>parcel_code</code> is CzechPost Tracking number of parcel and is used in following calls.</p>
+<p>8_) <em>They will await You at post office with warm welcome (hopefully). Parcels which are not delivered within 60 days are removed from CzechPost systems for free :-)</em></p>
+<p>9_) You can check current status of delivering with <code>DeliveringInspector</code>, which will return hash based on <code>parcel_code</code> keys.</p>
+<pre class="code ruby"><code class="ruby">delivery_boy = CzechPostB2bClient::Services::DeliveringInspector.call(parcel_codes: parcel_codes)
+if delivery_boy.success?
+  update_my_parcels_delivery_status_with(delivery_boy.result)
+  # result is like:
+  # { &#39;RA12345687&#39; =&gt; { current_state: { id: &#39;91&#39;,
+                                          date: Date.parse(&#39;2015-09-04&#39;),
+                                          text: &#39;Dodání zásilky.&#39;,
+                                          post_code: &#39;25756&#39;,
+                                          post_name: &#39;Neveklov&#39;},
+                        deposited_until: Date.new(2015, 9, 2),
+                        deposited_for_days: 15,
+                        all_states: [
+                          { id: &#39;21&#39;, date: Date.parse(&#39;2015-09-02&#39;), text: &#39;Podání zásilky.&#39;, post_code: &#39;26701&#39;, post_name: &#39;Králův Dvůr u Berouna&#39; },
+                          { id: &#39;-F&#39;, date: Date.parse(&#39;2015-09-03&#39;), text: &#39;Vstup zásilky na SPU.&#39;, post_code: &#39;22200&#39;, post_name: &#39;SPU Praha 022&#39; },
+                          { id: &#39;-I&#39;, date: Date.parse(&#39;2015-09-03&#39;), text: &#39;Výstup zásilky z SPU.&#39;, post_code: &#39;22200&#39;, post_name: &#39;SPU Praha 022&#39; },
+                          { id: &#39;-B&#39;, date: Date.parse(&#39;2015-09-03&#39;), text: &#39;Přeprava zásilky k dodací poště.&#39;, post_code: nil, post_name: nil },
+                          { id: &#39;51&#39;, date: Date.parse(&#39;2015-09-04&#39;), text: &#39;Příprava zásilky k doručení.&#39;, post_code: &#39;25607&#39;, post_name: &#39;Depo Benešov 70&#39; },
+                          { id: &#39;53&#39;, date: Date.parse(&#39;2015-09-04&#39;), text: &#39;Doručování zásilky.&#39;, post_code: &#39;25756&#39;, post_name: &#39;Neveklov&#39; },
+                          { id: &#39;91&#39;, date: Date.parse(&#39;2015-09-04&#39;), text: &#39;Dodání zásilky.&#39;, post_code: &#39;25756&#39;, post_name: &#39;Neveklov&#39; }
+                        ]},
+      &#39;BA56487125&#39; =&gt; {...}
+    }
+else
+  puts(delivery_boy.errors.full_messages)
+end
 </code></pre>
-<p>5) Repeat steps 1-4 until You decide to deliver packages to post office.</p>
-<p>6) Close your parcels submission with call <code>ParcelsSubmissionCloser.call(sending_data: sender_data)</code>.</p>
-<p>7) <em>They will await You at post office with warm welcome (hopefully). Parcels which are not delivered within 60 days are removed from CzechPost systems for free :-)</em></p>
-<p>8) You can check current status of delivering with <code>DeliveringInspector</code>, which will return hash based on <code>parcel_code</code> keys.
-     Eg. :
-     ```
-      delivery_boy = DeliveringInspector.call(parcel_codes: parcel_codes)</p>
-<pre class="code ruby"><code class="ruby">  if delivery_boy.success?
-    update_my_parcels_delivery_status_with(delivery_boy.result)
-    # result is like:
-    # { &#39;RA12345687&#39; =&gt; { current_state: { id: &#39;91&#39;,
-                                           date: Date.parse(&#39;2015-09-04&#39;),
-                                           text: &#39;Dodání zásilky.&#39;,
-                                           post_code: &#39;25756&#39;,
-                                           post_name: &#39;Neveklov&#39;},
-                          deposited_until: Date.new(2015, 9, 2),
-                          deposited_for_days: 15,
-                          all_states: [
-                            { id: &#39;21&#39;, date: Date.parse(&#39;2015-09-02&#39;), text: &#39;Podání zásilky.&#39;, post_code: &#39;26701&#39;, post_name: &#39;Králův Dvůr u Berouna&#39; },
-                            { id: &#39;-F&#39;, date: Date.parse(&#39;2015-09-03&#39;), text: &#39;Vstup zásilky na SPU.&#39;, post_code: &#39;22200&#39;, post_name: &#39;SPU Praha 022&#39; },
-                            { id: &#39;-I&#39;, date: Date.parse(&#39;2015-09-03&#39;), text: &#39;Výstup zásilky z SPU.&#39;, post_code: &#39;22200&#39;, post_name: &#39;SPU Praha 022&#39; },
-                            { id: &#39;-B&#39;, date: Date.parse(&#39;2015-09-03&#39;), text: &#39;Přeprava zásilky k dodací poště.&#39;, post_code: nil, post_name: nil },
-                            { id: &#39;51&#39;, date: Date.parse(&#39;2015-09-04&#39;), text: &#39;Příprava zásilky k doručení.&#39;, post_code: &#39;25607&#39;, post_name: &#39;Depo Benešov 70&#39; },
-                            { id: &#39;53&#39;, date: Date.parse(&#39;2015-09-04&#39;), text: &#39;Doručování zásilky.&#39;, post_code: &#39;25756&#39;, post_name: &#39;Neveklov&#39; },
-                            { id: &#39;91&#39;, date: Date.parse(&#39;2015-09-04&#39;), text: &#39;Dodání zásilky.&#39;, post_code: &#39;25756&#39;, post_name: &#39;Neveklov&#39; }
-                          ]},
-        &#39;BA56487125&#39; =&gt; {...}
-      }
-  else
-    puts(delivery_boy.errors.full_messages)
-  end
-  ```
+<p>10_) And You can always ask for statistics!</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_tps'>tps</span> <span class='op'>=</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="CzechPostB2bClient/Services.html" title="CzechPostB2bClient::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="CzechPostB2bClient/Services/TimePeriodStatisticator.html" title="CzechPostB2bClient::Services::TimePeriodStatisticator (class)">TimePeriodStatisticator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_call'><span class='object_link'><a href="SteppedService/Base.html#call-class_method" title="SteppedService::Base.call (method)">call</a></span></span><span class='lparen'>(</span><span class='label'>from_date:</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_today'>today</span> <span class='op'>-</span> <span class='int'>5</span><span class='comma'>,</span> <span class='label'>to_date:</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_today'>today</span><span class='rparen'>)</span>
+<span class='kw'>if</span> <span class='id identifier rubyid_tps'>tps</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
+  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_tps'>tps</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
+  <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_requests'>requests</span><span class='period'>.</span><span class='id identifier rubyid_total'>total</span> <span class='comment'># =&gt; 26,
+</span>  <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_requests'>requests</span><span class='period'>.</span><span class='id identifier rubyid_with_errors'>with_errors</span> <span class='comment'># =&gt; 16
+</span>  <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_requests'>requests</span><span class='period'>.</span><span class='id identifier rubyid_successful'>successful</span> <span class='comment'># =&gt; 10
+</span>  <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_imported_parcels'>imported_parcels</span> <span class='comment'># =&gt; 3
+</span><span class='kw'>else</span>
+  <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_tps'>tps</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_full_messages'>full_messages</span><span class='rparen'>)</span>
+<span class='kw'>end</span>
 </code></pre>
-<p>9) And You can always ask for statistics!
-      <code>
-      tps = TimePeriodStatisticator.call(from_date: Date.today - 5, to_date: Date.today)
-      if tps.success?
-        result = tps.result
-        result.requests.total # =&gt; 26,
-        result.requests.with_errors # =&gt; 16
-        result.requests.successful # =&gt; 10
-        result.imported_parcels # =&gt; 3
-      else
-        puts(tps.errors.full_messages)
-      end
-     </code></p>
-<h3 id="example-usage">Example usage</h3>
+<h3>Example usage</h3>
 <p>See <code>test/integration_test.rb</code> for almost production usage. HTTP calls to B2B services are blocked and responses from them are stubbed.</p>
 <p>You can quickly check you setup by altering config and run <code>ruby try_api_calls.rb</code> see <a href="./examples/try_api_calls.rb"><code>try_api_calls.rb</code></a>.</p>
-<h2 id="troubleshooting">Troubleshooting</h2>
+<h2>Troubleshooting</h2>
-<p>1) Read all stuff in <code>doc</code>, maybe it helps.
-  2) If You get “handshake protocol failed” You do not have correct setup for certificates. If You get any xml response (see logger in debug mode) certificates are ok.
-     You can always try <code>TimePeriodStatisticator</code> for that check, it do not need any “before” actions.
-  3) Error <code>UNAUTHORIZED_ROLE_ACCESS</code> means wrong <code>customer_id</code> or You are not yet registered in “PodáníOnline”
+<p>1) Read all stuff in <a href="./documents/"><code>./documents</code></a> and <a href="./doc/index.html">Yard docs</a>, maybe it helps.
+  2) If You get &quot;handshake protocol failed&quot; You do not have correct setup for certificates. If You get any xml response (see logger in debug mode) certificates are ok.
+     You can always try <code>TimePeriodStatisticator</code> for that check, it do not need any &quot;before&quot; actions.
+  3) Error <code>UNAUTHORIZED_ROLE_ACCESS</code> means wrong <code>customer_id</code> or You are not yet registered in &quot;PodáníOnline&quot;
   4) Error <code>11: INVALID_LOCATION</code> was occuring when only <code>sending_post_office_code</code> was used. Try to use <code>sending_post_office_location_number</code>.
-  5) And last tip <code>261 MISSING_SIZE_CATEGORY</code> -&gt; add correct “size service” to services (eg: ‘S’, ‘M’)
+  5) And last tip <code>261 MISSING_SIZE_CATEGORY</code> -&gt; add correct &quot;size service&quot; to services (eg: &#39;S&#39;, &#39;M&#39;)
   6) Compare resulting request XML with examples in <code>test/request_builders</code></p>
-<h2 id="development">Development</h2>
+<h2>Development</h2>
 <p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run <code>rake test</code> to run the tests. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
 <p>To install this gem onto your local machine, run <code>bundle exec rake install</code>. To release a new version, update the version number in <code>lib/czech_post_b2b_client/version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p>
-<h2 id="contributing">Contributing</h2>
+<h2>Contributing</h2>
-<p>Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/czech_post_b2b_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the <a href="http://contributor-covenant.org">Contributor Covenant</a> code of conduct.</p>
+<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/%5BUSERNAME%5D/czech_post_b2b_client">https://github.com/[USERNAME]/czech_post_b2b_client</a>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the <a href="http://contributor-covenant.org">Contributor Covenant</a> code of conduct.</p>
-<h2 id="license">License</h2>
+<h2>License</h2>
 <p>The gem is available as open source under the terms of the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
-<h2 id="code-of-conduct">Code of Conduct</h2>
+<h2>Code of Conduct</h2>
-<p>Everyone interacting in the CzechPostB2bClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the <a href="https://github.com/[USERNAME]/czech_post_b2b_client/blob/master/CODE_OF_CONDUCT.md">code of conduct</a>.</p>
+<p>Everyone interacting in the CzechPostB2bClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the <a href="https://github.com/%5BUSERNAME%5D/czech_post_b2b_client/blob/master/CODE_OF_CONDUCT.md">code of conduct</a>.</p>
 </div></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>