@xyo-network/api 2.57.5 → 2.57.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs.json +369 -369
- package/docs/classes/XyoApiBase.html +28 -28
- package/docs/classes/XyoApiSimple.html +40 -40
- package/docs/classes/XyoArchivistApi.html +41 -41
- package/docs/classes/XyoLocationDivinerApi.html +6 -6
- package/docs/functions/isLocationHeatmapQuery.html +1 -1
- package/docs/functions/isLocationQuadkeyHeatmapQuery.html +1 -1
- package/docs/functions/isLocationTimeRangeQuery.html +1 -1
- package/docs/functions/isSupportedLocationQuerySchema.html +1 -1
- package/docs/interfaces/ApiConfig.html +5 -5
- package/docs/interfaces/Coordinates.html +8 -8
- package/docs/interfaces/CurrentLocation.html +3 -3
- package/docs/interfaces/GetLocationQueryResponse.html +3 -3
- package/docs/interfaces/LocationHeatmapPointProperties.html +3 -3
- package/docs/interfaces/LocationQueryCreationRequest.html +7 -7
- package/docs/interfaces/LocationQueryCreationResponse.html +8 -8
- package/docs/interfaces/LocationTimeRangePointProperties.html +5 -5
- package/docs/interfaces/XyoArchivePath.html +2 -2
- package/docs/types/CurrentLocationWitnessPayload.html +1 -1
- package/docs/types/CurrentLocationWitnessSchema.html +2 -2
- package/docs/types/LocationHeatmapAnswerSchema.html +1 -1
- package/docs/types/LocationHeatmapQuery.html +1 -1
- package/docs/types/LocationHeatmapQueryCreationRequest.html +1 -1
- package/docs/types/LocationHeatmapQuerySchema.html +1 -1
- package/docs/types/LocationQuadkeyHeatmapAnswerSchema.html +1 -1
- package/docs/types/LocationQuadkeyHeatmapQuery.html +1 -1
- package/docs/types/LocationQuadkeyHeatmapQueryCreationRequest.html +1 -1
- package/docs/types/LocationQuadkeyHeatmapQuerySchema.html +1 -1
- package/docs/types/LocationQuerySchema.html +1 -1
- package/docs/types/LocationTimeRangeAnswerSchema.html +2 -2
- package/docs/types/LocationTimeRangeQuery.html +1 -1
- package/docs/types/LocationTimeRangeQueryCreationRequest.html +1 -1
- package/docs/types/LocationTimeRangeQuerySchema.html +2 -2
- package/docs/types/LocationWitnessPayload.html +1 -1
- package/docs/types/LocationWitnessSchema.html +2 -2
- package/docs/types/SupportedLocationQueryCreationRequest.html +1 -1
- package/docs/types/WithArchive.html +1 -1
- package/docs/types/XyoApiSimpleQuery.html +1 -1
- package/docs/types/XyoRemoteDivinerConfig.html +1 -1
- package/docs/types/XyoRemoteDivinerConfigSchema.html +2 -2
- package/docs/variables/CurrentLocationWitnessSchema-1.html +2 -2
- package/docs/variables/LocationTimeRangeAnswerSchema-1.html +2 -2
- package/docs/variables/LocationTimeRangeQuerySchema-1.html +2 -2
- package/docs/variables/LocationWitnessSchema-1.html +2 -2
- package/docs/variables/XyoRemoteDivinerConfigSchema-1.html +2 -2
- package/docs/variables/locationHeatmapAnswerSchema-1.html +1 -1
- package/docs/variables/locationHeatmapQuerySchema-1.html +1 -1
- package/docs/variables/locationQuadkeyHeatmapAnswerSchema-1.html +1 -1
- package/docs/variables/locationQuadkeyHeatmapQuerySchema-1.html +1 -1
- package/package.json +11 -11
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
<ul class="tsd-hierarchy">
|
|
32
32
|
<li><span class="tsd-signature-type ">XyoApiReportable</span></li></ul></section><aside class="tsd-sources">
|
|
33
33
|
<ul>
|
|
34
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
34
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L14">sdk/packages/api/src/Base.ts:14</a></li></ul></aside>
|
|
35
35
|
<section class="tsd-panel-group tsd-index-group">
|
|
36
36
|
<section class="tsd-panel tsd-index-panel">
|
|
37
37
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -87,19 +87,19 @@
|
|
|
87
87
|
<h5><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type tsd-kind-type-parameter">C</span></h5></li></ul></div>
|
|
88
88
|
<h4 class="tsd-returns-title">Returns <a href="XyoApiBase.html" class="tsd-signature-type tsd-kind-class">XyoApiBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">C</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
89
89
|
<ul>
|
|
90
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
90
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L18">sdk/packages/api/src/Base.ts:18</a></li></ul></aside></li></ul></section></section>
|
|
91
91
|
<section class="tsd-panel-group tsd-member-group">
|
|
92
92
|
<h2>Properties</h2>
|
|
93
93
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="axios" class="tsd-anchor"></a>
|
|
94
94
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
95
95
|
<div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">AxiosJson</span></div><aside class="tsd-sources">
|
|
96
96
|
<ul>
|
|
97
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
97
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L16">sdk/packages/api/src/Base.ts:16</a></li></ul></aside></section>
|
|
98
98
|
<section class="tsd-panel tsd-member"><a id="config" class="tsd-anchor"></a>
|
|
99
99
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
100
100
|
<div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type tsd-kind-type-parameter">C</span></div><aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L15">sdk/packages/api/src/Base.ts:15</a></li></ul></aside></section></section>
|
|
103
103
|
<section class="tsd-panel-group tsd-member-group">
|
|
104
104
|
<h2>Accessors</h2>
|
|
105
105
|
<section class="tsd-panel tsd-member"><a id="authenticated" class="tsd-anchor"></a>
|
|
@@ -109,7 +109,7 @@
|
|
|
109
109
|
<li class="tsd-description">
|
|
110
110
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
111
111
|
<ul>
|
|
112
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
112
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L23">sdk/packages/api/src/Base.ts:23</a></li></ul></aside></li></ul></section>
|
|
113
113
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="headers" class="tsd-anchor"></a>
|
|
114
114
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>headers</span><a href="#headers" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
115
115
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -117,7 +117,7 @@
|
|
|
117
117
|
<li class="tsd-description">
|
|
118
118
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
119
119
|
<ul>
|
|
120
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
120
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L27">sdk/packages/api/src/Base.ts:27</a></li></ul></aside></li></ul></section>
|
|
121
121
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="query" class="tsd-anchor"></a>
|
|
122
122
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>query</span><a href="#query" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
123
123
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -125,7 +125,7 @@
|
|
|
125
125
|
<li class="tsd-description">
|
|
126
126
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
127
127
|
<ul>
|
|
128
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
128
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L38">sdk/packages/api/src/Base.ts:38</a></li></ul></aside></li></ul></section>
|
|
129
129
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="root" class="tsd-anchor"></a>
|
|
130
130
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>root</span><a href="#root" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
131
131
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -133,7 +133,7 @@
|
|
|
133
133
|
<li class="tsd-description">
|
|
134
134
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
135
135
|
<ul>
|
|
136
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
136
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L42">sdk/packages/api/src/Base.ts:42</a></li></ul></aside></li></ul></section></section>
|
|
137
137
|
<section class="tsd-panel-group tsd-member-group">
|
|
138
138
|
<h2>Methods</h2>
|
|
139
139
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="deleteEndpoint" class="tsd-anchor"></a>
|
|
@@ -153,7 +153,7 @@
|
|
|
153
153
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">endPoint</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
154
154
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseBody</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
155
155
|
<ul>
|
|
156
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
156
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L70">sdk/packages/api/src/Base.ts:70</a></li></ul></aside></li>
|
|
157
157
|
<li class="tsd-signature tsd-anchor-link" id="deleteEndpoint.deleteEndpoint-2"><span class="tsd-kind-call-signature">delete<wbr/>Endpoint</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endPoint</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">responseType</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseBody</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteEndpoint.deleteEndpoint-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
158
158
|
<li class="tsd-description">
|
|
159
159
|
<section class="tsd-panel">
|
|
@@ -170,7 +170,7 @@
|
|
|
170
170
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">responseType</span>: <span class="tsd-signature-type">"body"</span></h5></li></ul></div>
|
|
171
171
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseBody</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
172
172
|
<ul>
|
|
173
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
173
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L71">sdk/packages/api/src/Base.ts:71</a></li></ul></aside></li>
|
|
174
174
|
<li class="tsd-signature tsd-anchor-link" id="deleteEndpoint.deleteEndpoint-3"><span class="tsd-kind-call-signature">delete<wbr/>Endpoint</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endPoint</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">responseType</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseTuple</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteEndpoint.deleteEndpoint-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
175
175
|
<li class="tsd-description">
|
|
176
176
|
<section class="tsd-panel">
|
|
@@ -187,7 +187,7 @@
|
|
|
187
187
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">responseType</span>: <span class="tsd-signature-type">"tuple"</span></h5></li></ul></div>
|
|
188
188
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseTuple</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
189
189
|
<ul>
|
|
190
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
190
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L72">sdk/packages/api/src/Base.ts:72</a></li></ul></aside></li></ul></section>
|
|
191
191
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="getEndpoint" class="tsd-anchor"></a>
|
|
192
192
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Endpoint</span><a href="#getEndpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
193
193
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -205,7 +205,7 @@
|
|
|
205
205
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">endPoint</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
206
206
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseBody</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
207
207
|
<ul>
|
|
208
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
208
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L80">sdk/packages/api/src/Base.ts:80</a></li></ul></aside></li>
|
|
209
209
|
<li class="tsd-signature tsd-anchor-link" id="getEndpoint.getEndpoint-2"><span class="tsd-kind-call-signature">get<wbr/>Endpoint</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endPoint</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">responseType</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseBody</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getEndpoint.getEndpoint-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
210
210
|
<li class="tsd-description">
|
|
211
211
|
<section class="tsd-panel">
|
|
@@ -222,7 +222,7 @@
|
|
|
222
222
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">responseType</span>: <span class="tsd-signature-type">"body"</span></h5></li></ul></div>
|
|
223
223
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseBody</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
224
224
|
<ul>
|
|
225
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
225
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L81">sdk/packages/api/src/Base.ts:81</a></li></ul></aside></li>
|
|
226
226
|
<li class="tsd-signature tsd-anchor-link" id="getEndpoint.getEndpoint-3"><span class="tsd-kind-call-signature">get<wbr/>Endpoint</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endPoint</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">responseType</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseTuple</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getEndpoint.getEndpoint-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
227
227
|
<li class="tsd-description">
|
|
228
228
|
<section class="tsd-panel">
|
|
@@ -239,7 +239,7 @@
|
|
|
239
239
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">responseType</span>: <span class="tsd-signature-type">"tuple"</span></h5></li></ul></div>
|
|
240
240
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseTuple</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
241
241
|
<ul>
|
|
242
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
242
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L82">sdk/packages/api/src/Base.ts:82</a></li></ul></aside></li></ul></section>
|
|
243
243
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="handleMonitorResponseError" class="tsd-anchor"></a>
|
|
244
244
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>handle<wbr/>Monitor<wbr/>Response<wbr/>Error</span><a href="#handleMonitorResponseError" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
245
245
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -259,7 +259,7 @@
|
|
|
259
259
|
<h5><span class="tsd-kind-parameter">trapAxiosException</span>: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
|
|
260
260
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">XyoApiResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiEnvelope</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
261
261
|
<ul>
|
|
262
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
262
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L90">sdk/packages/api/src/Base.ts:90</a></li></ul></aside></li></ul></section>
|
|
263
263
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="monitorResponse" class="tsd-anchor"></a>
|
|
264
264
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>monitor<wbr/>Response</span><a href="#monitorResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
265
265
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -283,7 +283,7 @@
|
|
|
283
283
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiEnvelope</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul></div>
|
|
284
284
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">XyoApiResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiEnvelope</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
285
285
|
<ul>
|
|
286
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
286
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L104">sdk/packages/api/src/Base.ts:104</a></li></ul></aside></li></ul></section>
|
|
287
287
|
<section class="tsd-panel tsd-member"><a id="onError" class="tsd-anchor"></a>
|
|
288
288
|
<h3 class="tsd-anchor-link"><span>on<wbr/>Error</span><a href="#onError" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
289
289
|
<ul class="tsd-signatures">
|
|
@@ -299,7 +299,7 @@
|
|
|
299
299
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
300
300
|
<p>Implementation of XyoApiReportable.onError</p>
|
|
301
301
|
<ul>
|
|
302
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
302
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L55">sdk/packages/api/src/Base.ts:55</a></li></ul></aside></li></ul></section>
|
|
303
303
|
<section class="tsd-panel tsd-member"><a id="onFailure" class="tsd-anchor"></a>
|
|
304
304
|
<h3 class="tsd-anchor-link"><span>on<wbr/>Failure</span><a href="#onFailure" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
305
305
|
<ul class="tsd-signatures">
|
|
@@ -315,7 +315,7 @@
|
|
|
315
315
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
316
316
|
<p>Implementation of XyoApiReportable.onFailure</p>
|
|
317
317
|
<ul>
|
|
318
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
318
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L60">sdk/packages/api/src/Base.ts:60</a></li></ul></aside></li></ul></section>
|
|
319
319
|
<section class="tsd-panel tsd-member"><a id="onSuccess" class="tsd-anchor"></a>
|
|
320
320
|
<h3 class="tsd-anchor-link"><span>on<wbr/>Success</span><a href="#onSuccess" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
321
321
|
<ul class="tsd-signatures">
|
|
@@ -331,7 +331,7 @@
|
|
|
331
331
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
332
332
|
<p>Implementation of XyoApiReportable.onSuccess</p>
|
|
333
333
|
<ul>
|
|
334
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
334
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L65">sdk/packages/api/src/Base.ts:65</a></li></ul></aside></li></ul></section>
|
|
335
335
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="postEndpoint" class="tsd-anchor"></a>
|
|
336
336
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>post<wbr/>Endpoint</span><a href="#postEndpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
337
337
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -353,7 +353,7 @@
|
|
|
353
353
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type tsd-kind-type-parameter">D</span></h5></li></ul></div>
|
|
354
354
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseBody</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
355
355
|
<ul>
|
|
356
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
356
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L119">sdk/packages/api/src/Base.ts:119</a></li></ul></aside></li>
|
|
357
357
|
<li class="tsd-signature tsd-anchor-link" id="postEndpoint.postEndpoint-2"><span class="tsd-kind-call-signature">post<wbr/>Endpoint</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">D</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endPoint</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">responseType</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseBody</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#postEndpoint.postEndpoint-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
358
358
|
<li class="tsd-description">
|
|
359
359
|
<section class="tsd-panel">
|
|
@@ -374,7 +374,7 @@
|
|
|
374
374
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">responseType</span>: <span class="tsd-signature-type">"body"</span></h5></li></ul></div>
|
|
375
375
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseBody</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
376
376
|
<ul>
|
|
377
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
377
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L120">sdk/packages/api/src/Base.ts:120</a></li></ul></aside></li>
|
|
378
378
|
<li class="tsd-signature tsd-anchor-link" id="postEndpoint.postEndpoint-3"><span class="tsd-kind-call-signature">post<wbr/>Endpoint</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">D</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endPoint</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">responseType</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseTuple</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#postEndpoint.postEndpoint-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
379
379
|
<li class="tsd-description">
|
|
380
380
|
<section class="tsd-panel">
|
|
@@ -395,7 +395,7 @@
|
|
|
395
395
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">responseType</span>: <span class="tsd-signature-type">"tuple"</span></h5></li></ul></div>
|
|
396
396
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseTuple</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
397
397
|
<ul>
|
|
398
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
398
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L121">sdk/packages/api/src/Base.ts:121</a></li></ul></aside></li></ul></section>
|
|
399
399
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="putEndpoint" class="tsd-anchor"></a>
|
|
400
400
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>put<wbr/>Endpoint</span><a href="#putEndpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
401
401
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -417,7 +417,7 @@
|
|
|
417
417
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type tsd-kind-type-parameter">D</span></h5></li></ul></div>
|
|
418
418
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseBody</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
419
419
|
<ul>
|
|
420
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
420
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L133">sdk/packages/api/src/Base.ts:133</a></li></ul></aside></li>
|
|
421
421
|
<li class="tsd-signature tsd-anchor-link" id="putEndpoint.putEndpoint-2"><span class="tsd-kind-call-signature">put<wbr/>Endpoint</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">D</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endPoint</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">responseType</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseBody</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#putEndpoint.putEndpoint-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
422
422
|
<li class="tsd-description">
|
|
423
423
|
<section class="tsd-panel">
|
|
@@ -438,7 +438,7 @@
|
|
|
438
438
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">responseType</span>: <span class="tsd-signature-type">"body"</span></h5></li></ul></div>
|
|
439
439
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseBody</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
440
440
|
<ul>
|
|
441
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
441
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L134">sdk/packages/api/src/Base.ts:134</a></li></ul></aside></li>
|
|
442
442
|
<li class="tsd-signature tsd-anchor-link" id="putEndpoint.putEndpoint-3"><span class="tsd-kind-call-signature">put<wbr/>Endpoint</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">D</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endPoint</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">responseType</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseTuple</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#putEndpoint.putEndpoint-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
443
443
|
<li class="tsd-description">
|
|
444
444
|
<section class="tsd-panel">
|
|
@@ -459,7 +459,7 @@
|
|
|
459
459
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">responseType</span>: <span class="tsd-signature-type">"tuple"</span></h5></li></ul></div>
|
|
460
460
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiResponseTuple</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
461
461
|
<ul>
|
|
462
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
462
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L135">sdk/packages/api/src/Base.ts:135</a></li></ul></aside></li></ul></section>
|
|
463
463
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="resolveRoot" class="tsd-anchor"></a>
|
|
464
464
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>resolve<wbr/>Root</span><a href="#resolveRoot" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
465
465
|
<ul class="tsd-signatures tsd-is-private">
|
|
@@ -467,7 +467,7 @@
|
|
|
467
467
|
<li class="tsd-description">
|
|
468
468
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
469
469
|
<ul>
|
|
470
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
470
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L147">sdk/packages/api/src/Base.ts:147</a></li></ul></aside></li></ul></section>
|
|
471
471
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="resolveResponse" class="tsd-anchor"></a>
|
|
472
472
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>resolve<wbr/>Response</span><a href="#resolveResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
473
473
|
<ul class="tsd-signatures tsd-is-private">
|
|
@@ -485,7 +485,7 @@
|
|
|
485
485
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">result</span>: <span class="tsd-signature-type ">XyoApiResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">XyoApiEnvelope</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
486
486
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">XyoApiResponseTuple</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
487
487
|
<ul>
|
|
488
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
488
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L46">sdk/packages/api/src/Base.ts:46</a></li></ul></aside></li></ul></section>
|
|
489
489
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="shapeResponse" class="tsd-anchor"></a>
|
|
490
490
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>shape<wbr/>Response</span><a href="#shapeResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
491
491
|
<ul class="tsd-signatures tsd-is-private">
|
|
@@ -505,7 +505,7 @@
|
|
|
505
505
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">responseType</span>: <span class="tsd-signature-type ">XyoApiResponseType</span></h5></li></ul></div>
|
|
506
506
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">XyoApiResponseTuple</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
507
507
|
<ul>
|
|
508
|
-
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/
|
|
508
|
+
<li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e991956c/packages/sdk/packages/api/src/Base.ts#L50">sdk/packages/api/src/Base.ts:50</a></li></ul></aside></li></ul></section></section></div>
|
|
509
509
|
<div class="col-sidebar">
|
|
510
510
|
<div class="page-menu">
|
|
511
511
|
<div class="tsd-navigation settings">
|