UNPKG

@adaptive-recognition/carmen-cloud-client

Version:

Node.js client for Carmen Cloud by Adaptive Recognition. Efficiently read license plates, recognize vehicle details, and process container, railway wagon, and US DOT codes.

157 lines (156 loc) • 5.6 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
{ "type": "array", "title": "Usage Plans", "description": "List of Usage Plans.", "items": { "type": "object", "title": "Usage Plan", "description": "The properties of a Usage Plan.", "properties": { "id": { "type": "string", "title": "ID", "description": "The unique identifier of the usage plan." }, "name": { "type": "string", "title": "Name", "description": "The name of the usage plan." }, "description": { "type": "string", "title": "Description", "description": "The description of the usage plan." }, "apis": { "type": "array", "title": "APIs", "description": "The friendly identifiers of the APIs this usage plan applies to.", "items": { "type": "string" } }, "apiStages": { "type": "object", "title": "API Stages", "description": "The API stages this usage plan applies to.", "properties": { "apiId": { "type": "string", "title": "API ID", "description": "The ID of the API." }, "stage": { "type": "string", "title": "API Stage", "description": "The friendly identifier of the stage." } }, "required": [ "apiId", "stage" ] }, "quota": { "type": "object", "title": "Quota", "description": "The number of requests included in this usage plan.", "properties": { "limit": { "type": "number", "title": "Limit", "description": "The maximum number of requests in one period." }, "offset": { "type": "number", "title": "Offset", "description": "When the quota window starts inside a calendar period (e.g. if `offset` is 10 and `period` is `MONTH`, counting requests restarts on the 10th of every calendar month)." }, "period": { "type": "string", "enum": [ "DAY", "MONTH" ], "title": "Period", "description": "The calendar period the quota applies to." } }, "required": [ "limit", "offset", "period" ] }, "throttle": { "type": "object", "title": "Throttle", "description": "Request rate and conncurrency limits that apply for this Usage Plan.", "properties": { "rateLimit": { "type": "number", "title": "Rate Limit", "description": "The maximum rate (requests/second)." }, "burstLimit": { "type": "number", "title": "Burst Limit", "description": "The maximum number of concurrent requests." } }, "required": [ "rateLimit", "burstLimit" ] }, "autoSignup": { "type": "boolean", "title": "Auto Sign-Up", "description": "Tor internal use only." }, "dimensions": { "type": "array", "title": "Dimensions", "description": "The paid subscription dimensions this usage plan applies to.", "items": { "type": "string" } }, "stripeProductCode": { "type": "string", "title": "Stripe Product Code", "description": "For internal use only." }, "marketplaceProductCode": { "type": "string", "title": "Marketplace Product Code", "description": "For internal use only." }, "enabled": { "type": "boolean", "title": "Enabled", "description": "For internal use only." }, "paid": { "type": "boolean", "title": "Paid", "description": "Indicates whether this usage plan applies to one or more paid subscription dimenions or the free tier." } }, "required": [ "id", "name", "description", "apis", "apiStages", "quota", "throttle", "autoSignup", "dimensions", "stripeProductCode", "marketplaceProductCode", "enabled", "paid" ] } }