· 5 years ago · Aug 04, 2020, 05:46 PM
1{
2 "openapi" : "3.0.0",
3 "info" : {
4 "title" : "Billingo API v3",
5 "description" : "This is a Billingo API v3 documentation. Our API based on REST software architectural style. API has resource-oriented URLs, accepts JSON-encoded request bodies and returns JSON-encoded responses. To use this API you have to generate a new API key on our [site](https://app.billingo.hu/api-key). After that, you can test your API key on this page.",
6 "termsOfService" : "https://www.billingo.hu/felhasznalasi-feltetelek",
7 "contact" : {
8 "name" : "Billingo Support",
9 "url" : "https://www.billingo.hu/kapcsolat",
10 "email" : "hello@billingo.hu"
11 },
12 "version" : "3.0.8"
13 },
14 "externalDocs" : {
15 "description" : "Find out more information about Billingo API v3 usage.",
16 "url" : "https://support.billingo.hu/content/446136358"
17 },
18 "servers" : [ {
19 "url" : "https://api.billingo.hu/v3",
20 "description" : "Billingo API"
21 } ],
22 "security" : [ {
23 "api_key" : [ ]
24 } ],
25 "tags" : [ {
26 "name" : "Document",
27 "description" : "Document object represents your invoice."
28 }, {
29 "name" : "DocumentBlock",
30 "description" : "DocumentBlock object represents your invoice pad."
31 }, {
32 "name" : "Partner",
33 "description" : "Partner object represents your client."
34 }, {
35 "name" : "Product",
36 "description" : "Product object represents your document's product."
37 }, {
38 "name" : "BankAccount",
39 "description" : "BankAccount object represents your bank account information."
40 } ],
41 "paths" : {
42 "/bank-accounts" : {
43 "get" : {
44 "tags" : [ "BankAccount" ],
45 "summary" : "List all bank account",
46 "description" : "Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recent bank account appearing first.",
47 "operationId" : "ListBankAccount",
48 "parameters" : [ {
49 "name" : "page",
50 "in" : "query",
51 "required" : false,
52 "style" : "form",
53 "explode" : true,
54 "schema" : {
55 "type" : "integer"
56 }
57 }, {
58 "name" : "per_page",
59 "in" : "query",
60 "required" : false,
61 "style" : "form",
62 "explode" : true,
63 "schema" : {
64 "maximum" : 100,
65 "minimum" : 1,
66 "type" : "integer",
67 "default" : 25
68 }
69 } ],
70 "responses" : {
71 "200" : {
72 "description" : "Success response",
73 "headers" : {
74 "X-RateLimit-Limit" : {
75 "description" : "Request limit per minute.",
76 "style" : "simple",
77 "explode" : false,
78 "schema" : {
79 "type" : "integer",
80 "format" : "int32"
81 }
82 },
83 "X-RateLimit-Remaining" : {
84 "description" : "The number of requests left for the time window.",
85 "style" : "simple",
86 "explode" : false,
87 "schema" : {
88 "type" : "integer",
89 "format" : "int32"
90 }
91 },
92 "X-RateLimit-Reset" : {
93 "description" : "The timestamp at which the current rate limit window resets.",
94 "style" : "simple",
95 "explode" : false,
96 "schema" : {
97 "type" : "integer",
98 "format" : "int32"
99 }
100 },
101 "Retry-After" : {
102 "description" : "How many seconds you have to wait before making new request.",
103 "style" : "simple",
104 "explode" : false,
105 "schema" : {
106 "type" : "integer",
107 "format" : "int32"
108 }
109 }
110 },
111 "content" : {
112 "application/json" : {
113 "schema" : {
114 "$ref" : "#/components/schemas/BankAccountList"
115 }
116 }
117 }
118 },
119 "400" : {
120 "description" : "The request is malformed.",
121 "headers" : {
122 "X-RateLimit-Limit" : {
123 "description" : "Request limit per minute.",
124 "style" : "simple",
125 "explode" : false,
126 "schema" : {
127 "type" : "integer",
128 "format" : "int32"
129 }
130 },
131 "X-RateLimit-Remaining" : {
132 "description" : "The number of requests left for the time window.",
133 "style" : "simple",
134 "explode" : false,
135 "schema" : {
136 "type" : "integer",
137 "format" : "int32"
138 }
139 },
140 "X-RateLimit-Reset" : {
141 "description" : "The timestamp at which the current rate limit window resets.",
142 "style" : "simple",
143 "explode" : false,
144 "schema" : {
145 "type" : "integer",
146 "format" : "int32"
147 }
148 },
149 "Retry-After" : {
150 "description" : "How many seconds you have to wait before making new request.",
151 "style" : "simple",
152 "explode" : false,
153 "schema" : {
154 "type" : "integer",
155 "format" : "int32"
156 }
157 }
158 },
159 "content" : {
160 "application/json" : {
161 "schema" : {
162 "$ref" : "#/components/schemas/ClientErrorResponse"
163 }
164 }
165 }
166 },
167 "401" : {
168 "description" : "Authorization information is missing or invalid.",
169 "headers" : {
170 "X-RateLimit-Limit" : {
171 "description" : "Request limit per minute.",
172 "style" : "simple",
173 "explode" : false,
174 "schema" : {
175 "type" : "integer",
176 "format" : "int32"
177 }
178 },
179 "X-RateLimit-Remaining" : {
180 "description" : "The number of requests left for the time window.",
181 "style" : "simple",
182 "explode" : false,
183 "schema" : {
184 "type" : "integer",
185 "format" : "int32"
186 }
187 },
188 "X-RateLimit-Reset" : {
189 "description" : "The timestamp at which the current rate limit window resets.",
190 "style" : "simple",
191 "explode" : false,
192 "schema" : {
193 "type" : "integer",
194 "format" : "int32"
195 }
196 },
197 "Retry-After" : {
198 "description" : "How many seconds you have to wait before making new request.",
199 "style" : "simple",
200 "explode" : false,
201 "schema" : {
202 "type" : "integer",
203 "format" : "int32"
204 }
205 }
206 },
207 "content" : {
208 "application/json" : {
209 "schema" : {
210 "$ref" : "#/components/schemas/ClientErrorResponse"
211 }
212 }
213 }
214 },
215 "402" : {
216 "description" : "Authenticated user doesn't have subscription.",
217 "content" : {
218 "application/json" : {
219 "schema" : {
220 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
221 }
222 }
223 }
224 },
225 "422" : {
226 "description" : "Validation errors occured.",
227 "headers" : {
228 "X-RateLimit-Limit" : {
229 "description" : "Request limit per minute.",
230 "style" : "simple",
231 "explode" : false,
232 "schema" : {
233 "type" : "integer",
234 "format" : "int32"
235 }
236 },
237 "X-RateLimit-Remaining" : {
238 "description" : "The number of requests left for the time window.",
239 "style" : "simple",
240 "explode" : false,
241 "schema" : {
242 "type" : "integer",
243 "format" : "int32"
244 }
245 },
246 "X-RateLimit-Reset" : {
247 "description" : "The timestamp at which the current rate limit window resets.",
248 "style" : "simple",
249 "explode" : false,
250 "schema" : {
251 "type" : "integer",
252 "format" : "int32"
253 }
254 },
255 "Retry-After" : {
256 "description" : "How many seconds you have to wait before making new request.",
257 "style" : "simple",
258 "explode" : false,
259 "schema" : {
260 "type" : "integer",
261 "format" : "int32"
262 }
263 }
264 },
265 "content" : {
266 "application/json" : {
267 "schema" : {
268 "$ref" : "#/components/schemas/ValidationErrorResponse"
269 }
270 }
271 }
272 },
273 "500" : {
274 "description" : "Internal server error.",
275 "headers" : {
276 "X-RateLimit-Limit" : {
277 "description" : "Request limit per minute.",
278 "style" : "simple",
279 "explode" : false,
280 "schema" : {
281 "type" : "integer",
282 "format" : "int32"
283 }
284 },
285 "X-RateLimit-Remaining" : {
286 "description" : "The number of requests left for the time window.",
287 "style" : "simple",
288 "explode" : false,
289 "schema" : {
290 "type" : "integer",
291 "format" : "int32"
292 }
293 },
294 "X-RateLimit-Reset" : {
295 "description" : "The timestamp at which the current rate limit window resets.",
296 "style" : "simple",
297 "explode" : false,
298 "schema" : {
299 "type" : "integer",
300 "format" : "int32"
301 }
302 },
303 "Retry-After" : {
304 "description" : "How many seconds you have to wait before making new request.",
305 "style" : "simple",
306 "explode" : false,
307 "schema" : {
308 "type" : "integer",
309 "format" : "int32"
310 }
311 }
312 },
313 "content" : {
314 "application/json" : {
315 "schema" : {
316 "$ref" : "#/components/schemas/ServerErrorResponse"
317 }
318 }
319 }
320 }
321 }
322 },
323 "post" : {
324 "tags" : [ "BankAccount" ],
325 "summary" : "Create a bank account",
326 "description" : "Create a new bank account. Returns a bank account object if the create is succeded.",
327 "operationId" : "CreateBankAccount",
328 "requestBody" : {
329 "description" : "BankAccount object that you would like to store.",
330 "content" : {
331 "application/json" : {
332 "schema" : {
333 "$ref" : "#/components/schemas/BankAccount"
334 }
335 }
336 },
337 "required" : true
338 },
339 "responses" : {
340 "201" : {
341 "description" : "BankAccount created successfully.",
342 "headers" : {
343 "X-RateLimit-Limit" : {
344 "description" : "Request limit per minute.",
345 "style" : "simple",
346 "explode" : false,
347 "schema" : {
348 "type" : "integer",
349 "format" : "int32"
350 }
351 },
352 "X-RateLimit-Remaining" : {
353 "description" : "The number of requests left for the time window.",
354 "style" : "simple",
355 "explode" : false,
356 "schema" : {
357 "type" : "integer",
358 "format" : "int32"
359 }
360 },
361 "X-RateLimit-Reset" : {
362 "description" : "The timestamp at which the current rate limit window resets.",
363 "style" : "simple",
364 "explode" : false,
365 "schema" : {
366 "type" : "integer",
367 "format" : "int32"
368 }
369 },
370 "Retry-After" : {
371 "description" : "How many seconds you have to wait before making new request.",
372 "style" : "simple",
373 "explode" : false,
374 "schema" : {
375 "type" : "integer",
376 "format" : "int32"
377 }
378 }
379 },
380 "content" : {
381 "application/json" : {
382 "schema" : {
383 "$ref" : "#/components/schemas/BankAccount"
384 }
385 }
386 }
387 },
388 "400" : {
389 "description" : "The request is malformed.",
390 "headers" : {
391 "X-RateLimit-Limit" : {
392 "description" : "Request limit per minute.",
393 "style" : "simple",
394 "explode" : false,
395 "schema" : {
396 "type" : "integer",
397 "format" : "int32"
398 }
399 },
400 "X-RateLimit-Remaining" : {
401 "description" : "The number of requests left for the time window.",
402 "style" : "simple",
403 "explode" : false,
404 "schema" : {
405 "type" : "integer",
406 "format" : "int32"
407 }
408 },
409 "X-RateLimit-Reset" : {
410 "description" : "The timestamp at which the current rate limit window resets.",
411 "style" : "simple",
412 "explode" : false,
413 "schema" : {
414 "type" : "integer",
415 "format" : "int32"
416 }
417 },
418 "Retry-After" : {
419 "description" : "How many seconds you have to wait before making new request.",
420 "style" : "simple",
421 "explode" : false,
422 "schema" : {
423 "type" : "integer",
424 "format" : "int32"
425 }
426 }
427 },
428 "content" : {
429 "application/json" : {
430 "schema" : {
431 "$ref" : "#/components/schemas/ClientErrorResponse"
432 }
433 }
434 }
435 },
436 "401" : {
437 "description" : "Authorization information is missing or invalid.",
438 "headers" : {
439 "X-RateLimit-Limit" : {
440 "description" : "Request limit per minute.",
441 "style" : "simple",
442 "explode" : false,
443 "schema" : {
444 "type" : "integer",
445 "format" : "int32"
446 }
447 },
448 "X-RateLimit-Remaining" : {
449 "description" : "The number of requests left for the time window.",
450 "style" : "simple",
451 "explode" : false,
452 "schema" : {
453 "type" : "integer",
454 "format" : "int32"
455 }
456 },
457 "X-RateLimit-Reset" : {
458 "description" : "The timestamp at which the current rate limit window resets.",
459 "style" : "simple",
460 "explode" : false,
461 "schema" : {
462 "type" : "integer",
463 "format" : "int32"
464 }
465 },
466 "Retry-After" : {
467 "description" : "How many seconds you have to wait before making new request.",
468 "style" : "simple",
469 "explode" : false,
470 "schema" : {
471 "type" : "integer",
472 "format" : "int32"
473 }
474 }
475 },
476 "content" : {
477 "application/json" : {
478 "schema" : {
479 "$ref" : "#/components/schemas/ClientErrorResponse"
480 }
481 }
482 }
483 },
484 "402" : {
485 "description" : "Authenticated user doesn't have subscription.",
486 "content" : {
487 "application/json" : {
488 "schema" : {
489 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
490 }
491 }
492 }
493 },
494 "403" : {
495 "description" : "Authenticated user doesn't have access to the resource.",
496 "headers" : {
497 "X-RateLimit-Limit" : {
498 "description" : "Request limit per minute.",
499 "style" : "simple",
500 "explode" : false,
501 "schema" : {
502 "type" : "integer",
503 "format" : "int32"
504 }
505 },
506 "X-RateLimit-Remaining" : {
507 "description" : "The number of requests left for the time window.",
508 "style" : "simple",
509 "explode" : false,
510 "schema" : {
511 "type" : "integer",
512 "format" : "int32"
513 }
514 },
515 "X-RateLimit-Reset" : {
516 "description" : "The timestamp at which the current rate limit window resets.",
517 "style" : "simple",
518 "explode" : false,
519 "schema" : {
520 "type" : "integer",
521 "format" : "int32"
522 }
523 },
524 "Retry-After" : {
525 "description" : "How many seconds you have to wait before making new request.",
526 "style" : "simple",
527 "explode" : false,
528 "schema" : {
529 "type" : "integer",
530 "format" : "int32"
531 }
532 }
533 },
534 "content" : {
535 "application/json" : {
536 "schema" : {
537 "$ref" : "#/components/schemas/ClientErrorResponse"
538 }
539 }
540 }
541 },
542 "422" : {
543 "description" : "Validation errors occured.",
544 "headers" : {
545 "X-RateLimit-Limit" : {
546 "description" : "Request limit per minute.",
547 "style" : "simple",
548 "explode" : false,
549 "schema" : {
550 "type" : "integer",
551 "format" : "int32"
552 }
553 },
554 "X-RateLimit-Remaining" : {
555 "description" : "The number of requests left for the time window.",
556 "style" : "simple",
557 "explode" : false,
558 "schema" : {
559 "type" : "integer",
560 "format" : "int32"
561 }
562 },
563 "X-RateLimit-Reset" : {
564 "description" : "The timestamp at which the current rate limit window resets.",
565 "style" : "simple",
566 "explode" : false,
567 "schema" : {
568 "type" : "integer",
569 "format" : "int32"
570 }
571 },
572 "Retry-After" : {
573 "description" : "How many seconds you have to wait before making new request.",
574 "style" : "simple",
575 "explode" : false,
576 "schema" : {
577 "type" : "integer",
578 "format" : "int32"
579 }
580 }
581 },
582 "content" : {
583 "application/json" : {
584 "schema" : {
585 "$ref" : "#/components/schemas/ValidationErrorResponse"
586 }
587 }
588 }
589 },
590 "500" : {
591 "description" : "Internal server error.",
592 "headers" : {
593 "X-RateLimit-Limit" : {
594 "description" : "Request limit per minute.",
595 "style" : "simple",
596 "explode" : false,
597 "schema" : {
598 "type" : "integer",
599 "format" : "int32"
600 }
601 },
602 "X-RateLimit-Remaining" : {
603 "description" : "The number of requests left for the time window.",
604 "style" : "simple",
605 "explode" : false,
606 "schema" : {
607 "type" : "integer",
608 "format" : "int32"
609 }
610 },
611 "X-RateLimit-Reset" : {
612 "description" : "The timestamp at which the current rate limit window resets.",
613 "style" : "simple",
614 "explode" : false,
615 "schema" : {
616 "type" : "integer",
617 "format" : "int32"
618 }
619 },
620 "Retry-After" : {
621 "description" : "How many seconds you have to wait before making new request.",
622 "style" : "simple",
623 "explode" : false,
624 "schema" : {
625 "type" : "integer",
626 "format" : "int32"
627 }
628 }
629 },
630 "content" : {
631 "application/json" : {
632 "schema" : {
633 "$ref" : "#/components/schemas/ServerErrorResponse"
634 }
635 }
636 }
637 }
638 }
639 }
640 },
641 "/bank-accounts/{id}" : {
642 "get" : {
643 "tags" : [ "BankAccount" ],
644 "summary" : "Retrieve a bank account",
645 "description" : "Retrieves the details of an existing bank account.",
646 "operationId" : "GetBankAccount",
647 "parameters" : [ {
648 "name" : "id",
649 "in" : "path",
650 "required" : true,
651 "style" : "simple",
652 "explode" : false,
653 "schema" : {
654 "type" : "integer"
655 }
656 } ],
657 "responses" : {
658 "200" : {
659 "description" : "Success response",
660 "headers" : {
661 "X-RateLimit-Limit" : {
662 "description" : "Request limit per minute.",
663 "style" : "simple",
664 "explode" : false,
665 "schema" : {
666 "type" : "integer",
667 "format" : "int32"
668 }
669 },
670 "X-RateLimit-Remaining" : {
671 "description" : "The number of requests left for the time window.",
672 "style" : "simple",
673 "explode" : false,
674 "schema" : {
675 "type" : "integer",
676 "format" : "int32"
677 }
678 },
679 "X-RateLimit-Reset" : {
680 "description" : "The timestamp at which the current rate limit window resets.",
681 "style" : "simple",
682 "explode" : false,
683 "schema" : {
684 "type" : "integer",
685 "format" : "int32"
686 }
687 },
688 "Retry-After" : {
689 "description" : "How many seconds you have to wait before making new request.",
690 "style" : "simple",
691 "explode" : false,
692 "schema" : {
693 "type" : "integer",
694 "format" : "int32"
695 }
696 }
697 },
698 "content" : {
699 "application/json" : {
700 "schema" : {
701 "$ref" : "#/components/schemas/BankAccount"
702 }
703 }
704 }
705 },
706 "400" : {
707 "description" : "The request is malformed.",
708 "headers" : {
709 "X-RateLimit-Limit" : {
710 "description" : "Request limit per minute.",
711 "style" : "simple",
712 "explode" : false,
713 "schema" : {
714 "type" : "integer",
715 "format" : "int32"
716 }
717 },
718 "X-RateLimit-Remaining" : {
719 "description" : "The number of requests left for the time window.",
720 "style" : "simple",
721 "explode" : false,
722 "schema" : {
723 "type" : "integer",
724 "format" : "int32"
725 }
726 },
727 "X-RateLimit-Reset" : {
728 "description" : "The timestamp at which the current rate limit window resets.",
729 "style" : "simple",
730 "explode" : false,
731 "schema" : {
732 "type" : "integer",
733 "format" : "int32"
734 }
735 },
736 "Retry-After" : {
737 "description" : "How many seconds you have to wait before making new request.",
738 "style" : "simple",
739 "explode" : false,
740 "schema" : {
741 "type" : "integer",
742 "format" : "int32"
743 }
744 }
745 },
746 "content" : {
747 "application/json" : {
748 "schema" : {
749 "$ref" : "#/components/schemas/ClientErrorResponse"
750 }
751 }
752 }
753 },
754 "401" : {
755 "description" : "Authorization information is missing or invalid.",
756 "headers" : {
757 "X-RateLimit-Limit" : {
758 "description" : "Request limit per minute.",
759 "style" : "simple",
760 "explode" : false,
761 "schema" : {
762 "type" : "integer",
763 "format" : "int32"
764 }
765 },
766 "X-RateLimit-Remaining" : {
767 "description" : "The number of requests left for the time window.",
768 "style" : "simple",
769 "explode" : false,
770 "schema" : {
771 "type" : "integer",
772 "format" : "int32"
773 }
774 },
775 "X-RateLimit-Reset" : {
776 "description" : "The timestamp at which the current rate limit window resets.",
777 "style" : "simple",
778 "explode" : false,
779 "schema" : {
780 "type" : "integer",
781 "format" : "int32"
782 }
783 },
784 "Retry-After" : {
785 "description" : "How many seconds you have to wait before making new request.",
786 "style" : "simple",
787 "explode" : false,
788 "schema" : {
789 "type" : "integer",
790 "format" : "int32"
791 }
792 }
793 },
794 "content" : {
795 "application/json" : {
796 "schema" : {
797 "$ref" : "#/components/schemas/ClientErrorResponse"
798 }
799 }
800 }
801 },
802 "402" : {
803 "description" : "Authenticated user doesn't have subscription.",
804 "content" : {
805 "application/json" : {
806 "schema" : {
807 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
808 }
809 }
810 }
811 },
812 "404" : {
813 "description" : "Non-existent resource is requested.",
814 "headers" : {
815 "X-RateLimit-Limit" : {
816 "description" : "Request limit per minute.",
817 "style" : "simple",
818 "explode" : false,
819 "schema" : {
820 "type" : "integer",
821 "format" : "int32"
822 }
823 },
824 "X-RateLimit-Remaining" : {
825 "description" : "The number of requests left for the time window.",
826 "style" : "simple",
827 "explode" : false,
828 "schema" : {
829 "type" : "integer",
830 "format" : "int32"
831 }
832 },
833 "X-RateLimit-Reset" : {
834 "description" : "The timestamp at which the current rate limit window resets.",
835 "style" : "simple",
836 "explode" : false,
837 "schema" : {
838 "type" : "integer",
839 "format" : "int32"
840 }
841 },
842 "Retry-After" : {
843 "description" : "How many seconds you have to wait before making new request.",
844 "style" : "simple",
845 "explode" : false,
846 "schema" : {
847 "type" : "integer",
848 "format" : "int32"
849 }
850 }
851 },
852 "content" : {
853 "application/json" : {
854 "schema" : {
855 "$ref" : "#/components/schemas/ClientErrorResponse"
856 }
857 }
858 }
859 },
860 "422" : {
861 "description" : "Validation errors occured.",
862 "headers" : {
863 "X-RateLimit-Limit" : {
864 "description" : "Request limit per minute.",
865 "style" : "simple",
866 "explode" : false,
867 "schema" : {
868 "type" : "integer",
869 "format" : "int32"
870 }
871 },
872 "X-RateLimit-Remaining" : {
873 "description" : "The number of requests left for the time window.",
874 "style" : "simple",
875 "explode" : false,
876 "schema" : {
877 "type" : "integer",
878 "format" : "int32"
879 }
880 },
881 "X-RateLimit-Reset" : {
882 "description" : "The timestamp at which the current rate limit window resets.",
883 "style" : "simple",
884 "explode" : false,
885 "schema" : {
886 "type" : "integer",
887 "format" : "int32"
888 }
889 },
890 "Retry-After" : {
891 "description" : "How many seconds you have to wait before making new request.",
892 "style" : "simple",
893 "explode" : false,
894 "schema" : {
895 "type" : "integer",
896 "format" : "int32"
897 }
898 }
899 },
900 "content" : {
901 "application/json" : {
902 "schema" : {
903 "$ref" : "#/components/schemas/ValidationErrorResponse"
904 }
905 }
906 }
907 },
908 "500" : {
909 "description" : "Internal server error.",
910 "headers" : {
911 "X-RateLimit-Limit" : {
912 "description" : "Request limit per minute.",
913 "style" : "simple",
914 "explode" : false,
915 "schema" : {
916 "type" : "integer",
917 "format" : "int32"
918 }
919 },
920 "X-RateLimit-Remaining" : {
921 "description" : "The number of requests left for the time window.",
922 "style" : "simple",
923 "explode" : false,
924 "schema" : {
925 "type" : "integer",
926 "format" : "int32"
927 }
928 },
929 "X-RateLimit-Reset" : {
930 "description" : "The timestamp at which the current rate limit window resets.",
931 "style" : "simple",
932 "explode" : false,
933 "schema" : {
934 "type" : "integer",
935 "format" : "int32"
936 }
937 },
938 "Retry-After" : {
939 "description" : "How many seconds you have to wait before making new request.",
940 "style" : "simple",
941 "explode" : false,
942 "schema" : {
943 "type" : "integer",
944 "format" : "int32"
945 }
946 }
947 },
948 "content" : {
949 "application/json" : {
950 "schema" : {
951 "$ref" : "#/components/schemas/ServerErrorResponse"
952 }
953 }
954 }
955 }
956 }
957 },
958 "put" : {
959 "tags" : [ "BankAccount" ],
960 "summary" : "Update a bank account",
961 "description" : "Update an existing bank accounts. Returns a bank account object if the update is succeded.",
962 "operationId" : "UpdateBankAccount",
963 "parameters" : [ {
964 "name" : "id",
965 "in" : "path",
966 "required" : true,
967 "style" : "simple",
968 "explode" : false,
969 "schema" : {
970 "type" : "integer"
971 }
972 } ],
973 "requestBody" : {
974 "description" : "Bank account object that you would like to update.",
975 "content" : {
976 "application/json" : {
977 "schema" : {
978 "$ref" : "#/components/schemas/BankAccount"
979 }
980 }
981 },
982 "required" : true
983 },
984 "responses" : {
985 "200" : {
986 "description" : "Bank account updated successfully.",
987 "headers" : {
988 "X-RateLimit-Limit" : {
989 "description" : "Request limit per minute.",
990 "style" : "simple",
991 "explode" : false,
992 "schema" : {
993 "type" : "integer",
994 "format" : "int32"
995 }
996 },
997 "X-RateLimit-Remaining" : {
998 "description" : "The number of requests left for the time window.",
999 "style" : "simple",
1000 "explode" : false,
1001 "schema" : {
1002 "type" : "integer",
1003 "format" : "int32"
1004 }
1005 },
1006 "X-RateLimit-Reset" : {
1007 "description" : "The timestamp at which the current rate limit window resets.",
1008 "style" : "simple",
1009 "explode" : false,
1010 "schema" : {
1011 "type" : "integer",
1012 "format" : "int32"
1013 }
1014 },
1015 "Retry-After" : {
1016 "description" : "How many seconds you have to wait before making new request.",
1017 "style" : "simple",
1018 "explode" : false,
1019 "schema" : {
1020 "type" : "integer",
1021 "format" : "int32"
1022 }
1023 }
1024 },
1025 "content" : {
1026 "application/json" : {
1027 "schema" : {
1028 "$ref" : "#/components/schemas/BankAccount"
1029 }
1030 }
1031 }
1032 },
1033 "400" : {
1034 "description" : "The request is malformed.",
1035 "headers" : {
1036 "X-RateLimit-Limit" : {
1037 "description" : "Request limit per minute.",
1038 "style" : "simple",
1039 "explode" : false,
1040 "schema" : {
1041 "type" : "integer",
1042 "format" : "int32"
1043 }
1044 },
1045 "X-RateLimit-Remaining" : {
1046 "description" : "The number of requests left for the time window.",
1047 "style" : "simple",
1048 "explode" : false,
1049 "schema" : {
1050 "type" : "integer",
1051 "format" : "int32"
1052 }
1053 },
1054 "X-RateLimit-Reset" : {
1055 "description" : "The timestamp at which the current rate limit window resets.",
1056 "style" : "simple",
1057 "explode" : false,
1058 "schema" : {
1059 "type" : "integer",
1060 "format" : "int32"
1061 }
1062 },
1063 "Retry-After" : {
1064 "description" : "How many seconds you have to wait before making new request.",
1065 "style" : "simple",
1066 "explode" : false,
1067 "schema" : {
1068 "type" : "integer",
1069 "format" : "int32"
1070 }
1071 }
1072 },
1073 "content" : {
1074 "application/json" : {
1075 "schema" : {
1076 "$ref" : "#/components/schemas/ClientErrorResponse"
1077 }
1078 }
1079 }
1080 },
1081 "401" : {
1082 "description" : "Authorization information is missing or invalid.",
1083 "headers" : {
1084 "X-RateLimit-Limit" : {
1085 "description" : "Request limit per minute.",
1086 "style" : "simple",
1087 "explode" : false,
1088 "schema" : {
1089 "type" : "integer",
1090 "format" : "int32"
1091 }
1092 },
1093 "X-RateLimit-Remaining" : {
1094 "description" : "The number of requests left for the time window.",
1095 "style" : "simple",
1096 "explode" : false,
1097 "schema" : {
1098 "type" : "integer",
1099 "format" : "int32"
1100 }
1101 },
1102 "X-RateLimit-Reset" : {
1103 "description" : "The timestamp at which the current rate limit window resets.",
1104 "style" : "simple",
1105 "explode" : false,
1106 "schema" : {
1107 "type" : "integer",
1108 "format" : "int32"
1109 }
1110 },
1111 "Retry-After" : {
1112 "description" : "How many seconds you have to wait before making new request.",
1113 "style" : "simple",
1114 "explode" : false,
1115 "schema" : {
1116 "type" : "integer",
1117 "format" : "int32"
1118 }
1119 }
1120 },
1121 "content" : {
1122 "application/json" : {
1123 "schema" : {
1124 "$ref" : "#/components/schemas/ClientErrorResponse"
1125 }
1126 }
1127 }
1128 },
1129 "402" : {
1130 "description" : "Authenticated user doesn't have subscription.",
1131 "content" : {
1132 "application/json" : {
1133 "schema" : {
1134 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
1135 }
1136 }
1137 }
1138 },
1139 "403" : {
1140 "description" : "Authenticated user doesn't have access to the resource.",
1141 "headers" : {
1142 "X-RateLimit-Limit" : {
1143 "description" : "Request limit per minute.",
1144 "style" : "simple",
1145 "explode" : false,
1146 "schema" : {
1147 "type" : "integer",
1148 "format" : "int32"
1149 }
1150 },
1151 "X-RateLimit-Remaining" : {
1152 "description" : "The number of requests left for the time window.",
1153 "style" : "simple",
1154 "explode" : false,
1155 "schema" : {
1156 "type" : "integer",
1157 "format" : "int32"
1158 }
1159 },
1160 "X-RateLimit-Reset" : {
1161 "description" : "The timestamp at which the current rate limit window resets.",
1162 "style" : "simple",
1163 "explode" : false,
1164 "schema" : {
1165 "type" : "integer",
1166 "format" : "int32"
1167 }
1168 },
1169 "Retry-After" : {
1170 "description" : "How many seconds you have to wait before making new request.",
1171 "style" : "simple",
1172 "explode" : false,
1173 "schema" : {
1174 "type" : "integer",
1175 "format" : "int32"
1176 }
1177 }
1178 },
1179 "content" : {
1180 "application/json" : {
1181 "schema" : {
1182 "$ref" : "#/components/schemas/ClientErrorResponse"
1183 }
1184 }
1185 }
1186 },
1187 "404" : {
1188 "description" : "Non-existent resource is requested.",
1189 "headers" : {
1190 "X-RateLimit-Limit" : {
1191 "description" : "Request limit per minute.",
1192 "style" : "simple",
1193 "explode" : false,
1194 "schema" : {
1195 "type" : "integer",
1196 "format" : "int32"
1197 }
1198 },
1199 "X-RateLimit-Remaining" : {
1200 "description" : "The number of requests left for the time window.",
1201 "style" : "simple",
1202 "explode" : false,
1203 "schema" : {
1204 "type" : "integer",
1205 "format" : "int32"
1206 }
1207 },
1208 "X-RateLimit-Reset" : {
1209 "description" : "The timestamp at which the current rate limit window resets.",
1210 "style" : "simple",
1211 "explode" : false,
1212 "schema" : {
1213 "type" : "integer",
1214 "format" : "int32"
1215 }
1216 },
1217 "Retry-After" : {
1218 "description" : "How many seconds you have to wait before making new request.",
1219 "style" : "simple",
1220 "explode" : false,
1221 "schema" : {
1222 "type" : "integer",
1223 "format" : "int32"
1224 }
1225 }
1226 },
1227 "content" : {
1228 "application/json" : {
1229 "schema" : {
1230 "$ref" : "#/components/schemas/ClientErrorResponse"
1231 }
1232 }
1233 }
1234 },
1235 "422" : {
1236 "description" : "Validation errors occured.",
1237 "headers" : {
1238 "X-RateLimit-Limit" : {
1239 "description" : "Request limit per minute.",
1240 "style" : "simple",
1241 "explode" : false,
1242 "schema" : {
1243 "type" : "integer",
1244 "format" : "int32"
1245 }
1246 },
1247 "X-RateLimit-Remaining" : {
1248 "description" : "The number of requests left for the time window.",
1249 "style" : "simple",
1250 "explode" : false,
1251 "schema" : {
1252 "type" : "integer",
1253 "format" : "int32"
1254 }
1255 },
1256 "X-RateLimit-Reset" : {
1257 "description" : "The timestamp at which the current rate limit window resets.",
1258 "style" : "simple",
1259 "explode" : false,
1260 "schema" : {
1261 "type" : "integer",
1262 "format" : "int32"
1263 }
1264 },
1265 "Retry-After" : {
1266 "description" : "How many seconds you have to wait before making new request.",
1267 "style" : "simple",
1268 "explode" : false,
1269 "schema" : {
1270 "type" : "integer",
1271 "format" : "int32"
1272 }
1273 }
1274 },
1275 "content" : {
1276 "application/json" : {
1277 "schema" : {
1278 "$ref" : "#/components/schemas/ValidationErrorResponse"
1279 }
1280 }
1281 }
1282 },
1283 "500" : {
1284 "description" : "Internal server error.",
1285 "headers" : {
1286 "X-RateLimit-Limit" : {
1287 "description" : "Request limit per minute.",
1288 "style" : "simple",
1289 "explode" : false,
1290 "schema" : {
1291 "type" : "integer",
1292 "format" : "int32"
1293 }
1294 },
1295 "X-RateLimit-Remaining" : {
1296 "description" : "The number of requests left for the time window.",
1297 "style" : "simple",
1298 "explode" : false,
1299 "schema" : {
1300 "type" : "integer",
1301 "format" : "int32"
1302 }
1303 },
1304 "X-RateLimit-Reset" : {
1305 "description" : "The timestamp at which the current rate limit window resets.",
1306 "style" : "simple",
1307 "explode" : false,
1308 "schema" : {
1309 "type" : "integer",
1310 "format" : "int32"
1311 }
1312 },
1313 "Retry-After" : {
1314 "description" : "How many seconds you have to wait before making new request.",
1315 "style" : "simple",
1316 "explode" : false,
1317 "schema" : {
1318 "type" : "integer",
1319 "format" : "int32"
1320 }
1321 }
1322 },
1323 "content" : {
1324 "application/json" : {
1325 "schema" : {
1326 "$ref" : "#/components/schemas/ServerErrorResponse"
1327 }
1328 }
1329 }
1330 }
1331 }
1332 },
1333 "delete" : {
1334 "tags" : [ "BankAccount" ],
1335 "summary" : "Delete a bank account",
1336 "description" : "Delete an existing bank account.",
1337 "operationId" : "DeleteBankAccount",
1338 "parameters" : [ {
1339 "name" : "id",
1340 "in" : "path",
1341 "required" : true,
1342 "style" : "simple",
1343 "explode" : false,
1344 "schema" : {
1345 "type" : "integer"
1346 }
1347 } ],
1348 "responses" : {
1349 "204" : {
1350 "description" : "Bank account deleted successfully.",
1351 "headers" : {
1352 "X-RateLimit-Limit" : {
1353 "description" : "Request limit per minute.",
1354 "style" : "simple",
1355 "explode" : false,
1356 "schema" : {
1357 "type" : "integer",
1358 "format" : "int32"
1359 }
1360 },
1361 "X-RateLimit-Remaining" : {
1362 "description" : "The number of requests left for the time window.",
1363 "style" : "simple",
1364 "explode" : false,
1365 "schema" : {
1366 "type" : "integer",
1367 "format" : "int32"
1368 }
1369 },
1370 "X-RateLimit-Reset" : {
1371 "description" : "The timestamp at which the current rate limit window resets.",
1372 "style" : "simple",
1373 "explode" : false,
1374 "schema" : {
1375 "type" : "integer",
1376 "format" : "int32"
1377 }
1378 },
1379 "Retry-After" : {
1380 "description" : "How many seconds you have to wait before making new request.",
1381 "style" : "simple",
1382 "explode" : false,
1383 "schema" : {
1384 "type" : "integer",
1385 "format" : "int32"
1386 }
1387 }
1388 }
1389 },
1390 "400" : {
1391 "description" : "The request is malformed.",
1392 "headers" : {
1393 "X-RateLimit-Limit" : {
1394 "description" : "Request limit per minute.",
1395 "style" : "simple",
1396 "explode" : false,
1397 "schema" : {
1398 "type" : "integer",
1399 "format" : "int32"
1400 }
1401 },
1402 "X-RateLimit-Remaining" : {
1403 "description" : "The number of requests left for the time window.",
1404 "style" : "simple",
1405 "explode" : false,
1406 "schema" : {
1407 "type" : "integer",
1408 "format" : "int32"
1409 }
1410 },
1411 "X-RateLimit-Reset" : {
1412 "description" : "The timestamp at which the current rate limit window resets.",
1413 "style" : "simple",
1414 "explode" : false,
1415 "schema" : {
1416 "type" : "integer",
1417 "format" : "int32"
1418 }
1419 },
1420 "Retry-After" : {
1421 "description" : "How many seconds you have to wait before making new request.",
1422 "style" : "simple",
1423 "explode" : false,
1424 "schema" : {
1425 "type" : "integer",
1426 "format" : "int32"
1427 }
1428 }
1429 },
1430 "content" : {
1431 "application/json" : {
1432 "schema" : {
1433 "$ref" : "#/components/schemas/ClientErrorResponse"
1434 }
1435 }
1436 }
1437 },
1438 "401" : {
1439 "description" : "Authorization information is missing or invalid.",
1440 "headers" : {
1441 "X-RateLimit-Limit" : {
1442 "description" : "Request limit per minute.",
1443 "style" : "simple",
1444 "explode" : false,
1445 "schema" : {
1446 "type" : "integer",
1447 "format" : "int32"
1448 }
1449 },
1450 "X-RateLimit-Remaining" : {
1451 "description" : "The number of requests left for the time window.",
1452 "style" : "simple",
1453 "explode" : false,
1454 "schema" : {
1455 "type" : "integer",
1456 "format" : "int32"
1457 }
1458 },
1459 "X-RateLimit-Reset" : {
1460 "description" : "The timestamp at which the current rate limit window resets.",
1461 "style" : "simple",
1462 "explode" : false,
1463 "schema" : {
1464 "type" : "integer",
1465 "format" : "int32"
1466 }
1467 },
1468 "Retry-After" : {
1469 "description" : "How many seconds you have to wait before making new request.",
1470 "style" : "simple",
1471 "explode" : false,
1472 "schema" : {
1473 "type" : "integer",
1474 "format" : "int32"
1475 }
1476 }
1477 },
1478 "content" : {
1479 "application/json" : {
1480 "schema" : {
1481 "$ref" : "#/components/schemas/ClientErrorResponse"
1482 }
1483 }
1484 }
1485 },
1486 "402" : {
1487 "description" : "Authenticated user doesn't have subscription.",
1488 "content" : {
1489 "application/json" : {
1490 "schema" : {
1491 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
1492 }
1493 }
1494 }
1495 },
1496 "403" : {
1497 "description" : "Authenticated user doesn't have access to the resource.",
1498 "headers" : {
1499 "X-RateLimit-Limit" : {
1500 "description" : "Request limit per minute.",
1501 "style" : "simple",
1502 "explode" : false,
1503 "schema" : {
1504 "type" : "integer",
1505 "format" : "int32"
1506 }
1507 },
1508 "X-RateLimit-Remaining" : {
1509 "description" : "The number of requests left for the time window.",
1510 "style" : "simple",
1511 "explode" : false,
1512 "schema" : {
1513 "type" : "integer",
1514 "format" : "int32"
1515 }
1516 },
1517 "X-RateLimit-Reset" : {
1518 "description" : "The timestamp at which the current rate limit window resets.",
1519 "style" : "simple",
1520 "explode" : false,
1521 "schema" : {
1522 "type" : "integer",
1523 "format" : "int32"
1524 }
1525 },
1526 "Retry-After" : {
1527 "description" : "How many seconds you have to wait before making new request.",
1528 "style" : "simple",
1529 "explode" : false,
1530 "schema" : {
1531 "type" : "integer",
1532 "format" : "int32"
1533 }
1534 }
1535 },
1536 "content" : {
1537 "application/json" : {
1538 "schema" : {
1539 "$ref" : "#/components/schemas/ClientErrorResponse"
1540 }
1541 }
1542 }
1543 },
1544 "404" : {
1545 "description" : "Non-existent resource is requested.",
1546 "headers" : {
1547 "X-RateLimit-Limit" : {
1548 "description" : "Request limit per minute.",
1549 "style" : "simple",
1550 "explode" : false,
1551 "schema" : {
1552 "type" : "integer",
1553 "format" : "int32"
1554 }
1555 },
1556 "X-RateLimit-Remaining" : {
1557 "description" : "The number of requests left for the time window.",
1558 "style" : "simple",
1559 "explode" : false,
1560 "schema" : {
1561 "type" : "integer",
1562 "format" : "int32"
1563 }
1564 },
1565 "X-RateLimit-Reset" : {
1566 "description" : "The timestamp at which the current rate limit window resets.",
1567 "style" : "simple",
1568 "explode" : false,
1569 "schema" : {
1570 "type" : "integer",
1571 "format" : "int32"
1572 }
1573 },
1574 "Retry-After" : {
1575 "description" : "How many seconds you have to wait before making new request.",
1576 "style" : "simple",
1577 "explode" : false,
1578 "schema" : {
1579 "type" : "integer",
1580 "format" : "int32"
1581 }
1582 }
1583 },
1584 "content" : {
1585 "application/json" : {
1586 "schema" : {
1587 "$ref" : "#/components/schemas/ClientErrorResponse"
1588 }
1589 }
1590 }
1591 },
1592 "500" : {
1593 "description" : "Internal server error.",
1594 "headers" : {
1595 "X-RateLimit-Limit" : {
1596 "description" : "Request limit per minute.",
1597 "style" : "simple",
1598 "explode" : false,
1599 "schema" : {
1600 "type" : "integer",
1601 "format" : "int32"
1602 }
1603 },
1604 "X-RateLimit-Remaining" : {
1605 "description" : "The number of requests left for the time window.",
1606 "style" : "simple",
1607 "explode" : false,
1608 "schema" : {
1609 "type" : "integer",
1610 "format" : "int32"
1611 }
1612 },
1613 "X-RateLimit-Reset" : {
1614 "description" : "The timestamp at which the current rate limit window resets.",
1615 "style" : "simple",
1616 "explode" : false,
1617 "schema" : {
1618 "type" : "integer",
1619 "format" : "int32"
1620 }
1621 },
1622 "Retry-After" : {
1623 "description" : "How many seconds you have to wait before making new request.",
1624 "style" : "simple",
1625 "explode" : false,
1626 "schema" : {
1627 "type" : "integer",
1628 "format" : "int32"
1629 }
1630 }
1631 },
1632 "content" : {
1633 "application/json" : {
1634 "schema" : {
1635 "$ref" : "#/components/schemas/ServerErrorResponse"
1636 }
1637 }
1638 }
1639 }
1640 }
1641 }
1642 },
1643 "/currencies" : {
1644 "get" : {
1645 "tags" : [ "Currency" ],
1646 "summary" : "Get currencies exchange rate.",
1647 "description" : "Return with the exchange value of given currencies.",
1648 "operationId" : "GetConversionRate",
1649 "parameters" : [ {
1650 "name" : "from",
1651 "in" : "query",
1652 "required" : true,
1653 "style" : "form",
1654 "explode" : true,
1655 "schema" : {
1656 "$ref" : "#/components/schemas/Currency"
1657 }
1658 }, {
1659 "name" : "to",
1660 "in" : "query",
1661 "required" : true,
1662 "style" : "form",
1663 "explode" : true,
1664 "schema" : {
1665 "$ref" : "#/components/schemas/Currency"
1666 }
1667 } ],
1668 "responses" : {
1669 "200" : {
1670 "description" : "Currencies exchange rate returned.",
1671 "headers" : {
1672 "X-RateLimit-Limit" : {
1673 "description" : "Request limit per minute.",
1674 "style" : "simple",
1675 "explode" : false,
1676 "schema" : {
1677 "type" : "integer",
1678 "format" : "int32"
1679 }
1680 },
1681 "X-RateLimit-Remaining" : {
1682 "description" : "The number of requests left for the time window.",
1683 "style" : "simple",
1684 "explode" : false,
1685 "schema" : {
1686 "type" : "integer",
1687 "format" : "int32"
1688 }
1689 },
1690 "X-RateLimit-Reset" : {
1691 "description" : "The timestamp at which the current rate limit window resets.",
1692 "style" : "simple",
1693 "explode" : false,
1694 "schema" : {
1695 "type" : "integer",
1696 "format" : "int32"
1697 }
1698 },
1699 "Retry-After" : {
1700 "description" : "How many seconds you have to wait before making new request.",
1701 "style" : "simple",
1702 "explode" : false,
1703 "schema" : {
1704 "type" : "integer",
1705 "format" : "int32"
1706 }
1707 }
1708 },
1709 "content" : {
1710 "application/json" : {
1711 "schema" : {
1712 "$ref" : "#/components/schemas/ConversationRate"
1713 }
1714 }
1715 }
1716 },
1717 "400" : {
1718 "description" : "The request is malformed.",
1719 "headers" : {
1720 "X-RateLimit-Limit" : {
1721 "description" : "Request limit per minute.",
1722 "style" : "simple",
1723 "explode" : false,
1724 "schema" : {
1725 "type" : "integer",
1726 "format" : "int32"
1727 }
1728 },
1729 "X-RateLimit-Remaining" : {
1730 "description" : "The number of requests left for the time window.",
1731 "style" : "simple",
1732 "explode" : false,
1733 "schema" : {
1734 "type" : "integer",
1735 "format" : "int32"
1736 }
1737 },
1738 "X-RateLimit-Reset" : {
1739 "description" : "The timestamp at which the current rate limit window resets.",
1740 "style" : "simple",
1741 "explode" : false,
1742 "schema" : {
1743 "type" : "integer",
1744 "format" : "int32"
1745 }
1746 },
1747 "Retry-After" : {
1748 "description" : "How many seconds you have to wait before making new request.",
1749 "style" : "simple",
1750 "explode" : false,
1751 "schema" : {
1752 "type" : "integer",
1753 "format" : "int32"
1754 }
1755 }
1756 },
1757 "content" : {
1758 "application/json" : {
1759 "schema" : {
1760 "$ref" : "#/components/schemas/ClientErrorResponse"
1761 }
1762 }
1763 }
1764 },
1765 "401" : {
1766 "description" : "Authorization information is missing or invalid.",
1767 "headers" : {
1768 "X-RateLimit-Limit" : {
1769 "description" : "Request limit per minute.",
1770 "style" : "simple",
1771 "explode" : false,
1772 "schema" : {
1773 "type" : "integer",
1774 "format" : "int32"
1775 }
1776 },
1777 "X-RateLimit-Remaining" : {
1778 "description" : "The number of requests left for the time window.",
1779 "style" : "simple",
1780 "explode" : false,
1781 "schema" : {
1782 "type" : "integer",
1783 "format" : "int32"
1784 }
1785 },
1786 "X-RateLimit-Reset" : {
1787 "description" : "The timestamp at which the current rate limit window resets.",
1788 "style" : "simple",
1789 "explode" : false,
1790 "schema" : {
1791 "type" : "integer",
1792 "format" : "int32"
1793 }
1794 },
1795 "Retry-After" : {
1796 "description" : "How many seconds you have to wait before making new request.",
1797 "style" : "simple",
1798 "explode" : false,
1799 "schema" : {
1800 "type" : "integer",
1801 "format" : "int32"
1802 }
1803 }
1804 },
1805 "content" : {
1806 "application/json" : {
1807 "schema" : {
1808 "$ref" : "#/components/schemas/ClientErrorResponse"
1809 }
1810 }
1811 }
1812 },
1813 "402" : {
1814 "description" : "Authenticated user doesn't have subscription.",
1815 "content" : {
1816 "application/json" : {
1817 "schema" : {
1818 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
1819 }
1820 }
1821 }
1822 },
1823 "422" : {
1824 "description" : "Validation errors occured.",
1825 "headers" : {
1826 "X-RateLimit-Limit" : {
1827 "description" : "Request limit per minute.",
1828 "style" : "simple",
1829 "explode" : false,
1830 "schema" : {
1831 "type" : "integer",
1832 "format" : "int32"
1833 }
1834 },
1835 "X-RateLimit-Remaining" : {
1836 "description" : "The number of requests left for the time window.",
1837 "style" : "simple",
1838 "explode" : false,
1839 "schema" : {
1840 "type" : "integer",
1841 "format" : "int32"
1842 }
1843 },
1844 "X-RateLimit-Reset" : {
1845 "description" : "The timestamp at which the current rate limit window resets.",
1846 "style" : "simple",
1847 "explode" : false,
1848 "schema" : {
1849 "type" : "integer",
1850 "format" : "int32"
1851 }
1852 },
1853 "Retry-After" : {
1854 "description" : "How many seconds you have to wait before making new request.",
1855 "style" : "simple",
1856 "explode" : false,
1857 "schema" : {
1858 "type" : "integer",
1859 "format" : "int32"
1860 }
1861 }
1862 },
1863 "content" : {
1864 "application/json" : {
1865 "schema" : {
1866 "$ref" : "#/components/schemas/ValidationErrorResponse"
1867 }
1868 }
1869 }
1870 },
1871 "500" : {
1872 "description" : "Internal server error.",
1873 "headers" : {
1874 "X-RateLimit-Limit" : {
1875 "description" : "Request limit per minute.",
1876 "style" : "simple",
1877 "explode" : false,
1878 "schema" : {
1879 "type" : "integer",
1880 "format" : "int32"
1881 }
1882 },
1883 "X-RateLimit-Remaining" : {
1884 "description" : "The number of requests left for the time window.",
1885 "style" : "simple",
1886 "explode" : false,
1887 "schema" : {
1888 "type" : "integer",
1889 "format" : "int32"
1890 }
1891 },
1892 "X-RateLimit-Reset" : {
1893 "description" : "The timestamp at which the current rate limit window resets.",
1894 "style" : "simple",
1895 "explode" : false,
1896 "schema" : {
1897 "type" : "integer",
1898 "format" : "int32"
1899 }
1900 },
1901 "Retry-After" : {
1902 "description" : "How many seconds you have to wait before making new request.",
1903 "style" : "simple",
1904 "explode" : false,
1905 "schema" : {
1906 "type" : "integer",
1907 "format" : "int32"
1908 }
1909 }
1910 },
1911 "content" : {
1912 "application/json" : {
1913 "schema" : {
1914 "$ref" : "#/components/schemas/ServerErrorResponse"
1915 }
1916 }
1917 }
1918 }
1919 }
1920 }
1921 },
1922 "/document-blocks" : {
1923 "get" : {
1924 "tags" : [ "DocumentBlock" ],
1925 "summary" : "List all document blocks",
1926 "description" : "Returns a list of your document blocks. The document blocks are returned sorted by creation date, with the most recent document blocks appearing first.",
1927 "operationId" : "ListDocumentBlock",
1928 "parameters" : [ {
1929 "name" : "page",
1930 "in" : "query",
1931 "required" : false,
1932 "style" : "form",
1933 "explode" : true,
1934 "schema" : {
1935 "type" : "integer"
1936 }
1937 }, {
1938 "name" : "per_page",
1939 "in" : "query",
1940 "required" : false,
1941 "style" : "form",
1942 "explode" : true,
1943 "schema" : {
1944 "maximum" : 100,
1945 "minimum" : 1,
1946 "type" : "integer",
1947 "default" : 25
1948 }
1949 } ],
1950 "responses" : {
1951 "200" : {
1952 "description" : "Success response",
1953 "headers" : {
1954 "X-RateLimit-Limit" : {
1955 "description" : "Request limit per minute.",
1956 "style" : "simple",
1957 "explode" : false,
1958 "schema" : {
1959 "type" : "integer",
1960 "format" : "int32"
1961 }
1962 },
1963 "X-RateLimit-Remaining" : {
1964 "description" : "The number of requests left for the time window.",
1965 "style" : "simple",
1966 "explode" : false,
1967 "schema" : {
1968 "type" : "integer",
1969 "format" : "int32"
1970 }
1971 },
1972 "X-RateLimit-Reset" : {
1973 "description" : "The timestamp at which the current rate limit window resets.",
1974 "style" : "simple",
1975 "explode" : false,
1976 "schema" : {
1977 "type" : "integer",
1978 "format" : "int32"
1979 }
1980 },
1981 "Retry-After" : {
1982 "description" : "How many seconds you have to wait before making new request.",
1983 "style" : "simple",
1984 "explode" : false,
1985 "schema" : {
1986 "type" : "integer",
1987 "format" : "int32"
1988 }
1989 }
1990 },
1991 "content" : {
1992 "application/json" : {
1993 "schema" : {
1994 "$ref" : "#/components/schemas/DocumentBlockList"
1995 }
1996 }
1997 }
1998 },
1999 "400" : {
2000 "description" : "The request is malformed.",
2001 "headers" : {
2002 "X-RateLimit-Limit" : {
2003 "description" : "Request limit per minute.",
2004 "style" : "simple",
2005 "explode" : false,
2006 "schema" : {
2007 "type" : "integer",
2008 "format" : "int32"
2009 }
2010 },
2011 "X-RateLimit-Remaining" : {
2012 "description" : "The number of requests left for the time window.",
2013 "style" : "simple",
2014 "explode" : false,
2015 "schema" : {
2016 "type" : "integer",
2017 "format" : "int32"
2018 }
2019 },
2020 "X-RateLimit-Reset" : {
2021 "description" : "The timestamp at which the current rate limit window resets.",
2022 "style" : "simple",
2023 "explode" : false,
2024 "schema" : {
2025 "type" : "integer",
2026 "format" : "int32"
2027 }
2028 },
2029 "Retry-After" : {
2030 "description" : "How many seconds you have to wait before making new request.",
2031 "style" : "simple",
2032 "explode" : false,
2033 "schema" : {
2034 "type" : "integer",
2035 "format" : "int32"
2036 }
2037 }
2038 },
2039 "content" : {
2040 "application/json" : {
2041 "schema" : {
2042 "$ref" : "#/components/schemas/ClientErrorResponse"
2043 }
2044 }
2045 }
2046 },
2047 "401" : {
2048 "description" : "Authorization information is missing or invalid.",
2049 "headers" : {
2050 "X-RateLimit-Limit" : {
2051 "description" : "Request limit per minute.",
2052 "style" : "simple",
2053 "explode" : false,
2054 "schema" : {
2055 "type" : "integer",
2056 "format" : "int32"
2057 }
2058 },
2059 "X-RateLimit-Remaining" : {
2060 "description" : "The number of requests left for the time window.",
2061 "style" : "simple",
2062 "explode" : false,
2063 "schema" : {
2064 "type" : "integer",
2065 "format" : "int32"
2066 }
2067 },
2068 "X-RateLimit-Reset" : {
2069 "description" : "The timestamp at which the current rate limit window resets.",
2070 "style" : "simple",
2071 "explode" : false,
2072 "schema" : {
2073 "type" : "integer",
2074 "format" : "int32"
2075 }
2076 },
2077 "Retry-After" : {
2078 "description" : "How many seconds you have to wait before making new request.",
2079 "style" : "simple",
2080 "explode" : false,
2081 "schema" : {
2082 "type" : "integer",
2083 "format" : "int32"
2084 }
2085 }
2086 },
2087 "content" : {
2088 "application/json" : {
2089 "schema" : {
2090 "$ref" : "#/components/schemas/ClientErrorResponse"
2091 }
2092 }
2093 }
2094 },
2095 "402" : {
2096 "description" : "Authenticated user doesn't have subscription.",
2097 "content" : {
2098 "application/json" : {
2099 "schema" : {
2100 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
2101 }
2102 }
2103 }
2104 },
2105 "422" : {
2106 "description" : "Validation errors occured.",
2107 "headers" : {
2108 "X-RateLimit-Limit" : {
2109 "description" : "Request limit per minute.",
2110 "style" : "simple",
2111 "explode" : false,
2112 "schema" : {
2113 "type" : "integer",
2114 "format" : "int32"
2115 }
2116 },
2117 "X-RateLimit-Remaining" : {
2118 "description" : "The number of requests left for the time window.",
2119 "style" : "simple",
2120 "explode" : false,
2121 "schema" : {
2122 "type" : "integer",
2123 "format" : "int32"
2124 }
2125 },
2126 "X-RateLimit-Reset" : {
2127 "description" : "The timestamp at which the current rate limit window resets.",
2128 "style" : "simple",
2129 "explode" : false,
2130 "schema" : {
2131 "type" : "integer",
2132 "format" : "int32"
2133 }
2134 },
2135 "Retry-After" : {
2136 "description" : "How many seconds you have to wait before making new request.",
2137 "style" : "simple",
2138 "explode" : false,
2139 "schema" : {
2140 "type" : "integer",
2141 "format" : "int32"
2142 }
2143 }
2144 },
2145 "content" : {
2146 "application/json" : {
2147 "schema" : {
2148 "$ref" : "#/components/schemas/ValidationErrorResponse"
2149 }
2150 }
2151 }
2152 },
2153 "500" : {
2154 "description" : "Internal server error.",
2155 "headers" : {
2156 "X-RateLimit-Limit" : {
2157 "description" : "Request limit per minute.",
2158 "style" : "simple",
2159 "explode" : false,
2160 "schema" : {
2161 "type" : "integer",
2162 "format" : "int32"
2163 }
2164 },
2165 "X-RateLimit-Remaining" : {
2166 "description" : "The number of requests left for the time window.",
2167 "style" : "simple",
2168 "explode" : false,
2169 "schema" : {
2170 "type" : "integer",
2171 "format" : "int32"
2172 }
2173 },
2174 "X-RateLimit-Reset" : {
2175 "description" : "The timestamp at which the current rate limit window resets.",
2176 "style" : "simple",
2177 "explode" : false,
2178 "schema" : {
2179 "type" : "integer",
2180 "format" : "int32"
2181 }
2182 },
2183 "Retry-After" : {
2184 "description" : "How many seconds you have to wait before making new request.",
2185 "style" : "simple",
2186 "explode" : false,
2187 "schema" : {
2188 "type" : "integer",
2189 "format" : "int32"
2190 }
2191 }
2192 },
2193 "content" : {
2194 "application/json" : {
2195 "schema" : {
2196 "$ref" : "#/components/schemas/ServerErrorResponse"
2197 }
2198 }
2199 }
2200 }
2201 }
2202 }
2203 },
2204 "/documents" : {
2205 "get" : {
2206 "tags" : [ "Document" ],
2207 "summary" : "List all documents",
2208 "description" : "Returns a list of your documents. The documents are returned sorted by creation date, with the most recent documents appearing first.",
2209 "operationId" : "ListDocument",
2210 "parameters" : [ {
2211 "name" : "page",
2212 "in" : "query",
2213 "required" : false,
2214 "style" : "form",
2215 "explode" : true,
2216 "schema" : {
2217 "type" : "integer"
2218 }
2219 }, {
2220 "name" : "per_page",
2221 "in" : "query",
2222 "required" : false,
2223 "style" : "form",
2224 "explode" : true,
2225 "schema" : {
2226 "maximum" : 100,
2227 "minimum" : 1,
2228 "type" : "integer",
2229 "default" : 25
2230 }
2231 }, {
2232 "name" : "block_id",
2233 "in" : "query",
2234 "description" : "Filter documents by the identifier of your DocumentBlock.",
2235 "required" : false,
2236 "style" : "form",
2237 "explode" : true,
2238 "schema" : {
2239 "type" : "integer"
2240 }
2241 }, {
2242 "name" : "partner_id",
2243 "in" : "query",
2244 "description" : "Filter documents by the identifier of your Partner.",
2245 "required" : false,
2246 "style" : "form",
2247 "explode" : true,
2248 "schema" : {
2249 "type" : "integer"
2250 }
2251 }, {
2252 "name" : "payment_method",
2253 "in" : "query",
2254 "description" : "Filter documents by PaymentMethod value.",
2255 "required" : false,
2256 "style" : "form",
2257 "explode" : true,
2258 "schema" : {
2259 "$ref" : "#/components/schemas/PaymentMethod"
2260 },
2261 "example" : "cash"
2262 }, {
2263 "name" : "payment_status",
2264 "in" : "query",
2265 "description" : "Filter documents by PaymentStatus value.",
2266 "required" : false,
2267 "style" : "form",
2268 "explode" : true,
2269 "schema" : {
2270 "$ref" : "#/components/schemas/PaymentStatus"
2271 },
2272 "example" : "paid"
2273 }, {
2274 "name" : "start_date",
2275 "in" : "query",
2276 "description" : "Filter documents by date.",
2277 "required" : false,
2278 "style" : "form",
2279 "explode" : true,
2280 "schema" : {
2281 "type" : "string",
2282 "format" : "date"
2283 },
2284 "example" : "2020-05-15"
2285 }, {
2286 "name" : "end_date",
2287 "in" : "query",
2288 "description" : "Filter documents by date.",
2289 "required" : false,
2290 "style" : "form",
2291 "explode" : true,
2292 "schema" : {
2293 "type" : "string",
2294 "format" : "date"
2295 },
2296 "example" : "2020-05-15"
2297 }, {
2298 "name" : "start_number",
2299 "in" : "query",
2300 "description" : "Starting number of the document, should not contain year or any other formatting. Required if `start_year` given",
2301 "required" : false,
2302 "style" : "form",
2303 "explode" : true,
2304 "schema" : {
2305 "type" : "integer"
2306 },
2307 "example" : "1"
2308 }, {
2309 "name" : "end_number",
2310 "in" : "query",
2311 "description" : "Ending number of the document, should not contain year or any other formatting. Required if `end_year` given",
2312 "required" : false,
2313 "style" : "form",
2314 "explode" : true,
2315 "schema" : {
2316 "type" : "integer"
2317 },
2318 "example" : "10"
2319 }, {
2320 "name" : "start_year",
2321 "in" : "query",
2322 "description" : "Year for `start_number` parameter. Required if `start_number` given.",
2323 "required" : false,
2324 "style" : "form",
2325 "explode" : true,
2326 "schema" : {
2327 "type" : "integer"
2328 },
2329 "example" : "2020"
2330 }, {
2331 "name" : "end_year",
2332 "in" : "query",
2333 "description" : "Year for `end_number` parameter. Required if `end_number` given.",
2334 "required" : false,
2335 "style" : "form",
2336 "explode" : true,
2337 "schema" : {
2338 "type" : "integer"
2339 },
2340 "example" : "2020"
2341 } ],
2342 "responses" : {
2343 "200" : {
2344 "description" : "Success response",
2345 "headers" : {
2346 "X-RateLimit-Limit" : {
2347 "description" : "Request limit per minute.",
2348 "style" : "simple",
2349 "explode" : false,
2350 "schema" : {
2351 "type" : "integer",
2352 "format" : "int32"
2353 }
2354 },
2355 "X-RateLimit-Remaining" : {
2356 "description" : "The number of requests left for the time window.",
2357 "style" : "simple",
2358 "explode" : false,
2359 "schema" : {
2360 "type" : "integer",
2361 "format" : "int32"
2362 }
2363 },
2364 "X-RateLimit-Reset" : {
2365 "description" : "The timestamp at which the current rate limit window resets.",
2366 "style" : "simple",
2367 "explode" : false,
2368 "schema" : {
2369 "type" : "integer",
2370 "format" : "int32"
2371 }
2372 },
2373 "Retry-After" : {
2374 "description" : "How many seconds you have to wait before making new request.",
2375 "style" : "simple",
2376 "explode" : false,
2377 "schema" : {
2378 "type" : "integer",
2379 "format" : "int32"
2380 }
2381 }
2382 },
2383 "content" : {
2384 "application/json" : {
2385 "schema" : {
2386 "$ref" : "#/components/schemas/DocumentList"
2387 }
2388 }
2389 }
2390 },
2391 "400" : {
2392 "description" : "The request is malformed.",
2393 "headers" : {
2394 "X-RateLimit-Limit" : {
2395 "description" : "Request limit per minute.",
2396 "style" : "simple",
2397 "explode" : false,
2398 "schema" : {
2399 "type" : "integer",
2400 "format" : "int32"
2401 }
2402 },
2403 "X-RateLimit-Remaining" : {
2404 "description" : "The number of requests left for the time window.",
2405 "style" : "simple",
2406 "explode" : false,
2407 "schema" : {
2408 "type" : "integer",
2409 "format" : "int32"
2410 }
2411 },
2412 "X-RateLimit-Reset" : {
2413 "description" : "The timestamp at which the current rate limit window resets.",
2414 "style" : "simple",
2415 "explode" : false,
2416 "schema" : {
2417 "type" : "integer",
2418 "format" : "int32"
2419 }
2420 },
2421 "Retry-After" : {
2422 "description" : "How many seconds you have to wait before making new request.",
2423 "style" : "simple",
2424 "explode" : false,
2425 "schema" : {
2426 "type" : "integer",
2427 "format" : "int32"
2428 }
2429 }
2430 },
2431 "content" : {
2432 "application/json" : {
2433 "schema" : {
2434 "$ref" : "#/components/schemas/ClientErrorResponse"
2435 }
2436 }
2437 }
2438 },
2439 "401" : {
2440 "description" : "Authorization information is missing or invalid.",
2441 "headers" : {
2442 "X-RateLimit-Limit" : {
2443 "description" : "Request limit per minute.",
2444 "style" : "simple",
2445 "explode" : false,
2446 "schema" : {
2447 "type" : "integer",
2448 "format" : "int32"
2449 }
2450 },
2451 "X-RateLimit-Remaining" : {
2452 "description" : "The number of requests left for the time window.",
2453 "style" : "simple",
2454 "explode" : false,
2455 "schema" : {
2456 "type" : "integer",
2457 "format" : "int32"
2458 }
2459 },
2460 "X-RateLimit-Reset" : {
2461 "description" : "The timestamp at which the current rate limit window resets.",
2462 "style" : "simple",
2463 "explode" : false,
2464 "schema" : {
2465 "type" : "integer",
2466 "format" : "int32"
2467 }
2468 },
2469 "Retry-After" : {
2470 "description" : "How many seconds you have to wait before making new request.",
2471 "style" : "simple",
2472 "explode" : false,
2473 "schema" : {
2474 "type" : "integer",
2475 "format" : "int32"
2476 }
2477 }
2478 },
2479 "content" : {
2480 "application/json" : {
2481 "schema" : {
2482 "$ref" : "#/components/schemas/ClientErrorResponse"
2483 }
2484 }
2485 }
2486 },
2487 "402" : {
2488 "description" : "Authenticated user doesn't have subscription.",
2489 "content" : {
2490 "application/json" : {
2491 "schema" : {
2492 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
2493 }
2494 }
2495 }
2496 },
2497 "422" : {
2498 "description" : "Validation errors occured.",
2499 "headers" : {
2500 "X-RateLimit-Limit" : {
2501 "description" : "Request limit per minute.",
2502 "style" : "simple",
2503 "explode" : false,
2504 "schema" : {
2505 "type" : "integer",
2506 "format" : "int32"
2507 }
2508 },
2509 "X-RateLimit-Remaining" : {
2510 "description" : "The number of requests left for the time window.",
2511 "style" : "simple",
2512 "explode" : false,
2513 "schema" : {
2514 "type" : "integer",
2515 "format" : "int32"
2516 }
2517 },
2518 "X-RateLimit-Reset" : {
2519 "description" : "The timestamp at which the current rate limit window resets.",
2520 "style" : "simple",
2521 "explode" : false,
2522 "schema" : {
2523 "type" : "integer",
2524 "format" : "int32"
2525 }
2526 },
2527 "Retry-After" : {
2528 "description" : "How many seconds you have to wait before making new request.",
2529 "style" : "simple",
2530 "explode" : false,
2531 "schema" : {
2532 "type" : "integer",
2533 "format" : "int32"
2534 }
2535 }
2536 },
2537 "content" : {
2538 "application/json" : {
2539 "schema" : {
2540 "$ref" : "#/components/schemas/ValidationErrorResponse"
2541 }
2542 }
2543 }
2544 },
2545 "500" : {
2546 "description" : "Internal server error.",
2547 "headers" : {
2548 "X-RateLimit-Limit" : {
2549 "description" : "Request limit per minute.",
2550 "style" : "simple",
2551 "explode" : false,
2552 "schema" : {
2553 "type" : "integer",
2554 "format" : "int32"
2555 }
2556 },
2557 "X-RateLimit-Remaining" : {
2558 "description" : "The number of requests left for the time window.",
2559 "style" : "simple",
2560 "explode" : false,
2561 "schema" : {
2562 "type" : "integer",
2563 "format" : "int32"
2564 }
2565 },
2566 "X-RateLimit-Reset" : {
2567 "description" : "The timestamp at which the current rate limit window resets.",
2568 "style" : "simple",
2569 "explode" : false,
2570 "schema" : {
2571 "type" : "integer",
2572 "format" : "int32"
2573 }
2574 },
2575 "Retry-After" : {
2576 "description" : "How many seconds you have to wait before making new request.",
2577 "style" : "simple",
2578 "explode" : false,
2579 "schema" : {
2580 "type" : "integer",
2581 "format" : "int32"
2582 }
2583 }
2584 },
2585 "content" : {
2586 "application/json" : {
2587 "schema" : {
2588 "$ref" : "#/components/schemas/ServerErrorResponse"
2589 }
2590 }
2591 }
2592 }
2593 }
2594 },
2595 "post" : {
2596 "tags" : [ "Document" ],
2597 "summary" : "Create a document",
2598 "description" : "Create a new document. Returns a document object if the create is succeded.",
2599 "operationId" : "CreateDocument",
2600 "requestBody" : {
2601 "description" : "DocumentInsert object that you would like to store.",
2602 "content" : {
2603 "application/json" : {
2604 "schema" : {
2605 "$ref" : "#/components/schemas/DocumentInsert"
2606 }
2607 }
2608 },
2609 "required" : true
2610 },
2611 "responses" : {
2612 "201" : {
2613 "description" : "Document created successfully.",
2614 "headers" : {
2615 "X-RateLimit-Limit" : {
2616 "description" : "Request limit per minute.",
2617 "style" : "simple",
2618 "explode" : false,
2619 "schema" : {
2620 "type" : "integer",
2621 "format" : "int32"
2622 }
2623 },
2624 "X-RateLimit-Remaining" : {
2625 "description" : "The number of requests left for the time window.",
2626 "style" : "simple",
2627 "explode" : false,
2628 "schema" : {
2629 "type" : "integer",
2630 "format" : "int32"
2631 }
2632 },
2633 "X-RateLimit-Reset" : {
2634 "description" : "The timestamp at which the current rate limit window resets.",
2635 "style" : "simple",
2636 "explode" : false,
2637 "schema" : {
2638 "type" : "integer",
2639 "format" : "int32"
2640 }
2641 },
2642 "Retry-After" : {
2643 "description" : "How many seconds you have to wait before making new request.",
2644 "style" : "simple",
2645 "explode" : false,
2646 "schema" : {
2647 "type" : "integer",
2648 "format" : "int32"
2649 }
2650 }
2651 },
2652 "content" : {
2653 "application/json" : {
2654 "schema" : {
2655 "$ref" : "#/components/schemas/Document"
2656 }
2657 }
2658 }
2659 },
2660 "400" : {
2661 "description" : "The request is malformed.",
2662 "headers" : {
2663 "X-RateLimit-Limit" : {
2664 "description" : "Request limit per minute.",
2665 "style" : "simple",
2666 "explode" : false,
2667 "schema" : {
2668 "type" : "integer",
2669 "format" : "int32"
2670 }
2671 },
2672 "X-RateLimit-Remaining" : {
2673 "description" : "The number of requests left for the time window.",
2674 "style" : "simple",
2675 "explode" : false,
2676 "schema" : {
2677 "type" : "integer",
2678 "format" : "int32"
2679 }
2680 },
2681 "X-RateLimit-Reset" : {
2682 "description" : "The timestamp at which the current rate limit window resets.",
2683 "style" : "simple",
2684 "explode" : false,
2685 "schema" : {
2686 "type" : "integer",
2687 "format" : "int32"
2688 }
2689 },
2690 "Retry-After" : {
2691 "description" : "How many seconds you have to wait before making new request.",
2692 "style" : "simple",
2693 "explode" : false,
2694 "schema" : {
2695 "type" : "integer",
2696 "format" : "int32"
2697 }
2698 }
2699 },
2700 "content" : {
2701 "application/json" : {
2702 "schema" : {
2703 "$ref" : "#/components/schemas/ClientErrorResponse"
2704 }
2705 }
2706 }
2707 },
2708 "401" : {
2709 "description" : "Authorization information is missing or invalid.",
2710 "headers" : {
2711 "X-RateLimit-Limit" : {
2712 "description" : "Request limit per minute.",
2713 "style" : "simple",
2714 "explode" : false,
2715 "schema" : {
2716 "type" : "integer",
2717 "format" : "int32"
2718 }
2719 },
2720 "X-RateLimit-Remaining" : {
2721 "description" : "The number of requests left for the time window.",
2722 "style" : "simple",
2723 "explode" : false,
2724 "schema" : {
2725 "type" : "integer",
2726 "format" : "int32"
2727 }
2728 },
2729 "X-RateLimit-Reset" : {
2730 "description" : "The timestamp at which the current rate limit window resets.",
2731 "style" : "simple",
2732 "explode" : false,
2733 "schema" : {
2734 "type" : "integer",
2735 "format" : "int32"
2736 }
2737 },
2738 "Retry-After" : {
2739 "description" : "How many seconds you have to wait before making new request.",
2740 "style" : "simple",
2741 "explode" : false,
2742 "schema" : {
2743 "type" : "integer",
2744 "format" : "int32"
2745 }
2746 }
2747 },
2748 "content" : {
2749 "application/json" : {
2750 "schema" : {
2751 "$ref" : "#/components/schemas/ClientErrorResponse"
2752 }
2753 }
2754 }
2755 },
2756 "402" : {
2757 "description" : "Authenticated user doesn't have subscription.",
2758 "content" : {
2759 "application/json" : {
2760 "schema" : {
2761 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
2762 }
2763 }
2764 }
2765 },
2766 "403" : {
2767 "description" : "Authenticated user doesn't have access to the resource.",
2768 "headers" : {
2769 "X-RateLimit-Limit" : {
2770 "description" : "Request limit per minute.",
2771 "style" : "simple",
2772 "explode" : false,
2773 "schema" : {
2774 "type" : "integer",
2775 "format" : "int32"
2776 }
2777 },
2778 "X-RateLimit-Remaining" : {
2779 "description" : "The number of requests left for the time window.",
2780 "style" : "simple",
2781 "explode" : false,
2782 "schema" : {
2783 "type" : "integer",
2784 "format" : "int32"
2785 }
2786 },
2787 "X-RateLimit-Reset" : {
2788 "description" : "The timestamp at which the current rate limit window resets.",
2789 "style" : "simple",
2790 "explode" : false,
2791 "schema" : {
2792 "type" : "integer",
2793 "format" : "int32"
2794 }
2795 },
2796 "Retry-After" : {
2797 "description" : "How many seconds you have to wait before making new request.",
2798 "style" : "simple",
2799 "explode" : false,
2800 "schema" : {
2801 "type" : "integer",
2802 "format" : "int32"
2803 }
2804 }
2805 },
2806 "content" : {
2807 "application/json" : {
2808 "schema" : {
2809 "$ref" : "#/components/schemas/ClientErrorResponse"
2810 }
2811 }
2812 }
2813 },
2814 "422" : {
2815 "description" : "Validation errors occured.",
2816 "headers" : {
2817 "X-RateLimit-Limit" : {
2818 "description" : "Request limit per minute.",
2819 "style" : "simple",
2820 "explode" : false,
2821 "schema" : {
2822 "type" : "integer",
2823 "format" : "int32"
2824 }
2825 },
2826 "X-RateLimit-Remaining" : {
2827 "description" : "The number of requests left for the time window.",
2828 "style" : "simple",
2829 "explode" : false,
2830 "schema" : {
2831 "type" : "integer",
2832 "format" : "int32"
2833 }
2834 },
2835 "X-RateLimit-Reset" : {
2836 "description" : "The timestamp at which the current rate limit window resets.",
2837 "style" : "simple",
2838 "explode" : false,
2839 "schema" : {
2840 "type" : "integer",
2841 "format" : "int32"
2842 }
2843 },
2844 "Retry-After" : {
2845 "description" : "How many seconds you have to wait before making new request.",
2846 "style" : "simple",
2847 "explode" : false,
2848 "schema" : {
2849 "type" : "integer",
2850 "format" : "int32"
2851 }
2852 }
2853 },
2854 "content" : {
2855 "application/json" : {
2856 "schema" : {
2857 "$ref" : "#/components/schemas/ValidationErrorResponse"
2858 }
2859 }
2860 }
2861 },
2862 "500" : {
2863 "description" : "Internal server error.",
2864 "headers" : {
2865 "X-RateLimit-Limit" : {
2866 "description" : "Request limit per minute.",
2867 "style" : "simple",
2868 "explode" : false,
2869 "schema" : {
2870 "type" : "integer",
2871 "format" : "int32"
2872 }
2873 },
2874 "X-RateLimit-Remaining" : {
2875 "description" : "The number of requests left for the time window.",
2876 "style" : "simple",
2877 "explode" : false,
2878 "schema" : {
2879 "type" : "integer",
2880 "format" : "int32"
2881 }
2882 },
2883 "X-RateLimit-Reset" : {
2884 "description" : "The timestamp at which the current rate limit window resets.",
2885 "style" : "simple",
2886 "explode" : false,
2887 "schema" : {
2888 "type" : "integer",
2889 "format" : "int32"
2890 }
2891 },
2892 "Retry-After" : {
2893 "description" : "How many seconds you have to wait before making new request.",
2894 "style" : "simple",
2895 "explode" : false,
2896 "schema" : {
2897 "type" : "integer",
2898 "format" : "int32"
2899 }
2900 }
2901 },
2902 "content" : {
2903 "application/json" : {
2904 "schema" : {
2905 "$ref" : "#/components/schemas/ServerErrorResponse"
2906 }
2907 }
2908 }
2909 }
2910 }
2911 }
2912 },
2913 "/documents/{id}" : {
2914 "get" : {
2915 "tags" : [ "Document" ],
2916 "summary" : "Retrieve a document",
2917 "description" : "Retrieves the details of an existing document.",
2918 "operationId" : "GetDocument",
2919 "parameters" : [ {
2920 "name" : "id",
2921 "in" : "path",
2922 "required" : true,
2923 "style" : "simple",
2924 "explode" : false,
2925 "schema" : {
2926 "type" : "integer"
2927 }
2928 } ],
2929 "responses" : {
2930 "200" : {
2931 "description" : "Success response",
2932 "headers" : {
2933 "X-RateLimit-Limit" : {
2934 "description" : "Request limit per minute.",
2935 "style" : "simple",
2936 "explode" : false,
2937 "schema" : {
2938 "type" : "integer",
2939 "format" : "int32"
2940 }
2941 },
2942 "X-RateLimit-Remaining" : {
2943 "description" : "The number of requests left for the time window.",
2944 "style" : "simple",
2945 "explode" : false,
2946 "schema" : {
2947 "type" : "integer",
2948 "format" : "int32"
2949 }
2950 },
2951 "X-RateLimit-Reset" : {
2952 "description" : "The timestamp at which the current rate limit window resets.",
2953 "style" : "simple",
2954 "explode" : false,
2955 "schema" : {
2956 "type" : "integer",
2957 "format" : "int32"
2958 }
2959 },
2960 "Retry-After" : {
2961 "description" : "How many seconds you have to wait before making new request.",
2962 "style" : "simple",
2963 "explode" : false,
2964 "schema" : {
2965 "type" : "integer",
2966 "format" : "int32"
2967 }
2968 }
2969 },
2970 "content" : {
2971 "application/json" : {
2972 "schema" : {
2973 "$ref" : "#/components/schemas/Document"
2974 }
2975 }
2976 }
2977 },
2978 "400" : {
2979 "description" : "The request is malformed.",
2980 "headers" : {
2981 "X-RateLimit-Limit" : {
2982 "description" : "Request limit per minute.",
2983 "style" : "simple",
2984 "explode" : false,
2985 "schema" : {
2986 "type" : "integer",
2987 "format" : "int32"
2988 }
2989 },
2990 "X-RateLimit-Remaining" : {
2991 "description" : "The number of requests left for the time window.",
2992 "style" : "simple",
2993 "explode" : false,
2994 "schema" : {
2995 "type" : "integer",
2996 "format" : "int32"
2997 }
2998 },
2999 "X-RateLimit-Reset" : {
3000 "description" : "The timestamp at which the current rate limit window resets.",
3001 "style" : "simple",
3002 "explode" : false,
3003 "schema" : {
3004 "type" : "integer",
3005 "format" : "int32"
3006 }
3007 },
3008 "Retry-After" : {
3009 "description" : "How many seconds you have to wait before making new request.",
3010 "style" : "simple",
3011 "explode" : false,
3012 "schema" : {
3013 "type" : "integer",
3014 "format" : "int32"
3015 }
3016 }
3017 },
3018 "content" : {
3019 "application/json" : {
3020 "schema" : {
3021 "$ref" : "#/components/schemas/ClientErrorResponse"
3022 }
3023 }
3024 }
3025 },
3026 "401" : {
3027 "description" : "Authorization information is missing or invalid.",
3028 "headers" : {
3029 "X-RateLimit-Limit" : {
3030 "description" : "Request limit per minute.",
3031 "style" : "simple",
3032 "explode" : false,
3033 "schema" : {
3034 "type" : "integer",
3035 "format" : "int32"
3036 }
3037 },
3038 "X-RateLimit-Remaining" : {
3039 "description" : "The number of requests left for the time window.",
3040 "style" : "simple",
3041 "explode" : false,
3042 "schema" : {
3043 "type" : "integer",
3044 "format" : "int32"
3045 }
3046 },
3047 "X-RateLimit-Reset" : {
3048 "description" : "The timestamp at which the current rate limit window resets.",
3049 "style" : "simple",
3050 "explode" : false,
3051 "schema" : {
3052 "type" : "integer",
3053 "format" : "int32"
3054 }
3055 },
3056 "Retry-After" : {
3057 "description" : "How many seconds you have to wait before making new request.",
3058 "style" : "simple",
3059 "explode" : false,
3060 "schema" : {
3061 "type" : "integer",
3062 "format" : "int32"
3063 }
3064 }
3065 },
3066 "content" : {
3067 "application/json" : {
3068 "schema" : {
3069 "$ref" : "#/components/schemas/ClientErrorResponse"
3070 }
3071 }
3072 }
3073 },
3074 "402" : {
3075 "description" : "Authenticated user doesn't have subscription.",
3076 "content" : {
3077 "application/json" : {
3078 "schema" : {
3079 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
3080 }
3081 }
3082 }
3083 },
3084 "404" : {
3085 "description" : "Non-existent resource is requested.",
3086 "headers" : {
3087 "X-RateLimit-Limit" : {
3088 "description" : "Request limit per minute.",
3089 "style" : "simple",
3090 "explode" : false,
3091 "schema" : {
3092 "type" : "integer",
3093 "format" : "int32"
3094 }
3095 },
3096 "X-RateLimit-Remaining" : {
3097 "description" : "The number of requests left for the time window.",
3098 "style" : "simple",
3099 "explode" : false,
3100 "schema" : {
3101 "type" : "integer",
3102 "format" : "int32"
3103 }
3104 },
3105 "X-RateLimit-Reset" : {
3106 "description" : "The timestamp at which the current rate limit window resets.",
3107 "style" : "simple",
3108 "explode" : false,
3109 "schema" : {
3110 "type" : "integer",
3111 "format" : "int32"
3112 }
3113 },
3114 "Retry-After" : {
3115 "description" : "How many seconds you have to wait before making new request.",
3116 "style" : "simple",
3117 "explode" : false,
3118 "schema" : {
3119 "type" : "integer",
3120 "format" : "int32"
3121 }
3122 }
3123 },
3124 "content" : {
3125 "application/json" : {
3126 "schema" : {
3127 "$ref" : "#/components/schemas/ClientErrorResponse"
3128 }
3129 }
3130 }
3131 },
3132 "422" : {
3133 "description" : "Validation errors occured.",
3134 "headers" : {
3135 "X-RateLimit-Limit" : {
3136 "description" : "Request limit per minute.",
3137 "style" : "simple",
3138 "explode" : false,
3139 "schema" : {
3140 "type" : "integer",
3141 "format" : "int32"
3142 }
3143 },
3144 "X-RateLimit-Remaining" : {
3145 "description" : "The number of requests left for the time window.",
3146 "style" : "simple",
3147 "explode" : false,
3148 "schema" : {
3149 "type" : "integer",
3150 "format" : "int32"
3151 }
3152 },
3153 "X-RateLimit-Reset" : {
3154 "description" : "The timestamp at which the current rate limit window resets.",
3155 "style" : "simple",
3156 "explode" : false,
3157 "schema" : {
3158 "type" : "integer",
3159 "format" : "int32"
3160 }
3161 },
3162 "Retry-After" : {
3163 "description" : "How many seconds you have to wait before making new request.",
3164 "style" : "simple",
3165 "explode" : false,
3166 "schema" : {
3167 "type" : "integer",
3168 "format" : "int32"
3169 }
3170 }
3171 },
3172 "content" : {
3173 "application/json" : {
3174 "schema" : {
3175 "$ref" : "#/components/schemas/ValidationErrorResponse"
3176 }
3177 }
3178 }
3179 },
3180 "500" : {
3181 "description" : "Internal server error.",
3182 "headers" : {
3183 "X-RateLimit-Limit" : {
3184 "description" : "Request limit per minute.",
3185 "style" : "simple",
3186 "explode" : false,
3187 "schema" : {
3188 "type" : "integer",
3189 "format" : "int32"
3190 }
3191 },
3192 "X-RateLimit-Remaining" : {
3193 "description" : "The number of requests left for the time window.",
3194 "style" : "simple",
3195 "explode" : false,
3196 "schema" : {
3197 "type" : "integer",
3198 "format" : "int32"
3199 }
3200 },
3201 "X-RateLimit-Reset" : {
3202 "description" : "The timestamp at which the current rate limit window resets.",
3203 "style" : "simple",
3204 "explode" : false,
3205 "schema" : {
3206 "type" : "integer",
3207 "format" : "int32"
3208 }
3209 },
3210 "Retry-After" : {
3211 "description" : "How many seconds you have to wait before making new request.",
3212 "style" : "simple",
3213 "explode" : false,
3214 "schema" : {
3215 "type" : "integer",
3216 "format" : "int32"
3217 }
3218 }
3219 },
3220 "content" : {
3221 "application/json" : {
3222 "schema" : {
3223 "$ref" : "#/components/schemas/ServerErrorResponse"
3224 }
3225 }
3226 }
3227 }
3228 }
3229 }
3230 },
3231 "/documents/{id}/cancel" : {
3232 "post" : {
3233 "tags" : [ "Document" ],
3234 "summary" : "Cancel a document",
3235 "description" : "Cancel a document. Returns a cancellation document object if the cancellation is succeded.",
3236 "operationId" : "CancelDocument",
3237 "parameters" : [ {
3238 "name" : "id",
3239 "in" : "path",
3240 "required" : true,
3241 "style" : "simple",
3242 "explode" : false,
3243 "schema" : {
3244 "type" : "integer"
3245 }
3246 } ],
3247 "responses" : {
3248 "200" : {
3249 "description" : "Document cancellation successfully. Cancel document returned.",
3250 "headers" : {
3251 "X-RateLimit-Limit" : {
3252 "description" : "Request limit per minute.",
3253 "style" : "simple",
3254 "explode" : false,
3255 "schema" : {
3256 "type" : "integer",
3257 "format" : "int32"
3258 }
3259 },
3260 "X-RateLimit-Remaining" : {
3261 "description" : "The number of requests left for the time window.",
3262 "style" : "simple",
3263 "explode" : false,
3264 "schema" : {
3265 "type" : "integer",
3266 "format" : "int32"
3267 }
3268 },
3269 "X-RateLimit-Reset" : {
3270 "description" : "The timestamp at which the current rate limit window resets.",
3271 "style" : "simple",
3272 "explode" : false,
3273 "schema" : {
3274 "type" : "integer",
3275 "format" : "int32"
3276 }
3277 },
3278 "Retry-After" : {
3279 "description" : "How many seconds you have to wait before making new request.",
3280 "style" : "simple",
3281 "explode" : false,
3282 "schema" : {
3283 "type" : "integer",
3284 "format" : "int32"
3285 }
3286 }
3287 },
3288 "content" : {
3289 "application/json" : {
3290 "schema" : {
3291 "$ref" : "#/components/schemas/Document"
3292 }
3293 }
3294 }
3295 },
3296 "400" : {
3297 "description" : "The request is malformed.",
3298 "headers" : {
3299 "X-RateLimit-Limit" : {
3300 "description" : "Request limit per minute.",
3301 "style" : "simple",
3302 "explode" : false,
3303 "schema" : {
3304 "type" : "integer",
3305 "format" : "int32"
3306 }
3307 },
3308 "X-RateLimit-Remaining" : {
3309 "description" : "The number of requests left for the time window.",
3310 "style" : "simple",
3311 "explode" : false,
3312 "schema" : {
3313 "type" : "integer",
3314 "format" : "int32"
3315 }
3316 },
3317 "X-RateLimit-Reset" : {
3318 "description" : "The timestamp at which the current rate limit window resets.",
3319 "style" : "simple",
3320 "explode" : false,
3321 "schema" : {
3322 "type" : "integer",
3323 "format" : "int32"
3324 }
3325 },
3326 "Retry-After" : {
3327 "description" : "How many seconds you have to wait before making new request.",
3328 "style" : "simple",
3329 "explode" : false,
3330 "schema" : {
3331 "type" : "integer",
3332 "format" : "int32"
3333 }
3334 }
3335 },
3336 "content" : {
3337 "application/json" : {
3338 "schema" : {
3339 "$ref" : "#/components/schemas/ClientErrorResponse"
3340 }
3341 }
3342 }
3343 },
3344 "401" : {
3345 "description" : "Authorization information is missing or invalid.",
3346 "headers" : {
3347 "X-RateLimit-Limit" : {
3348 "description" : "Request limit per minute.",
3349 "style" : "simple",
3350 "explode" : false,
3351 "schema" : {
3352 "type" : "integer",
3353 "format" : "int32"
3354 }
3355 },
3356 "X-RateLimit-Remaining" : {
3357 "description" : "The number of requests left for the time window.",
3358 "style" : "simple",
3359 "explode" : false,
3360 "schema" : {
3361 "type" : "integer",
3362 "format" : "int32"
3363 }
3364 },
3365 "X-RateLimit-Reset" : {
3366 "description" : "The timestamp at which the current rate limit window resets.",
3367 "style" : "simple",
3368 "explode" : false,
3369 "schema" : {
3370 "type" : "integer",
3371 "format" : "int32"
3372 }
3373 },
3374 "Retry-After" : {
3375 "description" : "How many seconds you have to wait before making new request.",
3376 "style" : "simple",
3377 "explode" : false,
3378 "schema" : {
3379 "type" : "integer",
3380 "format" : "int32"
3381 }
3382 }
3383 },
3384 "content" : {
3385 "application/json" : {
3386 "schema" : {
3387 "$ref" : "#/components/schemas/ClientErrorResponse"
3388 }
3389 }
3390 }
3391 },
3392 "402" : {
3393 "description" : "Authenticated user doesn't have subscription.",
3394 "content" : {
3395 "application/json" : {
3396 "schema" : {
3397 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
3398 }
3399 }
3400 }
3401 },
3402 "403" : {
3403 "description" : "Authenticated user doesn't have access to the resource.",
3404 "headers" : {
3405 "X-RateLimit-Limit" : {
3406 "description" : "Request limit per minute.",
3407 "style" : "simple",
3408 "explode" : false,
3409 "schema" : {
3410 "type" : "integer",
3411 "format" : "int32"
3412 }
3413 },
3414 "X-RateLimit-Remaining" : {
3415 "description" : "The number of requests left for the time window.",
3416 "style" : "simple",
3417 "explode" : false,
3418 "schema" : {
3419 "type" : "integer",
3420 "format" : "int32"
3421 }
3422 },
3423 "X-RateLimit-Reset" : {
3424 "description" : "The timestamp at which the current rate limit window resets.",
3425 "style" : "simple",
3426 "explode" : false,
3427 "schema" : {
3428 "type" : "integer",
3429 "format" : "int32"
3430 }
3431 },
3432 "Retry-After" : {
3433 "description" : "How many seconds you have to wait before making new request.",
3434 "style" : "simple",
3435 "explode" : false,
3436 "schema" : {
3437 "type" : "integer",
3438 "format" : "int32"
3439 }
3440 }
3441 },
3442 "content" : {
3443 "application/json" : {
3444 "schema" : {
3445 "$ref" : "#/components/schemas/ClientErrorResponse"
3446 }
3447 }
3448 }
3449 },
3450 "404" : {
3451 "description" : "Non-existent resource is requested.",
3452 "headers" : {
3453 "X-RateLimit-Limit" : {
3454 "description" : "Request limit per minute.",
3455 "style" : "simple",
3456 "explode" : false,
3457 "schema" : {
3458 "type" : "integer",
3459 "format" : "int32"
3460 }
3461 },
3462 "X-RateLimit-Remaining" : {
3463 "description" : "The number of requests left for the time window.",
3464 "style" : "simple",
3465 "explode" : false,
3466 "schema" : {
3467 "type" : "integer",
3468 "format" : "int32"
3469 }
3470 },
3471 "X-RateLimit-Reset" : {
3472 "description" : "The timestamp at which the current rate limit window resets.",
3473 "style" : "simple",
3474 "explode" : false,
3475 "schema" : {
3476 "type" : "integer",
3477 "format" : "int32"
3478 }
3479 },
3480 "Retry-After" : {
3481 "description" : "How many seconds you have to wait before making new request.",
3482 "style" : "simple",
3483 "explode" : false,
3484 "schema" : {
3485 "type" : "integer",
3486 "format" : "int32"
3487 }
3488 }
3489 },
3490 "content" : {
3491 "application/json" : {
3492 "schema" : {
3493 "$ref" : "#/components/schemas/ClientErrorResponse"
3494 }
3495 }
3496 }
3497 },
3498 "422" : {
3499 "description" : "Validation errors occured.",
3500 "headers" : {
3501 "X-RateLimit-Limit" : {
3502 "description" : "Request limit per minute.",
3503 "style" : "simple",
3504 "explode" : false,
3505 "schema" : {
3506 "type" : "integer",
3507 "format" : "int32"
3508 }
3509 },
3510 "X-RateLimit-Remaining" : {
3511 "description" : "The number of requests left for the time window.",
3512 "style" : "simple",
3513 "explode" : false,
3514 "schema" : {
3515 "type" : "integer",
3516 "format" : "int32"
3517 }
3518 },
3519 "X-RateLimit-Reset" : {
3520 "description" : "The timestamp at which the current rate limit window resets.",
3521 "style" : "simple",
3522 "explode" : false,
3523 "schema" : {
3524 "type" : "integer",
3525 "format" : "int32"
3526 }
3527 },
3528 "Retry-After" : {
3529 "description" : "How many seconds you have to wait before making new request.",
3530 "style" : "simple",
3531 "explode" : false,
3532 "schema" : {
3533 "type" : "integer",
3534 "format" : "int32"
3535 }
3536 }
3537 },
3538 "content" : {
3539 "application/json" : {
3540 "schema" : {
3541 "$ref" : "#/components/schemas/ValidationErrorResponse"
3542 }
3543 }
3544 }
3545 },
3546 "500" : {
3547 "description" : "Internal server error.",
3548 "headers" : {
3549 "X-RateLimit-Limit" : {
3550 "description" : "Request limit per minute.",
3551 "style" : "simple",
3552 "explode" : false,
3553 "schema" : {
3554 "type" : "integer",
3555 "format" : "int32"
3556 }
3557 },
3558 "X-RateLimit-Remaining" : {
3559 "description" : "The number of requests left for the time window.",
3560 "style" : "simple",
3561 "explode" : false,
3562 "schema" : {
3563 "type" : "integer",
3564 "format" : "int32"
3565 }
3566 },
3567 "X-RateLimit-Reset" : {
3568 "description" : "The timestamp at which the current rate limit window resets.",
3569 "style" : "simple",
3570 "explode" : false,
3571 "schema" : {
3572 "type" : "integer",
3573 "format" : "int32"
3574 }
3575 },
3576 "Retry-After" : {
3577 "description" : "How many seconds you have to wait before making new request.",
3578 "style" : "simple",
3579 "explode" : false,
3580 "schema" : {
3581 "type" : "integer",
3582 "format" : "int32"
3583 }
3584 }
3585 },
3586 "content" : {
3587 "application/json" : {
3588 "schema" : {
3589 "$ref" : "#/components/schemas/ServerErrorResponse"
3590 }
3591 }
3592 }
3593 }
3594 }
3595 }
3596 },
3597 "/documents/{id}/create-from-proforma" : {
3598 "post" : {
3599 "tags" : [ "Document" ],
3600 "summary" : "Create a document from proforma.",
3601 "description" : "Create a new document from proforma. Returns a document object if the create is succeded.",
3602 "operationId" : "CreateDocumentFromProforma",
3603 "parameters" : [ {
3604 "name" : "id",
3605 "in" : "path",
3606 "required" : true,
3607 "style" : "simple",
3608 "explode" : false,
3609 "schema" : {
3610 "type" : "integer"
3611 }
3612 } ],
3613 "responses" : {
3614 "201" : {
3615 "description" : "Document created successfully.",
3616 "headers" : {
3617 "X-RateLimit-Limit" : {
3618 "description" : "Request limit per minute.",
3619 "style" : "simple",
3620 "explode" : false,
3621 "schema" : {
3622 "type" : "integer",
3623 "format" : "int32"
3624 }
3625 },
3626 "X-RateLimit-Remaining" : {
3627 "description" : "The number of requests left for the time window.",
3628 "style" : "simple",
3629 "explode" : false,
3630 "schema" : {
3631 "type" : "integer",
3632 "format" : "int32"
3633 }
3634 },
3635 "X-RateLimit-Reset" : {
3636 "description" : "The timestamp at which the current rate limit window resets.",
3637 "style" : "simple",
3638 "explode" : false,
3639 "schema" : {
3640 "type" : "integer",
3641 "format" : "int32"
3642 }
3643 },
3644 "Retry-After" : {
3645 "description" : "How many seconds you have to wait before making new request.",
3646 "style" : "simple",
3647 "explode" : false,
3648 "schema" : {
3649 "type" : "integer",
3650 "format" : "int32"
3651 }
3652 }
3653 },
3654 "content" : {
3655 "application/json" : {
3656 "schema" : {
3657 "$ref" : "#/components/schemas/Document"
3658 }
3659 }
3660 }
3661 },
3662 "400" : {
3663 "description" : "The request is malformed.",
3664 "headers" : {
3665 "X-RateLimit-Limit" : {
3666 "description" : "Request limit per minute.",
3667 "style" : "simple",
3668 "explode" : false,
3669 "schema" : {
3670 "type" : "integer",
3671 "format" : "int32"
3672 }
3673 },
3674 "X-RateLimit-Remaining" : {
3675 "description" : "The number of requests left for the time window.",
3676 "style" : "simple",
3677 "explode" : false,
3678 "schema" : {
3679 "type" : "integer",
3680 "format" : "int32"
3681 }
3682 },
3683 "X-RateLimit-Reset" : {
3684 "description" : "The timestamp at which the current rate limit window resets.",
3685 "style" : "simple",
3686 "explode" : false,
3687 "schema" : {
3688 "type" : "integer",
3689 "format" : "int32"
3690 }
3691 },
3692 "Retry-After" : {
3693 "description" : "How many seconds you have to wait before making new request.",
3694 "style" : "simple",
3695 "explode" : false,
3696 "schema" : {
3697 "type" : "integer",
3698 "format" : "int32"
3699 }
3700 }
3701 },
3702 "content" : {
3703 "application/json" : {
3704 "schema" : {
3705 "$ref" : "#/components/schemas/ClientErrorResponse"
3706 }
3707 }
3708 }
3709 },
3710 "401" : {
3711 "description" : "Authorization information is missing or invalid.",
3712 "headers" : {
3713 "X-RateLimit-Limit" : {
3714 "description" : "Request limit per minute.",
3715 "style" : "simple",
3716 "explode" : false,
3717 "schema" : {
3718 "type" : "integer",
3719 "format" : "int32"
3720 }
3721 },
3722 "X-RateLimit-Remaining" : {
3723 "description" : "The number of requests left for the time window.",
3724 "style" : "simple",
3725 "explode" : false,
3726 "schema" : {
3727 "type" : "integer",
3728 "format" : "int32"
3729 }
3730 },
3731 "X-RateLimit-Reset" : {
3732 "description" : "The timestamp at which the current rate limit window resets.",
3733 "style" : "simple",
3734 "explode" : false,
3735 "schema" : {
3736 "type" : "integer",
3737 "format" : "int32"
3738 }
3739 },
3740 "Retry-After" : {
3741 "description" : "How many seconds you have to wait before making new request.",
3742 "style" : "simple",
3743 "explode" : false,
3744 "schema" : {
3745 "type" : "integer",
3746 "format" : "int32"
3747 }
3748 }
3749 },
3750 "content" : {
3751 "application/json" : {
3752 "schema" : {
3753 "$ref" : "#/components/schemas/ClientErrorResponse"
3754 }
3755 }
3756 }
3757 },
3758 "402" : {
3759 "description" : "Authenticated user doesn't have subscription.",
3760 "content" : {
3761 "application/json" : {
3762 "schema" : {
3763 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
3764 }
3765 }
3766 }
3767 },
3768 "403" : {
3769 "description" : "Authenticated user doesn't have access to the resource.",
3770 "headers" : {
3771 "X-RateLimit-Limit" : {
3772 "description" : "Request limit per minute.",
3773 "style" : "simple",
3774 "explode" : false,
3775 "schema" : {
3776 "type" : "integer",
3777 "format" : "int32"
3778 }
3779 },
3780 "X-RateLimit-Remaining" : {
3781 "description" : "The number of requests left for the time window.",
3782 "style" : "simple",
3783 "explode" : false,
3784 "schema" : {
3785 "type" : "integer",
3786 "format" : "int32"
3787 }
3788 },
3789 "X-RateLimit-Reset" : {
3790 "description" : "The timestamp at which the current rate limit window resets.",
3791 "style" : "simple",
3792 "explode" : false,
3793 "schema" : {
3794 "type" : "integer",
3795 "format" : "int32"
3796 }
3797 },
3798 "Retry-After" : {
3799 "description" : "How many seconds you have to wait before making new request.",
3800 "style" : "simple",
3801 "explode" : false,
3802 "schema" : {
3803 "type" : "integer",
3804 "format" : "int32"
3805 }
3806 }
3807 },
3808 "content" : {
3809 "application/json" : {
3810 "schema" : {
3811 "$ref" : "#/components/schemas/ClientErrorResponse"
3812 }
3813 }
3814 }
3815 },
3816 "404" : {
3817 "description" : "Non-existent resource is requested.",
3818 "headers" : {
3819 "X-RateLimit-Limit" : {
3820 "description" : "Request limit per minute.",
3821 "style" : "simple",
3822 "explode" : false,
3823 "schema" : {
3824 "type" : "integer",
3825 "format" : "int32"
3826 }
3827 },
3828 "X-RateLimit-Remaining" : {
3829 "description" : "The number of requests left for the time window.",
3830 "style" : "simple",
3831 "explode" : false,
3832 "schema" : {
3833 "type" : "integer",
3834 "format" : "int32"
3835 }
3836 },
3837 "X-RateLimit-Reset" : {
3838 "description" : "The timestamp at which the current rate limit window resets.",
3839 "style" : "simple",
3840 "explode" : false,
3841 "schema" : {
3842 "type" : "integer",
3843 "format" : "int32"
3844 }
3845 },
3846 "Retry-After" : {
3847 "description" : "How many seconds you have to wait before making new request.",
3848 "style" : "simple",
3849 "explode" : false,
3850 "schema" : {
3851 "type" : "integer",
3852 "format" : "int32"
3853 }
3854 }
3855 },
3856 "content" : {
3857 "application/json" : {
3858 "schema" : {
3859 "$ref" : "#/components/schemas/ClientErrorResponse"
3860 }
3861 }
3862 }
3863 },
3864 "422" : {
3865 "description" : "Validation errors occured.",
3866 "headers" : {
3867 "X-RateLimit-Limit" : {
3868 "description" : "Request limit per minute.",
3869 "style" : "simple",
3870 "explode" : false,
3871 "schema" : {
3872 "type" : "integer",
3873 "format" : "int32"
3874 }
3875 },
3876 "X-RateLimit-Remaining" : {
3877 "description" : "The number of requests left for the time window.",
3878 "style" : "simple",
3879 "explode" : false,
3880 "schema" : {
3881 "type" : "integer",
3882 "format" : "int32"
3883 }
3884 },
3885 "X-RateLimit-Reset" : {
3886 "description" : "The timestamp at which the current rate limit window resets.",
3887 "style" : "simple",
3888 "explode" : false,
3889 "schema" : {
3890 "type" : "integer",
3891 "format" : "int32"
3892 }
3893 },
3894 "Retry-After" : {
3895 "description" : "How many seconds you have to wait before making new request.",
3896 "style" : "simple",
3897 "explode" : false,
3898 "schema" : {
3899 "type" : "integer",
3900 "format" : "int32"
3901 }
3902 }
3903 },
3904 "content" : {
3905 "application/json" : {
3906 "schema" : {
3907 "$ref" : "#/components/schemas/ValidationErrorResponse"
3908 }
3909 }
3910 }
3911 },
3912 "500" : {
3913 "description" : "Internal server error.",
3914 "headers" : {
3915 "X-RateLimit-Limit" : {
3916 "description" : "Request limit per minute.",
3917 "style" : "simple",
3918 "explode" : false,
3919 "schema" : {
3920 "type" : "integer",
3921 "format" : "int32"
3922 }
3923 },
3924 "X-RateLimit-Remaining" : {
3925 "description" : "The number of requests left for the time window.",
3926 "style" : "simple",
3927 "explode" : false,
3928 "schema" : {
3929 "type" : "integer",
3930 "format" : "int32"
3931 }
3932 },
3933 "X-RateLimit-Reset" : {
3934 "description" : "The timestamp at which the current rate limit window resets.",
3935 "style" : "simple",
3936 "explode" : false,
3937 "schema" : {
3938 "type" : "integer",
3939 "format" : "int32"
3940 }
3941 },
3942 "Retry-After" : {
3943 "description" : "How many seconds you have to wait before making new request.",
3944 "style" : "simple",
3945 "explode" : false,
3946 "schema" : {
3947 "type" : "integer",
3948 "format" : "int32"
3949 }
3950 }
3951 },
3952 "content" : {
3953 "application/json" : {
3954 "schema" : {
3955 "$ref" : "#/components/schemas/ServerErrorResponse"
3956 }
3957 }
3958 }
3959 }
3960 }
3961 }
3962 },
3963 "/documents/{id}/download" : {
3964 "get" : {
3965 "tags" : [ "Document" ],
3966 "summary" : "Download a document in PDF format.",
3967 "description" : "Download a document. Returns a document in PDF format.",
3968 "operationId" : "DownloadDocument",
3969 "parameters" : [ {
3970 "name" : "id",
3971 "in" : "path",
3972 "required" : true,
3973 "style" : "simple",
3974 "explode" : false,
3975 "schema" : {
3976 "type" : "integer"
3977 }
3978 } ],
3979 "responses" : {
3980 "200" : {
3981 "description" : "Document PDF file.",
3982 "headers" : {
3983 "X-RateLimit-Limit" : {
3984 "description" : "Request limit per minute.",
3985 "style" : "simple",
3986 "explode" : false,
3987 "schema" : {
3988 "type" : "integer",
3989 "format" : "int32"
3990 }
3991 },
3992 "X-RateLimit-Remaining" : {
3993 "description" : "The number of requests left for the time window.",
3994 "style" : "simple",
3995 "explode" : false,
3996 "schema" : {
3997 "type" : "integer",
3998 "format" : "int32"
3999 }
4000 },
4001 "X-RateLimit-Reset" : {
4002 "description" : "The timestamp at which the current rate limit window resets.",
4003 "style" : "simple",
4004 "explode" : false,
4005 "schema" : {
4006 "type" : "integer",
4007 "format" : "int32"
4008 }
4009 },
4010 "Retry-After" : {
4011 "description" : "How many seconds you have to wait before making new request.",
4012 "style" : "simple",
4013 "explode" : false,
4014 "schema" : {
4015 "type" : "integer",
4016 "format" : "int32"
4017 }
4018 }
4019 },
4020 "content" : {
4021 "application/pdf" : {
4022 "schema" : {
4023 "type" : "string",
4024 "format" : "binary"
4025 }
4026 }
4027 }
4028 },
4029 "202" : {
4030 "description" : "Document PDF has not generated yet. You should try to download again later.",
4031 "headers" : {
4032 "X-RateLimit-Limit" : {
4033 "description" : "Request limit per minute.",
4034 "style" : "simple",
4035 "explode" : false,
4036 "schema" : {
4037 "type" : "integer",
4038 "format" : "int32"
4039 }
4040 },
4041 "X-RateLimit-Remaining" : {
4042 "description" : "The number of requests left for the time window.",
4043 "style" : "simple",
4044 "explode" : false,
4045 "schema" : {
4046 "type" : "integer",
4047 "format" : "int32"
4048 }
4049 },
4050 "X-RateLimit-Reset" : {
4051 "description" : "The timestamp at which the current rate limit window resets.",
4052 "style" : "simple",
4053 "explode" : false,
4054 "schema" : {
4055 "type" : "integer",
4056 "format" : "int32"
4057 }
4058 },
4059 "Retry-After" : {
4060 "description" : "How many seconds you have to wait before making new request.",
4061 "style" : "simple",
4062 "explode" : false,
4063 "schema" : {
4064 "type" : "integer",
4065 "format" : "int32"
4066 }
4067 }
4068 },
4069 "content" : {
4070 "application/json" : {
4071 "schema" : {
4072 "$ref" : "#/components/schemas/ClientError"
4073 }
4074 }
4075 }
4076 },
4077 "400" : {
4078 "description" : "The request is malformed.",
4079 "headers" : {
4080 "X-RateLimit-Limit" : {
4081 "description" : "Request limit per minute.",
4082 "style" : "simple",
4083 "explode" : false,
4084 "schema" : {
4085 "type" : "integer",
4086 "format" : "int32"
4087 }
4088 },
4089 "X-RateLimit-Remaining" : {
4090 "description" : "The number of requests left for the time window.",
4091 "style" : "simple",
4092 "explode" : false,
4093 "schema" : {
4094 "type" : "integer",
4095 "format" : "int32"
4096 }
4097 },
4098 "X-RateLimit-Reset" : {
4099 "description" : "The timestamp at which the current rate limit window resets.",
4100 "style" : "simple",
4101 "explode" : false,
4102 "schema" : {
4103 "type" : "integer",
4104 "format" : "int32"
4105 }
4106 },
4107 "Retry-After" : {
4108 "description" : "How many seconds you have to wait before making new request.",
4109 "style" : "simple",
4110 "explode" : false,
4111 "schema" : {
4112 "type" : "integer",
4113 "format" : "int32"
4114 }
4115 }
4116 },
4117 "content" : {
4118 "application/json" : {
4119 "schema" : {
4120 "$ref" : "#/components/schemas/ClientErrorResponse"
4121 }
4122 }
4123 }
4124 },
4125 "401" : {
4126 "description" : "Authorization information is missing or invalid.",
4127 "headers" : {
4128 "X-RateLimit-Limit" : {
4129 "description" : "Request limit per minute.",
4130 "style" : "simple",
4131 "explode" : false,
4132 "schema" : {
4133 "type" : "integer",
4134 "format" : "int32"
4135 }
4136 },
4137 "X-RateLimit-Remaining" : {
4138 "description" : "The number of requests left for the time window.",
4139 "style" : "simple",
4140 "explode" : false,
4141 "schema" : {
4142 "type" : "integer",
4143 "format" : "int32"
4144 }
4145 },
4146 "X-RateLimit-Reset" : {
4147 "description" : "The timestamp at which the current rate limit window resets.",
4148 "style" : "simple",
4149 "explode" : false,
4150 "schema" : {
4151 "type" : "integer",
4152 "format" : "int32"
4153 }
4154 },
4155 "Retry-After" : {
4156 "description" : "How many seconds you have to wait before making new request.",
4157 "style" : "simple",
4158 "explode" : false,
4159 "schema" : {
4160 "type" : "integer",
4161 "format" : "int32"
4162 }
4163 }
4164 },
4165 "content" : {
4166 "application/json" : {
4167 "schema" : {
4168 "$ref" : "#/components/schemas/ClientErrorResponse"
4169 }
4170 }
4171 }
4172 },
4173 "402" : {
4174 "description" : "Authenticated user doesn't have subscription.",
4175 "content" : {
4176 "application/json" : {
4177 "schema" : {
4178 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
4179 }
4180 }
4181 }
4182 },
4183 "404" : {
4184 "description" : "Non-existent resource is requested.",
4185 "headers" : {
4186 "X-RateLimit-Limit" : {
4187 "description" : "Request limit per minute.",
4188 "style" : "simple",
4189 "explode" : false,
4190 "schema" : {
4191 "type" : "integer",
4192 "format" : "int32"
4193 }
4194 },
4195 "X-RateLimit-Remaining" : {
4196 "description" : "The number of requests left for the time window.",
4197 "style" : "simple",
4198 "explode" : false,
4199 "schema" : {
4200 "type" : "integer",
4201 "format" : "int32"
4202 }
4203 },
4204 "X-RateLimit-Reset" : {
4205 "description" : "The timestamp at which the current rate limit window resets.",
4206 "style" : "simple",
4207 "explode" : false,
4208 "schema" : {
4209 "type" : "integer",
4210 "format" : "int32"
4211 }
4212 },
4213 "Retry-After" : {
4214 "description" : "How many seconds you have to wait before making new request.",
4215 "style" : "simple",
4216 "explode" : false,
4217 "schema" : {
4218 "type" : "integer",
4219 "format" : "int32"
4220 }
4221 }
4222 },
4223 "content" : {
4224 "application/json" : {
4225 "schema" : {
4226 "$ref" : "#/components/schemas/ClientErrorResponse"
4227 }
4228 }
4229 }
4230 },
4231 "422" : {
4232 "description" : "Validation errors occured.",
4233 "headers" : {
4234 "X-RateLimit-Limit" : {
4235 "description" : "Request limit per minute.",
4236 "style" : "simple",
4237 "explode" : false,
4238 "schema" : {
4239 "type" : "integer",
4240 "format" : "int32"
4241 }
4242 },
4243 "X-RateLimit-Remaining" : {
4244 "description" : "The number of requests left for the time window.",
4245 "style" : "simple",
4246 "explode" : false,
4247 "schema" : {
4248 "type" : "integer",
4249 "format" : "int32"
4250 }
4251 },
4252 "X-RateLimit-Reset" : {
4253 "description" : "The timestamp at which the current rate limit window resets.",
4254 "style" : "simple",
4255 "explode" : false,
4256 "schema" : {
4257 "type" : "integer",
4258 "format" : "int32"
4259 }
4260 },
4261 "Retry-After" : {
4262 "description" : "How many seconds you have to wait before making new request.",
4263 "style" : "simple",
4264 "explode" : false,
4265 "schema" : {
4266 "type" : "integer",
4267 "format" : "int32"
4268 }
4269 }
4270 },
4271 "content" : {
4272 "application/json" : {
4273 "schema" : {
4274 "$ref" : "#/components/schemas/ValidationErrorResponse"
4275 }
4276 }
4277 }
4278 },
4279 "500" : {
4280 "description" : "Internal server error.",
4281 "headers" : {
4282 "X-RateLimit-Limit" : {
4283 "description" : "Request limit per minute.",
4284 "style" : "simple",
4285 "explode" : false,
4286 "schema" : {
4287 "type" : "integer",
4288 "format" : "int32"
4289 }
4290 },
4291 "X-RateLimit-Remaining" : {
4292 "description" : "The number of requests left for the time window.",
4293 "style" : "simple",
4294 "explode" : false,
4295 "schema" : {
4296 "type" : "integer",
4297 "format" : "int32"
4298 }
4299 },
4300 "X-RateLimit-Reset" : {
4301 "description" : "The timestamp at which the current rate limit window resets.",
4302 "style" : "simple",
4303 "explode" : false,
4304 "schema" : {
4305 "type" : "integer",
4306 "format" : "int32"
4307 }
4308 },
4309 "Retry-After" : {
4310 "description" : "How many seconds you have to wait before making new request.",
4311 "style" : "simple",
4312 "explode" : false,
4313 "schema" : {
4314 "type" : "integer",
4315 "format" : "int32"
4316 }
4317 }
4318 },
4319 "content" : {
4320 "application/json" : {
4321 "schema" : {
4322 "$ref" : "#/components/schemas/ServerErrorResponse"
4323 }
4324 }
4325 }
4326 }
4327 }
4328 }
4329 },
4330 "/documents/{id}/online-szamla" : {
4331 "get" : {
4332 "tags" : [ "Document" ],
4333 "summary" : "Retrieve a document Online Számla status",
4334 "description" : "Retrieves the details of an existing document status.",
4335 "operationId" : "GetOnlineSzamlaStatus",
4336 "parameters" : [ {
4337 "name" : "id",
4338 "in" : "path",
4339 "required" : true,
4340 "style" : "simple",
4341 "explode" : false,
4342 "schema" : {
4343 "type" : "integer"
4344 }
4345 } ],
4346 "responses" : {
4347 "200" : {
4348 "description" : "Success response",
4349 "headers" : {
4350 "X-RateLimit-Limit" : {
4351 "description" : "Request limit per minute.",
4352 "style" : "simple",
4353 "explode" : false,
4354 "schema" : {
4355 "type" : "integer",
4356 "format" : "int32"
4357 }
4358 },
4359 "X-RateLimit-Remaining" : {
4360 "description" : "The number of requests left for the time window.",
4361 "style" : "simple",
4362 "explode" : false,
4363 "schema" : {
4364 "type" : "integer",
4365 "format" : "int32"
4366 }
4367 },
4368 "X-RateLimit-Reset" : {
4369 "description" : "The timestamp at which the current rate limit window resets.",
4370 "style" : "simple",
4371 "explode" : false,
4372 "schema" : {
4373 "type" : "integer",
4374 "format" : "int32"
4375 }
4376 },
4377 "Retry-After" : {
4378 "description" : "How many seconds you have to wait before making new request.",
4379 "style" : "simple",
4380 "explode" : false,
4381 "schema" : {
4382 "type" : "integer",
4383 "format" : "int32"
4384 }
4385 }
4386 },
4387 "content" : {
4388 "application/json" : {
4389 "schema" : {
4390 "$ref" : "#/components/schemas/OnlineSzamlaStatus"
4391 }
4392 }
4393 }
4394 },
4395 "400" : {
4396 "description" : "The request is malformed.",
4397 "headers" : {
4398 "X-RateLimit-Limit" : {
4399 "description" : "Request limit per minute.",
4400 "style" : "simple",
4401 "explode" : false,
4402 "schema" : {
4403 "type" : "integer",
4404 "format" : "int32"
4405 }
4406 },
4407 "X-RateLimit-Remaining" : {
4408 "description" : "The number of requests left for the time window.",
4409 "style" : "simple",
4410 "explode" : false,
4411 "schema" : {
4412 "type" : "integer",
4413 "format" : "int32"
4414 }
4415 },
4416 "X-RateLimit-Reset" : {
4417 "description" : "The timestamp at which the current rate limit window resets.",
4418 "style" : "simple",
4419 "explode" : false,
4420 "schema" : {
4421 "type" : "integer",
4422 "format" : "int32"
4423 }
4424 },
4425 "Retry-After" : {
4426 "description" : "How many seconds you have to wait before making new request.",
4427 "style" : "simple",
4428 "explode" : false,
4429 "schema" : {
4430 "type" : "integer",
4431 "format" : "int32"
4432 }
4433 }
4434 },
4435 "content" : {
4436 "application/json" : {
4437 "schema" : {
4438 "$ref" : "#/components/schemas/ClientErrorResponse"
4439 }
4440 }
4441 }
4442 },
4443 "401" : {
4444 "description" : "Authorization information is missing or invalid.",
4445 "headers" : {
4446 "X-RateLimit-Limit" : {
4447 "description" : "Request limit per minute.",
4448 "style" : "simple",
4449 "explode" : false,
4450 "schema" : {
4451 "type" : "integer",
4452 "format" : "int32"
4453 }
4454 },
4455 "X-RateLimit-Remaining" : {
4456 "description" : "The number of requests left for the time window.",
4457 "style" : "simple",
4458 "explode" : false,
4459 "schema" : {
4460 "type" : "integer",
4461 "format" : "int32"
4462 }
4463 },
4464 "X-RateLimit-Reset" : {
4465 "description" : "The timestamp at which the current rate limit window resets.",
4466 "style" : "simple",
4467 "explode" : false,
4468 "schema" : {
4469 "type" : "integer",
4470 "format" : "int32"
4471 }
4472 },
4473 "Retry-After" : {
4474 "description" : "How many seconds you have to wait before making new request.",
4475 "style" : "simple",
4476 "explode" : false,
4477 "schema" : {
4478 "type" : "integer",
4479 "format" : "int32"
4480 }
4481 }
4482 },
4483 "content" : {
4484 "application/json" : {
4485 "schema" : {
4486 "$ref" : "#/components/schemas/ClientErrorResponse"
4487 }
4488 }
4489 }
4490 },
4491 "402" : {
4492 "description" : "Authenticated user doesn't have subscription.",
4493 "content" : {
4494 "application/json" : {
4495 "schema" : {
4496 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
4497 }
4498 }
4499 }
4500 },
4501 "404" : {
4502 "description" : "Non-existent resource is requested.",
4503 "headers" : {
4504 "X-RateLimit-Limit" : {
4505 "description" : "Request limit per minute.",
4506 "style" : "simple",
4507 "explode" : false,
4508 "schema" : {
4509 "type" : "integer",
4510 "format" : "int32"
4511 }
4512 },
4513 "X-RateLimit-Remaining" : {
4514 "description" : "The number of requests left for the time window.",
4515 "style" : "simple",
4516 "explode" : false,
4517 "schema" : {
4518 "type" : "integer",
4519 "format" : "int32"
4520 }
4521 },
4522 "X-RateLimit-Reset" : {
4523 "description" : "The timestamp at which the current rate limit window resets.",
4524 "style" : "simple",
4525 "explode" : false,
4526 "schema" : {
4527 "type" : "integer",
4528 "format" : "int32"
4529 }
4530 },
4531 "Retry-After" : {
4532 "description" : "How many seconds you have to wait before making new request.",
4533 "style" : "simple",
4534 "explode" : false,
4535 "schema" : {
4536 "type" : "integer",
4537 "format" : "int32"
4538 }
4539 }
4540 },
4541 "content" : {
4542 "application/json" : {
4543 "schema" : {
4544 "$ref" : "#/components/schemas/ClientErrorResponse"
4545 }
4546 }
4547 }
4548 },
4549 "422" : {
4550 "description" : "Validation errors occured.",
4551 "headers" : {
4552 "X-RateLimit-Limit" : {
4553 "description" : "Request limit per minute.",
4554 "style" : "simple",
4555 "explode" : false,
4556 "schema" : {
4557 "type" : "integer",
4558 "format" : "int32"
4559 }
4560 },
4561 "X-RateLimit-Remaining" : {
4562 "description" : "The number of requests left for the time window.",
4563 "style" : "simple",
4564 "explode" : false,
4565 "schema" : {
4566 "type" : "integer",
4567 "format" : "int32"
4568 }
4569 },
4570 "X-RateLimit-Reset" : {
4571 "description" : "The timestamp at which the current rate limit window resets.",
4572 "style" : "simple",
4573 "explode" : false,
4574 "schema" : {
4575 "type" : "integer",
4576 "format" : "int32"
4577 }
4578 },
4579 "Retry-After" : {
4580 "description" : "How many seconds you have to wait before making new request.",
4581 "style" : "simple",
4582 "explode" : false,
4583 "schema" : {
4584 "type" : "integer",
4585 "format" : "int32"
4586 }
4587 }
4588 },
4589 "content" : {
4590 "application/json" : {
4591 "schema" : {
4592 "$ref" : "#/components/schemas/ValidationErrorResponse"
4593 }
4594 }
4595 }
4596 },
4597 "500" : {
4598 "description" : "Internal server error.",
4599 "headers" : {
4600 "X-RateLimit-Limit" : {
4601 "description" : "Request limit per minute.",
4602 "style" : "simple",
4603 "explode" : false,
4604 "schema" : {
4605 "type" : "integer",
4606 "format" : "int32"
4607 }
4608 },
4609 "X-RateLimit-Remaining" : {
4610 "description" : "The number of requests left for the time window.",
4611 "style" : "simple",
4612 "explode" : false,
4613 "schema" : {
4614 "type" : "integer",
4615 "format" : "int32"
4616 }
4617 },
4618 "X-RateLimit-Reset" : {
4619 "description" : "The timestamp at which the current rate limit window resets.",
4620 "style" : "simple",
4621 "explode" : false,
4622 "schema" : {
4623 "type" : "integer",
4624 "format" : "int32"
4625 }
4626 },
4627 "Retry-After" : {
4628 "description" : "How many seconds you have to wait before making new request.",
4629 "style" : "simple",
4630 "explode" : false,
4631 "schema" : {
4632 "type" : "integer",
4633 "format" : "int32"
4634 }
4635 }
4636 },
4637 "content" : {
4638 "application/json" : {
4639 "schema" : {
4640 "$ref" : "#/components/schemas/ServerErrorResponse"
4641 }
4642 }
4643 }
4644 }
4645 }
4646 }
4647 },
4648 "/documents/{id}/payments" : {
4649 "get" : {
4650 "tags" : [ "Document" ],
4651 "summary" : "Retrieve a payment histroy",
4652 "description" : "Retrieves the details of payment history an existing document.",
4653 "operationId" : "GetPayment",
4654 "parameters" : [ {
4655 "name" : "id",
4656 "in" : "path",
4657 "required" : true,
4658 "style" : "simple",
4659 "explode" : false,
4660 "schema" : {
4661 "type" : "integer"
4662 }
4663 } ],
4664 "responses" : {
4665 "200" : {
4666 "description" : "Success response",
4667 "headers" : {
4668 "X-RateLimit-Limit" : {
4669 "description" : "Request limit per minute.",
4670 "style" : "simple",
4671 "explode" : false,
4672 "schema" : {
4673 "type" : "integer",
4674 "format" : "int32"
4675 }
4676 },
4677 "X-RateLimit-Remaining" : {
4678 "description" : "The number of requests left for the time window.",
4679 "style" : "simple",
4680 "explode" : false,
4681 "schema" : {
4682 "type" : "integer",
4683 "format" : "int32"
4684 }
4685 },
4686 "X-RateLimit-Reset" : {
4687 "description" : "The timestamp at which the current rate limit window resets.",
4688 "style" : "simple",
4689 "explode" : false,
4690 "schema" : {
4691 "type" : "integer",
4692 "format" : "int32"
4693 }
4694 },
4695 "Retry-After" : {
4696 "description" : "How many seconds you have to wait before making new request.",
4697 "style" : "simple",
4698 "explode" : false,
4699 "schema" : {
4700 "type" : "integer",
4701 "format" : "int32"
4702 }
4703 }
4704 },
4705 "content" : {
4706 "application/json" : {
4707 "schema" : {
4708 "type" : "array",
4709 "items" : {
4710 "$ref" : "#/components/schemas/PaymentHistory"
4711 }
4712 }
4713 }
4714 }
4715 },
4716 "400" : {
4717 "description" : "The request is malformed.",
4718 "headers" : {
4719 "X-RateLimit-Limit" : {
4720 "description" : "Request limit per minute.",
4721 "style" : "simple",
4722 "explode" : false,
4723 "schema" : {
4724 "type" : "integer",
4725 "format" : "int32"
4726 }
4727 },
4728 "X-RateLimit-Remaining" : {
4729 "description" : "The number of requests left for the time window.",
4730 "style" : "simple",
4731 "explode" : false,
4732 "schema" : {
4733 "type" : "integer",
4734 "format" : "int32"
4735 }
4736 },
4737 "X-RateLimit-Reset" : {
4738 "description" : "The timestamp at which the current rate limit window resets.",
4739 "style" : "simple",
4740 "explode" : false,
4741 "schema" : {
4742 "type" : "integer",
4743 "format" : "int32"
4744 }
4745 },
4746 "Retry-After" : {
4747 "description" : "How many seconds you have to wait before making new request.",
4748 "style" : "simple",
4749 "explode" : false,
4750 "schema" : {
4751 "type" : "integer",
4752 "format" : "int32"
4753 }
4754 }
4755 },
4756 "content" : {
4757 "application/json" : {
4758 "schema" : {
4759 "$ref" : "#/components/schemas/ClientErrorResponse"
4760 }
4761 }
4762 }
4763 },
4764 "401" : {
4765 "description" : "Authorization information is missing or invalid.",
4766 "headers" : {
4767 "X-RateLimit-Limit" : {
4768 "description" : "Request limit per minute.",
4769 "style" : "simple",
4770 "explode" : false,
4771 "schema" : {
4772 "type" : "integer",
4773 "format" : "int32"
4774 }
4775 },
4776 "X-RateLimit-Remaining" : {
4777 "description" : "The number of requests left for the time window.",
4778 "style" : "simple",
4779 "explode" : false,
4780 "schema" : {
4781 "type" : "integer",
4782 "format" : "int32"
4783 }
4784 },
4785 "X-RateLimit-Reset" : {
4786 "description" : "The timestamp at which the current rate limit window resets.",
4787 "style" : "simple",
4788 "explode" : false,
4789 "schema" : {
4790 "type" : "integer",
4791 "format" : "int32"
4792 }
4793 },
4794 "Retry-After" : {
4795 "description" : "How many seconds you have to wait before making new request.",
4796 "style" : "simple",
4797 "explode" : false,
4798 "schema" : {
4799 "type" : "integer",
4800 "format" : "int32"
4801 }
4802 }
4803 },
4804 "content" : {
4805 "application/json" : {
4806 "schema" : {
4807 "$ref" : "#/components/schemas/ClientErrorResponse"
4808 }
4809 }
4810 }
4811 },
4812 "402" : {
4813 "description" : "Authenticated user doesn't have subscription.",
4814 "content" : {
4815 "application/json" : {
4816 "schema" : {
4817 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
4818 }
4819 }
4820 }
4821 },
4822 "404" : {
4823 "description" : "Non-existent resource is requested.",
4824 "headers" : {
4825 "X-RateLimit-Limit" : {
4826 "description" : "Request limit per minute.",
4827 "style" : "simple",
4828 "explode" : false,
4829 "schema" : {
4830 "type" : "integer",
4831 "format" : "int32"
4832 }
4833 },
4834 "X-RateLimit-Remaining" : {
4835 "description" : "The number of requests left for the time window.",
4836 "style" : "simple",
4837 "explode" : false,
4838 "schema" : {
4839 "type" : "integer",
4840 "format" : "int32"
4841 }
4842 },
4843 "X-RateLimit-Reset" : {
4844 "description" : "The timestamp at which the current rate limit window resets.",
4845 "style" : "simple",
4846 "explode" : false,
4847 "schema" : {
4848 "type" : "integer",
4849 "format" : "int32"
4850 }
4851 },
4852 "Retry-After" : {
4853 "description" : "How many seconds you have to wait before making new request.",
4854 "style" : "simple",
4855 "explode" : false,
4856 "schema" : {
4857 "type" : "integer",
4858 "format" : "int32"
4859 }
4860 }
4861 },
4862 "content" : {
4863 "application/json" : {
4864 "schema" : {
4865 "$ref" : "#/components/schemas/ClientErrorResponse"
4866 }
4867 }
4868 }
4869 },
4870 "422" : {
4871 "description" : "Validation errors occured.",
4872 "headers" : {
4873 "X-RateLimit-Limit" : {
4874 "description" : "Request limit per minute.",
4875 "style" : "simple",
4876 "explode" : false,
4877 "schema" : {
4878 "type" : "integer",
4879 "format" : "int32"
4880 }
4881 },
4882 "X-RateLimit-Remaining" : {
4883 "description" : "The number of requests left for the time window.",
4884 "style" : "simple",
4885 "explode" : false,
4886 "schema" : {
4887 "type" : "integer",
4888 "format" : "int32"
4889 }
4890 },
4891 "X-RateLimit-Reset" : {
4892 "description" : "The timestamp at which the current rate limit window resets.",
4893 "style" : "simple",
4894 "explode" : false,
4895 "schema" : {
4896 "type" : "integer",
4897 "format" : "int32"
4898 }
4899 },
4900 "Retry-After" : {
4901 "description" : "How many seconds you have to wait before making new request.",
4902 "style" : "simple",
4903 "explode" : false,
4904 "schema" : {
4905 "type" : "integer",
4906 "format" : "int32"
4907 }
4908 }
4909 },
4910 "content" : {
4911 "application/json" : {
4912 "schema" : {
4913 "$ref" : "#/components/schemas/ValidationErrorResponse"
4914 }
4915 }
4916 }
4917 },
4918 "500" : {
4919 "description" : "Internal server error.",
4920 "headers" : {
4921 "X-RateLimit-Limit" : {
4922 "description" : "Request limit per minute.",
4923 "style" : "simple",
4924 "explode" : false,
4925 "schema" : {
4926 "type" : "integer",
4927 "format" : "int32"
4928 }
4929 },
4930 "X-RateLimit-Remaining" : {
4931 "description" : "The number of requests left for the time window.",
4932 "style" : "simple",
4933 "explode" : false,
4934 "schema" : {
4935 "type" : "integer",
4936 "format" : "int32"
4937 }
4938 },
4939 "X-RateLimit-Reset" : {
4940 "description" : "The timestamp at which the current rate limit window resets.",
4941 "style" : "simple",
4942 "explode" : false,
4943 "schema" : {
4944 "type" : "integer",
4945 "format" : "int32"
4946 }
4947 },
4948 "Retry-After" : {
4949 "description" : "How many seconds you have to wait before making new request.",
4950 "style" : "simple",
4951 "explode" : false,
4952 "schema" : {
4953 "type" : "integer",
4954 "format" : "int32"
4955 }
4956 }
4957 },
4958 "content" : {
4959 "application/json" : {
4960 "schema" : {
4961 "$ref" : "#/components/schemas/ServerErrorResponse"
4962 }
4963 }
4964 }
4965 }
4966 }
4967 },
4968 "put" : {
4969 "tags" : [ "Document" ],
4970 "summary" : "Update payment history",
4971 "description" : "Update payment history an existing document. Returns a payment history object if the update is succeded.",
4972 "operationId" : "UpdatePayment",
4973 "parameters" : [ {
4974 "name" : "id",
4975 "in" : "path",
4976 "required" : true,
4977 "style" : "simple",
4978 "explode" : false,
4979 "schema" : {
4980 "type" : "integer"
4981 }
4982 } ],
4983 "requestBody" : {
4984 "description" : "Payment history object that you would like to update.",
4985 "content" : {
4986 "application/json" : {
4987 "schema" : {
4988 "type" : "array",
4989 "items" : {
4990 "$ref" : "#/components/schemas/PaymentHistory"
4991 }
4992 }
4993 }
4994 },
4995 "required" : true
4996 },
4997 "responses" : {
4998 "200" : {
4999 "description" : "Payment history updated successfully.",
5000 "headers" : {
5001 "X-RateLimit-Limit" : {
5002 "description" : "Request limit per minute.",
5003 "style" : "simple",
5004 "explode" : false,
5005 "schema" : {
5006 "type" : "integer",
5007 "format" : "int32"
5008 }
5009 },
5010 "X-RateLimit-Remaining" : {
5011 "description" : "The number of requests left for the time window.",
5012 "style" : "simple",
5013 "explode" : false,
5014 "schema" : {
5015 "type" : "integer",
5016 "format" : "int32"
5017 }
5018 },
5019 "X-RateLimit-Reset" : {
5020 "description" : "The timestamp at which the current rate limit window resets.",
5021 "style" : "simple",
5022 "explode" : false,
5023 "schema" : {
5024 "type" : "integer",
5025 "format" : "int32"
5026 }
5027 },
5028 "Retry-After" : {
5029 "description" : "How many seconds you have to wait before making new request.",
5030 "style" : "simple",
5031 "explode" : false,
5032 "schema" : {
5033 "type" : "integer",
5034 "format" : "int32"
5035 }
5036 }
5037 },
5038 "content" : {
5039 "application/json" : {
5040 "schema" : {
5041 "type" : "array",
5042 "items" : {
5043 "$ref" : "#/components/schemas/PaymentHistory"
5044 }
5045 }
5046 }
5047 }
5048 },
5049 "400" : {
5050 "description" : "The request is malformed.",
5051 "headers" : {
5052 "X-RateLimit-Limit" : {
5053 "description" : "Request limit per minute.",
5054 "style" : "simple",
5055 "explode" : false,
5056 "schema" : {
5057 "type" : "integer",
5058 "format" : "int32"
5059 }
5060 },
5061 "X-RateLimit-Remaining" : {
5062 "description" : "The number of requests left for the time window.",
5063 "style" : "simple",
5064 "explode" : false,
5065 "schema" : {
5066 "type" : "integer",
5067 "format" : "int32"
5068 }
5069 },
5070 "X-RateLimit-Reset" : {
5071 "description" : "The timestamp at which the current rate limit window resets.",
5072 "style" : "simple",
5073 "explode" : false,
5074 "schema" : {
5075 "type" : "integer",
5076 "format" : "int32"
5077 }
5078 },
5079 "Retry-After" : {
5080 "description" : "How many seconds you have to wait before making new request.",
5081 "style" : "simple",
5082 "explode" : false,
5083 "schema" : {
5084 "type" : "integer",
5085 "format" : "int32"
5086 }
5087 }
5088 },
5089 "content" : {
5090 "application/json" : {
5091 "schema" : {
5092 "$ref" : "#/components/schemas/ClientErrorResponse"
5093 }
5094 }
5095 }
5096 },
5097 "401" : {
5098 "description" : "Authorization information is missing or invalid.",
5099 "headers" : {
5100 "X-RateLimit-Limit" : {
5101 "description" : "Request limit per minute.",
5102 "style" : "simple",
5103 "explode" : false,
5104 "schema" : {
5105 "type" : "integer",
5106 "format" : "int32"
5107 }
5108 },
5109 "X-RateLimit-Remaining" : {
5110 "description" : "The number of requests left for the time window.",
5111 "style" : "simple",
5112 "explode" : false,
5113 "schema" : {
5114 "type" : "integer",
5115 "format" : "int32"
5116 }
5117 },
5118 "X-RateLimit-Reset" : {
5119 "description" : "The timestamp at which the current rate limit window resets.",
5120 "style" : "simple",
5121 "explode" : false,
5122 "schema" : {
5123 "type" : "integer",
5124 "format" : "int32"
5125 }
5126 },
5127 "Retry-After" : {
5128 "description" : "How many seconds you have to wait before making new request.",
5129 "style" : "simple",
5130 "explode" : false,
5131 "schema" : {
5132 "type" : "integer",
5133 "format" : "int32"
5134 }
5135 }
5136 },
5137 "content" : {
5138 "application/json" : {
5139 "schema" : {
5140 "$ref" : "#/components/schemas/ClientErrorResponse"
5141 }
5142 }
5143 }
5144 },
5145 "402" : {
5146 "description" : "Authenticated user doesn't have subscription.",
5147 "content" : {
5148 "application/json" : {
5149 "schema" : {
5150 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
5151 }
5152 }
5153 }
5154 },
5155 "403" : {
5156 "description" : "Authenticated user doesn't have access to the resource.",
5157 "headers" : {
5158 "X-RateLimit-Limit" : {
5159 "description" : "Request limit per minute.",
5160 "style" : "simple",
5161 "explode" : false,
5162 "schema" : {
5163 "type" : "integer",
5164 "format" : "int32"
5165 }
5166 },
5167 "X-RateLimit-Remaining" : {
5168 "description" : "The number of requests left for the time window.",
5169 "style" : "simple",
5170 "explode" : false,
5171 "schema" : {
5172 "type" : "integer",
5173 "format" : "int32"
5174 }
5175 },
5176 "X-RateLimit-Reset" : {
5177 "description" : "The timestamp at which the current rate limit window resets.",
5178 "style" : "simple",
5179 "explode" : false,
5180 "schema" : {
5181 "type" : "integer",
5182 "format" : "int32"
5183 }
5184 },
5185 "Retry-After" : {
5186 "description" : "How many seconds you have to wait before making new request.",
5187 "style" : "simple",
5188 "explode" : false,
5189 "schema" : {
5190 "type" : "integer",
5191 "format" : "int32"
5192 }
5193 }
5194 },
5195 "content" : {
5196 "application/json" : {
5197 "schema" : {
5198 "$ref" : "#/components/schemas/ClientErrorResponse"
5199 }
5200 }
5201 }
5202 },
5203 "404" : {
5204 "description" : "Non-existent resource is requested.",
5205 "headers" : {
5206 "X-RateLimit-Limit" : {
5207 "description" : "Request limit per minute.",
5208 "style" : "simple",
5209 "explode" : false,
5210 "schema" : {
5211 "type" : "integer",
5212 "format" : "int32"
5213 }
5214 },
5215 "X-RateLimit-Remaining" : {
5216 "description" : "The number of requests left for the time window.",
5217 "style" : "simple",
5218 "explode" : false,
5219 "schema" : {
5220 "type" : "integer",
5221 "format" : "int32"
5222 }
5223 },
5224 "X-RateLimit-Reset" : {
5225 "description" : "The timestamp at which the current rate limit window resets.",
5226 "style" : "simple",
5227 "explode" : false,
5228 "schema" : {
5229 "type" : "integer",
5230 "format" : "int32"
5231 }
5232 },
5233 "Retry-After" : {
5234 "description" : "How many seconds you have to wait before making new request.",
5235 "style" : "simple",
5236 "explode" : false,
5237 "schema" : {
5238 "type" : "integer",
5239 "format" : "int32"
5240 }
5241 }
5242 },
5243 "content" : {
5244 "application/json" : {
5245 "schema" : {
5246 "$ref" : "#/components/schemas/ClientErrorResponse"
5247 }
5248 }
5249 }
5250 },
5251 "422" : {
5252 "description" : "Validation errors occured.",
5253 "headers" : {
5254 "X-RateLimit-Limit" : {
5255 "description" : "Request limit per minute.",
5256 "style" : "simple",
5257 "explode" : false,
5258 "schema" : {
5259 "type" : "integer",
5260 "format" : "int32"
5261 }
5262 },
5263 "X-RateLimit-Remaining" : {
5264 "description" : "The number of requests left for the time window.",
5265 "style" : "simple",
5266 "explode" : false,
5267 "schema" : {
5268 "type" : "integer",
5269 "format" : "int32"
5270 }
5271 },
5272 "X-RateLimit-Reset" : {
5273 "description" : "The timestamp at which the current rate limit window resets.",
5274 "style" : "simple",
5275 "explode" : false,
5276 "schema" : {
5277 "type" : "integer",
5278 "format" : "int32"
5279 }
5280 },
5281 "Retry-After" : {
5282 "description" : "How many seconds you have to wait before making new request.",
5283 "style" : "simple",
5284 "explode" : false,
5285 "schema" : {
5286 "type" : "integer",
5287 "format" : "int32"
5288 }
5289 }
5290 },
5291 "content" : {
5292 "application/json" : {
5293 "schema" : {
5294 "$ref" : "#/components/schemas/ValidationErrorResponse"
5295 }
5296 }
5297 }
5298 },
5299 "500" : {
5300 "description" : "Internal server error.",
5301 "headers" : {
5302 "X-RateLimit-Limit" : {
5303 "description" : "Request limit per minute.",
5304 "style" : "simple",
5305 "explode" : false,
5306 "schema" : {
5307 "type" : "integer",
5308 "format" : "int32"
5309 }
5310 },
5311 "X-RateLimit-Remaining" : {
5312 "description" : "The number of requests left for the time window.",
5313 "style" : "simple",
5314 "explode" : false,
5315 "schema" : {
5316 "type" : "integer",
5317 "format" : "int32"
5318 }
5319 },
5320 "X-RateLimit-Reset" : {
5321 "description" : "The timestamp at which the current rate limit window resets.",
5322 "style" : "simple",
5323 "explode" : false,
5324 "schema" : {
5325 "type" : "integer",
5326 "format" : "int32"
5327 }
5328 },
5329 "Retry-After" : {
5330 "description" : "How many seconds you have to wait before making new request.",
5331 "style" : "simple",
5332 "explode" : false,
5333 "schema" : {
5334 "type" : "integer",
5335 "format" : "int32"
5336 }
5337 }
5338 },
5339 "content" : {
5340 "application/json" : {
5341 "schema" : {
5342 "$ref" : "#/components/schemas/ServerErrorResponse"
5343 }
5344 }
5345 }
5346 }
5347 }
5348 },
5349 "delete" : {
5350 "tags" : [ "Document" ],
5351 "summary" : "Delete all payment history on document",
5352 "description" : "Delete all exist payment history on document.",
5353 "operationId" : "DeletePayment",
5354 "parameters" : [ {
5355 "name" : "id",
5356 "in" : "path",
5357 "required" : true,
5358 "style" : "simple",
5359 "explode" : false,
5360 "schema" : {
5361 "type" : "integer"
5362 }
5363 } ],
5364 "responses" : {
5365 "200" : {
5366 "description" : "Payment history deleted successfully.",
5367 "headers" : {
5368 "X-RateLimit-Limit" : {
5369 "description" : "Request limit per minute.",
5370 "style" : "simple",
5371 "explode" : false,
5372 "schema" : {
5373 "type" : "integer",
5374 "format" : "int32"
5375 }
5376 },
5377 "X-RateLimit-Remaining" : {
5378 "description" : "The number of requests left for the time window.",
5379 "style" : "simple",
5380 "explode" : false,
5381 "schema" : {
5382 "type" : "integer",
5383 "format" : "int32"
5384 }
5385 },
5386 "X-RateLimit-Reset" : {
5387 "description" : "The timestamp at which the current rate limit window resets.",
5388 "style" : "simple",
5389 "explode" : false,
5390 "schema" : {
5391 "type" : "integer",
5392 "format" : "int32"
5393 }
5394 },
5395 "Retry-After" : {
5396 "description" : "How many seconds you have to wait before making new request.",
5397 "style" : "simple",
5398 "explode" : false,
5399 "schema" : {
5400 "type" : "integer",
5401 "format" : "int32"
5402 }
5403 }
5404 },
5405 "content" : {
5406 "application/json" : {
5407 "schema" : {
5408 "type" : "array",
5409 "items" : {
5410 "$ref" : "#/components/schemas/PaymentHistory"
5411 }
5412 }
5413 }
5414 }
5415 },
5416 "400" : {
5417 "description" : "The request is malformed.",
5418 "headers" : {
5419 "X-RateLimit-Limit" : {
5420 "description" : "Request limit per minute.",
5421 "style" : "simple",
5422 "explode" : false,
5423 "schema" : {
5424 "type" : "integer",
5425 "format" : "int32"
5426 }
5427 },
5428 "X-RateLimit-Remaining" : {
5429 "description" : "The number of requests left for the time window.",
5430 "style" : "simple",
5431 "explode" : false,
5432 "schema" : {
5433 "type" : "integer",
5434 "format" : "int32"
5435 }
5436 },
5437 "X-RateLimit-Reset" : {
5438 "description" : "The timestamp at which the current rate limit window resets.",
5439 "style" : "simple",
5440 "explode" : false,
5441 "schema" : {
5442 "type" : "integer",
5443 "format" : "int32"
5444 }
5445 },
5446 "Retry-After" : {
5447 "description" : "How many seconds you have to wait before making new request.",
5448 "style" : "simple",
5449 "explode" : false,
5450 "schema" : {
5451 "type" : "integer",
5452 "format" : "int32"
5453 }
5454 }
5455 },
5456 "content" : {
5457 "application/json" : {
5458 "schema" : {
5459 "$ref" : "#/components/schemas/ClientErrorResponse"
5460 }
5461 }
5462 }
5463 },
5464 "401" : {
5465 "description" : "Authorization information is missing or invalid.",
5466 "headers" : {
5467 "X-RateLimit-Limit" : {
5468 "description" : "Request limit per minute.",
5469 "style" : "simple",
5470 "explode" : false,
5471 "schema" : {
5472 "type" : "integer",
5473 "format" : "int32"
5474 }
5475 },
5476 "X-RateLimit-Remaining" : {
5477 "description" : "The number of requests left for the time window.",
5478 "style" : "simple",
5479 "explode" : false,
5480 "schema" : {
5481 "type" : "integer",
5482 "format" : "int32"
5483 }
5484 },
5485 "X-RateLimit-Reset" : {
5486 "description" : "The timestamp at which the current rate limit window resets.",
5487 "style" : "simple",
5488 "explode" : false,
5489 "schema" : {
5490 "type" : "integer",
5491 "format" : "int32"
5492 }
5493 },
5494 "Retry-After" : {
5495 "description" : "How many seconds you have to wait before making new request.",
5496 "style" : "simple",
5497 "explode" : false,
5498 "schema" : {
5499 "type" : "integer",
5500 "format" : "int32"
5501 }
5502 }
5503 },
5504 "content" : {
5505 "application/json" : {
5506 "schema" : {
5507 "$ref" : "#/components/schemas/ClientErrorResponse"
5508 }
5509 }
5510 }
5511 },
5512 "402" : {
5513 "description" : "Authenticated user doesn't have subscription.",
5514 "content" : {
5515 "application/json" : {
5516 "schema" : {
5517 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
5518 }
5519 }
5520 }
5521 },
5522 "403" : {
5523 "description" : "Authenticated user doesn't have access to the resource.",
5524 "headers" : {
5525 "X-RateLimit-Limit" : {
5526 "description" : "Request limit per minute.",
5527 "style" : "simple",
5528 "explode" : false,
5529 "schema" : {
5530 "type" : "integer",
5531 "format" : "int32"
5532 }
5533 },
5534 "X-RateLimit-Remaining" : {
5535 "description" : "The number of requests left for the time window.",
5536 "style" : "simple",
5537 "explode" : false,
5538 "schema" : {
5539 "type" : "integer",
5540 "format" : "int32"
5541 }
5542 },
5543 "X-RateLimit-Reset" : {
5544 "description" : "The timestamp at which the current rate limit window resets.",
5545 "style" : "simple",
5546 "explode" : false,
5547 "schema" : {
5548 "type" : "integer",
5549 "format" : "int32"
5550 }
5551 },
5552 "Retry-After" : {
5553 "description" : "How many seconds you have to wait before making new request.",
5554 "style" : "simple",
5555 "explode" : false,
5556 "schema" : {
5557 "type" : "integer",
5558 "format" : "int32"
5559 }
5560 }
5561 },
5562 "content" : {
5563 "application/json" : {
5564 "schema" : {
5565 "$ref" : "#/components/schemas/ClientErrorResponse"
5566 }
5567 }
5568 }
5569 },
5570 "404" : {
5571 "description" : "Non-existent resource is requested.",
5572 "headers" : {
5573 "X-RateLimit-Limit" : {
5574 "description" : "Request limit per minute.",
5575 "style" : "simple",
5576 "explode" : false,
5577 "schema" : {
5578 "type" : "integer",
5579 "format" : "int32"
5580 }
5581 },
5582 "X-RateLimit-Remaining" : {
5583 "description" : "The number of requests left for the time window.",
5584 "style" : "simple",
5585 "explode" : false,
5586 "schema" : {
5587 "type" : "integer",
5588 "format" : "int32"
5589 }
5590 },
5591 "X-RateLimit-Reset" : {
5592 "description" : "The timestamp at which the current rate limit window resets.",
5593 "style" : "simple",
5594 "explode" : false,
5595 "schema" : {
5596 "type" : "integer",
5597 "format" : "int32"
5598 }
5599 },
5600 "Retry-After" : {
5601 "description" : "How many seconds you have to wait before making new request.",
5602 "style" : "simple",
5603 "explode" : false,
5604 "schema" : {
5605 "type" : "integer",
5606 "format" : "int32"
5607 }
5608 }
5609 },
5610 "content" : {
5611 "application/json" : {
5612 "schema" : {
5613 "$ref" : "#/components/schemas/ClientErrorResponse"
5614 }
5615 }
5616 }
5617 },
5618 "500" : {
5619 "description" : "Internal server error.",
5620 "headers" : {
5621 "X-RateLimit-Limit" : {
5622 "description" : "Request limit per minute.",
5623 "style" : "simple",
5624 "explode" : false,
5625 "schema" : {
5626 "type" : "integer",
5627 "format" : "int32"
5628 }
5629 },
5630 "X-RateLimit-Remaining" : {
5631 "description" : "The number of requests left for the time window.",
5632 "style" : "simple",
5633 "explode" : false,
5634 "schema" : {
5635 "type" : "integer",
5636 "format" : "int32"
5637 }
5638 },
5639 "X-RateLimit-Reset" : {
5640 "description" : "The timestamp at which the current rate limit window resets.",
5641 "style" : "simple",
5642 "explode" : false,
5643 "schema" : {
5644 "type" : "integer",
5645 "format" : "int32"
5646 }
5647 },
5648 "Retry-After" : {
5649 "description" : "How many seconds you have to wait before making new request.",
5650 "style" : "simple",
5651 "explode" : false,
5652 "schema" : {
5653 "type" : "integer",
5654 "format" : "int32"
5655 }
5656 }
5657 },
5658 "content" : {
5659 "application/json" : {
5660 "schema" : {
5661 "$ref" : "#/components/schemas/ServerErrorResponse"
5662 }
5663 }
5664 }
5665 }
5666 }
5667 }
5668 },
5669 "/documents/{id}/public-url" : {
5670 "get" : {
5671 "tags" : [ "Document" ],
5672 "summary" : "Retrieve a document download public url.",
5673 "description" : "Retrieves public url to download an existing document.",
5674 "operationId" : "GetPublicUrl",
5675 "parameters" : [ {
5676 "name" : "id",
5677 "in" : "path",
5678 "required" : true,
5679 "style" : "simple",
5680 "explode" : false,
5681 "schema" : {
5682 "type" : "integer"
5683 }
5684 } ],
5685 "responses" : {
5686 "200" : {
5687 "description" : "Success response",
5688 "headers" : {
5689 "X-RateLimit-Limit" : {
5690 "description" : "Request limit per minute.",
5691 "style" : "simple",
5692 "explode" : false,
5693 "schema" : {
5694 "type" : "integer",
5695 "format" : "int32"
5696 }
5697 },
5698 "X-RateLimit-Remaining" : {
5699 "description" : "The number of requests left for the time window.",
5700 "style" : "simple",
5701 "explode" : false,
5702 "schema" : {
5703 "type" : "integer",
5704 "format" : "int32"
5705 }
5706 },
5707 "X-RateLimit-Reset" : {
5708 "description" : "The timestamp at which the current rate limit window resets.",
5709 "style" : "simple",
5710 "explode" : false,
5711 "schema" : {
5712 "type" : "integer",
5713 "format" : "int32"
5714 }
5715 },
5716 "Retry-After" : {
5717 "description" : "How many seconds you have to wait before making new request.",
5718 "style" : "simple",
5719 "explode" : false,
5720 "schema" : {
5721 "type" : "integer",
5722 "format" : "int32"
5723 }
5724 }
5725 },
5726 "content" : {
5727 "application/json" : {
5728 "schema" : {
5729 "$ref" : "#/components/schemas/DocumentPublicUrl"
5730 }
5731 }
5732 }
5733 },
5734 "400" : {
5735 "description" : "The request is malformed.",
5736 "headers" : {
5737 "X-RateLimit-Limit" : {
5738 "description" : "Request limit per minute.",
5739 "style" : "simple",
5740 "explode" : false,
5741 "schema" : {
5742 "type" : "integer",
5743 "format" : "int32"
5744 }
5745 },
5746 "X-RateLimit-Remaining" : {
5747 "description" : "The number of requests left for the time window.",
5748 "style" : "simple",
5749 "explode" : false,
5750 "schema" : {
5751 "type" : "integer",
5752 "format" : "int32"
5753 }
5754 },
5755 "X-RateLimit-Reset" : {
5756 "description" : "The timestamp at which the current rate limit window resets.",
5757 "style" : "simple",
5758 "explode" : false,
5759 "schema" : {
5760 "type" : "integer",
5761 "format" : "int32"
5762 }
5763 },
5764 "Retry-After" : {
5765 "description" : "How many seconds you have to wait before making new request.",
5766 "style" : "simple",
5767 "explode" : false,
5768 "schema" : {
5769 "type" : "integer",
5770 "format" : "int32"
5771 }
5772 }
5773 },
5774 "content" : {
5775 "application/json" : {
5776 "schema" : {
5777 "$ref" : "#/components/schemas/ClientErrorResponse"
5778 }
5779 }
5780 }
5781 },
5782 "401" : {
5783 "description" : "Authorization information is missing or invalid.",
5784 "headers" : {
5785 "X-RateLimit-Limit" : {
5786 "description" : "Request limit per minute.",
5787 "style" : "simple",
5788 "explode" : false,
5789 "schema" : {
5790 "type" : "integer",
5791 "format" : "int32"
5792 }
5793 },
5794 "X-RateLimit-Remaining" : {
5795 "description" : "The number of requests left for the time window.",
5796 "style" : "simple",
5797 "explode" : false,
5798 "schema" : {
5799 "type" : "integer",
5800 "format" : "int32"
5801 }
5802 },
5803 "X-RateLimit-Reset" : {
5804 "description" : "The timestamp at which the current rate limit window resets.",
5805 "style" : "simple",
5806 "explode" : false,
5807 "schema" : {
5808 "type" : "integer",
5809 "format" : "int32"
5810 }
5811 },
5812 "Retry-After" : {
5813 "description" : "How many seconds you have to wait before making new request.",
5814 "style" : "simple",
5815 "explode" : false,
5816 "schema" : {
5817 "type" : "integer",
5818 "format" : "int32"
5819 }
5820 }
5821 },
5822 "content" : {
5823 "application/json" : {
5824 "schema" : {
5825 "$ref" : "#/components/schemas/ClientErrorResponse"
5826 }
5827 }
5828 }
5829 },
5830 "402" : {
5831 "description" : "Authenticated user doesn't have subscription.",
5832 "content" : {
5833 "application/json" : {
5834 "schema" : {
5835 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
5836 }
5837 }
5838 }
5839 },
5840 "404" : {
5841 "description" : "Non-existent resource is requested.",
5842 "headers" : {
5843 "X-RateLimit-Limit" : {
5844 "description" : "Request limit per minute.",
5845 "style" : "simple",
5846 "explode" : false,
5847 "schema" : {
5848 "type" : "integer",
5849 "format" : "int32"
5850 }
5851 },
5852 "X-RateLimit-Remaining" : {
5853 "description" : "The number of requests left for the time window.",
5854 "style" : "simple",
5855 "explode" : false,
5856 "schema" : {
5857 "type" : "integer",
5858 "format" : "int32"
5859 }
5860 },
5861 "X-RateLimit-Reset" : {
5862 "description" : "The timestamp at which the current rate limit window resets.",
5863 "style" : "simple",
5864 "explode" : false,
5865 "schema" : {
5866 "type" : "integer",
5867 "format" : "int32"
5868 }
5869 },
5870 "Retry-After" : {
5871 "description" : "How many seconds you have to wait before making new request.",
5872 "style" : "simple",
5873 "explode" : false,
5874 "schema" : {
5875 "type" : "integer",
5876 "format" : "int32"
5877 }
5878 }
5879 },
5880 "content" : {
5881 "application/json" : {
5882 "schema" : {
5883 "$ref" : "#/components/schemas/ClientErrorResponse"
5884 }
5885 }
5886 }
5887 },
5888 "422" : {
5889 "description" : "Validation errors occured.",
5890 "headers" : {
5891 "X-RateLimit-Limit" : {
5892 "description" : "Request limit per minute.",
5893 "style" : "simple",
5894 "explode" : false,
5895 "schema" : {
5896 "type" : "integer",
5897 "format" : "int32"
5898 }
5899 },
5900 "X-RateLimit-Remaining" : {
5901 "description" : "The number of requests left for the time window.",
5902 "style" : "simple",
5903 "explode" : false,
5904 "schema" : {
5905 "type" : "integer",
5906 "format" : "int32"
5907 }
5908 },
5909 "X-RateLimit-Reset" : {
5910 "description" : "The timestamp at which the current rate limit window resets.",
5911 "style" : "simple",
5912 "explode" : false,
5913 "schema" : {
5914 "type" : "integer",
5915 "format" : "int32"
5916 }
5917 },
5918 "Retry-After" : {
5919 "description" : "How many seconds you have to wait before making new request.",
5920 "style" : "simple",
5921 "explode" : false,
5922 "schema" : {
5923 "type" : "integer",
5924 "format" : "int32"
5925 }
5926 }
5927 },
5928 "content" : {
5929 "application/json" : {
5930 "schema" : {
5931 "$ref" : "#/components/schemas/ValidationErrorResponse"
5932 }
5933 }
5934 }
5935 },
5936 "500" : {
5937 "description" : "Internal server error.",
5938 "headers" : {
5939 "X-RateLimit-Limit" : {
5940 "description" : "Request limit per minute.",
5941 "style" : "simple",
5942 "explode" : false,
5943 "schema" : {
5944 "type" : "integer",
5945 "format" : "int32"
5946 }
5947 },
5948 "X-RateLimit-Remaining" : {
5949 "description" : "The number of requests left for the time window.",
5950 "style" : "simple",
5951 "explode" : false,
5952 "schema" : {
5953 "type" : "integer",
5954 "format" : "int32"
5955 }
5956 },
5957 "X-RateLimit-Reset" : {
5958 "description" : "The timestamp at which the current rate limit window resets.",
5959 "style" : "simple",
5960 "explode" : false,
5961 "schema" : {
5962 "type" : "integer",
5963 "format" : "int32"
5964 }
5965 },
5966 "Retry-After" : {
5967 "description" : "How many seconds you have to wait before making new request.",
5968 "style" : "simple",
5969 "explode" : false,
5970 "schema" : {
5971 "type" : "integer",
5972 "format" : "int32"
5973 }
5974 }
5975 },
5976 "content" : {
5977 "application/json" : {
5978 "schema" : {
5979 "$ref" : "#/components/schemas/ServerErrorResponse"
5980 }
5981 }
5982 }
5983 }
5984 }
5985 }
5986 },
5987 "/documents/{id}/send" : {
5988 "post" : {
5989 "tags" : [ "Document" ],
5990 "summary" : "Send invoice to given email adresses.",
5991 "description" : "Returns a list of emails, where the invoice is sent.",
5992 "operationId" : "SendDocument",
5993 "parameters" : [ {
5994 "name" : "id",
5995 "in" : "path",
5996 "required" : true,
5997 "style" : "simple",
5998 "explode" : false,
5999 "schema" : {
6000 "type" : "integer"
6001 }
6002 } ],
6003 "requestBody" : {
6004 "description" : "List of email-s where you want to send the invoice.",
6005 "content" : {
6006 "application/json" : {
6007 "schema" : {
6008 "$ref" : "#/components/schemas/SendDocument"
6009 }
6010 }
6011 },
6012 "required" : false
6013 },
6014 "responses" : {
6015 "200" : {
6016 "description" : "List of email adresses where the invoice sent.",
6017 "headers" : {
6018 "X-RateLimit-Limit" : {
6019 "description" : "Request limit per minute.",
6020 "style" : "simple",
6021 "explode" : false,
6022 "schema" : {
6023 "type" : "integer",
6024 "format" : "int32"
6025 }
6026 },
6027 "X-RateLimit-Remaining" : {
6028 "description" : "The number of requests left for the time window.",
6029 "style" : "simple",
6030 "explode" : false,
6031 "schema" : {
6032 "type" : "integer",
6033 "format" : "int32"
6034 }
6035 },
6036 "X-RateLimit-Reset" : {
6037 "description" : "The timestamp at which the current rate limit window resets.",
6038 "style" : "simple",
6039 "explode" : false,
6040 "schema" : {
6041 "type" : "integer",
6042 "format" : "int32"
6043 }
6044 },
6045 "Retry-After" : {
6046 "description" : "How many seconds you have to wait before making new request.",
6047 "style" : "simple",
6048 "explode" : false,
6049 "schema" : {
6050 "type" : "integer",
6051 "format" : "int32"
6052 }
6053 }
6054 },
6055 "content" : {
6056 "application/json" : {
6057 "schema" : {
6058 "$ref" : "#/components/schemas/SendDocument"
6059 }
6060 }
6061 }
6062 },
6063 "400" : {
6064 "description" : "The request is malformed.",
6065 "headers" : {
6066 "X-RateLimit-Limit" : {
6067 "description" : "Request limit per minute.",
6068 "style" : "simple",
6069 "explode" : false,
6070 "schema" : {
6071 "type" : "integer",
6072 "format" : "int32"
6073 }
6074 },
6075 "X-RateLimit-Remaining" : {
6076 "description" : "The number of requests left for the time window.",
6077 "style" : "simple",
6078 "explode" : false,
6079 "schema" : {
6080 "type" : "integer",
6081 "format" : "int32"
6082 }
6083 },
6084 "X-RateLimit-Reset" : {
6085 "description" : "The timestamp at which the current rate limit window resets.",
6086 "style" : "simple",
6087 "explode" : false,
6088 "schema" : {
6089 "type" : "integer",
6090 "format" : "int32"
6091 }
6092 },
6093 "Retry-After" : {
6094 "description" : "How many seconds you have to wait before making new request.",
6095 "style" : "simple",
6096 "explode" : false,
6097 "schema" : {
6098 "type" : "integer",
6099 "format" : "int32"
6100 }
6101 }
6102 },
6103 "content" : {
6104 "application/json" : {
6105 "schema" : {
6106 "$ref" : "#/components/schemas/ClientErrorResponse"
6107 }
6108 }
6109 }
6110 },
6111 "401" : {
6112 "description" : "Authorization information is missing or invalid.",
6113 "headers" : {
6114 "X-RateLimit-Limit" : {
6115 "description" : "Request limit per minute.",
6116 "style" : "simple",
6117 "explode" : false,
6118 "schema" : {
6119 "type" : "integer",
6120 "format" : "int32"
6121 }
6122 },
6123 "X-RateLimit-Remaining" : {
6124 "description" : "The number of requests left for the time window.",
6125 "style" : "simple",
6126 "explode" : false,
6127 "schema" : {
6128 "type" : "integer",
6129 "format" : "int32"
6130 }
6131 },
6132 "X-RateLimit-Reset" : {
6133 "description" : "The timestamp at which the current rate limit window resets.",
6134 "style" : "simple",
6135 "explode" : false,
6136 "schema" : {
6137 "type" : "integer",
6138 "format" : "int32"
6139 }
6140 },
6141 "Retry-After" : {
6142 "description" : "How many seconds you have to wait before making new request.",
6143 "style" : "simple",
6144 "explode" : false,
6145 "schema" : {
6146 "type" : "integer",
6147 "format" : "int32"
6148 }
6149 }
6150 },
6151 "content" : {
6152 "application/json" : {
6153 "schema" : {
6154 "$ref" : "#/components/schemas/ClientErrorResponse"
6155 }
6156 }
6157 }
6158 },
6159 "402" : {
6160 "description" : "Authenticated user doesn't have subscription.",
6161 "content" : {
6162 "application/json" : {
6163 "schema" : {
6164 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
6165 }
6166 }
6167 }
6168 },
6169 "403" : {
6170 "description" : "Authenticated user doesn't have access to the resource.",
6171 "headers" : {
6172 "X-RateLimit-Limit" : {
6173 "description" : "Request limit per minute.",
6174 "style" : "simple",
6175 "explode" : false,
6176 "schema" : {
6177 "type" : "integer",
6178 "format" : "int32"
6179 }
6180 },
6181 "X-RateLimit-Remaining" : {
6182 "description" : "The number of requests left for the time window.",
6183 "style" : "simple",
6184 "explode" : false,
6185 "schema" : {
6186 "type" : "integer",
6187 "format" : "int32"
6188 }
6189 },
6190 "X-RateLimit-Reset" : {
6191 "description" : "The timestamp at which the current rate limit window resets.",
6192 "style" : "simple",
6193 "explode" : false,
6194 "schema" : {
6195 "type" : "integer",
6196 "format" : "int32"
6197 }
6198 },
6199 "Retry-After" : {
6200 "description" : "How many seconds you have to wait before making new request.",
6201 "style" : "simple",
6202 "explode" : false,
6203 "schema" : {
6204 "type" : "integer",
6205 "format" : "int32"
6206 }
6207 }
6208 },
6209 "content" : {
6210 "application/json" : {
6211 "schema" : {
6212 "$ref" : "#/components/schemas/ClientErrorResponse"
6213 }
6214 }
6215 }
6216 },
6217 "404" : {
6218 "description" : "Non-existent resource is requested.",
6219 "headers" : {
6220 "X-RateLimit-Limit" : {
6221 "description" : "Request limit per minute.",
6222 "style" : "simple",
6223 "explode" : false,
6224 "schema" : {
6225 "type" : "integer",
6226 "format" : "int32"
6227 }
6228 },
6229 "X-RateLimit-Remaining" : {
6230 "description" : "The number of requests left for the time window.",
6231 "style" : "simple",
6232 "explode" : false,
6233 "schema" : {
6234 "type" : "integer",
6235 "format" : "int32"
6236 }
6237 },
6238 "X-RateLimit-Reset" : {
6239 "description" : "The timestamp at which the current rate limit window resets.",
6240 "style" : "simple",
6241 "explode" : false,
6242 "schema" : {
6243 "type" : "integer",
6244 "format" : "int32"
6245 }
6246 },
6247 "Retry-After" : {
6248 "description" : "How many seconds you have to wait before making new request.",
6249 "style" : "simple",
6250 "explode" : false,
6251 "schema" : {
6252 "type" : "integer",
6253 "format" : "int32"
6254 }
6255 }
6256 },
6257 "content" : {
6258 "application/json" : {
6259 "schema" : {
6260 "$ref" : "#/components/schemas/ClientErrorResponse"
6261 }
6262 }
6263 }
6264 },
6265 "422" : {
6266 "description" : "Validation errors occured.",
6267 "headers" : {
6268 "X-RateLimit-Limit" : {
6269 "description" : "Request limit per minute.",
6270 "style" : "simple",
6271 "explode" : false,
6272 "schema" : {
6273 "type" : "integer",
6274 "format" : "int32"
6275 }
6276 },
6277 "X-RateLimit-Remaining" : {
6278 "description" : "The number of requests left for the time window.",
6279 "style" : "simple",
6280 "explode" : false,
6281 "schema" : {
6282 "type" : "integer",
6283 "format" : "int32"
6284 }
6285 },
6286 "X-RateLimit-Reset" : {
6287 "description" : "The timestamp at which the current rate limit window resets.",
6288 "style" : "simple",
6289 "explode" : false,
6290 "schema" : {
6291 "type" : "integer",
6292 "format" : "int32"
6293 }
6294 },
6295 "Retry-After" : {
6296 "description" : "How many seconds you have to wait before making new request.",
6297 "style" : "simple",
6298 "explode" : false,
6299 "schema" : {
6300 "type" : "integer",
6301 "format" : "int32"
6302 }
6303 }
6304 },
6305 "content" : {
6306 "application/json" : {
6307 "schema" : {
6308 "$ref" : "#/components/schemas/ValidationErrorResponse"
6309 }
6310 }
6311 }
6312 },
6313 "500" : {
6314 "description" : "Internal server error.",
6315 "headers" : {
6316 "X-RateLimit-Limit" : {
6317 "description" : "Request limit per minute.",
6318 "style" : "simple",
6319 "explode" : false,
6320 "schema" : {
6321 "type" : "integer",
6322 "format" : "int32"
6323 }
6324 },
6325 "X-RateLimit-Remaining" : {
6326 "description" : "The number of requests left for the time window.",
6327 "style" : "simple",
6328 "explode" : false,
6329 "schema" : {
6330 "type" : "integer",
6331 "format" : "int32"
6332 }
6333 },
6334 "X-RateLimit-Reset" : {
6335 "description" : "The timestamp at which the current rate limit window resets.",
6336 "style" : "simple",
6337 "explode" : false,
6338 "schema" : {
6339 "type" : "integer",
6340 "format" : "int32"
6341 }
6342 },
6343 "Retry-After" : {
6344 "description" : "How many seconds you have to wait before making new request.",
6345 "style" : "simple",
6346 "explode" : false,
6347 "schema" : {
6348 "type" : "integer",
6349 "format" : "int32"
6350 }
6351 }
6352 },
6353 "content" : {
6354 "application/json" : {
6355 "schema" : {
6356 "$ref" : "#/components/schemas/ServerErrorResponse"
6357 }
6358 }
6359 }
6360 }
6361 }
6362 }
6363 },
6364 "/organization" : {
6365 "get" : {
6366 "tags" : [ "Organization" ],
6367 "summary" : "Retrieve a organization data.",
6368 "description" : "Retrieves the data of organization.",
6369 "operationId" : "GetOrganizationData",
6370 "responses" : {
6371 "200" : {
6372 "description" : "Success response",
6373 "headers" : {
6374 "X-RateLimit-Limit" : {
6375 "description" : "Request limit per minute.",
6376 "style" : "simple",
6377 "explode" : false,
6378 "schema" : {
6379 "type" : "integer",
6380 "format" : "int32"
6381 }
6382 },
6383 "X-RateLimit-Remaining" : {
6384 "description" : "The number of requests left for the time window.",
6385 "style" : "simple",
6386 "explode" : false,
6387 "schema" : {
6388 "type" : "integer",
6389 "format" : "int32"
6390 }
6391 },
6392 "X-RateLimit-Reset" : {
6393 "description" : "The timestamp at which the current rate limit window resets.",
6394 "style" : "simple",
6395 "explode" : false,
6396 "schema" : {
6397 "type" : "integer",
6398 "format" : "int32"
6399 }
6400 },
6401 "Retry-After" : {
6402 "description" : "How many seconds you have to wait before making new request.",
6403 "style" : "simple",
6404 "explode" : false,
6405 "schema" : {
6406 "type" : "integer",
6407 "format" : "int32"
6408 }
6409 }
6410 },
6411 "content" : {
6412 "application/json" : {
6413 "schema" : {
6414 "$ref" : "#/components/schemas/OrganizationData"
6415 }
6416 }
6417 }
6418 },
6419 "400" : {
6420 "description" : "The request is malformed.",
6421 "headers" : {
6422 "X-RateLimit-Limit" : {
6423 "description" : "Request limit per minute.",
6424 "style" : "simple",
6425 "explode" : false,
6426 "schema" : {
6427 "type" : "integer",
6428 "format" : "int32"
6429 }
6430 },
6431 "X-RateLimit-Remaining" : {
6432 "description" : "The number of requests left for the time window.",
6433 "style" : "simple",
6434 "explode" : false,
6435 "schema" : {
6436 "type" : "integer",
6437 "format" : "int32"
6438 }
6439 },
6440 "X-RateLimit-Reset" : {
6441 "description" : "The timestamp at which the current rate limit window resets.",
6442 "style" : "simple",
6443 "explode" : false,
6444 "schema" : {
6445 "type" : "integer",
6446 "format" : "int32"
6447 }
6448 },
6449 "Retry-After" : {
6450 "description" : "How many seconds you have to wait before making new request.",
6451 "style" : "simple",
6452 "explode" : false,
6453 "schema" : {
6454 "type" : "integer",
6455 "format" : "int32"
6456 }
6457 }
6458 },
6459 "content" : {
6460 "application/json" : {
6461 "schema" : {
6462 "$ref" : "#/components/schemas/ClientErrorResponse"
6463 }
6464 }
6465 }
6466 },
6467 "401" : {
6468 "description" : "Authorization information is missing or invalid.",
6469 "headers" : {
6470 "X-RateLimit-Limit" : {
6471 "description" : "Request limit per minute.",
6472 "style" : "simple",
6473 "explode" : false,
6474 "schema" : {
6475 "type" : "integer",
6476 "format" : "int32"
6477 }
6478 },
6479 "X-RateLimit-Remaining" : {
6480 "description" : "The number of requests left for the time window.",
6481 "style" : "simple",
6482 "explode" : false,
6483 "schema" : {
6484 "type" : "integer",
6485 "format" : "int32"
6486 }
6487 },
6488 "X-RateLimit-Reset" : {
6489 "description" : "The timestamp at which the current rate limit window resets.",
6490 "style" : "simple",
6491 "explode" : false,
6492 "schema" : {
6493 "type" : "integer",
6494 "format" : "int32"
6495 }
6496 },
6497 "Retry-After" : {
6498 "description" : "How many seconds you have to wait before making new request.",
6499 "style" : "simple",
6500 "explode" : false,
6501 "schema" : {
6502 "type" : "integer",
6503 "format" : "int32"
6504 }
6505 }
6506 },
6507 "content" : {
6508 "application/json" : {
6509 "schema" : {
6510 "$ref" : "#/components/schemas/ClientErrorResponse"
6511 }
6512 }
6513 }
6514 },
6515 "402" : {
6516 "description" : "Authenticated user doesn't have subscription.",
6517 "content" : {
6518 "application/json" : {
6519 "schema" : {
6520 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
6521 }
6522 }
6523 }
6524 },
6525 "422" : {
6526 "description" : "Validation errors occured.",
6527 "headers" : {
6528 "X-RateLimit-Limit" : {
6529 "description" : "Request limit per minute.",
6530 "style" : "simple",
6531 "explode" : false,
6532 "schema" : {
6533 "type" : "integer",
6534 "format" : "int32"
6535 }
6536 },
6537 "X-RateLimit-Remaining" : {
6538 "description" : "The number of requests left for the time window.",
6539 "style" : "simple",
6540 "explode" : false,
6541 "schema" : {
6542 "type" : "integer",
6543 "format" : "int32"
6544 }
6545 },
6546 "X-RateLimit-Reset" : {
6547 "description" : "The timestamp at which the current rate limit window resets.",
6548 "style" : "simple",
6549 "explode" : false,
6550 "schema" : {
6551 "type" : "integer",
6552 "format" : "int32"
6553 }
6554 },
6555 "Retry-After" : {
6556 "description" : "How many seconds you have to wait before making new request.",
6557 "style" : "simple",
6558 "explode" : false,
6559 "schema" : {
6560 "type" : "integer",
6561 "format" : "int32"
6562 }
6563 }
6564 },
6565 "content" : {
6566 "application/json" : {
6567 "schema" : {
6568 "$ref" : "#/components/schemas/ValidationErrorResponse"
6569 }
6570 }
6571 }
6572 },
6573 "500" : {
6574 "description" : "Internal server error.",
6575 "headers" : {
6576 "X-RateLimit-Limit" : {
6577 "description" : "Request limit per minute.",
6578 "style" : "simple",
6579 "explode" : false,
6580 "schema" : {
6581 "type" : "integer",
6582 "format" : "int32"
6583 }
6584 },
6585 "X-RateLimit-Remaining" : {
6586 "description" : "The number of requests left for the time window.",
6587 "style" : "simple",
6588 "explode" : false,
6589 "schema" : {
6590 "type" : "integer",
6591 "format" : "int32"
6592 }
6593 },
6594 "X-RateLimit-Reset" : {
6595 "description" : "The timestamp at which the current rate limit window resets.",
6596 "style" : "simple",
6597 "explode" : false,
6598 "schema" : {
6599 "type" : "integer",
6600 "format" : "int32"
6601 }
6602 },
6603 "Retry-After" : {
6604 "description" : "How many seconds you have to wait before making new request.",
6605 "style" : "simple",
6606 "explode" : false,
6607 "schema" : {
6608 "type" : "integer",
6609 "format" : "int32"
6610 }
6611 }
6612 },
6613 "content" : {
6614 "application/json" : {
6615 "schema" : {
6616 "$ref" : "#/components/schemas/ServerErrorResponse"
6617 }
6618 }
6619 }
6620 }
6621 }
6622 }
6623 },
6624 "/partners" : {
6625 "get" : {
6626 "tags" : [ "Partner" ],
6627 "summary" : "List all partners",
6628 "description" : "Returns a list of your partners. The partners are returned sorted by creation date, with the most recent partners appearing first.",
6629 "operationId" : "ListPartner",
6630 "parameters" : [ {
6631 "name" : "page",
6632 "in" : "query",
6633 "required" : false,
6634 "style" : "form",
6635 "explode" : true,
6636 "schema" : {
6637 "type" : "integer"
6638 }
6639 }, {
6640 "name" : "per_page",
6641 "in" : "query",
6642 "required" : false,
6643 "style" : "form",
6644 "explode" : true,
6645 "schema" : {
6646 "maximum" : 100,
6647 "minimum" : 1,
6648 "type" : "integer",
6649 "default" : 25
6650 }
6651 } ],
6652 "responses" : {
6653 "200" : {
6654 "description" : "Success response",
6655 "headers" : {
6656 "X-RateLimit-Limit" : {
6657 "description" : "Request limit per minute.",
6658 "style" : "simple",
6659 "explode" : false,
6660 "schema" : {
6661 "type" : "integer",
6662 "format" : "int32"
6663 }
6664 },
6665 "X-RateLimit-Remaining" : {
6666 "description" : "The number of requests left for the time window.",
6667 "style" : "simple",
6668 "explode" : false,
6669 "schema" : {
6670 "type" : "integer",
6671 "format" : "int32"
6672 }
6673 },
6674 "X-RateLimit-Reset" : {
6675 "description" : "The timestamp at which the current rate limit window resets.",
6676 "style" : "simple",
6677 "explode" : false,
6678 "schema" : {
6679 "type" : "integer",
6680 "format" : "int32"
6681 }
6682 },
6683 "Retry-After" : {
6684 "description" : "How many seconds you have to wait before making new request.",
6685 "style" : "simple",
6686 "explode" : false,
6687 "schema" : {
6688 "type" : "integer",
6689 "format" : "int32"
6690 }
6691 }
6692 },
6693 "content" : {
6694 "application/json" : {
6695 "schema" : {
6696 "$ref" : "#/components/schemas/PartnerList"
6697 }
6698 }
6699 }
6700 },
6701 "400" : {
6702 "description" : "The request is malformed.",
6703 "headers" : {
6704 "X-RateLimit-Limit" : {
6705 "description" : "Request limit per minute.",
6706 "style" : "simple",
6707 "explode" : false,
6708 "schema" : {
6709 "type" : "integer",
6710 "format" : "int32"
6711 }
6712 },
6713 "X-RateLimit-Remaining" : {
6714 "description" : "The number of requests left for the time window.",
6715 "style" : "simple",
6716 "explode" : false,
6717 "schema" : {
6718 "type" : "integer",
6719 "format" : "int32"
6720 }
6721 },
6722 "X-RateLimit-Reset" : {
6723 "description" : "The timestamp at which the current rate limit window resets.",
6724 "style" : "simple",
6725 "explode" : false,
6726 "schema" : {
6727 "type" : "integer",
6728 "format" : "int32"
6729 }
6730 },
6731 "Retry-After" : {
6732 "description" : "How many seconds you have to wait before making new request.",
6733 "style" : "simple",
6734 "explode" : false,
6735 "schema" : {
6736 "type" : "integer",
6737 "format" : "int32"
6738 }
6739 }
6740 },
6741 "content" : {
6742 "application/json" : {
6743 "schema" : {
6744 "$ref" : "#/components/schemas/ClientErrorResponse"
6745 }
6746 }
6747 }
6748 },
6749 "401" : {
6750 "description" : "Authorization information is missing or invalid.",
6751 "headers" : {
6752 "X-RateLimit-Limit" : {
6753 "description" : "Request limit per minute.",
6754 "style" : "simple",
6755 "explode" : false,
6756 "schema" : {
6757 "type" : "integer",
6758 "format" : "int32"
6759 }
6760 },
6761 "X-RateLimit-Remaining" : {
6762 "description" : "The number of requests left for the time window.",
6763 "style" : "simple",
6764 "explode" : false,
6765 "schema" : {
6766 "type" : "integer",
6767 "format" : "int32"
6768 }
6769 },
6770 "X-RateLimit-Reset" : {
6771 "description" : "The timestamp at which the current rate limit window resets.",
6772 "style" : "simple",
6773 "explode" : false,
6774 "schema" : {
6775 "type" : "integer",
6776 "format" : "int32"
6777 }
6778 },
6779 "Retry-After" : {
6780 "description" : "How many seconds you have to wait before making new request.",
6781 "style" : "simple",
6782 "explode" : false,
6783 "schema" : {
6784 "type" : "integer",
6785 "format" : "int32"
6786 }
6787 }
6788 },
6789 "content" : {
6790 "application/json" : {
6791 "schema" : {
6792 "$ref" : "#/components/schemas/ClientErrorResponse"
6793 }
6794 }
6795 }
6796 },
6797 "402" : {
6798 "description" : "Authenticated user doesn't have subscription.",
6799 "content" : {
6800 "application/json" : {
6801 "schema" : {
6802 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
6803 }
6804 }
6805 }
6806 },
6807 "422" : {
6808 "description" : "Validation errors occured.",
6809 "headers" : {
6810 "X-RateLimit-Limit" : {
6811 "description" : "Request limit per minute.",
6812 "style" : "simple",
6813 "explode" : false,
6814 "schema" : {
6815 "type" : "integer",
6816 "format" : "int32"
6817 }
6818 },
6819 "X-RateLimit-Remaining" : {
6820 "description" : "The number of requests left for the time window.",
6821 "style" : "simple",
6822 "explode" : false,
6823 "schema" : {
6824 "type" : "integer",
6825 "format" : "int32"
6826 }
6827 },
6828 "X-RateLimit-Reset" : {
6829 "description" : "The timestamp at which the current rate limit window resets.",
6830 "style" : "simple",
6831 "explode" : false,
6832 "schema" : {
6833 "type" : "integer",
6834 "format" : "int32"
6835 }
6836 },
6837 "Retry-After" : {
6838 "description" : "How many seconds you have to wait before making new request.",
6839 "style" : "simple",
6840 "explode" : false,
6841 "schema" : {
6842 "type" : "integer",
6843 "format" : "int32"
6844 }
6845 }
6846 },
6847 "content" : {
6848 "application/json" : {
6849 "schema" : {
6850 "$ref" : "#/components/schemas/ValidationErrorResponse"
6851 }
6852 }
6853 }
6854 },
6855 "500" : {
6856 "description" : "Internal server error.",
6857 "headers" : {
6858 "X-RateLimit-Limit" : {
6859 "description" : "Request limit per minute.",
6860 "style" : "simple",
6861 "explode" : false,
6862 "schema" : {
6863 "type" : "integer",
6864 "format" : "int32"
6865 }
6866 },
6867 "X-RateLimit-Remaining" : {
6868 "description" : "The number of requests left for the time window.",
6869 "style" : "simple",
6870 "explode" : false,
6871 "schema" : {
6872 "type" : "integer",
6873 "format" : "int32"
6874 }
6875 },
6876 "X-RateLimit-Reset" : {
6877 "description" : "The timestamp at which the current rate limit window resets.",
6878 "style" : "simple",
6879 "explode" : false,
6880 "schema" : {
6881 "type" : "integer",
6882 "format" : "int32"
6883 }
6884 },
6885 "Retry-After" : {
6886 "description" : "How many seconds you have to wait before making new request.",
6887 "style" : "simple",
6888 "explode" : false,
6889 "schema" : {
6890 "type" : "integer",
6891 "format" : "int32"
6892 }
6893 }
6894 },
6895 "content" : {
6896 "application/json" : {
6897 "schema" : {
6898 "$ref" : "#/components/schemas/ServerErrorResponse"
6899 }
6900 }
6901 }
6902 }
6903 }
6904 },
6905 "post" : {
6906 "tags" : [ "Partner" ],
6907 "summary" : "Create a partner",
6908 "description" : "Create a new partner. Returns a partner object if the create is succeded.",
6909 "operationId" : "CreatePartner",
6910 "requestBody" : {
6911 "description" : "PartnerUpsert object that you would like to store.",
6912 "content" : {
6913 "application/json" : {
6914 "schema" : {
6915 "$ref" : "#/components/schemas/PartnerUpsert"
6916 }
6917 }
6918 },
6919 "required" : true
6920 },
6921 "responses" : {
6922 "201" : {
6923 "description" : "Partner created successfully.",
6924 "headers" : {
6925 "X-RateLimit-Limit" : {
6926 "description" : "Request limit per minute.",
6927 "style" : "simple",
6928 "explode" : false,
6929 "schema" : {
6930 "type" : "integer",
6931 "format" : "int32"
6932 }
6933 },
6934 "X-RateLimit-Remaining" : {
6935 "description" : "The number of requests left for the time window.",
6936 "style" : "simple",
6937 "explode" : false,
6938 "schema" : {
6939 "type" : "integer",
6940 "format" : "int32"
6941 }
6942 },
6943 "X-RateLimit-Reset" : {
6944 "description" : "The timestamp at which the current rate limit window resets.",
6945 "style" : "simple",
6946 "explode" : false,
6947 "schema" : {
6948 "type" : "integer",
6949 "format" : "int32"
6950 }
6951 },
6952 "Retry-After" : {
6953 "description" : "How many seconds you have to wait before making new request.",
6954 "style" : "simple",
6955 "explode" : false,
6956 "schema" : {
6957 "type" : "integer",
6958 "format" : "int32"
6959 }
6960 }
6961 },
6962 "content" : {
6963 "application/json" : {
6964 "schema" : {
6965 "$ref" : "#/components/schemas/Partner"
6966 }
6967 }
6968 }
6969 },
6970 "400" : {
6971 "description" : "The request is malformed.",
6972 "headers" : {
6973 "X-RateLimit-Limit" : {
6974 "description" : "Request limit per minute.",
6975 "style" : "simple",
6976 "explode" : false,
6977 "schema" : {
6978 "type" : "integer",
6979 "format" : "int32"
6980 }
6981 },
6982 "X-RateLimit-Remaining" : {
6983 "description" : "The number of requests left for the time window.",
6984 "style" : "simple",
6985 "explode" : false,
6986 "schema" : {
6987 "type" : "integer",
6988 "format" : "int32"
6989 }
6990 },
6991 "X-RateLimit-Reset" : {
6992 "description" : "The timestamp at which the current rate limit window resets.",
6993 "style" : "simple",
6994 "explode" : false,
6995 "schema" : {
6996 "type" : "integer",
6997 "format" : "int32"
6998 }
6999 },
7000 "Retry-After" : {
7001 "description" : "How many seconds you have to wait before making new request.",
7002 "style" : "simple",
7003 "explode" : false,
7004 "schema" : {
7005 "type" : "integer",
7006 "format" : "int32"
7007 }
7008 }
7009 },
7010 "content" : {
7011 "application/json" : {
7012 "schema" : {
7013 "$ref" : "#/components/schemas/ClientErrorResponse"
7014 }
7015 }
7016 }
7017 },
7018 "401" : {
7019 "description" : "Authorization information is missing or invalid.",
7020 "headers" : {
7021 "X-RateLimit-Limit" : {
7022 "description" : "Request limit per minute.",
7023 "style" : "simple",
7024 "explode" : false,
7025 "schema" : {
7026 "type" : "integer",
7027 "format" : "int32"
7028 }
7029 },
7030 "X-RateLimit-Remaining" : {
7031 "description" : "The number of requests left for the time window.",
7032 "style" : "simple",
7033 "explode" : false,
7034 "schema" : {
7035 "type" : "integer",
7036 "format" : "int32"
7037 }
7038 },
7039 "X-RateLimit-Reset" : {
7040 "description" : "The timestamp at which the current rate limit window resets.",
7041 "style" : "simple",
7042 "explode" : false,
7043 "schema" : {
7044 "type" : "integer",
7045 "format" : "int32"
7046 }
7047 },
7048 "Retry-After" : {
7049 "description" : "How many seconds you have to wait before making new request.",
7050 "style" : "simple",
7051 "explode" : false,
7052 "schema" : {
7053 "type" : "integer",
7054 "format" : "int32"
7055 }
7056 }
7057 },
7058 "content" : {
7059 "application/json" : {
7060 "schema" : {
7061 "$ref" : "#/components/schemas/ClientErrorResponse"
7062 }
7063 }
7064 }
7065 },
7066 "402" : {
7067 "description" : "Authenticated user doesn't have subscription.",
7068 "content" : {
7069 "application/json" : {
7070 "schema" : {
7071 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
7072 }
7073 }
7074 }
7075 },
7076 "403" : {
7077 "description" : "Authenticated user doesn't have access to the resource.",
7078 "headers" : {
7079 "X-RateLimit-Limit" : {
7080 "description" : "Request limit per minute.",
7081 "style" : "simple",
7082 "explode" : false,
7083 "schema" : {
7084 "type" : "integer",
7085 "format" : "int32"
7086 }
7087 },
7088 "X-RateLimit-Remaining" : {
7089 "description" : "The number of requests left for the time window.",
7090 "style" : "simple",
7091 "explode" : false,
7092 "schema" : {
7093 "type" : "integer",
7094 "format" : "int32"
7095 }
7096 },
7097 "X-RateLimit-Reset" : {
7098 "description" : "The timestamp at which the current rate limit window resets.",
7099 "style" : "simple",
7100 "explode" : false,
7101 "schema" : {
7102 "type" : "integer",
7103 "format" : "int32"
7104 }
7105 },
7106 "Retry-After" : {
7107 "description" : "How many seconds you have to wait before making new request.",
7108 "style" : "simple",
7109 "explode" : false,
7110 "schema" : {
7111 "type" : "integer",
7112 "format" : "int32"
7113 }
7114 }
7115 },
7116 "content" : {
7117 "application/json" : {
7118 "schema" : {
7119 "$ref" : "#/components/schemas/ClientErrorResponse"
7120 }
7121 }
7122 }
7123 },
7124 "422" : {
7125 "description" : "Validation errors occured.",
7126 "headers" : {
7127 "X-RateLimit-Limit" : {
7128 "description" : "Request limit per minute.",
7129 "style" : "simple",
7130 "explode" : false,
7131 "schema" : {
7132 "type" : "integer",
7133 "format" : "int32"
7134 }
7135 },
7136 "X-RateLimit-Remaining" : {
7137 "description" : "The number of requests left for the time window.",
7138 "style" : "simple",
7139 "explode" : false,
7140 "schema" : {
7141 "type" : "integer",
7142 "format" : "int32"
7143 }
7144 },
7145 "X-RateLimit-Reset" : {
7146 "description" : "The timestamp at which the current rate limit window resets.",
7147 "style" : "simple",
7148 "explode" : false,
7149 "schema" : {
7150 "type" : "integer",
7151 "format" : "int32"
7152 }
7153 },
7154 "Retry-After" : {
7155 "description" : "How many seconds you have to wait before making new request.",
7156 "style" : "simple",
7157 "explode" : false,
7158 "schema" : {
7159 "type" : "integer",
7160 "format" : "int32"
7161 }
7162 }
7163 },
7164 "content" : {
7165 "application/json" : {
7166 "schema" : {
7167 "$ref" : "#/components/schemas/ValidationErrorResponse"
7168 }
7169 }
7170 }
7171 },
7172 "500" : {
7173 "description" : "Internal server error.",
7174 "headers" : {
7175 "X-RateLimit-Limit" : {
7176 "description" : "Request limit per minute.",
7177 "style" : "simple",
7178 "explode" : false,
7179 "schema" : {
7180 "type" : "integer",
7181 "format" : "int32"
7182 }
7183 },
7184 "X-RateLimit-Remaining" : {
7185 "description" : "The number of requests left for the time window.",
7186 "style" : "simple",
7187 "explode" : false,
7188 "schema" : {
7189 "type" : "integer",
7190 "format" : "int32"
7191 }
7192 },
7193 "X-RateLimit-Reset" : {
7194 "description" : "The timestamp at which the current rate limit window resets.",
7195 "style" : "simple",
7196 "explode" : false,
7197 "schema" : {
7198 "type" : "integer",
7199 "format" : "int32"
7200 }
7201 },
7202 "Retry-After" : {
7203 "description" : "How many seconds you have to wait before making new request.",
7204 "style" : "simple",
7205 "explode" : false,
7206 "schema" : {
7207 "type" : "integer",
7208 "format" : "int32"
7209 }
7210 }
7211 },
7212 "content" : {
7213 "application/json" : {
7214 "schema" : {
7215 "$ref" : "#/components/schemas/ServerErrorResponse"
7216 }
7217 }
7218 }
7219 }
7220 }
7221 }
7222 },
7223 "/partners/{id}" : {
7224 "get" : {
7225 "tags" : [ "Partner" ],
7226 "summary" : "Retrieve a partner",
7227 "description" : "Retrieves the details of an existing partner.",
7228 "operationId" : "GetPartner",
7229 "parameters" : [ {
7230 "name" : "id",
7231 "in" : "path",
7232 "required" : true,
7233 "style" : "simple",
7234 "explode" : false,
7235 "schema" : {
7236 "type" : "integer"
7237 }
7238 } ],
7239 "responses" : {
7240 "200" : {
7241 "description" : "Success response",
7242 "headers" : {
7243 "X-RateLimit-Limit" : {
7244 "description" : "Request limit per minute.",
7245 "style" : "simple",
7246 "explode" : false,
7247 "schema" : {
7248 "type" : "integer",
7249 "format" : "int32"
7250 }
7251 },
7252 "X-RateLimit-Remaining" : {
7253 "description" : "The number of requests left for the time window.",
7254 "style" : "simple",
7255 "explode" : false,
7256 "schema" : {
7257 "type" : "integer",
7258 "format" : "int32"
7259 }
7260 },
7261 "X-RateLimit-Reset" : {
7262 "description" : "The timestamp at which the current rate limit window resets.",
7263 "style" : "simple",
7264 "explode" : false,
7265 "schema" : {
7266 "type" : "integer",
7267 "format" : "int32"
7268 }
7269 },
7270 "Retry-After" : {
7271 "description" : "How many seconds you have to wait before making new request.",
7272 "style" : "simple",
7273 "explode" : false,
7274 "schema" : {
7275 "type" : "integer",
7276 "format" : "int32"
7277 }
7278 }
7279 },
7280 "content" : {
7281 "application/json" : {
7282 "schema" : {
7283 "$ref" : "#/components/schemas/Partner"
7284 }
7285 }
7286 }
7287 },
7288 "400" : {
7289 "description" : "The request is malformed.",
7290 "headers" : {
7291 "X-RateLimit-Limit" : {
7292 "description" : "Request limit per minute.",
7293 "style" : "simple",
7294 "explode" : false,
7295 "schema" : {
7296 "type" : "integer",
7297 "format" : "int32"
7298 }
7299 },
7300 "X-RateLimit-Remaining" : {
7301 "description" : "The number of requests left for the time window.",
7302 "style" : "simple",
7303 "explode" : false,
7304 "schema" : {
7305 "type" : "integer",
7306 "format" : "int32"
7307 }
7308 },
7309 "X-RateLimit-Reset" : {
7310 "description" : "The timestamp at which the current rate limit window resets.",
7311 "style" : "simple",
7312 "explode" : false,
7313 "schema" : {
7314 "type" : "integer",
7315 "format" : "int32"
7316 }
7317 },
7318 "Retry-After" : {
7319 "description" : "How many seconds you have to wait before making new request.",
7320 "style" : "simple",
7321 "explode" : false,
7322 "schema" : {
7323 "type" : "integer",
7324 "format" : "int32"
7325 }
7326 }
7327 },
7328 "content" : {
7329 "application/json" : {
7330 "schema" : {
7331 "$ref" : "#/components/schemas/ClientErrorResponse"
7332 }
7333 }
7334 }
7335 },
7336 "401" : {
7337 "description" : "Authorization information is missing or invalid.",
7338 "headers" : {
7339 "X-RateLimit-Limit" : {
7340 "description" : "Request limit per minute.",
7341 "style" : "simple",
7342 "explode" : false,
7343 "schema" : {
7344 "type" : "integer",
7345 "format" : "int32"
7346 }
7347 },
7348 "X-RateLimit-Remaining" : {
7349 "description" : "The number of requests left for the time window.",
7350 "style" : "simple",
7351 "explode" : false,
7352 "schema" : {
7353 "type" : "integer",
7354 "format" : "int32"
7355 }
7356 },
7357 "X-RateLimit-Reset" : {
7358 "description" : "The timestamp at which the current rate limit window resets.",
7359 "style" : "simple",
7360 "explode" : false,
7361 "schema" : {
7362 "type" : "integer",
7363 "format" : "int32"
7364 }
7365 },
7366 "Retry-After" : {
7367 "description" : "How many seconds you have to wait before making new request.",
7368 "style" : "simple",
7369 "explode" : false,
7370 "schema" : {
7371 "type" : "integer",
7372 "format" : "int32"
7373 }
7374 }
7375 },
7376 "content" : {
7377 "application/json" : {
7378 "schema" : {
7379 "$ref" : "#/components/schemas/ClientErrorResponse"
7380 }
7381 }
7382 }
7383 },
7384 "402" : {
7385 "description" : "Authenticated user doesn't have subscription.",
7386 "content" : {
7387 "application/json" : {
7388 "schema" : {
7389 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
7390 }
7391 }
7392 }
7393 },
7394 "404" : {
7395 "description" : "Non-existent resource is requested.",
7396 "headers" : {
7397 "X-RateLimit-Limit" : {
7398 "description" : "Request limit per minute.",
7399 "style" : "simple",
7400 "explode" : false,
7401 "schema" : {
7402 "type" : "integer",
7403 "format" : "int32"
7404 }
7405 },
7406 "X-RateLimit-Remaining" : {
7407 "description" : "The number of requests left for the time window.",
7408 "style" : "simple",
7409 "explode" : false,
7410 "schema" : {
7411 "type" : "integer",
7412 "format" : "int32"
7413 }
7414 },
7415 "X-RateLimit-Reset" : {
7416 "description" : "The timestamp at which the current rate limit window resets.",
7417 "style" : "simple",
7418 "explode" : false,
7419 "schema" : {
7420 "type" : "integer",
7421 "format" : "int32"
7422 }
7423 },
7424 "Retry-After" : {
7425 "description" : "How many seconds you have to wait before making new request.",
7426 "style" : "simple",
7427 "explode" : false,
7428 "schema" : {
7429 "type" : "integer",
7430 "format" : "int32"
7431 }
7432 }
7433 },
7434 "content" : {
7435 "application/json" : {
7436 "schema" : {
7437 "$ref" : "#/components/schemas/ClientErrorResponse"
7438 }
7439 }
7440 }
7441 },
7442 "422" : {
7443 "description" : "Validation errors occured.",
7444 "headers" : {
7445 "X-RateLimit-Limit" : {
7446 "description" : "Request limit per minute.",
7447 "style" : "simple",
7448 "explode" : false,
7449 "schema" : {
7450 "type" : "integer",
7451 "format" : "int32"
7452 }
7453 },
7454 "X-RateLimit-Remaining" : {
7455 "description" : "The number of requests left for the time window.",
7456 "style" : "simple",
7457 "explode" : false,
7458 "schema" : {
7459 "type" : "integer",
7460 "format" : "int32"
7461 }
7462 },
7463 "X-RateLimit-Reset" : {
7464 "description" : "The timestamp at which the current rate limit window resets.",
7465 "style" : "simple",
7466 "explode" : false,
7467 "schema" : {
7468 "type" : "integer",
7469 "format" : "int32"
7470 }
7471 },
7472 "Retry-After" : {
7473 "description" : "How many seconds you have to wait before making new request.",
7474 "style" : "simple",
7475 "explode" : false,
7476 "schema" : {
7477 "type" : "integer",
7478 "format" : "int32"
7479 }
7480 }
7481 },
7482 "content" : {
7483 "application/json" : {
7484 "schema" : {
7485 "$ref" : "#/components/schemas/ValidationErrorResponse"
7486 }
7487 }
7488 }
7489 },
7490 "500" : {
7491 "description" : "Internal server error.",
7492 "headers" : {
7493 "X-RateLimit-Limit" : {
7494 "description" : "Request limit per minute.",
7495 "style" : "simple",
7496 "explode" : false,
7497 "schema" : {
7498 "type" : "integer",
7499 "format" : "int32"
7500 }
7501 },
7502 "X-RateLimit-Remaining" : {
7503 "description" : "The number of requests left for the time window.",
7504 "style" : "simple",
7505 "explode" : false,
7506 "schema" : {
7507 "type" : "integer",
7508 "format" : "int32"
7509 }
7510 },
7511 "X-RateLimit-Reset" : {
7512 "description" : "The timestamp at which the current rate limit window resets.",
7513 "style" : "simple",
7514 "explode" : false,
7515 "schema" : {
7516 "type" : "integer",
7517 "format" : "int32"
7518 }
7519 },
7520 "Retry-After" : {
7521 "description" : "How many seconds you have to wait before making new request.",
7522 "style" : "simple",
7523 "explode" : false,
7524 "schema" : {
7525 "type" : "integer",
7526 "format" : "int32"
7527 }
7528 }
7529 },
7530 "content" : {
7531 "application/json" : {
7532 "schema" : {
7533 "$ref" : "#/components/schemas/ServerErrorResponse"
7534 }
7535 }
7536 }
7537 }
7538 }
7539 },
7540 "put" : {
7541 "tags" : [ "Partner" ],
7542 "summary" : "Update a partner",
7543 "description" : "Update an existing partner. Returns a partner object if the update is succeded.",
7544 "operationId" : "UpdatePartner",
7545 "parameters" : [ {
7546 "name" : "id",
7547 "in" : "path",
7548 "required" : true,
7549 "style" : "simple",
7550 "explode" : false,
7551 "schema" : {
7552 "type" : "integer"
7553 }
7554 } ],
7555 "requestBody" : {
7556 "description" : "Partner object that you would like to update.",
7557 "content" : {
7558 "application/json" : {
7559 "schema" : {
7560 "$ref" : "#/components/schemas/PartnerUpsert"
7561 }
7562 }
7563 },
7564 "required" : true
7565 },
7566 "responses" : {
7567 "200" : {
7568 "description" : "Partner updated successfully.",
7569 "headers" : {
7570 "X-RateLimit-Limit" : {
7571 "description" : "Request limit per minute.",
7572 "style" : "simple",
7573 "explode" : false,
7574 "schema" : {
7575 "type" : "integer",
7576 "format" : "int32"
7577 }
7578 },
7579 "X-RateLimit-Remaining" : {
7580 "description" : "The number of requests left for the time window.",
7581 "style" : "simple",
7582 "explode" : false,
7583 "schema" : {
7584 "type" : "integer",
7585 "format" : "int32"
7586 }
7587 },
7588 "X-RateLimit-Reset" : {
7589 "description" : "The timestamp at which the current rate limit window resets.",
7590 "style" : "simple",
7591 "explode" : false,
7592 "schema" : {
7593 "type" : "integer",
7594 "format" : "int32"
7595 }
7596 },
7597 "Retry-After" : {
7598 "description" : "How many seconds you have to wait before making new request.",
7599 "style" : "simple",
7600 "explode" : false,
7601 "schema" : {
7602 "type" : "integer",
7603 "format" : "int32"
7604 }
7605 }
7606 },
7607 "content" : {
7608 "application/json" : {
7609 "schema" : {
7610 "$ref" : "#/components/schemas/Partner"
7611 }
7612 }
7613 }
7614 },
7615 "400" : {
7616 "description" : "The request is malformed.",
7617 "headers" : {
7618 "X-RateLimit-Limit" : {
7619 "description" : "Request limit per minute.",
7620 "style" : "simple",
7621 "explode" : false,
7622 "schema" : {
7623 "type" : "integer",
7624 "format" : "int32"
7625 }
7626 },
7627 "X-RateLimit-Remaining" : {
7628 "description" : "The number of requests left for the time window.",
7629 "style" : "simple",
7630 "explode" : false,
7631 "schema" : {
7632 "type" : "integer",
7633 "format" : "int32"
7634 }
7635 },
7636 "X-RateLimit-Reset" : {
7637 "description" : "The timestamp at which the current rate limit window resets.",
7638 "style" : "simple",
7639 "explode" : false,
7640 "schema" : {
7641 "type" : "integer",
7642 "format" : "int32"
7643 }
7644 },
7645 "Retry-After" : {
7646 "description" : "How many seconds you have to wait before making new request.",
7647 "style" : "simple",
7648 "explode" : false,
7649 "schema" : {
7650 "type" : "integer",
7651 "format" : "int32"
7652 }
7653 }
7654 },
7655 "content" : {
7656 "application/json" : {
7657 "schema" : {
7658 "$ref" : "#/components/schemas/ClientErrorResponse"
7659 }
7660 }
7661 }
7662 },
7663 "401" : {
7664 "description" : "Authorization information is missing or invalid.",
7665 "headers" : {
7666 "X-RateLimit-Limit" : {
7667 "description" : "Request limit per minute.",
7668 "style" : "simple",
7669 "explode" : false,
7670 "schema" : {
7671 "type" : "integer",
7672 "format" : "int32"
7673 }
7674 },
7675 "X-RateLimit-Remaining" : {
7676 "description" : "The number of requests left for the time window.",
7677 "style" : "simple",
7678 "explode" : false,
7679 "schema" : {
7680 "type" : "integer",
7681 "format" : "int32"
7682 }
7683 },
7684 "X-RateLimit-Reset" : {
7685 "description" : "The timestamp at which the current rate limit window resets.",
7686 "style" : "simple",
7687 "explode" : false,
7688 "schema" : {
7689 "type" : "integer",
7690 "format" : "int32"
7691 }
7692 },
7693 "Retry-After" : {
7694 "description" : "How many seconds you have to wait before making new request.",
7695 "style" : "simple",
7696 "explode" : false,
7697 "schema" : {
7698 "type" : "integer",
7699 "format" : "int32"
7700 }
7701 }
7702 },
7703 "content" : {
7704 "application/json" : {
7705 "schema" : {
7706 "$ref" : "#/components/schemas/ClientErrorResponse"
7707 }
7708 }
7709 }
7710 },
7711 "402" : {
7712 "description" : "Authenticated user doesn't have subscription.",
7713 "content" : {
7714 "application/json" : {
7715 "schema" : {
7716 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
7717 }
7718 }
7719 }
7720 },
7721 "403" : {
7722 "description" : "Authenticated user doesn't have access to the resource.",
7723 "headers" : {
7724 "X-RateLimit-Limit" : {
7725 "description" : "Request limit per minute.",
7726 "style" : "simple",
7727 "explode" : false,
7728 "schema" : {
7729 "type" : "integer",
7730 "format" : "int32"
7731 }
7732 },
7733 "X-RateLimit-Remaining" : {
7734 "description" : "The number of requests left for the time window.",
7735 "style" : "simple",
7736 "explode" : false,
7737 "schema" : {
7738 "type" : "integer",
7739 "format" : "int32"
7740 }
7741 },
7742 "X-RateLimit-Reset" : {
7743 "description" : "The timestamp at which the current rate limit window resets.",
7744 "style" : "simple",
7745 "explode" : false,
7746 "schema" : {
7747 "type" : "integer",
7748 "format" : "int32"
7749 }
7750 },
7751 "Retry-After" : {
7752 "description" : "How many seconds you have to wait before making new request.",
7753 "style" : "simple",
7754 "explode" : false,
7755 "schema" : {
7756 "type" : "integer",
7757 "format" : "int32"
7758 }
7759 }
7760 },
7761 "content" : {
7762 "application/json" : {
7763 "schema" : {
7764 "$ref" : "#/components/schemas/ClientErrorResponse"
7765 }
7766 }
7767 }
7768 },
7769 "404" : {
7770 "description" : "Non-existent resource is requested.",
7771 "headers" : {
7772 "X-RateLimit-Limit" : {
7773 "description" : "Request limit per minute.",
7774 "style" : "simple",
7775 "explode" : false,
7776 "schema" : {
7777 "type" : "integer",
7778 "format" : "int32"
7779 }
7780 },
7781 "X-RateLimit-Remaining" : {
7782 "description" : "The number of requests left for the time window.",
7783 "style" : "simple",
7784 "explode" : false,
7785 "schema" : {
7786 "type" : "integer",
7787 "format" : "int32"
7788 }
7789 },
7790 "X-RateLimit-Reset" : {
7791 "description" : "The timestamp at which the current rate limit window resets.",
7792 "style" : "simple",
7793 "explode" : false,
7794 "schema" : {
7795 "type" : "integer",
7796 "format" : "int32"
7797 }
7798 },
7799 "Retry-After" : {
7800 "description" : "How many seconds you have to wait before making new request.",
7801 "style" : "simple",
7802 "explode" : false,
7803 "schema" : {
7804 "type" : "integer",
7805 "format" : "int32"
7806 }
7807 }
7808 },
7809 "content" : {
7810 "application/json" : {
7811 "schema" : {
7812 "$ref" : "#/components/schemas/ClientErrorResponse"
7813 }
7814 }
7815 }
7816 },
7817 "422" : {
7818 "description" : "Validation errors occured.",
7819 "headers" : {
7820 "X-RateLimit-Limit" : {
7821 "description" : "Request limit per minute.",
7822 "style" : "simple",
7823 "explode" : false,
7824 "schema" : {
7825 "type" : "integer",
7826 "format" : "int32"
7827 }
7828 },
7829 "X-RateLimit-Remaining" : {
7830 "description" : "The number of requests left for the time window.",
7831 "style" : "simple",
7832 "explode" : false,
7833 "schema" : {
7834 "type" : "integer",
7835 "format" : "int32"
7836 }
7837 },
7838 "X-RateLimit-Reset" : {
7839 "description" : "The timestamp at which the current rate limit window resets.",
7840 "style" : "simple",
7841 "explode" : false,
7842 "schema" : {
7843 "type" : "integer",
7844 "format" : "int32"
7845 }
7846 },
7847 "Retry-After" : {
7848 "description" : "How many seconds you have to wait before making new request.",
7849 "style" : "simple",
7850 "explode" : false,
7851 "schema" : {
7852 "type" : "integer",
7853 "format" : "int32"
7854 }
7855 }
7856 },
7857 "content" : {
7858 "application/json" : {
7859 "schema" : {
7860 "$ref" : "#/components/schemas/ValidationErrorResponse"
7861 }
7862 }
7863 }
7864 },
7865 "500" : {
7866 "description" : "Internal server error.",
7867 "headers" : {
7868 "X-RateLimit-Limit" : {
7869 "description" : "Request limit per minute.",
7870 "style" : "simple",
7871 "explode" : false,
7872 "schema" : {
7873 "type" : "integer",
7874 "format" : "int32"
7875 }
7876 },
7877 "X-RateLimit-Remaining" : {
7878 "description" : "The number of requests left for the time window.",
7879 "style" : "simple",
7880 "explode" : false,
7881 "schema" : {
7882 "type" : "integer",
7883 "format" : "int32"
7884 }
7885 },
7886 "X-RateLimit-Reset" : {
7887 "description" : "The timestamp at which the current rate limit window resets.",
7888 "style" : "simple",
7889 "explode" : false,
7890 "schema" : {
7891 "type" : "integer",
7892 "format" : "int32"
7893 }
7894 },
7895 "Retry-After" : {
7896 "description" : "How many seconds you have to wait before making new request.",
7897 "style" : "simple",
7898 "explode" : false,
7899 "schema" : {
7900 "type" : "integer",
7901 "format" : "int32"
7902 }
7903 }
7904 },
7905 "content" : {
7906 "application/json" : {
7907 "schema" : {
7908 "$ref" : "#/components/schemas/ServerErrorResponse"
7909 }
7910 }
7911 }
7912 }
7913 }
7914 },
7915 "delete" : {
7916 "tags" : [ "Partner" ],
7917 "summary" : "Delete a partner",
7918 "description" : "Delete an existing partner.",
7919 "operationId" : "DeletePartner",
7920 "parameters" : [ {
7921 "name" : "id",
7922 "in" : "path",
7923 "required" : true,
7924 "style" : "simple",
7925 "explode" : false,
7926 "schema" : {
7927 "type" : "integer"
7928 }
7929 } ],
7930 "responses" : {
7931 "204" : {
7932 "description" : "Partner deleted successfully.",
7933 "headers" : {
7934 "X-RateLimit-Limit" : {
7935 "description" : "Request limit per minute.",
7936 "style" : "simple",
7937 "explode" : false,
7938 "schema" : {
7939 "type" : "integer",
7940 "format" : "int32"
7941 }
7942 },
7943 "X-RateLimit-Remaining" : {
7944 "description" : "The number of requests left for the time window.",
7945 "style" : "simple",
7946 "explode" : false,
7947 "schema" : {
7948 "type" : "integer",
7949 "format" : "int32"
7950 }
7951 },
7952 "X-RateLimit-Reset" : {
7953 "description" : "The timestamp at which the current rate limit window resets.",
7954 "style" : "simple",
7955 "explode" : false,
7956 "schema" : {
7957 "type" : "integer",
7958 "format" : "int32"
7959 }
7960 },
7961 "Retry-After" : {
7962 "description" : "How many seconds you have to wait before making new request.",
7963 "style" : "simple",
7964 "explode" : false,
7965 "schema" : {
7966 "type" : "integer",
7967 "format" : "int32"
7968 }
7969 }
7970 }
7971 },
7972 "400" : {
7973 "description" : "The request is malformed.",
7974 "headers" : {
7975 "X-RateLimit-Limit" : {
7976 "description" : "Request limit per minute.",
7977 "style" : "simple",
7978 "explode" : false,
7979 "schema" : {
7980 "type" : "integer",
7981 "format" : "int32"
7982 }
7983 },
7984 "X-RateLimit-Remaining" : {
7985 "description" : "The number of requests left for the time window.",
7986 "style" : "simple",
7987 "explode" : false,
7988 "schema" : {
7989 "type" : "integer",
7990 "format" : "int32"
7991 }
7992 },
7993 "X-RateLimit-Reset" : {
7994 "description" : "The timestamp at which the current rate limit window resets.",
7995 "style" : "simple",
7996 "explode" : false,
7997 "schema" : {
7998 "type" : "integer",
7999 "format" : "int32"
8000 }
8001 },
8002 "Retry-After" : {
8003 "description" : "How many seconds you have to wait before making new request.",
8004 "style" : "simple",
8005 "explode" : false,
8006 "schema" : {
8007 "type" : "integer",
8008 "format" : "int32"
8009 }
8010 }
8011 },
8012 "content" : {
8013 "application/json" : {
8014 "schema" : {
8015 "$ref" : "#/components/schemas/ClientErrorResponse"
8016 }
8017 }
8018 }
8019 },
8020 "401" : {
8021 "description" : "Authorization information is missing or invalid.",
8022 "headers" : {
8023 "X-RateLimit-Limit" : {
8024 "description" : "Request limit per minute.",
8025 "style" : "simple",
8026 "explode" : false,
8027 "schema" : {
8028 "type" : "integer",
8029 "format" : "int32"
8030 }
8031 },
8032 "X-RateLimit-Remaining" : {
8033 "description" : "The number of requests left for the time window.",
8034 "style" : "simple",
8035 "explode" : false,
8036 "schema" : {
8037 "type" : "integer",
8038 "format" : "int32"
8039 }
8040 },
8041 "X-RateLimit-Reset" : {
8042 "description" : "The timestamp at which the current rate limit window resets.",
8043 "style" : "simple",
8044 "explode" : false,
8045 "schema" : {
8046 "type" : "integer",
8047 "format" : "int32"
8048 }
8049 },
8050 "Retry-After" : {
8051 "description" : "How many seconds you have to wait before making new request.",
8052 "style" : "simple",
8053 "explode" : false,
8054 "schema" : {
8055 "type" : "integer",
8056 "format" : "int32"
8057 }
8058 }
8059 },
8060 "content" : {
8061 "application/json" : {
8062 "schema" : {
8063 "$ref" : "#/components/schemas/ClientErrorResponse"
8064 }
8065 }
8066 }
8067 },
8068 "402" : {
8069 "description" : "Authenticated user doesn't have subscription.",
8070 "content" : {
8071 "application/json" : {
8072 "schema" : {
8073 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
8074 }
8075 }
8076 }
8077 },
8078 "403" : {
8079 "description" : "Authenticated user doesn't have access to the resource.",
8080 "headers" : {
8081 "X-RateLimit-Limit" : {
8082 "description" : "Request limit per minute.",
8083 "style" : "simple",
8084 "explode" : false,
8085 "schema" : {
8086 "type" : "integer",
8087 "format" : "int32"
8088 }
8089 },
8090 "X-RateLimit-Remaining" : {
8091 "description" : "The number of requests left for the time window.",
8092 "style" : "simple",
8093 "explode" : false,
8094 "schema" : {
8095 "type" : "integer",
8096 "format" : "int32"
8097 }
8098 },
8099 "X-RateLimit-Reset" : {
8100 "description" : "The timestamp at which the current rate limit window resets.",
8101 "style" : "simple",
8102 "explode" : false,
8103 "schema" : {
8104 "type" : "integer",
8105 "format" : "int32"
8106 }
8107 },
8108 "Retry-After" : {
8109 "description" : "How many seconds you have to wait before making new request.",
8110 "style" : "simple",
8111 "explode" : false,
8112 "schema" : {
8113 "type" : "integer",
8114 "format" : "int32"
8115 }
8116 }
8117 },
8118 "content" : {
8119 "application/json" : {
8120 "schema" : {
8121 "$ref" : "#/components/schemas/ClientErrorResponse"
8122 }
8123 }
8124 }
8125 },
8126 "404" : {
8127 "description" : "Non-existent resource is requested.",
8128 "headers" : {
8129 "X-RateLimit-Limit" : {
8130 "description" : "Request limit per minute.",
8131 "style" : "simple",
8132 "explode" : false,
8133 "schema" : {
8134 "type" : "integer",
8135 "format" : "int32"
8136 }
8137 },
8138 "X-RateLimit-Remaining" : {
8139 "description" : "The number of requests left for the time window.",
8140 "style" : "simple",
8141 "explode" : false,
8142 "schema" : {
8143 "type" : "integer",
8144 "format" : "int32"
8145 }
8146 },
8147 "X-RateLimit-Reset" : {
8148 "description" : "The timestamp at which the current rate limit window resets.",
8149 "style" : "simple",
8150 "explode" : false,
8151 "schema" : {
8152 "type" : "integer",
8153 "format" : "int32"
8154 }
8155 },
8156 "Retry-After" : {
8157 "description" : "How many seconds you have to wait before making new request.",
8158 "style" : "simple",
8159 "explode" : false,
8160 "schema" : {
8161 "type" : "integer",
8162 "format" : "int32"
8163 }
8164 }
8165 },
8166 "content" : {
8167 "application/json" : {
8168 "schema" : {
8169 "$ref" : "#/components/schemas/ClientErrorResponse"
8170 }
8171 }
8172 }
8173 },
8174 "500" : {
8175 "description" : "Internal server error.",
8176 "headers" : {
8177 "X-RateLimit-Limit" : {
8178 "description" : "Request limit per minute.",
8179 "style" : "simple",
8180 "explode" : false,
8181 "schema" : {
8182 "type" : "integer",
8183 "format" : "int32"
8184 }
8185 },
8186 "X-RateLimit-Remaining" : {
8187 "description" : "The number of requests left for the time window.",
8188 "style" : "simple",
8189 "explode" : false,
8190 "schema" : {
8191 "type" : "integer",
8192 "format" : "int32"
8193 }
8194 },
8195 "X-RateLimit-Reset" : {
8196 "description" : "The timestamp at which the current rate limit window resets.",
8197 "style" : "simple",
8198 "explode" : false,
8199 "schema" : {
8200 "type" : "integer",
8201 "format" : "int32"
8202 }
8203 },
8204 "Retry-After" : {
8205 "description" : "How many seconds you have to wait before making new request.",
8206 "style" : "simple",
8207 "explode" : false,
8208 "schema" : {
8209 "type" : "integer",
8210 "format" : "int32"
8211 }
8212 }
8213 },
8214 "content" : {
8215 "application/json" : {
8216 "schema" : {
8217 "$ref" : "#/components/schemas/ServerErrorResponse"
8218 }
8219 }
8220 }
8221 }
8222 }
8223 }
8224 },
8225 "/products" : {
8226 "get" : {
8227 "tags" : [ "Product" ],
8228 "summary" : "List all product",
8229 "description" : "Returns a list of your products. The partners are returned sorted by creation date, with the most recent partners appearing first.",
8230 "operationId" : "ListProduct",
8231 "parameters" : [ {
8232 "name" : "page",
8233 "in" : "query",
8234 "required" : false,
8235 "style" : "form",
8236 "explode" : true,
8237 "schema" : {
8238 "type" : "integer"
8239 }
8240 }, {
8241 "name" : "per_page",
8242 "in" : "query",
8243 "required" : false,
8244 "style" : "form",
8245 "explode" : true,
8246 "schema" : {
8247 "maximum" : 100,
8248 "minimum" : 1,
8249 "type" : "integer",
8250 "default" : 25
8251 }
8252 } ],
8253 "responses" : {
8254 "200" : {
8255 "description" : "Success response",
8256 "headers" : {
8257 "X-RateLimit-Limit" : {
8258 "description" : "Request limit per minute.",
8259 "style" : "simple",
8260 "explode" : false,
8261 "schema" : {
8262 "type" : "integer",
8263 "format" : "int32"
8264 }
8265 },
8266 "X-RateLimit-Remaining" : {
8267 "description" : "The number of requests left for the time window.",
8268 "style" : "simple",
8269 "explode" : false,
8270 "schema" : {
8271 "type" : "integer",
8272 "format" : "int32"
8273 }
8274 },
8275 "X-RateLimit-Reset" : {
8276 "description" : "The timestamp at which the current rate limit window resets.",
8277 "style" : "simple",
8278 "explode" : false,
8279 "schema" : {
8280 "type" : "integer",
8281 "format" : "int32"
8282 }
8283 },
8284 "Retry-After" : {
8285 "description" : "How many seconds you have to wait before making new request.",
8286 "style" : "simple",
8287 "explode" : false,
8288 "schema" : {
8289 "type" : "integer",
8290 "format" : "int32"
8291 }
8292 }
8293 },
8294 "content" : {
8295 "application/json" : {
8296 "schema" : {
8297 "$ref" : "#/components/schemas/ProductList"
8298 }
8299 }
8300 }
8301 },
8302 "400" : {
8303 "description" : "The request is malformed.",
8304 "headers" : {
8305 "X-RateLimit-Limit" : {
8306 "description" : "Request limit per minute.",
8307 "style" : "simple",
8308 "explode" : false,
8309 "schema" : {
8310 "type" : "integer",
8311 "format" : "int32"
8312 }
8313 },
8314 "X-RateLimit-Remaining" : {
8315 "description" : "The number of requests left for the time window.",
8316 "style" : "simple",
8317 "explode" : false,
8318 "schema" : {
8319 "type" : "integer",
8320 "format" : "int32"
8321 }
8322 },
8323 "X-RateLimit-Reset" : {
8324 "description" : "The timestamp at which the current rate limit window resets.",
8325 "style" : "simple",
8326 "explode" : false,
8327 "schema" : {
8328 "type" : "integer",
8329 "format" : "int32"
8330 }
8331 },
8332 "Retry-After" : {
8333 "description" : "How many seconds you have to wait before making new request.",
8334 "style" : "simple",
8335 "explode" : false,
8336 "schema" : {
8337 "type" : "integer",
8338 "format" : "int32"
8339 }
8340 }
8341 },
8342 "content" : {
8343 "application/json" : {
8344 "schema" : {
8345 "$ref" : "#/components/schemas/ClientErrorResponse"
8346 }
8347 }
8348 }
8349 },
8350 "401" : {
8351 "description" : "Authorization information is missing or invalid.",
8352 "headers" : {
8353 "X-RateLimit-Limit" : {
8354 "description" : "Request limit per minute.",
8355 "style" : "simple",
8356 "explode" : false,
8357 "schema" : {
8358 "type" : "integer",
8359 "format" : "int32"
8360 }
8361 },
8362 "X-RateLimit-Remaining" : {
8363 "description" : "The number of requests left for the time window.",
8364 "style" : "simple",
8365 "explode" : false,
8366 "schema" : {
8367 "type" : "integer",
8368 "format" : "int32"
8369 }
8370 },
8371 "X-RateLimit-Reset" : {
8372 "description" : "The timestamp at which the current rate limit window resets.",
8373 "style" : "simple",
8374 "explode" : false,
8375 "schema" : {
8376 "type" : "integer",
8377 "format" : "int32"
8378 }
8379 },
8380 "Retry-After" : {
8381 "description" : "How many seconds you have to wait before making new request.",
8382 "style" : "simple",
8383 "explode" : false,
8384 "schema" : {
8385 "type" : "integer",
8386 "format" : "int32"
8387 }
8388 }
8389 },
8390 "content" : {
8391 "application/json" : {
8392 "schema" : {
8393 "$ref" : "#/components/schemas/ClientErrorResponse"
8394 }
8395 }
8396 }
8397 },
8398 "402" : {
8399 "description" : "Authenticated user doesn't have subscription.",
8400 "content" : {
8401 "application/json" : {
8402 "schema" : {
8403 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
8404 }
8405 }
8406 }
8407 },
8408 "422" : {
8409 "description" : "Validation errors occured.",
8410 "headers" : {
8411 "X-RateLimit-Limit" : {
8412 "description" : "Request limit per minute.",
8413 "style" : "simple",
8414 "explode" : false,
8415 "schema" : {
8416 "type" : "integer",
8417 "format" : "int32"
8418 }
8419 },
8420 "X-RateLimit-Remaining" : {
8421 "description" : "The number of requests left for the time window.",
8422 "style" : "simple",
8423 "explode" : false,
8424 "schema" : {
8425 "type" : "integer",
8426 "format" : "int32"
8427 }
8428 },
8429 "X-RateLimit-Reset" : {
8430 "description" : "The timestamp at which the current rate limit window resets.",
8431 "style" : "simple",
8432 "explode" : false,
8433 "schema" : {
8434 "type" : "integer",
8435 "format" : "int32"
8436 }
8437 },
8438 "Retry-After" : {
8439 "description" : "How many seconds you have to wait before making new request.",
8440 "style" : "simple",
8441 "explode" : false,
8442 "schema" : {
8443 "type" : "integer",
8444 "format" : "int32"
8445 }
8446 }
8447 },
8448 "content" : {
8449 "application/json" : {
8450 "schema" : {
8451 "$ref" : "#/components/schemas/ValidationErrorResponse"
8452 }
8453 }
8454 }
8455 },
8456 "500" : {
8457 "description" : "Internal server error.",
8458 "headers" : {
8459 "X-RateLimit-Limit" : {
8460 "description" : "Request limit per minute.",
8461 "style" : "simple",
8462 "explode" : false,
8463 "schema" : {
8464 "type" : "integer",
8465 "format" : "int32"
8466 }
8467 },
8468 "X-RateLimit-Remaining" : {
8469 "description" : "The number of requests left for the time window.",
8470 "style" : "simple",
8471 "explode" : false,
8472 "schema" : {
8473 "type" : "integer",
8474 "format" : "int32"
8475 }
8476 },
8477 "X-RateLimit-Reset" : {
8478 "description" : "The timestamp at which the current rate limit window resets.",
8479 "style" : "simple",
8480 "explode" : false,
8481 "schema" : {
8482 "type" : "integer",
8483 "format" : "int32"
8484 }
8485 },
8486 "Retry-After" : {
8487 "description" : "How many seconds you have to wait before making new request.",
8488 "style" : "simple",
8489 "explode" : false,
8490 "schema" : {
8491 "type" : "integer",
8492 "format" : "int32"
8493 }
8494 }
8495 },
8496 "content" : {
8497 "application/json" : {
8498 "schema" : {
8499 "$ref" : "#/components/schemas/ServerErrorResponse"
8500 }
8501 }
8502 }
8503 }
8504 }
8505 },
8506 "post" : {
8507 "tags" : [ "Product" ],
8508 "summary" : "Create a product",
8509 "description" : "Create a new product. Returns a product object if the create is succeded.",
8510 "operationId" : "CreateProduct",
8511 "requestBody" : {
8512 "description" : "Product object that you would like to store.",
8513 "content" : {
8514 "application/json" : {
8515 "schema" : {
8516 "$ref" : "#/components/schemas/Product"
8517 }
8518 }
8519 },
8520 "required" : true
8521 },
8522 "responses" : {
8523 "201" : {
8524 "description" : "Product created successfully.",
8525 "headers" : {
8526 "X-RateLimit-Limit" : {
8527 "description" : "Request limit per minute.",
8528 "style" : "simple",
8529 "explode" : false,
8530 "schema" : {
8531 "type" : "integer",
8532 "format" : "int32"
8533 }
8534 },
8535 "X-RateLimit-Remaining" : {
8536 "description" : "The number of requests left for the time window.",
8537 "style" : "simple",
8538 "explode" : false,
8539 "schema" : {
8540 "type" : "integer",
8541 "format" : "int32"
8542 }
8543 },
8544 "X-RateLimit-Reset" : {
8545 "description" : "The timestamp at which the current rate limit window resets.",
8546 "style" : "simple",
8547 "explode" : false,
8548 "schema" : {
8549 "type" : "integer",
8550 "format" : "int32"
8551 }
8552 },
8553 "Retry-After" : {
8554 "description" : "How many seconds you have to wait before making new request.",
8555 "style" : "simple",
8556 "explode" : false,
8557 "schema" : {
8558 "type" : "integer",
8559 "format" : "int32"
8560 }
8561 }
8562 },
8563 "content" : {
8564 "application/json" : {
8565 "schema" : {
8566 "$ref" : "#/components/schemas/Product"
8567 }
8568 }
8569 }
8570 },
8571 "400" : {
8572 "description" : "The request is malformed.",
8573 "headers" : {
8574 "X-RateLimit-Limit" : {
8575 "description" : "Request limit per minute.",
8576 "style" : "simple",
8577 "explode" : false,
8578 "schema" : {
8579 "type" : "integer",
8580 "format" : "int32"
8581 }
8582 },
8583 "X-RateLimit-Remaining" : {
8584 "description" : "The number of requests left for the time window.",
8585 "style" : "simple",
8586 "explode" : false,
8587 "schema" : {
8588 "type" : "integer",
8589 "format" : "int32"
8590 }
8591 },
8592 "X-RateLimit-Reset" : {
8593 "description" : "The timestamp at which the current rate limit window resets.",
8594 "style" : "simple",
8595 "explode" : false,
8596 "schema" : {
8597 "type" : "integer",
8598 "format" : "int32"
8599 }
8600 },
8601 "Retry-After" : {
8602 "description" : "How many seconds you have to wait before making new request.",
8603 "style" : "simple",
8604 "explode" : false,
8605 "schema" : {
8606 "type" : "integer",
8607 "format" : "int32"
8608 }
8609 }
8610 },
8611 "content" : {
8612 "application/json" : {
8613 "schema" : {
8614 "$ref" : "#/components/schemas/ClientErrorResponse"
8615 }
8616 }
8617 }
8618 },
8619 "401" : {
8620 "description" : "Authorization information is missing or invalid.",
8621 "headers" : {
8622 "X-RateLimit-Limit" : {
8623 "description" : "Request limit per minute.",
8624 "style" : "simple",
8625 "explode" : false,
8626 "schema" : {
8627 "type" : "integer",
8628 "format" : "int32"
8629 }
8630 },
8631 "X-RateLimit-Remaining" : {
8632 "description" : "The number of requests left for the time window.",
8633 "style" : "simple",
8634 "explode" : false,
8635 "schema" : {
8636 "type" : "integer",
8637 "format" : "int32"
8638 }
8639 },
8640 "X-RateLimit-Reset" : {
8641 "description" : "The timestamp at which the current rate limit window resets.",
8642 "style" : "simple",
8643 "explode" : false,
8644 "schema" : {
8645 "type" : "integer",
8646 "format" : "int32"
8647 }
8648 },
8649 "Retry-After" : {
8650 "description" : "How many seconds you have to wait before making new request.",
8651 "style" : "simple",
8652 "explode" : false,
8653 "schema" : {
8654 "type" : "integer",
8655 "format" : "int32"
8656 }
8657 }
8658 },
8659 "content" : {
8660 "application/json" : {
8661 "schema" : {
8662 "$ref" : "#/components/schemas/ClientErrorResponse"
8663 }
8664 }
8665 }
8666 },
8667 "402" : {
8668 "description" : "Authenticated user doesn't have subscription.",
8669 "content" : {
8670 "application/json" : {
8671 "schema" : {
8672 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
8673 }
8674 }
8675 }
8676 },
8677 "403" : {
8678 "description" : "Authenticated user doesn't have access to the resource.",
8679 "headers" : {
8680 "X-RateLimit-Limit" : {
8681 "description" : "Request limit per minute.",
8682 "style" : "simple",
8683 "explode" : false,
8684 "schema" : {
8685 "type" : "integer",
8686 "format" : "int32"
8687 }
8688 },
8689 "X-RateLimit-Remaining" : {
8690 "description" : "The number of requests left for the time window.",
8691 "style" : "simple",
8692 "explode" : false,
8693 "schema" : {
8694 "type" : "integer",
8695 "format" : "int32"
8696 }
8697 },
8698 "X-RateLimit-Reset" : {
8699 "description" : "The timestamp at which the current rate limit window resets.",
8700 "style" : "simple",
8701 "explode" : false,
8702 "schema" : {
8703 "type" : "integer",
8704 "format" : "int32"
8705 }
8706 },
8707 "Retry-After" : {
8708 "description" : "How many seconds you have to wait before making new request.",
8709 "style" : "simple",
8710 "explode" : false,
8711 "schema" : {
8712 "type" : "integer",
8713 "format" : "int32"
8714 }
8715 }
8716 },
8717 "content" : {
8718 "application/json" : {
8719 "schema" : {
8720 "$ref" : "#/components/schemas/ClientErrorResponse"
8721 }
8722 }
8723 }
8724 },
8725 "422" : {
8726 "description" : "Validation errors occured.",
8727 "headers" : {
8728 "X-RateLimit-Limit" : {
8729 "description" : "Request limit per minute.",
8730 "style" : "simple",
8731 "explode" : false,
8732 "schema" : {
8733 "type" : "integer",
8734 "format" : "int32"
8735 }
8736 },
8737 "X-RateLimit-Remaining" : {
8738 "description" : "The number of requests left for the time window.",
8739 "style" : "simple",
8740 "explode" : false,
8741 "schema" : {
8742 "type" : "integer",
8743 "format" : "int32"
8744 }
8745 },
8746 "X-RateLimit-Reset" : {
8747 "description" : "The timestamp at which the current rate limit window resets.",
8748 "style" : "simple",
8749 "explode" : false,
8750 "schema" : {
8751 "type" : "integer",
8752 "format" : "int32"
8753 }
8754 },
8755 "Retry-After" : {
8756 "description" : "How many seconds you have to wait before making new request.",
8757 "style" : "simple",
8758 "explode" : false,
8759 "schema" : {
8760 "type" : "integer",
8761 "format" : "int32"
8762 }
8763 }
8764 },
8765 "content" : {
8766 "application/json" : {
8767 "schema" : {
8768 "$ref" : "#/components/schemas/ValidationErrorResponse"
8769 }
8770 }
8771 }
8772 },
8773 "500" : {
8774 "description" : "Internal server error.",
8775 "headers" : {
8776 "X-RateLimit-Limit" : {
8777 "description" : "Request limit per minute.",
8778 "style" : "simple",
8779 "explode" : false,
8780 "schema" : {
8781 "type" : "integer",
8782 "format" : "int32"
8783 }
8784 },
8785 "X-RateLimit-Remaining" : {
8786 "description" : "The number of requests left for the time window.",
8787 "style" : "simple",
8788 "explode" : false,
8789 "schema" : {
8790 "type" : "integer",
8791 "format" : "int32"
8792 }
8793 },
8794 "X-RateLimit-Reset" : {
8795 "description" : "The timestamp at which the current rate limit window resets.",
8796 "style" : "simple",
8797 "explode" : false,
8798 "schema" : {
8799 "type" : "integer",
8800 "format" : "int32"
8801 }
8802 },
8803 "Retry-After" : {
8804 "description" : "How many seconds you have to wait before making new request.",
8805 "style" : "simple",
8806 "explode" : false,
8807 "schema" : {
8808 "type" : "integer",
8809 "format" : "int32"
8810 }
8811 }
8812 },
8813 "content" : {
8814 "application/json" : {
8815 "schema" : {
8816 "$ref" : "#/components/schemas/ServerErrorResponse"
8817 }
8818 }
8819 }
8820 }
8821 }
8822 }
8823 },
8824 "/products/{id}" : {
8825 "get" : {
8826 "tags" : [ "Product" ],
8827 "summary" : "Retrieve a product",
8828 "description" : "Retrieves the details of an existing product.",
8829 "operationId" : "GetProduct",
8830 "parameters" : [ {
8831 "name" : "id",
8832 "in" : "path",
8833 "required" : true,
8834 "style" : "simple",
8835 "explode" : false,
8836 "schema" : {
8837 "type" : "integer"
8838 }
8839 } ],
8840 "responses" : {
8841 "200" : {
8842 "description" : "Success response",
8843 "headers" : {
8844 "X-RateLimit-Limit" : {
8845 "description" : "Request limit per minute.",
8846 "style" : "simple",
8847 "explode" : false,
8848 "schema" : {
8849 "type" : "integer",
8850 "format" : "int32"
8851 }
8852 },
8853 "X-RateLimit-Remaining" : {
8854 "description" : "The number of requests left for the time window.",
8855 "style" : "simple",
8856 "explode" : false,
8857 "schema" : {
8858 "type" : "integer",
8859 "format" : "int32"
8860 }
8861 },
8862 "X-RateLimit-Reset" : {
8863 "description" : "The timestamp at which the current rate limit window resets.",
8864 "style" : "simple",
8865 "explode" : false,
8866 "schema" : {
8867 "type" : "integer",
8868 "format" : "int32"
8869 }
8870 },
8871 "Retry-After" : {
8872 "description" : "How many seconds you have to wait before making new request.",
8873 "style" : "simple",
8874 "explode" : false,
8875 "schema" : {
8876 "type" : "integer",
8877 "format" : "int32"
8878 }
8879 }
8880 },
8881 "content" : {
8882 "application/json" : {
8883 "schema" : {
8884 "$ref" : "#/components/schemas/Product"
8885 }
8886 }
8887 }
8888 },
8889 "400" : {
8890 "description" : "The request is malformed.",
8891 "headers" : {
8892 "X-RateLimit-Limit" : {
8893 "description" : "Request limit per minute.",
8894 "style" : "simple",
8895 "explode" : false,
8896 "schema" : {
8897 "type" : "integer",
8898 "format" : "int32"
8899 }
8900 },
8901 "X-RateLimit-Remaining" : {
8902 "description" : "The number of requests left for the time window.",
8903 "style" : "simple",
8904 "explode" : false,
8905 "schema" : {
8906 "type" : "integer",
8907 "format" : "int32"
8908 }
8909 },
8910 "X-RateLimit-Reset" : {
8911 "description" : "The timestamp at which the current rate limit window resets.",
8912 "style" : "simple",
8913 "explode" : false,
8914 "schema" : {
8915 "type" : "integer",
8916 "format" : "int32"
8917 }
8918 },
8919 "Retry-After" : {
8920 "description" : "How many seconds you have to wait before making new request.",
8921 "style" : "simple",
8922 "explode" : false,
8923 "schema" : {
8924 "type" : "integer",
8925 "format" : "int32"
8926 }
8927 }
8928 },
8929 "content" : {
8930 "application/json" : {
8931 "schema" : {
8932 "$ref" : "#/components/schemas/ClientErrorResponse"
8933 }
8934 }
8935 }
8936 },
8937 "401" : {
8938 "description" : "Authorization information is missing or invalid.",
8939 "headers" : {
8940 "X-RateLimit-Limit" : {
8941 "description" : "Request limit per minute.",
8942 "style" : "simple",
8943 "explode" : false,
8944 "schema" : {
8945 "type" : "integer",
8946 "format" : "int32"
8947 }
8948 },
8949 "X-RateLimit-Remaining" : {
8950 "description" : "The number of requests left for the time window.",
8951 "style" : "simple",
8952 "explode" : false,
8953 "schema" : {
8954 "type" : "integer",
8955 "format" : "int32"
8956 }
8957 },
8958 "X-RateLimit-Reset" : {
8959 "description" : "The timestamp at which the current rate limit window resets.",
8960 "style" : "simple",
8961 "explode" : false,
8962 "schema" : {
8963 "type" : "integer",
8964 "format" : "int32"
8965 }
8966 },
8967 "Retry-After" : {
8968 "description" : "How many seconds you have to wait before making new request.",
8969 "style" : "simple",
8970 "explode" : false,
8971 "schema" : {
8972 "type" : "integer",
8973 "format" : "int32"
8974 }
8975 }
8976 },
8977 "content" : {
8978 "application/json" : {
8979 "schema" : {
8980 "$ref" : "#/components/schemas/ClientErrorResponse"
8981 }
8982 }
8983 }
8984 },
8985 "402" : {
8986 "description" : "Authenticated user doesn't have subscription.",
8987 "content" : {
8988 "application/json" : {
8989 "schema" : {
8990 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
8991 }
8992 }
8993 }
8994 },
8995 "404" : {
8996 "description" : "Non-existent resource is requested.",
8997 "headers" : {
8998 "X-RateLimit-Limit" : {
8999 "description" : "Request limit per minute.",
9000 "style" : "simple",
9001 "explode" : false,
9002 "schema" : {
9003 "type" : "integer",
9004 "format" : "int32"
9005 }
9006 },
9007 "X-RateLimit-Remaining" : {
9008 "description" : "The number of requests left for the time window.",
9009 "style" : "simple",
9010 "explode" : false,
9011 "schema" : {
9012 "type" : "integer",
9013 "format" : "int32"
9014 }
9015 },
9016 "X-RateLimit-Reset" : {
9017 "description" : "The timestamp at which the current rate limit window resets.",
9018 "style" : "simple",
9019 "explode" : false,
9020 "schema" : {
9021 "type" : "integer",
9022 "format" : "int32"
9023 }
9024 },
9025 "Retry-After" : {
9026 "description" : "How many seconds you have to wait before making new request.",
9027 "style" : "simple",
9028 "explode" : false,
9029 "schema" : {
9030 "type" : "integer",
9031 "format" : "int32"
9032 }
9033 }
9034 },
9035 "content" : {
9036 "application/json" : {
9037 "schema" : {
9038 "$ref" : "#/components/schemas/ClientErrorResponse"
9039 }
9040 }
9041 }
9042 },
9043 "422" : {
9044 "description" : "Validation errors occured.",
9045 "headers" : {
9046 "X-RateLimit-Limit" : {
9047 "description" : "Request limit per minute.",
9048 "style" : "simple",
9049 "explode" : false,
9050 "schema" : {
9051 "type" : "integer",
9052 "format" : "int32"
9053 }
9054 },
9055 "X-RateLimit-Remaining" : {
9056 "description" : "The number of requests left for the time window.",
9057 "style" : "simple",
9058 "explode" : false,
9059 "schema" : {
9060 "type" : "integer",
9061 "format" : "int32"
9062 }
9063 },
9064 "X-RateLimit-Reset" : {
9065 "description" : "The timestamp at which the current rate limit window resets.",
9066 "style" : "simple",
9067 "explode" : false,
9068 "schema" : {
9069 "type" : "integer",
9070 "format" : "int32"
9071 }
9072 },
9073 "Retry-After" : {
9074 "description" : "How many seconds you have to wait before making new request.",
9075 "style" : "simple",
9076 "explode" : false,
9077 "schema" : {
9078 "type" : "integer",
9079 "format" : "int32"
9080 }
9081 }
9082 },
9083 "content" : {
9084 "application/json" : {
9085 "schema" : {
9086 "$ref" : "#/components/schemas/ValidationErrorResponse"
9087 }
9088 }
9089 }
9090 },
9091 "500" : {
9092 "description" : "Internal server error.",
9093 "headers" : {
9094 "X-RateLimit-Limit" : {
9095 "description" : "Request limit per minute.",
9096 "style" : "simple",
9097 "explode" : false,
9098 "schema" : {
9099 "type" : "integer",
9100 "format" : "int32"
9101 }
9102 },
9103 "X-RateLimit-Remaining" : {
9104 "description" : "The number of requests left for the time window.",
9105 "style" : "simple",
9106 "explode" : false,
9107 "schema" : {
9108 "type" : "integer",
9109 "format" : "int32"
9110 }
9111 },
9112 "X-RateLimit-Reset" : {
9113 "description" : "The timestamp at which the current rate limit window resets.",
9114 "style" : "simple",
9115 "explode" : false,
9116 "schema" : {
9117 "type" : "integer",
9118 "format" : "int32"
9119 }
9120 },
9121 "Retry-After" : {
9122 "description" : "How many seconds you have to wait before making new request.",
9123 "style" : "simple",
9124 "explode" : false,
9125 "schema" : {
9126 "type" : "integer",
9127 "format" : "int32"
9128 }
9129 }
9130 },
9131 "content" : {
9132 "application/json" : {
9133 "schema" : {
9134 "$ref" : "#/components/schemas/ServerErrorResponse"
9135 }
9136 }
9137 }
9138 }
9139 }
9140 },
9141 "put" : {
9142 "tags" : [ "Product" ],
9143 "summary" : "Update a product",
9144 "description" : "Update an existing product. Returns a product object if the update is succeded.",
9145 "operationId" : "UpdateProduct",
9146 "parameters" : [ {
9147 "name" : "id",
9148 "in" : "path",
9149 "required" : true,
9150 "style" : "simple",
9151 "explode" : false,
9152 "schema" : {
9153 "type" : "integer"
9154 }
9155 } ],
9156 "requestBody" : {
9157 "description" : "Product object that you would like to update.",
9158 "content" : {
9159 "application/json" : {
9160 "schema" : {
9161 "$ref" : "#/components/schemas/Product"
9162 }
9163 }
9164 },
9165 "required" : true
9166 },
9167 "responses" : {
9168 "200" : {
9169 "description" : "Product updated successfully.",
9170 "headers" : {
9171 "X-RateLimit-Limit" : {
9172 "description" : "Request limit per minute.",
9173 "style" : "simple",
9174 "explode" : false,
9175 "schema" : {
9176 "type" : "integer",
9177 "format" : "int32"
9178 }
9179 },
9180 "X-RateLimit-Remaining" : {
9181 "description" : "The number of requests left for the time window.",
9182 "style" : "simple",
9183 "explode" : false,
9184 "schema" : {
9185 "type" : "integer",
9186 "format" : "int32"
9187 }
9188 },
9189 "X-RateLimit-Reset" : {
9190 "description" : "The timestamp at which the current rate limit window resets.",
9191 "style" : "simple",
9192 "explode" : false,
9193 "schema" : {
9194 "type" : "integer",
9195 "format" : "int32"
9196 }
9197 },
9198 "Retry-After" : {
9199 "description" : "How many seconds you have to wait before making new request.",
9200 "style" : "simple",
9201 "explode" : false,
9202 "schema" : {
9203 "type" : "integer",
9204 "format" : "int32"
9205 }
9206 }
9207 },
9208 "content" : {
9209 "application/json" : {
9210 "schema" : {
9211 "$ref" : "#/components/schemas/Product"
9212 }
9213 }
9214 }
9215 },
9216 "400" : {
9217 "description" : "The request is malformed.",
9218 "headers" : {
9219 "X-RateLimit-Limit" : {
9220 "description" : "Request limit per minute.",
9221 "style" : "simple",
9222 "explode" : false,
9223 "schema" : {
9224 "type" : "integer",
9225 "format" : "int32"
9226 }
9227 },
9228 "X-RateLimit-Remaining" : {
9229 "description" : "The number of requests left for the time window.",
9230 "style" : "simple",
9231 "explode" : false,
9232 "schema" : {
9233 "type" : "integer",
9234 "format" : "int32"
9235 }
9236 },
9237 "X-RateLimit-Reset" : {
9238 "description" : "The timestamp at which the current rate limit window resets.",
9239 "style" : "simple",
9240 "explode" : false,
9241 "schema" : {
9242 "type" : "integer",
9243 "format" : "int32"
9244 }
9245 },
9246 "Retry-After" : {
9247 "description" : "How many seconds you have to wait before making new request.",
9248 "style" : "simple",
9249 "explode" : false,
9250 "schema" : {
9251 "type" : "integer",
9252 "format" : "int32"
9253 }
9254 }
9255 },
9256 "content" : {
9257 "application/json" : {
9258 "schema" : {
9259 "$ref" : "#/components/schemas/ClientErrorResponse"
9260 }
9261 }
9262 }
9263 },
9264 "401" : {
9265 "description" : "Authorization information is missing or invalid.",
9266 "headers" : {
9267 "X-RateLimit-Limit" : {
9268 "description" : "Request limit per minute.",
9269 "style" : "simple",
9270 "explode" : false,
9271 "schema" : {
9272 "type" : "integer",
9273 "format" : "int32"
9274 }
9275 },
9276 "X-RateLimit-Remaining" : {
9277 "description" : "The number of requests left for the time window.",
9278 "style" : "simple",
9279 "explode" : false,
9280 "schema" : {
9281 "type" : "integer",
9282 "format" : "int32"
9283 }
9284 },
9285 "X-RateLimit-Reset" : {
9286 "description" : "The timestamp at which the current rate limit window resets.",
9287 "style" : "simple",
9288 "explode" : false,
9289 "schema" : {
9290 "type" : "integer",
9291 "format" : "int32"
9292 }
9293 },
9294 "Retry-After" : {
9295 "description" : "How many seconds you have to wait before making new request.",
9296 "style" : "simple",
9297 "explode" : false,
9298 "schema" : {
9299 "type" : "integer",
9300 "format" : "int32"
9301 }
9302 }
9303 },
9304 "content" : {
9305 "application/json" : {
9306 "schema" : {
9307 "$ref" : "#/components/schemas/ClientErrorResponse"
9308 }
9309 }
9310 }
9311 },
9312 "402" : {
9313 "description" : "Authenticated user doesn't have subscription.",
9314 "content" : {
9315 "application/json" : {
9316 "schema" : {
9317 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
9318 }
9319 }
9320 }
9321 },
9322 "403" : {
9323 "description" : "Authenticated user doesn't have access to the resource.",
9324 "headers" : {
9325 "X-RateLimit-Limit" : {
9326 "description" : "Request limit per minute.",
9327 "style" : "simple",
9328 "explode" : false,
9329 "schema" : {
9330 "type" : "integer",
9331 "format" : "int32"
9332 }
9333 },
9334 "X-RateLimit-Remaining" : {
9335 "description" : "The number of requests left for the time window.",
9336 "style" : "simple",
9337 "explode" : false,
9338 "schema" : {
9339 "type" : "integer",
9340 "format" : "int32"
9341 }
9342 },
9343 "X-RateLimit-Reset" : {
9344 "description" : "The timestamp at which the current rate limit window resets.",
9345 "style" : "simple",
9346 "explode" : false,
9347 "schema" : {
9348 "type" : "integer",
9349 "format" : "int32"
9350 }
9351 },
9352 "Retry-After" : {
9353 "description" : "How many seconds you have to wait before making new request.",
9354 "style" : "simple",
9355 "explode" : false,
9356 "schema" : {
9357 "type" : "integer",
9358 "format" : "int32"
9359 }
9360 }
9361 },
9362 "content" : {
9363 "application/json" : {
9364 "schema" : {
9365 "$ref" : "#/components/schemas/ClientErrorResponse"
9366 }
9367 }
9368 }
9369 },
9370 "404" : {
9371 "description" : "Non-existent resource is requested.",
9372 "headers" : {
9373 "X-RateLimit-Limit" : {
9374 "description" : "Request limit per minute.",
9375 "style" : "simple",
9376 "explode" : false,
9377 "schema" : {
9378 "type" : "integer",
9379 "format" : "int32"
9380 }
9381 },
9382 "X-RateLimit-Remaining" : {
9383 "description" : "The number of requests left for the time window.",
9384 "style" : "simple",
9385 "explode" : false,
9386 "schema" : {
9387 "type" : "integer",
9388 "format" : "int32"
9389 }
9390 },
9391 "X-RateLimit-Reset" : {
9392 "description" : "The timestamp at which the current rate limit window resets.",
9393 "style" : "simple",
9394 "explode" : false,
9395 "schema" : {
9396 "type" : "integer",
9397 "format" : "int32"
9398 }
9399 },
9400 "Retry-After" : {
9401 "description" : "How many seconds you have to wait before making new request.",
9402 "style" : "simple",
9403 "explode" : false,
9404 "schema" : {
9405 "type" : "integer",
9406 "format" : "int32"
9407 }
9408 }
9409 },
9410 "content" : {
9411 "application/json" : {
9412 "schema" : {
9413 "$ref" : "#/components/schemas/ClientErrorResponse"
9414 }
9415 }
9416 }
9417 },
9418 "422" : {
9419 "description" : "Validation errors occured.",
9420 "headers" : {
9421 "X-RateLimit-Limit" : {
9422 "description" : "Request limit per minute.",
9423 "style" : "simple",
9424 "explode" : false,
9425 "schema" : {
9426 "type" : "integer",
9427 "format" : "int32"
9428 }
9429 },
9430 "X-RateLimit-Remaining" : {
9431 "description" : "The number of requests left for the time window.",
9432 "style" : "simple",
9433 "explode" : false,
9434 "schema" : {
9435 "type" : "integer",
9436 "format" : "int32"
9437 }
9438 },
9439 "X-RateLimit-Reset" : {
9440 "description" : "The timestamp at which the current rate limit window resets.",
9441 "style" : "simple",
9442 "explode" : false,
9443 "schema" : {
9444 "type" : "integer",
9445 "format" : "int32"
9446 }
9447 },
9448 "Retry-After" : {
9449 "description" : "How many seconds you have to wait before making new request.",
9450 "style" : "simple",
9451 "explode" : false,
9452 "schema" : {
9453 "type" : "integer",
9454 "format" : "int32"
9455 }
9456 }
9457 },
9458 "content" : {
9459 "application/json" : {
9460 "schema" : {
9461 "$ref" : "#/components/schemas/ValidationErrorResponse"
9462 }
9463 }
9464 }
9465 },
9466 "500" : {
9467 "description" : "Internal server error.",
9468 "headers" : {
9469 "X-RateLimit-Limit" : {
9470 "description" : "Request limit per minute.",
9471 "style" : "simple",
9472 "explode" : false,
9473 "schema" : {
9474 "type" : "integer",
9475 "format" : "int32"
9476 }
9477 },
9478 "X-RateLimit-Remaining" : {
9479 "description" : "The number of requests left for the time window.",
9480 "style" : "simple",
9481 "explode" : false,
9482 "schema" : {
9483 "type" : "integer",
9484 "format" : "int32"
9485 }
9486 },
9487 "X-RateLimit-Reset" : {
9488 "description" : "The timestamp at which the current rate limit window resets.",
9489 "style" : "simple",
9490 "explode" : false,
9491 "schema" : {
9492 "type" : "integer",
9493 "format" : "int32"
9494 }
9495 },
9496 "Retry-After" : {
9497 "description" : "How many seconds you have to wait before making new request.",
9498 "style" : "simple",
9499 "explode" : false,
9500 "schema" : {
9501 "type" : "integer",
9502 "format" : "int32"
9503 }
9504 }
9505 },
9506 "content" : {
9507 "application/json" : {
9508 "schema" : {
9509 "$ref" : "#/components/schemas/ServerErrorResponse"
9510 }
9511 }
9512 }
9513 }
9514 }
9515 },
9516 "delete" : {
9517 "tags" : [ "Product" ],
9518 "summary" : "Delete a product",
9519 "description" : "Delete an existing product.",
9520 "operationId" : "DeleteProduct",
9521 "parameters" : [ {
9522 "name" : "id",
9523 "in" : "path",
9524 "required" : true,
9525 "style" : "simple",
9526 "explode" : false,
9527 "schema" : {
9528 "type" : "integer"
9529 }
9530 } ],
9531 "responses" : {
9532 "204" : {
9533 "description" : "Product deleted successfully.",
9534 "headers" : {
9535 "X-RateLimit-Limit" : {
9536 "description" : "Request limit per minute.",
9537 "style" : "simple",
9538 "explode" : false,
9539 "schema" : {
9540 "type" : "integer",
9541 "format" : "int32"
9542 }
9543 },
9544 "X-RateLimit-Remaining" : {
9545 "description" : "The number of requests left for the time window.",
9546 "style" : "simple",
9547 "explode" : false,
9548 "schema" : {
9549 "type" : "integer",
9550 "format" : "int32"
9551 }
9552 },
9553 "X-RateLimit-Reset" : {
9554 "description" : "The timestamp at which the current rate limit window resets.",
9555 "style" : "simple",
9556 "explode" : false,
9557 "schema" : {
9558 "type" : "integer",
9559 "format" : "int32"
9560 }
9561 },
9562 "Retry-After" : {
9563 "description" : "How many seconds you have to wait before making new request.",
9564 "style" : "simple",
9565 "explode" : false,
9566 "schema" : {
9567 "type" : "integer",
9568 "format" : "int32"
9569 }
9570 }
9571 }
9572 },
9573 "400" : {
9574 "description" : "The request is malformed.",
9575 "headers" : {
9576 "X-RateLimit-Limit" : {
9577 "description" : "Request limit per minute.",
9578 "style" : "simple",
9579 "explode" : false,
9580 "schema" : {
9581 "type" : "integer",
9582 "format" : "int32"
9583 }
9584 },
9585 "X-RateLimit-Remaining" : {
9586 "description" : "The number of requests left for the time window.",
9587 "style" : "simple",
9588 "explode" : false,
9589 "schema" : {
9590 "type" : "integer",
9591 "format" : "int32"
9592 }
9593 },
9594 "X-RateLimit-Reset" : {
9595 "description" : "The timestamp at which the current rate limit window resets.",
9596 "style" : "simple",
9597 "explode" : false,
9598 "schema" : {
9599 "type" : "integer",
9600 "format" : "int32"
9601 }
9602 },
9603 "Retry-After" : {
9604 "description" : "How many seconds you have to wait before making new request.",
9605 "style" : "simple",
9606 "explode" : false,
9607 "schema" : {
9608 "type" : "integer",
9609 "format" : "int32"
9610 }
9611 }
9612 },
9613 "content" : {
9614 "application/json" : {
9615 "schema" : {
9616 "$ref" : "#/components/schemas/ClientErrorResponse"
9617 }
9618 }
9619 }
9620 },
9621 "401" : {
9622 "description" : "Authorization information is missing or invalid.",
9623 "headers" : {
9624 "X-RateLimit-Limit" : {
9625 "description" : "Request limit per minute.",
9626 "style" : "simple",
9627 "explode" : false,
9628 "schema" : {
9629 "type" : "integer",
9630 "format" : "int32"
9631 }
9632 },
9633 "X-RateLimit-Remaining" : {
9634 "description" : "The number of requests left for the time window.",
9635 "style" : "simple",
9636 "explode" : false,
9637 "schema" : {
9638 "type" : "integer",
9639 "format" : "int32"
9640 }
9641 },
9642 "X-RateLimit-Reset" : {
9643 "description" : "The timestamp at which the current rate limit window resets.",
9644 "style" : "simple",
9645 "explode" : false,
9646 "schema" : {
9647 "type" : "integer",
9648 "format" : "int32"
9649 }
9650 },
9651 "Retry-After" : {
9652 "description" : "How many seconds you have to wait before making new request.",
9653 "style" : "simple",
9654 "explode" : false,
9655 "schema" : {
9656 "type" : "integer",
9657 "format" : "int32"
9658 }
9659 }
9660 },
9661 "content" : {
9662 "application/json" : {
9663 "schema" : {
9664 "$ref" : "#/components/schemas/ClientErrorResponse"
9665 }
9666 }
9667 }
9668 },
9669 "402" : {
9670 "description" : "Authenticated user doesn't have subscription.",
9671 "content" : {
9672 "application/json" : {
9673 "schema" : {
9674 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
9675 }
9676 }
9677 }
9678 },
9679 "403" : {
9680 "description" : "Authenticated user doesn't have access to the resource.",
9681 "headers" : {
9682 "X-RateLimit-Limit" : {
9683 "description" : "Request limit per minute.",
9684 "style" : "simple",
9685 "explode" : false,
9686 "schema" : {
9687 "type" : "integer",
9688 "format" : "int32"
9689 }
9690 },
9691 "X-RateLimit-Remaining" : {
9692 "description" : "The number of requests left for the time window.",
9693 "style" : "simple",
9694 "explode" : false,
9695 "schema" : {
9696 "type" : "integer",
9697 "format" : "int32"
9698 }
9699 },
9700 "X-RateLimit-Reset" : {
9701 "description" : "The timestamp at which the current rate limit window resets.",
9702 "style" : "simple",
9703 "explode" : false,
9704 "schema" : {
9705 "type" : "integer",
9706 "format" : "int32"
9707 }
9708 },
9709 "Retry-After" : {
9710 "description" : "How many seconds you have to wait before making new request.",
9711 "style" : "simple",
9712 "explode" : false,
9713 "schema" : {
9714 "type" : "integer",
9715 "format" : "int32"
9716 }
9717 }
9718 },
9719 "content" : {
9720 "application/json" : {
9721 "schema" : {
9722 "$ref" : "#/components/schemas/ClientErrorResponse"
9723 }
9724 }
9725 }
9726 },
9727 "404" : {
9728 "description" : "Non-existent resource is requested.",
9729 "headers" : {
9730 "X-RateLimit-Limit" : {
9731 "description" : "Request limit per minute.",
9732 "style" : "simple",
9733 "explode" : false,
9734 "schema" : {
9735 "type" : "integer",
9736 "format" : "int32"
9737 }
9738 },
9739 "X-RateLimit-Remaining" : {
9740 "description" : "The number of requests left for the time window.",
9741 "style" : "simple",
9742 "explode" : false,
9743 "schema" : {
9744 "type" : "integer",
9745 "format" : "int32"
9746 }
9747 },
9748 "X-RateLimit-Reset" : {
9749 "description" : "The timestamp at which the current rate limit window resets.",
9750 "style" : "simple",
9751 "explode" : false,
9752 "schema" : {
9753 "type" : "integer",
9754 "format" : "int32"
9755 }
9756 },
9757 "Retry-After" : {
9758 "description" : "How many seconds you have to wait before making new request.",
9759 "style" : "simple",
9760 "explode" : false,
9761 "schema" : {
9762 "type" : "integer",
9763 "format" : "int32"
9764 }
9765 }
9766 },
9767 "content" : {
9768 "application/json" : {
9769 "schema" : {
9770 "$ref" : "#/components/schemas/ClientErrorResponse"
9771 }
9772 }
9773 }
9774 },
9775 "500" : {
9776 "description" : "Internal server error.",
9777 "headers" : {
9778 "X-RateLimit-Limit" : {
9779 "description" : "Request limit per minute.",
9780 "style" : "simple",
9781 "explode" : false,
9782 "schema" : {
9783 "type" : "integer",
9784 "format" : "int32"
9785 }
9786 },
9787 "X-RateLimit-Remaining" : {
9788 "description" : "The number of requests left for the time window.",
9789 "style" : "simple",
9790 "explode" : false,
9791 "schema" : {
9792 "type" : "integer",
9793 "format" : "int32"
9794 }
9795 },
9796 "X-RateLimit-Reset" : {
9797 "description" : "The timestamp at which the current rate limit window resets.",
9798 "style" : "simple",
9799 "explode" : false,
9800 "schema" : {
9801 "type" : "integer",
9802 "format" : "int32"
9803 }
9804 },
9805 "Retry-After" : {
9806 "description" : "How many seconds you have to wait before making new request.",
9807 "style" : "simple",
9808 "explode" : false,
9809 "schema" : {
9810 "type" : "integer",
9811 "format" : "int32"
9812 }
9813 }
9814 },
9815 "content" : {
9816 "application/json" : {
9817 "schema" : {
9818 "$ref" : "#/components/schemas/ServerErrorResponse"
9819 }
9820 }
9821 }
9822 }
9823 }
9824 }
9825 },
9826 "/utils/convert-legacy-id/{id}" : {
9827 "get" : {
9828 "tags" : [ "Util" ],
9829 "summary" : "Convert legacy ID to v3 ID.",
9830 "description" : "Retrieves the API v3 ID.",
9831 "operationId" : "GetId",
9832 "parameters" : [ {
9833 "name" : "id",
9834 "in" : "path",
9835 "required" : true,
9836 "style" : "simple",
9837 "explode" : false,
9838 "schema" : {
9839 "type" : "integer"
9840 }
9841 } ],
9842 "responses" : {
9843 "200" : {
9844 "description" : "Success response",
9845 "headers" : {
9846 "X-RateLimit-Limit" : {
9847 "description" : "Request limit per minute.",
9848 "style" : "simple",
9849 "explode" : false,
9850 "schema" : {
9851 "type" : "integer",
9852 "format" : "int32"
9853 }
9854 },
9855 "X-RateLimit-Remaining" : {
9856 "description" : "The number of requests left for the time window.",
9857 "style" : "simple",
9858 "explode" : false,
9859 "schema" : {
9860 "type" : "integer",
9861 "format" : "int32"
9862 }
9863 },
9864 "X-RateLimit-Reset" : {
9865 "description" : "The timestamp at which the current rate limit window resets.",
9866 "style" : "simple",
9867 "explode" : false,
9868 "schema" : {
9869 "type" : "integer",
9870 "format" : "int32"
9871 }
9872 },
9873 "Retry-After" : {
9874 "description" : "How many seconds you have to wait before making new request.",
9875 "style" : "simple",
9876 "explode" : false,
9877 "schema" : {
9878 "type" : "integer",
9879 "format" : "int32"
9880 }
9881 }
9882 },
9883 "content" : {
9884 "application/json" : {
9885 "schema" : {
9886 "$ref" : "#/components/schemas/Id"
9887 }
9888 }
9889 }
9890 },
9891 "400" : {
9892 "description" : "The request is malformed.",
9893 "headers" : {
9894 "X-RateLimit-Limit" : {
9895 "description" : "Request limit per minute.",
9896 "style" : "simple",
9897 "explode" : false,
9898 "schema" : {
9899 "type" : "integer",
9900 "format" : "int32"
9901 }
9902 },
9903 "X-RateLimit-Remaining" : {
9904 "description" : "The number of requests left for the time window.",
9905 "style" : "simple",
9906 "explode" : false,
9907 "schema" : {
9908 "type" : "integer",
9909 "format" : "int32"
9910 }
9911 },
9912 "X-RateLimit-Reset" : {
9913 "description" : "The timestamp at which the current rate limit window resets.",
9914 "style" : "simple",
9915 "explode" : false,
9916 "schema" : {
9917 "type" : "integer",
9918 "format" : "int32"
9919 }
9920 },
9921 "Retry-After" : {
9922 "description" : "How many seconds you have to wait before making new request.",
9923 "style" : "simple",
9924 "explode" : false,
9925 "schema" : {
9926 "type" : "integer",
9927 "format" : "int32"
9928 }
9929 }
9930 },
9931 "content" : {
9932 "application/json" : {
9933 "schema" : {
9934 "$ref" : "#/components/schemas/ClientErrorResponse"
9935 }
9936 }
9937 }
9938 },
9939 "401" : {
9940 "description" : "Authorization information is missing or invalid.",
9941 "headers" : {
9942 "X-RateLimit-Limit" : {
9943 "description" : "Request limit per minute.",
9944 "style" : "simple",
9945 "explode" : false,
9946 "schema" : {
9947 "type" : "integer",
9948 "format" : "int32"
9949 }
9950 },
9951 "X-RateLimit-Remaining" : {
9952 "description" : "The number of requests left for the time window.",
9953 "style" : "simple",
9954 "explode" : false,
9955 "schema" : {
9956 "type" : "integer",
9957 "format" : "int32"
9958 }
9959 },
9960 "X-RateLimit-Reset" : {
9961 "description" : "The timestamp at which the current rate limit window resets.",
9962 "style" : "simple",
9963 "explode" : false,
9964 "schema" : {
9965 "type" : "integer",
9966 "format" : "int32"
9967 }
9968 },
9969 "Retry-After" : {
9970 "description" : "How many seconds you have to wait before making new request.",
9971 "style" : "simple",
9972 "explode" : false,
9973 "schema" : {
9974 "type" : "integer",
9975 "format" : "int32"
9976 }
9977 }
9978 },
9979 "content" : {
9980 "application/json" : {
9981 "schema" : {
9982 "$ref" : "#/components/schemas/ClientErrorResponse"
9983 }
9984 }
9985 }
9986 },
9987 "402" : {
9988 "description" : "Authenticated user doesn't have subscription.",
9989 "content" : {
9990 "application/json" : {
9991 "schema" : {
9992 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
9993 }
9994 }
9995 }
9996 },
9997 "404" : {
9998 "description" : "Non-existent resource is requested.",
9999 "headers" : {
10000 "X-RateLimit-Limit" : {
10001 "description" : "Request limit per minute.",
10002 "style" : "simple",
10003 "explode" : false,
10004 "schema" : {
10005 "type" : "integer",
10006 "format" : "int32"
10007 }
10008 },
10009 "X-RateLimit-Remaining" : {
10010 "description" : "The number of requests left for the time window.",
10011 "style" : "simple",
10012 "explode" : false,
10013 "schema" : {
10014 "type" : "integer",
10015 "format" : "int32"
10016 }
10017 },
10018 "X-RateLimit-Reset" : {
10019 "description" : "The timestamp at which the current rate limit window resets.",
10020 "style" : "simple",
10021 "explode" : false,
10022 "schema" : {
10023 "type" : "integer",
10024 "format" : "int32"
10025 }
10026 },
10027 "Retry-After" : {
10028 "description" : "How many seconds you have to wait before making new request.",
10029 "style" : "simple",
10030 "explode" : false,
10031 "schema" : {
10032 "type" : "integer",
10033 "format" : "int32"
10034 }
10035 }
10036 },
10037 "content" : {
10038 "application/json" : {
10039 "schema" : {
10040 "$ref" : "#/components/schemas/ClientErrorResponse"
10041 }
10042 }
10043 }
10044 },
10045 "422" : {
10046 "description" : "Validation errors occured.",
10047 "headers" : {
10048 "X-RateLimit-Limit" : {
10049 "description" : "Request limit per minute.",
10050 "style" : "simple",
10051 "explode" : false,
10052 "schema" : {
10053 "type" : "integer",
10054 "format" : "int32"
10055 }
10056 },
10057 "X-RateLimit-Remaining" : {
10058 "description" : "The number of requests left for the time window.",
10059 "style" : "simple",
10060 "explode" : false,
10061 "schema" : {
10062 "type" : "integer",
10063 "format" : "int32"
10064 }
10065 },
10066 "X-RateLimit-Reset" : {
10067 "description" : "The timestamp at which the current rate limit window resets.",
10068 "style" : "simple",
10069 "explode" : false,
10070 "schema" : {
10071 "type" : "integer",
10072 "format" : "int32"
10073 }
10074 },
10075 "Retry-After" : {
10076 "description" : "How many seconds you have to wait before making new request.",
10077 "style" : "simple",
10078 "explode" : false,
10079 "schema" : {
10080 "type" : "integer",
10081 "format" : "int32"
10082 }
10083 }
10084 },
10085 "content" : {
10086 "application/json" : {
10087 "schema" : {
10088 "$ref" : "#/components/schemas/ValidationErrorResponse"
10089 }
10090 }
10091 }
10092 },
10093 "500" : {
10094 "description" : "Internal server error.",
10095 "headers" : {
10096 "X-RateLimit-Limit" : {
10097 "description" : "Request limit per minute.",
10098 "style" : "simple",
10099 "explode" : false,
10100 "schema" : {
10101 "type" : "integer",
10102 "format" : "int32"
10103 }
10104 },
10105 "X-RateLimit-Remaining" : {
10106 "description" : "The number of requests left for the time window.",
10107 "style" : "simple",
10108 "explode" : false,
10109 "schema" : {
10110 "type" : "integer",
10111 "format" : "int32"
10112 }
10113 },
10114 "X-RateLimit-Reset" : {
10115 "description" : "The timestamp at which the current rate limit window resets.",
10116 "style" : "simple",
10117 "explode" : false,
10118 "schema" : {
10119 "type" : "integer",
10120 "format" : "int32"
10121 }
10122 },
10123 "Retry-After" : {
10124 "description" : "How many seconds you have to wait before making new request.",
10125 "style" : "simple",
10126 "explode" : false,
10127 "schema" : {
10128 "type" : "integer",
10129 "format" : "int32"
10130 }
10131 }
10132 },
10133 "content" : {
10134 "application/json" : {
10135 "schema" : {
10136 "$ref" : "#/components/schemas/ServerErrorResponse"
10137 }
10138 }
10139 }
10140 }
10141 }
10142 }
10143 }
10144 },
10145 "components" : {
10146 "schemas" : {
10147 "ClientErrorResponse" : {
10148 "type" : "object",
10149 "properties" : {
10150 "error" : {
10151 "$ref" : "#/components/schemas/ClientError"
10152 }
10153 },
10154 "example" : {
10155 "error" : {
10156 "message" : "Authorization information (Header: %s) is missing or invalid."
10157 }
10158 }
10159 },
10160 "ServerErrorResponse" : {
10161 "type" : "object",
10162 "properties" : {
10163 "error" : {
10164 "$ref" : "#/components/schemas/ServerError"
10165 }
10166 },
10167 "example" : {
10168 "error" : {
10169 "message" : "Internal Server Error.",
10170 "trace_id" : "664b218f93954a3480cb0ddb8f919c3f"
10171 }
10172 }
10173 },
10174 "SubscriptionErrorResponse" : {
10175 "type" : "object",
10176 "properties" : {
10177 "error" : {
10178 "$ref" : "#/components/schemas/ClientError"
10179 }
10180 },
10181 "example" : {
10182 "error" : {
10183 "message" : "You do not have subscription for this operation"
10184 }
10185 }
10186 },
10187 "ValidationErrorResponse" : {
10188 "type" : "object",
10189 "properties" : {
10190 "message" : {
10191 "type" : "string"
10192 },
10193 "errors" : {
10194 "type" : "array",
10195 "items" : {
10196 "$ref" : "#/components/schemas/ValidationError"
10197 }
10198 }
10199 }
10200 },
10201 "ClientError" : {
10202 "type" : "object",
10203 "properties" : {
10204 "message" : {
10205 "type" : "string"
10206 }
10207 }
10208 },
10209 "ServerError" : {
10210 "type" : "object",
10211 "properties" : {
10212 "message" : {
10213 "type" : "string"
10214 },
10215 "trace_id" : {
10216 "type" : "string",
10217 "description" : "You should send us this ID to investigate the issue."
10218 }
10219 }
10220 },
10221 "ValidationError" : {
10222 "type" : "object",
10223 "properties" : {
10224 "field" : {
10225 "type" : "string"
10226 },
10227 "message" : {
10228 "type" : "string"
10229 }
10230 }
10231 },
10232 "BankAccount" : {
10233 "required" : [ "account_number", "currency", "name" ],
10234 "type" : "object",
10235 "properties" : {
10236 "id" : {
10237 "type" : "integer",
10238 "readOnly" : true
10239 },
10240 "name" : {
10241 "type" : "string"
10242 },
10243 "account_number" : {
10244 "type" : "string"
10245 },
10246 "account_number_iban" : {
10247 "type" : "string"
10248 },
10249 "swift" : {
10250 "type" : "string"
10251 },
10252 "currency" : {
10253 "$ref" : "#/components/schemas/Currency"
10254 },
10255 "need_qr" : {
10256 "type" : "boolean",
10257 "default" : false
10258 }
10259 }
10260 },
10261 "BankAccountList" : {
10262 "type" : "object",
10263 "properties" : {
10264 "data" : {
10265 "type" : "array",
10266 "items" : {
10267 "$ref" : "#/components/schemas/BankAccount"
10268 }
10269 },
10270 "total" : {
10271 "type" : "integer"
10272 },
10273 "per_page" : {
10274 "type" : "integer"
10275 },
10276 "current_page" : {
10277 "type" : "integer"
10278 },
10279 "last_page" : {
10280 "type" : "integer"
10281 },
10282 "prev_page_url" : {
10283 "type" : "string"
10284 },
10285 "next_page_url" : {
10286 "type" : "string"
10287 }
10288 },
10289 "description" : "A object with a data property that contains an array of up to limit bank accounts. Each entry in the array is a separate bank account object. If no more bank accounts are available, the resulting array will be empty."
10290 },
10291 "Address" : {
10292 "required" : [ "address", "city", "country_code", "post_code" ],
10293 "type" : "object",
10294 "properties" : {
10295 "country_code" : {
10296 "$ref" : "#/components/schemas/Country"
10297 },
10298 "post_code" : {
10299 "type" : "string"
10300 },
10301 "city" : {
10302 "type" : "string"
10303 },
10304 "address" : {
10305 "type" : "string"
10306 }
10307 }
10308 },
10309 "Country" : {
10310 "type" : "string",
10311 "enum" : [ "", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XA", "XB", "XK", "YE", "YT", "ZA", "ZM", "ZW" ]
10312 },
10313 "Currency" : {
10314 "type" : "string",
10315 "enum" : [ "AUD", "BGN", "BRL", "CAD", "CHF", "CNY", "CZK", "DKK", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KRW", "LTL", "LVL", "MXN", "MYR", "NOK", "NZD", "PHP", "PLN", "RON", "RSD", "RUB", "SEK", "SGD", "THB", "TRY", "UAH", "USD", "ZAR" ]
10316 },
10317 "ConversationRate" : {
10318 "type" : "object",
10319 "properties" : {
10320 "from_currency" : {
10321 "$ref" : "#/components/schemas/Currency"
10322 },
10323 "to_currency" : {
10324 "$ref" : "#/components/schemas/Currency"
10325 },
10326 "conversation_rate" : {
10327 "type" : "number",
10328 "format" : "float"
10329 }
10330 }
10331 },
10332 "Document" : {
10333 "type" : "object",
10334 "properties" : {
10335 "id" : {
10336 "type" : "integer",
10337 "description" : "The document's unique identifier."
10338 },
10339 "invoice_number" : {
10340 "type" : "string",
10341 "description" : "The document's invoice number.",
10342 "example" : "PREFIX / 2020-000001"
10343 },
10344 "type" : {
10345 "$ref" : "#/components/schemas/DocumentType"
10346 },
10347 "cancelled" : {
10348 "type" : "boolean"
10349 },
10350 "block_id" : {
10351 "type" : "integer",
10352 "description" : "DocumentBlock's identifier."
10353 },
10354 "payment_status" : {
10355 "$ref" : "#/components/schemas/PaymentStatus"
10356 },
10357 "payment_method" : {
10358 "$ref" : "#/components/schemas/PaymentMethod"
10359 },
10360 "gross_total" : {
10361 "type" : "number",
10362 "description" : "The document's gross total price.",
10363 "format" : "float"
10364 },
10365 "currency" : {
10366 "$ref" : "#/components/schemas/Currency"
10367 },
10368 "conversion_rate" : {
10369 "type" : "number",
10370 "format" : "float"
10371 },
10372 "invoice_date" : {
10373 "type" : "string",
10374 "format" : "date"
10375 },
10376 "fulfillment_date" : {
10377 "type" : "string",
10378 "format" : "date"
10379 },
10380 "due_date" : {
10381 "type" : "string",
10382 "format" : "date"
10383 },
10384 "paid_date" : {
10385 "type" : "string",
10386 "format" : "date"
10387 },
10388 "organization" : {
10389 "$ref" : "#/components/schemas/DocumentOrganization"
10390 },
10391 "partner" : {
10392 "description" : "You should use document_partner instead.",
10393 "deprecated" : true,
10394 "allOf" : [ {
10395 "$ref" : "#/components/schemas/Partner"
10396 } ]
10397 },
10398 "document_partner" : {
10399 "$ref" : "#/components/schemas/DocumentPartner"
10400 },
10401 "electronic" : {
10402 "type" : "boolean"
10403 },
10404 "comment" : {
10405 "type" : "string"
10406 },
10407 "tags" : {
10408 "type" : "array",
10409 "items" : {
10410 "type" : "string"
10411 }
10412 },
10413 "notification_status" : {
10414 "$ref" : "#/components/schemas/DocumentNotificationStatus"
10415 },
10416 "language" : {
10417 "$ref" : "#/components/schemas/DocumentLanguage"
10418 },
10419 "items" : {
10420 "type" : "array",
10421 "items" : {
10422 "$ref" : "#/components/schemas/DocumentItem"
10423 }
10424 },
10425 "summary" : {
10426 "$ref" : "#/components/schemas/DocumentSummary"
10427 },
10428 "settings" : {
10429 "$ref" : "#/components/schemas/DocumentSettings"
10430 }
10431 },
10432 "description" : "Document object representing your invoice."
10433 },
10434 "DocumentBankAccount" : {
10435 "required" : [ "account_number", "name" ],
10436 "type" : "object",
10437 "properties" : {
10438 "id" : {
10439 "type" : "integer",
10440 "readOnly" : true
10441 },
10442 "name" : {
10443 "type" : "string"
10444 },
10445 "account_number" : {
10446 "type" : "string"
10447 },
10448 "account_number_iban" : {
10449 "type" : "string"
10450 },
10451 "swift" : {
10452 "type" : "string"
10453 }
10454 }
10455 },
10456 "DocumentInsert" : {
10457 "required" : [ "block_id", "currency", "due_date", "fulfillment_date", "language", "partner_id", "payment_method", "type" ],
10458 "type" : "object",
10459 "properties" : {
10460 "vendor_id" : {
10461 "type" : "string"
10462 },
10463 "partner_id" : {
10464 "type" : "integer"
10465 },
10466 "block_id" : {
10467 "type" : "integer"
10468 },
10469 "bank_account_id" : {
10470 "type" : "integer"
10471 },
10472 "type" : {
10473 "$ref" : "#/components/schemas/DocumentInsertType"
10474 },
10475 "fulfillment_date" : {
10476 "type" : "string",
10477 "format" : "date"
10478 },
10479 "due_date" : {
10480 "type" : "string",
10481 "format" : "date"
10482 },
10483 "payment_method" : {
10484 "$ref" : "#/components/schemas/PaymentMethod"
10485 },
10486 "language" : {
10487 "$ref" : "#/components/schemas/DocumentLanguage"
10488 },
10489 "currency" : {
10490 "$ref" : "#/components/schemas/Currency"
10491 },
10492 "conversion_rate" : {
10493 "type" : "number",
10494 "format" : "float"
10495 },
10496 "electronic" : {
10497 "type" : "boolean",
10498 "default" : false
10499 },
10500 "paid" : {
10501 "type" : "boolean",
10502 "default" : false
10503 },
10504 "items" : {
10505 "type" : "array",
10506 "items" : {
10507 "oneOf" : [ {
10508 "$ref" : "#/components/schemas/DocumentItemData"
10509 }, {
10510 "$ref" : "#/components/schemas/DocumentProductData"
10511 } ]
10512 }
10513 },
10514 "comment" : {
10515 "type" : "string"
10516 },
10517 "settings" : {
10518 "$ref" : "#/components/schemas/DocumentSettings"
10519 }
10520 }
10521 },
10522 "DocumentInsertType" : {
10523 "type" : "string",
10524 "enum" : [ "advance", "draft", "invoice", "proforma" ]
10525 },
10526 "DocumentItem" : {
10527 "type" : "object",
10528 "properties" : {
10529 "product_id" : {
10530 "type" : "integer"
10531 },
10532 "name" : {
10533 "type" : "string"
10534 },
10535 "net_unit_amount" : {
10536 "type" : "number",
10537 "format" : "float"
10538 },
10539 "quantity" : {
10540 "type" : "number",
10541 "format" : "float"
10542 },
10543 "net_amount" : {
10544 "type" : "number",
10545 "format" : "float"
10546 },
10547 "gross_amount" : {
10548 "type" : "number",
10549 "format" : "float"
10550 },
10551 "vat" : {
10552 "$ref" : "#/components/schemas/Vat"
10553 },
10554 "vat_amount" : {
10555 "type" : "number",
10556 "format" : "float"
10557 }
10558 }
10559 },
10560 "DocumentItemData" : {
10561 "required" : [ "product_id", "quantity" ],
10562 "type" : "object",
10563 "properties" : {
10564 "product_id" : {
10565 "type" : "integer"
10566 },
10567 "quantity" : {
10568 "type" : "number",
10569 "format" : "float"
10570 }
10571 }
10572 },
10573 "DocumentLanguage" : {
10574 "type" : "string",
10575 "enum" : [ "de", "en", "fr", "hr", "hu", "it", "ro", "sk" ]
10576 },
10577 "DocumentList" : {
10578 "type" : "object",
10579 "properties" : {
10580 "data" : {
10581 "type" : "array",
10582 "items" : {
10583 "$ref" : "#/components/schemas/Document"
10584 }
10585 },
10586 "total" : {
10587 "type" : "integer"
10588 },
10589 "per_page" : {
10590 "type" : "integer"
10591 },
10592 "current_page" : {
10593 "type" : "integer"
10594 },
10595 "last_page" : {
10596 "type" : "integer"
10597 },
10598 "prev_page_url" : {
10599 "type" : "string"
10600 },
10601 "next_page_url" : {
10602 "type" : "string"
10603 }
10604 },
10605 "description" : "A object with a data property that contains an array of up to limit documents. Each entry in the array is a separate document object. If no more documents are available, the resulting array will be empty."
10606 },
10607 "DocumentNotificationStatus" : {
10608 "type" : "string",
10609 "enum" : [ "closed", "downloaded", "failed", "none", "opened", "readed" ]
10610 },
10611 "DocumentOrganization" : {
10612 "type" : "object",
10613 "properties" : {
10614 "name" : {
10615 "type" : "string"
10616 },
10617 "tax_number" : {
10618 "type" : "string"
10619 },
10620 "bank_account" : {
10621 "$ref" : "#/components/schemas/DocumentBankAccount"
10622 },
10623 "address" : {
10624 "$ref" : "#/components/schemas/Address"
10625 },
10626 "small_taxpayer" : {
10627 "type" : "boolean"
10628 },
10629 "ev_number" : {
10630 "type" : "string"
10631 },
10632 "eu_tax_number" : {
10633 "type" : "string"
10634 },
10635 "cash_settled" : {
10636 "type" : "boolean"
10637 }
10638 }
10639 },
10640 "DocumentPartner" : {
10641 "type" : "object",
10642 "properties" : {
10643 "id" : {
10644 "type" : "integer"
10645 },
10646 "name" : {
10647 "type" : "string"
10648 },
10649 "address" : {
10650 "$ref" : "#/components/schemas/Address"
10651 },
10652 "emails" : {
10653 "type" : "array",
10654 "items" : {
10655 "type" : "string"
10656 }
10657 },
10658 "taxcode" : {
10659 "type" : "string"
10660 },
10661 "iban" : {
10662 "type" : "string"
10663 },
10664 "swift" : {
10665 "type" : "string"
10666 },
10667 "account_number" : {
10668 "type" : "string"
10669 },
10670 "phone" : {
10671 "type" : "string"
10672 },
10673 "tax_type" : {
10674 "$ref" : "#/components/schemas/PartnerTaxType"
10675 }
10676 }
10677 },
10678 "DocumentProductData" : {
10679 "required" : [ "name", "quantity", "unit", "unit_price", "unit_price_type", "vat" ],
10680 "type" : "object",
10681 "properties" : {
10682 "name" : {
10683 "type" : "string"
10684 },
10685 "unit_price" : {
10686 "type" : "number",
10687 "format" : "float"
10688 },
10689 "unit_price_type" : {
10690 "$ref" : "#/components/schemas/UnitPriceType"
10691 },
10692 "quantity" : {
10693 "type" : "number",
10694 "format" : "float"
10695 },
10696 "unit" : {
10697 "type" : "string"
10698 },
10699 "vat" : {
10700 "$ref" : "#/components/schemas/Vat"
10701 },
10702 "comment" : {
10703 "type" : "string"
10704 }
10705 }
10706 },
10707 "DocumentPublicUrl" : {
10708 "type" : "object",
10709 "properties" : {
10710 "public_url" : {
10711 "type" : "string"
10712 }
10713 }
10714 },
10715 "DocumentSettings" : {
10716 "type" : "object",
10717 "properties" : {
10718 "mediated_service" : {
10719 "type" : "boolean",
10720 "default" : false
10721 },
10722 "without_financial_fulfillment" : {
10723 "type" : "boolean",
10724 "default" : false
10725 },
10726 "online_payment" : {
10727 "$ref" : "#/components/schemas/OnlinePayment"
10728 },
10729 "round" : {
10730 "$ref" : "#/components/schemas/Round"
10731 },
10732 "place_id" : {
10733 "type" : "integer"
10734 }
10735 }
10736 },
10737 "DocumentSummary" : {
10738 "type" : "object",
10739 "properties" : {
10740 "net_amount" : {
10741 "type" : "number",
10742 "format" : "float"
10743 },
10744 "net_amount_local" : {
10745 "type" : "number",
10746 "format" : "float"
10747 },
10748 "gross_amount_local" : {
10749 "type" : "number",
10750 "format" : "float"
10751 },
10752 "vat_amount" : {
10753 "type" : "number",
10754 "format" : "float"
10755 },
10756 "vat_amount_local" : {
10757 "type" : "number",
10758 "format" : "float"
10759 },
10760 "vat_rate_summary" : {
10761 "type" : "array",
10762 "items" : {
10763 "$ref" : "#/components/schemas/DocumentVatRateSummary"
10764 }
10765 }
10766 }
10767 },
10768 "DocumentType" : {
10769 "type" : "string",
10770 "enum" : [ "advance", "canceled", "cancellation", "draft", "invoice", "proforma" ]
10771 },
10772 "DocumentVatRateSummary" : {
10773 "type" : "object",
10774 "properties" : {
10775 "vat_name" : {
10776 "type" : "string"
10777 },
10778 "vat_percentage" : {
10779 "type" : "number",
10780 "format" : "float"
10781 },
10782 "vat_rate_net_amount" : {
10783 "type" : "number",
10784 "format" : "float"
10785 },
10786 "vat_rate_vat_amount" : {
10787 "type" : "number",
10788 "format" : "float"
10789 },
10790 "vat_rate_vat_amount_local" : {
10791 "type" : "number",
10792 "format" : "float"
10793 },
10794 "vat_rate_gross_amount" : {
10795 "type" : "number",
10796 "format" : "float"
10797 }
10798 }
10799 },
10800 "OnlinePayment" : {
10801 "type" : "string",
10802 "enum" : [ "", "Barion", "SimplePay", "no" ]
10803 },
10804 "OnlineSzamlaStatus" : {
10805 "type" : "object",
10806 "properties" : {
10807 "transaction_id" : {
10808 "type" : "string"
10809 },
10810 "status" : {
10811 "type" : "string"
10812 },
10813 "messages" : {
10814 "type" : "array",
10815 "items" : {
10816 "$ref" : "#/components/schemas/OnlineSzamlaStatusMessage"
10817 }
10818 }
10819 }
10820 },
10821 "OnlineSzamlaStatusMessage" : {
10822 "type" : "object",
10823 "properties" : {
10824 "validation_result_code" : {
10825 "type" : "string"
10826 },
10827 "validation_error_code" : {
10828 "type" : "string"
10829 },
10830 "human_readable_message" : {
10831 "type" : "string"
10832 }
10833 }
10834 },
10835 "PaymentHistory" : {
10836 "required" : [ "date", "payment_method", "price" ],
10837 "type" : "object",
10838 "properties" : {
10839 "date" : {
10840 "type" : "string",
10841 "format" : "date"
10842 },
10843 "price" : {
10844 "type" : "number",
10845 "format" : "float"
10846 },
10847 "payment_method" : {
10848 "$ref" : "#/components/schemas/PaymentMethod"
10849 },
10850 "voucher_number" : {
10851 "type" : "string"
10852 },
10853 "conversion_rate" : {
10854 "type" : "number",
10855 "format" : "float"
10856 }
10857 }
10858 },
10859 "PaymentMethod" : {
10860 "type" : "string",
10861 "enum" : [ "aruhitel", "bankcard", "barion", "barter", "cash", "cash_on_delivery", "coupon", "elore_utalas", "ep_kartya", "kompenzacio", "levonas", "online_bankcard", "payoneer", "paypal", "paypal_utolag", "payu", "pick_pack_pont", "postai_csekk", "postautalvany", "skrill", "szep_card", "transferwise", "upwork", "utalvany", "valto", "wire_transfer" ]
10862 },
10863 "PaymentStatus" : {
10864 "type" : "string",
10865 "enum" : [ "expired", "none", "outstanding", "paid", "partially_paid" ]
10866 },
10867 "Round" : {
10868 "type" : "string",
10869 "enum" : [ "five", "none", "one", "ten" ]
10870 },
10871 "SendDocument" : {
10872 "type" : "object",
10873 "properties" : {
10874 "emails" : {
10875 "type" : "array",
10876 "items" : {
10877 "type" : "string"
10878 }
10879 }
10880 }
10881 },
10882 "UnitPriceType" : {
10883 "type" : "string",
10884 "enum" : [ "gross", "net" ]
10885 },
10886 "Vat" : {
10887 "type" : "string",
10888 "enum" : [ "0%", "1%", "10%", "11%", "12%", "13%", "14%", "15%", "16%", "17%", "18%", "19%", "2%", "20%", "21%", "22%", "23%", "24%", "25%", "26%", "27%", "3%", "4%", "5%", "6%", "7%", "8%", "9%", "AAM", "AM", "EU", "EUK", "F.AFA", "FAD", "K.AFA", "MAA", "TAM", "ÁKK", "ÁTHK" ]
10889 },
10890 "DocumentBlock" : {
10891 "type" : "object",
10892 "properties" : {
10893 "id" : {
10894 "type" : "integer"
10895 },
10896 "name" : {
10897 "type" : "string"
10898 },
10899 "prefix" : {
10900 "type" : "string"
10901 },
10902 "custom_field1" : {
10903 "type" : "string"
10904 },
10905 "custom_field2" : {
10906 "type" : "string"
10907 }
10908 }
10909 },
10910 "DocumentBlockList" : {
10911 "type" : "object",
10912 "properties" : {
10913 "data" : {
10914 "type" : "array",
10915 "items" : {
10916 "$ref" : "#/components/schemas/DocumentBlock"
10917 }
10918 },
10919 "total" : {
10920 "type" : "integer"
10921 },
10922 "per_page" : {
10923 "type" : "integer"
10924 },
10925 "current_page" : {
10926 "type" : "integer"
10927 },
10928 "last_page" : {
10929 "type" : "integer"
10930 },
10931 "prev_page_url" : {
10932 "type" : "string"
10933 },
10934 "next_page_url" : {
10935 "type" : "string"
10936 }
10937 },
10938 "description" : "A object with a data property that contains an array of up to limit document blocks. Each entry in the array is a separate document block object. If no more document block are available, the resulting array will be empty."
10939 },
10940 "OrganizationData" : {
10941 "type" : "object",
10942 "properties" : {
10943 "tax_code" : {
10944 "type" : "string"
10945 }
10946 }
10947 },
10948 "Partner" : {
10949 "allOf" : [ {
10950 "$ref" : "#/components/schemas/PartnerUpsert"
10951 }, {
10952 "properties" : {
10953 "id" : {
10954 "type" : "integer"
10955 }
10956 }
10957 } ]
10958 },
10959 "PartnerList" : {
10960 "type" : "object",
10961 "properties" : {
10962 "data" : {
10963 "type" : "array",
10964 "items" : {
10965 "$ref" : "#/components/schemas/Partner"
10966 }
10967 },
10968 "total" : {
10969 "type" : "integer"
10970 },
10971 "per_page" : {
10972 "type" : "integer"
10973 },
10974 "current_page" : {
10975 "type" : "integer"
10976 },
10977 "last_page" : {
10978 "type" : "integer"
10979 },
10980 "prev_page_url" : {
10981 "type" : "string"
10982 },
10983 "next_page_url" : {
10984 "type" : "string"
10985 }
10986 },
10987 "description" : "A object with a data property that contains an array of up to limit partners. Each entry in the array is a separate partner object. If no more partners are available, the resulting array will be empty."
10988 },
10989 "PartnerTaxType" : {
10990 "type" : "string",
10991 "enum" : [ "", "FOREIGN", "HAS_TAX_NUMBER", "NO_TAX_NUMBER" ]
10992 },
10993 "PartnerUpsert" : {
10994 "required" : [ "address", "name" ],
10995 "type" : "object",
10996 "properties" : {
10997 "name" : {
10998 "type" : "string"
10999 },
11000 "address" : {
11001 "$ref" : "#/components/schemas/Address"
11002 },
11003 "emails" : {
11004 "type" : "array",
11005 "items" : {
11006 "type" : "string"
11007 }
11008 },
11009 "taxcode" : {
11010 "type" : "string"
11011 },
11012 "iban" : {
11013 "type" : "string"
11014 },
11015 "swift" : {
11016 "type" : "string"
11017 },
11018 "account_number" : {
11019 "type" : "string"
11020 },
11021 "phone" : {
11022 "type" : "string"
11023 },
11024 "general_ledger_number" : {
11025 "type" : "string"
11026 },
11027 "tax_type" : {
11028 "$ref" : "#/components/schemas/PartnerTaxType"
11029 }
11030 }
11031 },
11032 "Product" : {
11033 "required" : [ "currency", "name", "unit", "vat" ],
11034 "type" : "object",
11035 "properties" : {
11036 "id" : {
11037 "type" : "integer",
11038 "readOnly" : true
11039 },
11040 "name" : {
11041 "type" : "string"
11042 },
11043 "comment" : {
11044 "type" : "string"
11045 },
11046 "currency" : {
11047 "$ref" : "#/components/schemas/Currency"
11048 },
11049 "vat" : {
11050 "$ref" : "#/components/schemas/Vat"
11051 },
11052 "net_unit_price" : {
11053 "type" : "number",
11054 "format" : "float"
11055 },
11056 "unit" : {
11057 "type" : "string"
11058 },
11059 "general_ledger_number" : {
11060 "type" : "string"
11061 },
11062 "general_ledger_taxcode" : {
11063 "type" : "string"
11064 }
11065 }
11066 },
11067 "ProductList" : {
11068 "type" : "object",
11069 "properties" : {
11070 "data" : {
11071 "type" : "array",
11072 "items" : {
11073 "$ref" : "#/components/schemas/Product"
11074 }
11075 },
11076 "total" : {
11077 "type" : "integer"
11078 },
11079 "per_page" : {
11080 "type" : "integer"
11081 },
11082 "current_page" : {
11083 "type" : "integer"
11084 },
11085 "last_page" : {
11086 "type" : "integer"
11087 },
11088 "prev_page_url" : {
11089 "type" : "string"
11090 },
11091 "next_page_url" : {
11092 "type" : "string"
11093 }
11094 },
11095 "description" : "A object with a data property that contains an array of up to limit products. Each entry in the array is a separate product object. If no more products are available, the resulting array will be empty."
11096 },
11097 "Id" : {
11098 "type" : "object",
11099 "properties" : {
11100 "id" : {
11101 "type" : "integer"
11102 },
11103 "legacy_id" : {
11104 "type" : "integer"
11105 }
11106 }
11107 }
11108 },
11109 "responses" : {
11110 "BadRequest" : {
11111 "description" : "The request is malformed.",
11112 "headers" : {
11113 "X-RateLimit-Limit" : {
11114 "description" : "Request limit per minute.",
11115 "style" : "simple",
11116 "explode" : false,
11117 "schema" : {
11118 "type" : "integer",
11119 "format" : "int32"
11120 }
11121 },
11122 "X-RateLimit-Remaining" : {
11123 "description" : "The number of requests left for the time window.",
11124 "style" : "simple",
11125 "explode" : false,
11126 "schema" : {
11127 "type" : "integer",
11128 "format" : "int32"
11129 }
11130 },
11131 "X-RateLimit-Reset" : {
11132 "description" : "The timestamp at which the current rate limit window resets.",
11133 "style" : "simple",
11134 "explode" : false,
11135 "schema" : {
11136 "type" : "integer",
11137 "format" : "int32"
11138 }
11139 },
11140 "Retry-After" : {
11141 "description" : "How many seconds you have to wait before making new request.",
11142 "style" : "simple",
11143 "explode" : false,
11144 "schema" : {
11145 "type" : "integer",
11146 "format" : "int32"
11147 }
11148 }
11149 },
11150 "content" : {
11151 "application/json" : {
11152 "schema" : {
11153 "$ref" : "#/components/schemas/ClientErrorResponse"
11154 }
11155 }
11156 }
11157 },
11158 "Unauthorized" : {
11159 "description" : "Authorization information is missing or invalid.",
11160 "headers" : {
11161 "X-RateLimit-Limit" : {
11162 "description" : "Request limit per minute.",
11163 "style" : "simple",
11164 "explode" : false,
11165 "schema" : {
11166 "type" : "integer",
11167 "format" : "int32"
11168 }
11169 },
11170 "X-RateLimit-Remaining" : {
11171 "description" : "The number of requests left for the time window.",
11172 "style" : "simple",
11173 "explode" : false,
11174 "schema" : {
11175 "type" : "integer",
11176 "format" : "int32"
11177 }
11178 },
11179 "X-RateLimit-Reset" : {
11180 "description" : "The timestamp at which the current rate limit window resets.",
11181 "style" : "simple",
11182 "explode" : false,
11183 "schema" : {
11184 "type" : "integer",
11185 "format" : "int32"
11186 }
11187 },
11188 "Retry-After" : {
11189 "description" : "How many seconds you have to wait before making new request.",
11190 "style" : "simple",
11191 "explode" : false,
11192 "schema" : {
11193 "type" : "integer",
11194 "format" : "int32"
11195 }
11196 }
11197 },
11198 "content" : {
11199 "application/json" : {
11200 "schema" : {
11201 "$ref" : "#/components/schemas/ClientErrorResponse"
11202 }
11203 }
11204 }
11205 },
11206 "Forbidden" : {
11207 "description" : "Authenticated user doesn't have access to the resource.",
11208 "headers" : {
11209 "X-RateLimit-Limit" : {
11210 "description" : "Request limit per minute.",
11211 "style" : "simple",
11212 "explode" : false,
11213 "schema" : {
11214 "type" : "integer",
11215 "format" : "int32"
11216 }
11217 },
11218 "X-RateLimit-Remaining" : {
11219 "description" : "The number of requests left for the time window.",
11220 "style" : "simple",
11221 "explode" : false,
11222 "schema" : {
11223 "type" : "integer",
11224 "format" : "int32"
11225 }
11226 },
11227 "X-RateLimit-Reset" : {
11228 "description" : "The timestamp at which the current rate limit window resets.",
11229 "style" : "simple",
11230 "explode" : false,
11231 "schema" : {
11232 "type" : "integer",
11233 "format" : "int32"
11234 }
11235 },
11236 "Retry-After" : {
11237 "description" : "How many seconds you have to wait before making new request.",
11238 "style" : "simple",
11239 "explode" : false,
11240 "schema" : {
11241 "type" : "integer",
11242 "format" : "int32"
11243 }
11244 }
11245 },
11246 "content" : {
11247 "application/json" : {
11248 "schema" : {
11249 "$ref" : "#/components/schemas/ClientErrorResponse"
11250 }
11251 }
11252 }
11253 },
11254 "NotFound" : {
11255 "description" : "Non-existent resource is requested.",
11256 "headers" : {
11257 "X-RateLimit-Limit" : {
11258 "description" : "Request limit per minute.",
11259 "style" : "simple",
11260 "explode" : false,
11261 "schema" : {
11262 "type" : "integer",
11263 "format" : "int32"
11264 }
11265 },
11266 "X-RateLimit-Remaining" : {
11267 "description" : "The number of requests left for the time window.",
11268 "style" : "simple",
11269 "explode" : false,
11270 "schema" : {
11271 "type" : "integer",
11272 "format" : "int32"
11273 }
11274 },
11275 "X-RateLimit-Reset" : {
11276 "description" : "The timestamp at which the current rate limit window resets.",
11277 "style" : "simple",
11278 "explode" : false,
11279 "schema" : {
11280 "type" : "integer",
11281 "format" : "int32"
11282 }
11283 },
11284 "Retry-After" : {
11285 "description" : "How many seconds you have to wait before making new request.",
11286 "style" : "simple",
11287 "explode" : false,
11288 "schema" : {
11289 "type" : "integer",
11290 "format" : "int32"
11291 }
11292 }
11293 },
11294 "content" : {
11295 "application/json" : {
11296 "schema" : {
11297 "$ref" : "#/components/schemas/ClientErrorResponse"
11298 }
11299 }
11300 }
11301 },
11302 "UnprocessableEntity" : {
11303 "description" : "Validation errors occured.",
11304 "headers" : {
11305 "X-RateLimit-Limit" : {
11306 "description" : "Request limit per minute.",
11307 "style" : "simple",
11308 "explode" : false,
11309 "schema" : {
11310 "type" : "integer",
11311 "format" : "int32"
11312 }
11313 },
11314 "X-RateLimit-Remaining" : {
11315 "description" : "The number of requests left for the time window.",
11316 "style" : "simple",
11317 "explode" : false,
11318 "schema" : {
11319 "type" : "integer",
11320 "format" : "int32"
11321 }
11322 },
11323 "X-RateLimit-Reset" : {
11324 "description" : "The timestamp at which the current rate limit window resets.",
11325 "style" : "simple",
11326 "explode" : false,
11327 "schema" : {
11328 "type" : "integer",
11329 "format" : "int32"
11330 }
11331 },
11332 "Retry-After" : {
11333 "description" : "How many seconds you have to wait before making new request.",
11334 "style" : "simple",
11335 "explode" : false,
11336 "schema" : {
11337 "type" : "integer",
11338 "format" : "int32"
11339 }
11340 }
11341 },
11342 "content" : {
11343 "application/json" : {
11344 "schema" : {
11345 "$ref" : "#/components/schemas/ValidationErrorResponse"
11346 }
11347 }
11348 }
11349 },
11350 "ServerError" : {
11351 "description" : "Internal server error.",
11352 "headers" : {
11353 "X-RateLimit-Limit" : {
11354 "description" : "Request limit per minute.",
11355 "style" : "simple",
11356 "explode" : false,
11357 "schema" : {
11358 "type" : "integer",
11359 "format" : "int32"
11360 }
11361 },
11362 "X-RateLimit-Remaining" : {
11363 "description" : "The number of requests left for the time window.",
11364 "style" : "simple",
11365 "explode" : false,
11366 "schema" : {
11367 "type" : "integer",
11368 "format" : "int32"
11369 }
11370 },
11371 "X-RateLimit-Reset" : {
11372 "description" : "The timestamp at which the current rate limit window resets.",
11373 "style" : "simple",
11374 "explode" : false,
11375 "schema" : {
11376 "type" : "integer",
11377 "format" : "int32"
11378 }
11379 },
11380 "Retry-After" : {
11381 "description" : "How many seconds you have to wait before making new request.",
11382 "style" : "simple",
11383 "explode" : false,
11384 "schema" : {
11385 "type" : "integer",
11386 "format" : "int32"
11387 }
11388 }
11389 },
11390 "content" : {
11391 "application/json" : {
11392 "schema" : {
11393 "$ref" : "#/components/schemas/ServerErrorResponse"
11394 }
11395 }
11396 }
11397 },
11398 "PaymentRequired" : {
11399 "description" : "Authenticated user doesn't have subscription.",
11400 "content" : {
11401 "application/json" : {
11402 "schema" : {
11403 "$ref" : "#/components/schemas/SubscriptionErrorResponse"
11404 }
11405 }
11406 }
11407 }
11408 },
11409 "securitySchemes" : {
11410 "api_key" : {
11411 "type" : "apiKey",
11412 "name" : "X-API-KEY",
11413 "in" : "header"
11414 }
11415 }
11416 }
11417}