Skip to content

Commit 6570d4f

Browse files
committed
Update SDK API References
1 parent 38f3f5d commit 6570d4f

File tree

146 files changed

+8421
-2495
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

146 files changed

+8421
-2495
lines changed

docs/assets/main.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/style.css

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -825,6 +825,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
825825
padding-left: 5.5rem;
826826
}
827827

828+
#tsd-sidebar-links a {
829+
margin-top: 0;
830+
margin-bottom: 0.5rem;
831+
line-height: 1.25rem;
832+
}
833+
#tsd-sidebar-links a:last-of-type {
834+
margin-bottom: 0;
835+
}
836+
828837
a.tsd-index-link {
829838
margin: 0.25rem 0;
830839
font-size: 1rem;
@@ -978,7 +987,8 @@ a.tsd-index-link {
978987
right: -40px;
979988
}
980989
#tsd-search .field input,
981-
#tsd-search .title {
990+
#tsd-search .title,
991+
#tsd-toolbar-links a {
982992
transition: opacity 0.2s;
983993
}
984994
#tsd-search .results {
@@ -1022,7 +1032,8 @@ a.tsd-index-link {
10221032
top: 0;
10231033
opacity: 1;
10241034
}
1025-
#tsd-search.has-focus .title {
1035+
#tsd-search.has-focus .title,
1036+
#tsd-search.has-focus #tsd-toolbar-links a {
10261037
z-index: 0;
10271038
opacity: 0;
10281039
}
@@ -1036,6 +1047,22 @@ a.tsd-index-link {
10361047
display: block;
10371048
}
10381049

1050+
#tsd-toolbar-links {
1051+
position: absolute;
1052+
top: 0;
1053+
right: 2rem;
1054+
height: 100%;
1055+
display: flex;
1056+
align-items: center;
1057+
justify-content: flex-end;
1058+
}
1059+
#tsd-toolbar-links a {
1060+
margin-left: 1.5rem;
1061+
}
1062+
#tsd-toolbar-links a:hover {
1063+
text-decoration: underline;
1064+
}
1065+
10391066
.tsd-signature {
10401067
margin: 0 0 1rem 0;
10411068
padding: 1rem 0.5rem;
@@ -1134,6 +1161,11 @@ ul.tsd-type-parameter-list h5 {
11341161
.tsd-page-toolbar .table-cell:first-child {
11351162
width: 100%;
11361163
}
1164+
.tsd-page-toolbar .tsd-toolbar-icon {
1165+
box-sizing: border-box;
1166+
line-height: 0;
1167+
padding: 12px 0;
1168+
}
11371169

11381170
.tsd-page-toolbar--hide {
11391171
transform: translateY(-100%);

docs/classes/errors_defaultError.ApiKeyError.html

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ApiKeyError | solapi</title><meta name="description" content="Documentation for solapi"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
22
<div class="tsd-toolbar-contents container">
33
<div class="table-cell" id="tsd-search" data-base="..">
4-
<div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
4+
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5+
<div class="field">
6+
<div id="tsd-toolbar-links"></div></div>
57
<ul class="results">
68
<li class="state loading">Preparing search index...</li>
79
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">solapi</a></div>
8-
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
10+
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
911
<div class="container container-main">
1012
<div class="col-8 col-content">
1113
<div class="tsd-page-title">
@@ -21,7 +23,7 @@ <h4>Hierarchy</h4>
2123
<ul class="tsd-hierarchy">
2224
<li><span class="target">ApiKeyError</span></li></ul></li></ul></section><aside class="tsd-sources">
2325
<ul>
24-
<li>Defined in <a href="https://github.com/solapi/solapi-nodejs/blob/90cef4e/src/errors/defaultError.ts#L15">src/errors/defaultError.ts:15</a></li></ul></aside>
26+
<li>Defined in <a href="https://github.com/solapi/solapi-nodejs/blob/38f3f5d/src/errors/defaultError.ts#L15">src/errors/defaultError.ts:15</a></li></ul></aside>
2527
<section class="tsd-panel-group tsd-index-group">
2628
<section class="tsd-panel tsd-index-panel">
2729
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -58,27 +60,27 @@ <h5>message: <span class="tsd-signature-type">string</span></h5></li></ul></div>
5860
<h4 class="tsd-returns-title">Returns <a href="errors_defaultError.ApiKeyError.html" class="tsd-signature-type" data-tsd-kind="Class">ApiKeyError</a></h4><aside class="tsd-sources">
5961
<p>Overrides Error.constructor</p>
6062
<ul>
61-
<li>Defined in <a href="https://github.com/solapi/solapi-nodejs/blob/90cef4e/src/errors/defaultError.ts#L16">src/errors/defaultError.ts:16</a></li></ul></aside></li></ul></section></section>
63+
<li>Defined in <a href="https://github.com/solapi/solapi-nodejs/blob/38f3f5d/src/errors/defaultError.ts#L16">src/errors/defaultError.ts:16</a></li></ul></aside></li></ul></section></section>
6264
<section class="tsd-panel-group tsd-member-group">
6365
<h2>Properties</h2>
6466
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
6567
<h3 class="tsd-anchor-link"><span>message</span><a href="#message" 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>
6668
<div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
6769
<p>Inherited from Error.message</p>
6870
<ul>
69-
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1041</li></ul></aside></section>
71+
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1054</li></ul></aside></section>
7072
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a>
7173
<h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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>
7274
<div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
7375
<p>Inherited from Error.name</p>
7476
<ul>
75-
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1040</li></ul></aside></section>
77+
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1053</li></ul></aside></section>
7678
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
7779
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" 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>
7880
<div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
7981
<p>Inherited from Error.stack</p>
8082
<ul>
81-
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1042</li></ul></aside></section>
83+
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1055</li></ul></aside></section>
8284
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
8385
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" 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>
8486
<div class="tsd-signature">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>
@@ -154,15 +156,27 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
154156
<li class="current tsd-kind-module"><a href="../modules/errors_defaultError.html">errors/default<wbr/>Error</a></li>
155157
<li class="tsd-kind-module"><a href="../modules/lib_authenticator.html">lib/authenticator</a></li>
156158
<li class="tsd-kind-module"><a href="../modules/lib_defaultFetcher.html">lib/default<wbr/>Fetcher</a></li>
157-
<li class="tsd-kind-module"><a href="../modules/lib_queryParameterGenerator.html">lib/query<wbr/>Parameter<wbr/>Generator</a></li>
158159
<li class="tsd-kind-module"><a href="../modules/lib_stringDateTrasnfer.html">lib/string<wbr/>Date<wbr/>Trasnfer</a></li>
159160
<li class="tsd-kind-module"><a href="../modules/models_kakao_kakaoAlimtalkTemplate.html">models/kakao/kakao<wbr/>Alimtalk<wbr/>Template</a></li>
161+
<li class="tsd-kind-module"><a href="../modules/models_kakao_kakaoAlimtalkTemplateQuickReply.html">models/kakao/kakao<wbr/>Alimtalk<wbr/>Template<wbr/>Quick<wbr/>Reply</a></li>
160162
<li class="tsd-kind-module"><a href="../modules/models_kakao_kakaoButton.html">models/kakao/kakao<wbr/>Button</a></li>
161163
<li class="tsd-kind-module"><a href="../modules/models_kakao_kakaoChannel.html">models/kakao/kakao<wbr/>Channel</a></li>
162164
<li class="tsd-kind-module"><a href="../modules/models_kakao_kakaoOption.html">models/kakao/kakao<wbr/>Option</a></li>
163165
<li class="tsd-kind-module"><a href="../modules/models_message.html">models/message</a></li>
166+
<li class="tsd-kind-module"><a href="../modules/requests_kakao_createKakaoAlimtalkTemplateRequest.html">requests/kakao/create<wbr/>Kakao<wbr/>Alimtalk<wbr/>Template<wbr/>Request</a></li>
167+
<li class="tsd-kind-module"><a href="../modules/requests_kakao_getKakaoAlimtalkTemplatesRequest.html">requests/kakao/get<wbr/>Kakao<wbr/>Alimtalk<wbr/>Templates<wbr/>Request</a></li>
168+
<li class="tsd-kind-module"><a href="../modules/requests_kakao_getKakaoChannelsRequest.html">requests/kakao/get<wbr/>Kakao<wbr/>Channels<wbr/>Request</a></li>
169+
<li class="tsd-kind-module"><a href="../modules/requests_kakao_updateKakaoAlimtalkTemplateRequest.html">requests/kakao/update<wbr/>Kakao<wbr/>Alimtalk<wbr/>Template<wbr/>Request</a></li>
164170
<li class="tsd-kind-module"><a href="../modules/requests_messageRequest.html">requests/message<wbr/>Request</a></li>
171+
<li class="tsd-kind-module"><a href="../modules/requests_messages_getMessagesRequest.html">requests/messages/get<wbr/>Messages<wbr/>Request</a></li>
172+
<li class="tsd-kind-module"><a href="../modules/requests_messages_groups_getGroupsRequest.html">requests/messages/groups/get<wbr/>Groups<wbr/>Request</a></li>
173+
<li class="tsd-kind-module"><a href="../modules/requests_messages_statistics_getStatisticsRequest.html">requests/messages/statistics/get<wbr/>Statistics<wbr/>Request</a></li>
174+
<li class="tsd-kind-module"><a href="../modules/requests_sendRequestConfig.html">requests/send<wbr/>Request<wbr/>Config</a></li>
175+
<li class="tsd-kind-module"><a href="../modules/responses_kakao_getKakaoAlimtalkTemplatesResponse.html">responses/kakao/get<wbr/>Kakao<wbr/>Alimtalk<wbr/>Templates<wbr/>Response</a></li>
176+
<li class="tsd-kind-module"><a href="../modules/responses_kakao_getKakaoChannelsResponse.html">responses/kakao/get<wbr/>Kakao<wbr/>Channels<wbr/>Response</a></li>
177+
<li class="tsd-kind-module"><a href="../modules/responses_kakao_getKakaoTemplateResponse.html">responses/kakao/get<wbr/>Kakao<wbr/>Template<wbr/>Response</a></li>
165178
<li class="tsd-kind-module"><a href="../modules/responses_messageResponses.html">responses/message<wbr/>Responses</a></li>
179+
<li class="tsd-kind-module"><a href="../modules/responses_sendManyDetailResponse.html">responses/send<wbr/>Many<wbr/>Detail<wbr/>Response</a></li>
166180
<li class="tsd-kind-module"><a href="../modules/solapi.html">solapi</a></li>
167181
<li class="tsd-kind-module"><a href="../modules/types_commonTypes.html">types/common<wbr/>Types</a></li></ul></li></ul></div></details></nav>
168182
<nav class="tsd-navigation secondary menu-sticky">

0 commit comments

Comments
 (0)