Skip to content

Commit

Permalink
deploy: a471d84
Browse files Browse the repository at this point in the history
  • Loading branch information
cillian committed Aug 19, 2024
1 parent 809407c commit ea94e8a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 22 deletions.
16 changes: 8 additions & 8 deletions docs/api/admin/3.0/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@
<a href="#authentication" class="toc-h1 toc-link" data-title="Authentication">Authentication</a>
<ul class="toc-list-h2">
<li>
<a href="#authentication-confirm-you-can-connect" class="toc-h2 toc-link" data-title="Confirm you can connect">Confirm you can connect</a>
<a href="#authentication-register-interest-widget-confirm-you-can-connect" class="toc-h2 toc-link" data-title="Confirm you can connect">Confirm you can connect</a>
</li>
</ul>
</li>
Expand All @@ -330,13 +330,13 @@
<a href="#views" class="toc-h1 toc-link" data-title="Views">Views</a>
<ul class="toc-list-h2">
<li>
<a href="#views-short" class="toc-h2 toc-link" data-title=" Short"> Short</a>
<a href="#views-register-interest-widget-short" class="toc-h2 toc-link" data-title=" Short"> Short</a>
</li>
<li>
<a href="#views-extended" class="toc-h2 toc-link" data-title="Extended">Extended</a>
<a href="#views-register-interest-widget-extended" class="toc-h2 toc-link" data-title="Extended">Extended</a>
</li>
<li>
<a href="#views-choosing-the-view" class="toc-h2 toc-link" data-title="Choosing the view">Choosing the view</a>
<a href="#views-register-interest-widget-choosing-the-view" class="toc-h2 toc-link" data-title="Choosing the view">Choosing the view</a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -787,7 +787,7 @@ <h1 id='authentication'>Authentication</h1>
<p>If you find your API token has been compromised it can be <a href="https://id.tito.io/api-access-tokens">revoked</a> and a new one generated.</p>

<p>Your API token needs to be included in the <code>Authorization</code> header so your requests can be authenticated.</p>
<h3 id='authentication-confirm-you-can-connect'>Confirm you can connect</h3><div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">--request</span> GET <span class="se">\</span>
<h3 id='authentication-register-interest-widget-confirm-you-can-connect'>Confirm you can connect</h3><div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">--request</span> GET <span class="se">\</span>
<span class="nt">--url</span> <span class="s1">'https://api.tito.io/v3/hello'</span> <span class="se">\</span>
<span class="nt">--header</span> <span class="s1">'Authorization: Token token=YOUR-API-TOKEN'</span> <span class="se">\</span>
<span class="nt">--header</span> <span class="s1">'Accept: application/json'</span> <span class="se">\</span>
Expand Down Expand Up @@ -846,11 +846,11 @@ <h1 id='views'>Views</h1>
<li>Short</li>
<li>Extended</li>
</ul>
<h3 id='views-short'> Short</h3>
<h3 id='views-register-interest-widget-short'> Short</h3>
<p>This is what you get if you ask for a list of records (e.g. <a href="#registrations-get-all-registrations">Get all Registrations</a>) then we give you the &quot;short&quot; view of the data, so that we can make the response as quick as possible and you don&#39;t get a lot of data all at once.</p>
<h3 id='views-extended'>Extended</h3>
<h3 id='views-register-interest-widget-extended'>Extended</h3>
<p>If you ask for a single record (e.g. <a href="#registrations-get-a-registration">Get a Registration</a>) then we give you the &quot;extended&quot; view which gives you more detailed information and possible associated records.</p>
<h3 id='views-choosing-the-view'>Choosing the view</h3>
<h3 id='views-register-interest-widget-choosing-the-view'>Choosing the view</h3>
<p>You can override this by passing the <code>view</code> parameter. For example:</p>

<p><code>GET https://api.tito.io/v3/:account_slug/:event_slug/tickets?view=extended</code></p>
Expand Down
16 changes: 2 additions & 14 deletions docs/api/admin/3.1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@
<a href="#authentication" class="toc-h1 toc-link" data-title="Authentication">Authentication</a>
<ul class="toc-list-h2">
<li>
<a href="#authentication-widget-confirm-you-can-connect" class="toc-h2 toc-link" data-title="Confirm you can connect">Confirm you can connect</a>
<a href="#authentication-confirm-you-can-connect" class="toc-h2 toc-link" data-title="Confirm you can connect">Confirm you can connect</a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -884,7 +884,7 @@ <h1 id='authentication'>Authentication</h1>
<p>If you find your API token has been compromised it can be <a href="https://id.tito.io/api-access-tokens">revoked</a> and a new one generated.</p>

<p>Your API token needs to be included in the <code>Authorization</code> header so your requests can be authenticated.</p>
<h3 id='authentication-widget-confirm-you-can-connect'>Confirm you can connect</h3><div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">--request</span> GET <span class="se">\</span>
<h3 id='authentication-confirm-you-can-connect'>Confirm you can connect</h3><div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">--request</span> GET <span class="se">\</span>
<span class="nt">--url</span> <span class="s1">'https://api.tito.io/v3/hello'</span> <span class="se">\</span>
<span class="nt">--header</span> <span class="s1">'Authorization: Token token=YOUR-API-TOKEN'</span> <span class="se">\</span>
<span class="nt">--header</span> <span class="s1">'Accept: application/json'</span> <span class="se">\</span>
Expand Down Expand Up @@ -2290,7 +2290,6 @@ <h2 id='events-attributes'>Attributes <i class="fa-regular fa-tags"></i></h2>
<li><div><code class="name">any_live_tickets</code><span class="type">boolean</span><span class="read-only">read only</span></div></li>
<li><div><code class="name">archived</code><span class="type">boolean</span></div><div class="attribute-description">Whether this event is archived or not.</div></li>
<li><div><code class="name">banner</code><span class="type">object</span></div></li>
<li><div><code class="name">banner_link</code></div></li>
<li><div><code class="name">banner_url</code><span class="type">url</span><span class="read-only">read only</span></div><div class="attribute-description">A link to the event's banner image.</div></li>
<li><div><code class="name">consent</code><span class="type">object</span></div><div class="attribute-description">Whether consent is required for data protection</div></li>
<li><div><code class="name">credit_card_payment_option_gateway_type</code><span class="type">string</span></div><div class="attribute-description">The payment option for credit cards, e.g. "stripe".</div></li>
Expand Down Expand Up @@ -2325,7 +2324,6 @@ <h2 id='events-attributes'>Attributes <i class="fa-regular fa-tags"></i></h2>
<li><div><code class="name">email_image</code></div></li>
<li><div><code class="name">email_invoice</code></div></li>
<li><div><code class="name">end_date</code><span class="type">date</span></div><div class="attribute-description">The date the event is going to end</div></li>
<li><div><code class="name">external_order_reference_format</code></div></li>
<li><div><code class="name">facebook_share_message</code><span class="translated">translated</span><span class="translated-note">*</span></div></li>
<li><div><code class="name">from_email</code></div></li>
<li><div><code class="name">happening_in</code></div><div class="attribute-description">Either <code>past</code>, <code>now</code>, <code>future</code> or <code>unknown</code> (if <code>start_date</code> is blank).</div></li>
Expand Down Expand Up @@ -2525,7 +2523,6 @@ <h2 id='events-get-all-upcoming-events'>Get all upcoming events <i class="fa-reg
</span><span class="nl">"after_registration_redirect_after_questions"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"any_live_sales"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nl">"any_live_tickets"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nl">"banner_link"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"credit_card_payment_option_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"credit_card_payment_option_gateway_type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"custom_background_color"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
Expand Down Expand Up @@ -2553,7 +2550,6 @@ <h2 id='events-get-all-upcoming-events'>Get all upcoming events <i class="fa-reg
</span><span class="p">}</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"email_invoice"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nl">"external_order_reference_format"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"facebook_share_message"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"hide_tax_types"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"invoice_change_cutoff_days"</span><span class="p">:</span><span class="w"> </span><span class="mi">90</span><span class="p">,</span><span class="w">
Expand Down Expand Up @@ -2712,7 +2708,6 @@ <h2 id='events-get-all-upcoming-events'>Get all upcoming events <i class="fa-reg
</span><span class="nl">"after_registration_redirect_after_questions"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"any_live_sales"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"any_live_tickets"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"banner_link"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"credit_card_payment_option_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"credit_card_payment_option_gateway_type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"custom_background_color"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
Expand Down Expand Up @@ -2740,7 +2735,6 @@ <h2 id='events-get-all-upcoming-events'>Get all upcoming events <i class="fa-reg
</span><span class="p">}</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"email_invoice"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nl">"external_order_reference_format"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"facebook_share_message"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"hide_tax_types"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"invoice_change_cutoff_days"</span><span class="p">:</span><span class="w"> </span><span class="mi">90</span><span class="p">,</span><span class="w">
Expand Down Expand Up @@ -2986,7 +2980,6 @@ <h2 id='events-get-an-event'>Get an event <i class="fa-regular fa-file"></i></h2
</span><span class="nl">"after_registration_redirect_after_questions"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"any_live_sales"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nl">"any_live_tickets"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nl">"banner_link"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"credit_card_payment_option_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"credit_card_payment_option_gateway_type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"custom_background_color"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
Expand Down Expand Up @@ -3014,7 +3007,6 @@ <h2 id='events-get-an-event'>Get an event <i class="fa-regular fa-file"></i></h2
</span><span class="p">}</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"email_invoice"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nl">"external_order_reference_format"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"facebook_share_message"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"hide_tax_types"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"invoice_change_cutoff_days"</span><span class="p">:</span><span class="w"> </span><span class="mi">90</span><span class="p">,</span><span class="w">
Expand Down Expand Up @@ -3202,7 +3194,6 @@ <h2 id='events-create-an-event'>Create an event <i class="fa-regular fa-file-plu
</span><span class="nl">"after_registration_redirect_after_questions"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"any_live_sales"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"any_live_tickets"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"banner_link"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"credit_card_payment_option_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"credit_card_payment_option_gateway_type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"custom_background_color"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
Expand Down Expand Up @@ -3230,7 +3221,6 @@ <h2 id='events-create-an-event'>Create an event <i class="fa-regular fa-file-plu
</span><span class="p">}</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"email_invoice"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nl">"external_order_reference_format"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"facebook_share_message"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"hide_tax_types"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"invoice_change_cutoff_days"</span><span class="p">:</span><span class="w"> </span><span class="mi">90</span><span class="p">,</span><span class="w">
Expand Down Expand Up @@ -3420,7 +3410,6 @@ <h2 id='events-update-an-event'>Update an event <i class="fa-regular fa-file-pen
</span><span class="nl">"after_registration_redirect_after_questions"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"any_live_sales"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nl">"any_live_tickets"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nl">"banner_link"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"credit_card_payment_option_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"credit_card_payment_option_gateway_type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"custom_background_color"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
Expand Down Expand Up @@ -3448,7 +3437,6 @@ <h2 id='events-update-an-event'>Update an event <i class="fa-regular fa-file-pen
</span><span class="p">}</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"email_invoice"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nl">"external_order_reference_format"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"facebook_share_message"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
</span><span class="nl">"hide_tax_types"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"invoice_change_cutoff_days"</span><span class="p">:</span><span class="w"> </span><span class="mi">90</span><span class="p">,</span><span class="w">
Expand Down

0 comments on commit ea94e8a

Please sign in to comment.