Merge pull request #24 from Boulevard/update-docs-2.0

Documentation Update
Boulevard · Nov 15, 2023 · e66243b · e66243b
2 parents 27aac9f + d0f3dfe
commit e66243b
Show file tree

Hide file tree

Showing 68 changed files with 569 additions and 389 deletions.
diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js
diff --git a/docs/classes/appointments.appointment.html b/docs/classes/appointments.appointment.html
diff --git a/docs/classes/appointments.appointmentcancellation.html b/docs/classes/appointments.appointmentcancellation.html
@@ -104,7 +104,7 @@ <h3>cancelled<wbr>At</h3>
 					<div class="tsd-signature tsd-kind-icon">cancelled<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L82">appointments.ts:82</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L82">appointments.ts:82</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -119,7 +119,7 @@ <h3>notes</h3>
 					<div class="tsd-signature tsd-kind-icon">notes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L83">appointments.ts:83</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L83">appointments.ts:83</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -129,7 +129,7 @@ <h3>reason</h3>
 					<div class="tsd-signature tsd-kind-icon">reason<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AppointmentCancellationReason</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L84">appointments.ts:84</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L84">appointments.ts:84</a></li>
 						</ul>
 					</aside>
 				</section>

diff --git a/docs/classes/appointments.appointments-1.html b/docs/classes/appointments.appointments-1.html
@@ -103,7 +103,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> get</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L290">appointments.ts:290</a></li>
+									<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L308">appointments.ts:308</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -139,7 +139,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>From<wbr>Ca
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L306">appointments.ts:306</a></li>
+									<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L324">appointments.ts:324</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -175,7 +175,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> list</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L323">appointments.ts:323</a></li>
+									<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L341">appointments.ts:341</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/appointments.appointmentservice.html b/docs/classes/appointments.appointmentservice.html
@@ -110,7 +110,7 @@ <h3>duration</h3>
 					<div class="tsd-signature tsd-kind-icon">duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L41">appointments.ts:41</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L41">appointments.ts:41</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -125,7 +125,7 @@ <h3>end<wbr>At</h3>
 					<div class="tsd-signature tsd-kind-icon">end<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L44">appointments.ts:44</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L44">appointments.ts:44</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -140,7 +140,7 @@ <h3>price</h3>
 					<div class="tsd-signature tsd-kind-icon">price<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L47">appointments.ts:47</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L47">appointments.ts:47</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -155,7 +155,7 @@ <h3>service</h3>
 					<div class="tsd-signature tsd-kind-icon">service<span class="tsd-signature-symbol">:</span> <a href="services.service.html" class="tsd-signature-type" data-tsd-kind="Class">Service</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L50">appointments.ts:50</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L50">appointments.ts:50</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -170,7 +170,7 @@ <h3>staff</h3>
 					<div class="tsd-signature tsd-kind-icon">staff<span class="tsd-signature-symbol">:</span> <a href="staff.staff-1.html" class="tsd-signature-type" data-tsd-kind="Class">Staff</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L53">appointments.ts:53</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L53">appointments.ts:53</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -185,7 +185,7 @@ <h3>staff<wbr>Requested</h3>
 					<div class="tsd-signature tsd-kind-icon">staff<wbr>Requested<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L56">appointments.ts:56</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L56">appointments.ts:56</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -200,7 +200,7 @@ <h3>start<wbr>At</h3>
 					<div class="tsd-signature tsd-kind-icon">start<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L59">appointments.ts:59</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L59">appointments.ts:59</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -215,7 +215,7 @@ <h3>start<wbr>Time<wbr>Offset</h3>
 					<div class="tsd-signature tsd-kind-icon">start<wbr>Time<wbr>Offset<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L62">appointments.ts:62</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L62">appointments.ts:62</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -230,7 +230,7 @@ <h3>total<wbr>Duration</h3>
 					<div class="tsd-signature tsd-kind-icon">total<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L65">appointments.ts:65</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L65">appointments.ts:65</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/appointments.availablerescheduledate.html b/docs/classes/appointments.availablerescheduledate.html
@@ -102,7 +102,7 @@ <h3>date</h3>
 					<div class="tsd-signature tsd-kind-icon">date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L36">appointments.ts:36</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L36">appointments.ts:36</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/appointments.availablerescheduletime.html b/docs/classes/appointments.availablerescheduletime.html
@@ -103,7 +103,7 @@ <h3>bookable<wbr>Time<wbr>Id</h3>
 					<div class="tsd-signature tsd-kind-icon">bookable<wbr>Time<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L22">appointments.ts:22</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L22">appointments.ts:22</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -113,7 +113,7 @@ <h3>start<wbr>Time</h3>
 					<div class="tsd-signature tsd-kind-icon">start<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/appointments.ts#L25">appointments.ts:25</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/appointments.ts#L25">appointments.ts:25</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/blvd.blvd-1.html b/docs/classes/blvd.blvd-1.html
@@ -111,7 +111,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/blvd.ts#L14">blvd.ts:14</a></li>
+									<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/blvd.ts#L14">blvd.ts:14</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -155,7 +155,7 @@ <h3>appointments</h3>
 					<div class="tsd-signature tsd-kind-icon">appointments<span class="tsd-signature-symbol">:</span> <a href="appointments.appointments-1.html" class="tsd-signature-type" data-tsd-kind="Class">Appointments</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/blvd.ts#L10">blvd.ts:10</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/blvd.ts#L10">blvd.ts:10</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -165,7 +165,7 @@ <h3>businesses</h3>
 					<div class="tsd-signature tsd-kind-icon">businesses<span class="tsd-signature-symbol">:</span> <a href="businesses.businesses-1.html" class="tsd-signature-type" data-tsd-kind="Class">Businesses</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/blvd.ts#L11">blvd.ts:11</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/blvd.ts#L11">blvd.ts:11</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -175,7 +175,7 @@ <h3>carts</h3>
 					<div class="tsd-signature tsd-kind-icon">carts<span class="tsd-signature-symbol">:</span> <a href="carts.carts-1.html" class="tsd-signature-type" data-tsd-kind="Class">Carts</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/blvd.ts#L12">blvd.ts:12</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/blvd.ts#L12">blvd.ts:12</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -185,7 +185,7 @@ <h3>clients</h3>
 					<div class="tsd-signature tsd-kind-icon">clients<span class="tsd-signature-symbol">:</span> <a href="clients.clients-1.html" class="tsd-signature-type" data-tsd-kind="Class">Clients</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/blvd.ts#L13">blvd.ts:13</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/blvd.ts#L13">blvd.ts:13</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -195,7 +195,7 @@ <h3>locations</h3>
 					<div class="tsd-signature tsd-kind-icon">locations<span class="tsd-signature-symbol">:</span> <a href="locations.locations-1.html" class="tsd-signature-type" data-tsd-kind="Class">Locations</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/blvd.ts#L14">blvd.ts:14</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/blvd.ts#L14">blvd.ts:14</a></li>
 						</ul>
 					</aside>
 				</section>

diff --git a/docs/classes/businesses.business.html b/docs/classes/businesses.business.html
@@ -114,7 +114,7 @@ <h3>avatar</h3>
 					<div class="tsd-signature tsd-kind-icon">avatar<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/businesses.ts#L8">businesses.ts:8</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/businesses.ts#L8">businesses.ts:8</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -124,7 +124,7 @@ <h3>id</h3>
 					<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/businesses.ts#L11">businesses.ts:11</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/businesses.ts#L11">businesses.ts:11</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -139,7 +139,7 @@ <h3>inserted<wbr>At</h3>
 					<div class="tsd-signature tsd-kind-icon">inserted<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/businesses.ts#L13">businesses.ts:13</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/businesses.ts#L13">businesses.ts:13</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -149,7 +149,7 @@ <h3>name</h3>
 					<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/businesses.ts#L16">businesses.ts:16</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/businesses.ts#L16">businesses.ts:16</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -164,7 +164,7 @@ <h3>tz</h3>
 					<div class="tsd-signature tsd-kind-icon">tz<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/businesses.ts#L22">businesses.ts:22</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/businesses.ts#L22">businesses.ts:22</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -179,7 +179,7 @@ <h3>updated<wbr>At</h3>
 					<div class="tsd-signature tsd-kind-icon">updated<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/businesses.ts#L24">businesses.ts:24</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/businesses.ts#L24">businesses.ts:24</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -189,7 +189,7 @@ <h3>website</h3>
 					<div class="tsd-signature tsd-kind-icon">website<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/businesses.ts#L27">businesses.ts:27</a></li>
+							<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/businesses.ts#L27">businesses.ts:27</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -211,7 +211,7 @@ <h3>get<wbr>Locations</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/businesses.ts#L36">businesses.ts:36</a></li>
+									<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/businesses.ts#L36">businesses.ts:36</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/businesses.businesses-1.html b/docs/classes/businesses.businesses-1.html
@@ -101,7 +101,7 @@ <h3>get</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/d071761/src/businesses.ts#L58">businesses.ts:58</a></li>
+									<li>Defined in <a href="https://github.com/Boulevard/book-sdk/blob/27aac9f/src/businesses.ts#L58">businesses.ts:58</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">