UNPKG

14.1 kBHTMLView Raw
1<!doctype html>
2<html class="default no-js">
3<head>
4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <title>@motionpicture/coa-service</title>
7 <meta name="description" content="">
8 <meta name="viewport" content="width=device-width, initial-scale=1">
9 <link rel="stylesheet" href="assets/css/main.css">
10</head>
11<body>
12<header>
13 <div class="tsd-page-toolbar">
14 <div class="container">
15 <div class="table-wrap">
16 <div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
17 <div class="field">
18 <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19 <input id="tsd-search-field" type="text" />
20 </div>
21 <ul class="results">
22 <li class="state loading">Preparing search index...</li>
23 <li class="state failure">The search index is not available</li>
24 </ul>
25 <a href="index.html" class="title">@motionpicture/coa-service</a>
26 </div>
27 <div class="table-cell" id="tsd-widgets">
28 <div id="tsd-filter">
29 <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30 <div class="tsd-filter-group">
31 <div class="tsd-select" id="tsd-filter-visibility">
32 <span class="tsd-select-label">All</span>
33 <ul class="tsd-select-list">
34 <li data-value="public">Public</li>
35 <li data-value="protected">Public/Protected</li>
36 <li data-value="private" class="selected">All</li>
37 </ul>
38 </div>
39 <input type="checkbox" id="tsd-filter-inherited" checked />
40 <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41 <input type="checkbox" id="tsd-filter-externals" checked />
42 <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43 <input type="checkbox" id="tsd-filter-only-exported" />
44 <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45 </div>
46 </div>
47 <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48 </div>
49 </div>
50 </div>
51 </div>
52 <div class="tsd-page-title">
53 <div class="container">
54 <ul class="tsd-breadcrumb">
55 <li>
56 <a href="globals.html">Globals</a>
57 </li>
58 </ul>
59 <h1> @motionpicture/coa-service</h1>
60 </div>
61 </div>
62</header>
63<div class="container container-main">
64 <div class="row">
65 <div class="col-8 col-content">
66 <div class="tsd-panel tsd-typography">
67 <h1 id="coa-client-library-for-node-js">COA client library for Node.js</h1>
68 <p><a href="https://www.npmjs.com/package/@motionpicture/coa-service"><img src="https://img.shields.io/npm/v/@motionpicture/coa-service.svg" alt="npm (scoped)"></a>
69 <a href="https://circleci.com/gh/motionpicture/coa-service"><img src="https://circleci.com/gh/motionpicture/coa-service.svg?style=shield" alt="CircleCI"></a>
70 <a href="https://coveralls.io/github/motionpicture/coa-service?branch=master"><img src="https://coveralls.io/repos/github/motionpicture/coa-service/badge.svg?branch=master" alt="Coverage Status"></a>
71 <a href="https://david-dm.org/motionpicture/coa-service"><img src="https://img.shields.io/david/motionpicture/coa-service.svg" alt="Dependency Status"></a>
72 <a href="https://snyk.io/test/github/motionpicture/coa-service"><img src="https://snyk.io/test/github/motionpicture/coa-service/badge.svg" alt="Known Vulnerabilities"></a>
73 <a href="https://nodei.co/npm/@motionpicture/coa-service/"><img src="https://img.shields.io/npm/dm/@motionpicture/coa-service.svg" alt="npm"></a></p>
74 <p>Node.jsでCOAサービスを使うためのライブラリです。</p>
75 <h2 id="table-of-contents">Table of contents</h2>
76 <ul>
77 <li><a href="#specification">Specification</a></li>
78 <li><a href="#usage">Usage</a></li>
79 <li><a href="#code-samples">Example</a></li>
80 <li><a href="#documentation">Documentation</a></li>
81 <li><a href="#license">License</a></li>
82 </ul>
83 <h2 id="specification">Specification</h2>
84 <p>COA APIの仕様で注意すべき点は以下の通りです。</p>
85 <ul>
86 <li>正常時レスポンスにはstatusが含まれるが、0以外のステータスはない。</li>
87 <li>カタカナは全角統一(半角はありえない)</li>
88 <li>仮予約番号と購入番号の型はnumberで統一。</li>
89 <li>座席番号は半角と全角を区別する、</li>
90 <li>購入番号は劇場内でユニーク、劇場コード合わせれば全体でユニーク。</li>
91 <li>購入番号は連番かどうか<ul>
92 <li>仮予約番号は連番だが、購入番号は仮予約番号と同じ番号。よって、仮予約で止めたり、仮予約のキャンセルが発生すると、空き番号が発生しうる。</li>
93 </ul>
94 </li>
95 <li>購入番号は最大8桁。 最大番号(99999999)を超える時点で１に戻る。</li>
96 <li>劇場コードは、基本的に3桁(001、018等)だが、場合によっては1桁や2桁（1、18等）の表示になっていることはあるかもしれない、とのこと。</li>
97 <li>座席の解放については、基幹システム側では何も行っていない。</li>
98 </ul>
99 <h2 id="usage">Usage</h2>
100 <pre><code class="lang-shell">npm install @motionpicture/coa-service
101</code></pre>
102 <pre><code class="lang-js"><span class="hljs-keyword">const</span> COA = <span class="hljs-built_in">require</span>(<span class="hljs-string">'@motionpicture/coa-service'</span>);
103</code></pre>
104 <h3 id="environment-variables">Environment variables</h3>
105 <table>
106 <thead>
107 <tr>
108 <th>Name</th>
109 <th>Required</th>
110 <th>Value</th>
111 <th>Purpose</th>
112 </tr>
113 </thead>
114 <tbody>
115 <tr>
116 <td><code>DEBUG</code></td>
117 <td>false</td>
118 <td>coa-service:*</td>
119 <td>Debug</td>
120 </tr>
121 </tbody>
122 </table>
123 <h3 id="-">劇場情報を取得する</h3>
124 <pre><code class="lang-js"><span class="hljs-keyword">const</span> COA = <span class="hljs-built_in">require</span>(<span class="hljs-string">'@motionpicture/coa-service'</span>);
125
126<span class="hljs-keyword">const</span> masterService = <span class="hljs-keyword">new</span> COA.service.Master({
127 <span class="hljs-attr">endpoint</span>: <span class="hljs-string">''</span>,
128 <span class="hljs-attr">auth</span>: <span class="hljs-keyword">new</span> COA.auth.RefreshTokenClient({
129 <span class="hljs-attr">endpoint</span>: <span class="hljs-string">''</span>,
130 <span class="hljs-attr">refreshToken</span>: <span class="hljs-string">''</span>
131 })
132});
133
134masterService.theater({
135 <span class="hljs-attr">theaterCode</span>: <span class="hljs-string">'123'</span>
136})
137 .then(<span class="hljs-built_in">console</span>.log)
138 .catch(<span class="hljs-built_in">console</span>.error);
139</code></pre>
140 <h2 id="code-samples">Code Samples</h2>
141 <p>Code sample are <a href="https://github.com/motionpicture/coa-service/tree/master/example">here</a>.</p>
142 <h2 id="documentation">Documentation</h2>
143 <p><code>npm run doc</code> emits typedoc to ./docs.</p>
144 <h2 id="license">License</h2>
145 <p>UNLICENSED</p>
146 </div>
147 </div>
148 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
149 <nav class="tsd-navigation primary">
150 <ul>
151 <li class="globals ">
152 <a href="globals.html"><em>Globals</em></a>
153 </li>
154 <li class=" tsd-kind-external-module">
155 <a href="modules/_auth_credentials_.html">"auth/credentials"</a>
156 </li>
157 <li class=" tsd-kind-external-module">
158 <a href="modules/_auth_refreshtokenclient_.html">"auth/refresh<wbr>Token<wbr>Client"</a>
159 </li>
160 <li class=" tsd-kind-external-module">
161 <a href="modules/_auth_refreshtokenclient_spec_.html">"auth/refresh<wbr>Token<wbr>Client.spec"</a>
162 </li>
163 <li class=" tsd-kind-external-module">
164 <a href="modules/_factory_.html">"factory"</a>
165 </li>
166 <li class=" tsd-kind-external-module">
167 <a href="modules/_factory_master_.html">"factory/master"</a>
168 </li>
169 <li class=" tsd-kind-external-module">
170 <a href="modules/_factory_reserve_.html">"factory/reserve"</a>
171 </li>
172 <li class=" tsd-kind-external-module">
173 <a href="modules/_index_.html">"index"</a>
174 </li>
175 <li class=" tsd-kind-external-module">
176 <a href="modules/_service_.html">"service"</a>
177 </li>
178 <li class=" tsd-kind-external-module">
179 <a href="modules/_service_master_.html">"service/master"</a>
180 </li>
181 <li class=" tsd-kind-external-module">
182 <a href="modules/_service_master_spec_.html">"service/master.spec"</a>
183 </li>
184 <li class=" tsd-kind-external-module">
185 <a href="modules/_service_reserve_.html">"service/reserve"</a>
186 </li>
187 <li class=" tsd-kind-external-module">
188 <a href="modules/_service_reserve_spec_.html">"service/reserve.spec"</a>
189 </li>
190 <li class=" tsd-kind-external-module">
191 <a href="modules/_transporters_.html">"transporters"</a>
192 </li>
193 <li class=" tsd-kind-external-module">
194 <a href="modules/_transporters_spec_.html">"transporters.spec"</a>
195 </li>
196 </ul>
197 </nav>
198 <nav class="tsd-navigation secondary menu-sticky">
199 <ul class="before-current">
200 </ul>
201 </nav>
202 </div>
203 </div>
204</div>
205<footer class="with-border-bottom">
206 <div class="container">
207 <h2>Legend</h2>
208 <div class="tsd-legend-group">
209 <ul class="tsd-legend">
210 <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
211 <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
212 <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
213 <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
214 <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
215 <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
216 <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
217 </ul>
218 <ul class="tsd-legend">
219 <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
220 <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
221 <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
222 <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
223 </ul>
224 <ul class="tsd-legend">
225 <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
226 <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
227 <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
228 <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
229 <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
230 <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
231 </ul>
232 <ul class="tsd-legend">
233 <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
234 <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
235 <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
236 <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
237 <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
238 <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
239 <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
240 </ul>
241 <ul class="tsd-legend">
242 <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
243 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
244 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
245 <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
246 </ul>
247 <ul class="tsd-legend">
248 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
249 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
250 <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
251 </ul>
252 <ul class="tsd-legend">
253 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
254 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
255 <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
256 </ul>
257 <ul class="tsd-legend">
258 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
259 <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
260 </ul>
261 </div>
262 </div>
263</footer>
264<div class="container tsd-generator">
265 <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
266</div>
267<div class="overlay"></div>
268<script src="assets/js/main.js"></script>
269<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
270</body>
271</html>
\No newline at end of file