flashpi 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +25 -0
- data/LICENSE +21 -0
- data/README.en.md +379 -0
- data/README.md +383 -0
- data/lib/flashpi/api_response.rb +33 -0
- data/lib/flashpi/client.rb +112 -0
- data/lib/flashpi/errors.rb +116 -0
- data/lib/flashpi/internal/engine.rb +355 -0
- data/lib/flashpi/internal/json_text.rb +108 -0
- data/lib/flashpi/internal/multipart.rb +141 -0
- data/lib/flashpi/internal/problems.rb +111 -0
- data/lib/flashpi/internal/request.rb +231 -0
- data/lib/flashpi/internal/resource.rb +125 -0
- data/lib/flashpi/internal/secret.rb +41 -0
- data/lib/flashpi/internal/settings.rb +88 -0
- data/lib/flashpi/internal/transport.rb +432 -0
- data/lib/flashpi/internal/validate.rb +122 -0
- data/lib/flashpi/page.rb +82 -0
- data/lib/flashpi/resources/documents.rb +136 -0
- data/lib/flashpi/resources/events.rb +36 -0
- data/lib/flashpi/resources/issuer_onboardings.rb +47 -0
- data/lib/flashpi/resources/issuers.rb +179 -0
- data/lib/flashpi/resources/webhook_endpoints.rb +110 -0
- data/lib/flashpi/version.rb +6 -0
- data/lib/flashpi/webhooks.rb +223 -0
- data/lib/flashpi.rb +42 -0
- data/sig/flashpi/internal.rbs +376 -0
- data/sig/flashpi/resources.rbs +712 -0
- data/sig/flashpi/sdk_types.rbs +114 -0
- data/sig/flashpi/types.rbs +2495 -0
- data/sig/flashpi.rbs +187 -0
- data/sig/manifest.yaml +8 -0
- metadata +80 -0
|
@@ -0,0 +1,712 @@
|
|
|
1
|
+
# The resources of the client: `client.invoices`, `client.documents`, `client.issuers`...
|
|
2
|
+
#
|
|
3
|
+
# Every method takes the per-call options as keywords: `idempotency_key` (POSTs), `timeout`,
|
|
4
|
+
# `max_retries`, `language`, `correlation_id` and `extra_headers`.
|
|
5
|
+
module Flashpi
|
|
6
|
+
module Resources
|
|
7
|
+
# Issues one document type.
|
|
8
|
+
class DocumentIssuer[B] < Internal::Resource
|
|
9
|
+
# The path of the document type, set by each subclass.
|
|
10
|
+
PATH: String
|
|
11
|
+
DEFAULT_WAIT_SECONDS: Integer
|
|
12
|
+
SYNC_MARGIN_SECONDS: Integer
|
|
13
|
+
def self.sync_timeout_floor: (untyped body) -> Float
|
|
14
|
+
def self.member: (untyped value, Symbol name) -> untyped
|
|
15
|
+
|
|
16
|
+
def with_response: () -> DocumentIssuer::WithResponse[B]
|
|
17
|
+
|
|
18
|
+
def create: (
|
|
19
|
+
B body,
|
|
20
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
21
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
22
|
+
) -> Types::document
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
# `DocumentIssuer`'s methods, returning an APIResponse with the HTTP status, headers and request id.
|
|
26
|
+
class DocumentIssuer::WithResponse[B] < Internal::ResponseView
|
|
27
|
+
def initialize: (DocumentIssuer[B] resource) -> void
|
|
28
|
+
|
|
29
|
+
def create: (
|
|
30
|
+
B body,
|
|
31
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
32
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
33
|
+
) -> APIResponse[Types::document]
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Every issued document, of any type: search, XML, RIDE (PDF) and email.
|
|
37
|
+
class Documents < Internal::Resource
|
|
38
|
+
XML_ACCEPT: String
|
|
39
|
+
PDF_ACCEPT: String
|
|
40
|
+
XML_KINDS: Array[String]
|
|
41
|
+
|
|
42
|
+
def with_response: () -> Documents::WithResponse
|
|
43
|
+
|
|
44
|
+
def list: (
|
|
45
|
+
?Types::document_list_params? params,
|
|
46
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
47
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
48
|
+
) -> Page[Types::document]
|
|
49
|
+
|
|
50
|
+
def get: (
|
|
51
|
+
String document_id,
|
|
52
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
53
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
54
|
+
) -> Types::document
|
|
55
|
+
|
|
56
|
+
def xml: (
|
|
57
|
+
String document_id,
|
|
58
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
59
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
60
|
+
) -> Types::document_xml
|
|
61
|
+
|
|
62
|
+
def pdf: (
|
|
63
|
+
String document_id,
|
|
64
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
65
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
66
|
+
) -> String
|
|
67
|
+
|
|
68
|
+
def send_email: (
|
|
69
|
+
String document_id,
|
|
70
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
71
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
72
|
+
) -> Types::document
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# `Documents`'s methods, returning an APIResponse with the HTTP status, headers and request id.
|
|
76
|
+
class Documents::WithResponse < Internal::ResponseView
|
|
77
|
+
def initialize: (Documents resource) -> void
|
|
78
|
+
|
|
79
|
+
def list: (
|
|
80
|
+
?Types::document_list_params? params,
|
|
81
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
82
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
83
|
+
) -> APIResponse[Page[Types::document]]
|
|
84
|
+
|
|
85
|
+
def get: (
|
|
86
|
+
String document_id,
|
|
87
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
88
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
89
|
+
) -> APIResponse[Types::document]
|
|
90
|
+
|
|
91
|
+
def xml: (
|
|
92
|
+
String document_id,
|
|
93
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
94
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
95
|
+
) -> APIResponse[Types::document_xml]
|
|
96
|
+
|
|
97
|
+
def pdf: (
|
|
98
|
+
String document_id,
|
|
99
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
100
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
101
|
+
) -> APIResponse[String]
|
|
102
|
+
|
|
103
|
+
def send_email: (
|
|
104
|
+
String document_id,
|
|
105
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
106
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
107
|
+
) -> APIResponse[Types::document]
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Emission points (the second 3-digit series code) of an establishment.
|
|
111
|
+
class EmissionPoints < Internal::Resource
|
|
112
|
+
PATH: String
|
|
113
|
+
ITEM: String
|
|
114
|
+
|
|
115
|
+
def with_response: () -> EmissionPoints::WithResponse
|
|
116
|
+
|
|
117
|
+
def create: (
|
|
118
|
+
String issuer_id,
|
|
119
|
+
String establishment_id,
|
|
120
|
+
Types::create_emission_point body,
|
|
121
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
122
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
123
|
+
) -> Types::emission_point
|
|
124
|
+
|
|
125
|
+
def list: (
|
|
126
|
+
String issuer_id,
|
|
127
|
+
String establishment_id,
|
|
128
|
+
?Types::emission_point_list_params? params,
|
|
129
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
130
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
131
|
+
) -> Page[Types::emission_point]
|
|
132
|
+
|
|
133
|
+
def get: (
|
|
134
|
+
String issuer_id,
|
|
135
|
+
String establishment_id,
|
|
136
|
+
String emission_point_id,
|
|
137
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
138
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
139
|
+
) -> Types::emission_point
|
|
140
|
+
|
|
141
|
+
def delete: (
|
|
142
|
+
String issuer_id,
|
|
143
|
+
String establishment_id,
|
|
144
|
+
String emission_point_id,
|
|
145
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
146
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
147
|
+
) -> nil
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
# `EmissionPoints`'s methods, returning an APIResponse with the HTTP status, headers and request id.
|
|
151
|
+
class EmissionPoints::WithResponse < Internal::ResponseView
|
|
152
|
+
def initialize: (EmissionPoints resource) -> void
|
|
153
|
+
|
|
154
|
+
def create: (
|
|
155
|
+
String issuer_id,
|
|
156
|
+
String establishment_id,
|
|
157
|
+
Types::create_emission_point body,
|
|
158
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
159
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
160
|
+
) -> APIResponse[Types::emission_point]
|
|
161
|
+
|
|
162
|
+
def list: (
|
|
163
|
+
String issuer_id,
|
|
164
|
+
String establishment_id,
|
|
165
|
+
?Types::emission_point_list_params? params,
|
|
166
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
167
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
168
|
+
) -> APIResponse[Page[Types::emission_point]]
|
|
169
|
+
|
|
170
|
+
def get: (
|
|
171
|
+
String issuer_id,
|
|
172
|
+
String establishment_id,
|
|
173
|
+
String emission_point_id,
|
|
174
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
175
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
176
|
+
) -> APIResponse[Types::emission_point]
|
|
177
|
+
|
|
178
|
+
def delete: (
|
|
179
|
+
String issuer_id,
|
|
180
|
+
String establishment_id,
|
|
181
|
+
String emission_point_id,
|
|
182
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
183
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
184
|
+
) -> APIResponse[nil]
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
# Establishments (the 3-digit series codes such as `001`) of an issuer.
|
|
188
|
+
class Establishments < Internal::Resource
|
|
189
|
+
PATH: String
|
|
190
|
+
ITEM: String
|
|
191
|
+
|
|
192
|
+
attr_reader emission_points: EmissionPoints
|
|
193
|
+
def initialize: (Internal::Engine engine) -> void
|
|
194
|
+
|
|
195
|
+
def with_response: () -> Establishments::WithResponse
|
|
196
|
+
|
|
197
|
+
def create: (
|
|
198
|
+
String issuer_id,
|
|
199
|
+
Types::create_establishment body,
|
|
200
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
201
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
202
|
+
) -> Types::establishment
|
|
203
|
+
|
|
204
|
+
def list: (
|
|
205
|
+
String issuer_id,
|
|
206
|
+
?Types::establishment_list_params? params,
|
|
207
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
208
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
209
|
+
) -> Page[Types::establishment]
|
|
210
|
+
|
|
211
|
+
def get: (
|
|
212
|
+
String issuer_id,
|
|
213
|
+
String establishment_id,
|
|
214
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
215
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
216
|
+
) -> Types::establishment
|
|
217
|
+
|
|
218
|
+
def update: (
|
|
219
|
+
String issuer_id,
|
|
220
|
+
String establishment_id,
|
|
221
|
+
Types::update_establishment body,
|
|
222
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
223
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
224
|
+
) -> Types::establishment
|
|
225
|
+
|
|
226
|
+
def delete: (
|
|
227
|
+
String issuer_id,
|
|
228
|
+
String establishment_id,
|
|
229
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
230
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
231
|
+
) -> nil
|
|
232
|
+
end
|
|
233
|
+
|
|
234
|
+
# `Establishments`'s methods, returning an APIResponse with the HTTP status, headers and request id.
|
|
235
|
+
class Establishments::WithResponse < Internal::ResponseView
|
|
236
|
+
def initialize: (Establishments resource) -> void
|
|
237
|
+
|
|
238
|
+
def create: (
|
|
239
|
+
String issuer_id,
|
|
240
|
+
Types::create_establishment body,
|
|
241
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
242
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
243
|
+
) -> APIResponse[Types::establishment]
|
|
244
|
+
|
|
245
|
+
def list: (
|
|
246
|
+
String issuer_id,
|
|
247
|
+
?Types::establishment_list_params? params,
|
|
248
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
249
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
250
|
+
) -> APIResponse[Page[Types::establishment]]
|
|
251
|
+
|
|
252
|
+
def get: (
|
|
253
|
+
String issuer_id,
|
|
254
|
+
String establishment_id,
|
|
255
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
256
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
257
|
+
) -> APIResponse[Types::establishment]
|
|
258
|
+
|
|
259
|
+
def update: (
|
|
260
|
+
String issuer_id,
|
|
261
|
+
String establishment_id,
|
|
262
|
+
Types::update_establishment body,
|
|
263
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
264
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
265
|
+
) -> APIResponse[Types::establishment]
|
|
266
|
+
|
|
267
|
+
def delete: (
|
|
268
|
+
String issuer_id,
|
|
269
|
+
String establishment_id,
|
|
270
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
271
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
272
|
+
) -> APIResponse[nil]
|
|
273
|
+
end
|
|
274
|
+
|
|
275
|
+
# The .p12 certificates (firmas electrónicas) of an issuer.
|
|
276
|
+
class Certificates < Internal::Resource
|
|
277
|
+
PATH: String
|
|
278
|
+
ITEM: String
|
|
279
|
+
|
|
280
|
+
def with_response: () -> Certificates::WithResponse
|
|
281
|
+
|
|
282
|
+
def upload: (
|
|
283
|
+
String issuer_id,
|
|
284
|
+
Types::certificate_upload upload,
|
|
285
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
286
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
287
|
+
) -> Types::certificate
|
|
288
|
+
|
|
289
|
+
def list: (
|
|
290
|
+
String issuer_id,
|
|
291
|
+
?Types::certificate_list_params? params,
|
|
292
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
293
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
294
|
+
) -> Page[Types::certificate]
|
|
295
|
+
|
|
296
|
+
def get: (
|
|
297
|
+
String issuer_id,
|
|
298
|
+
String certificate_id,
|
|
299
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
300
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
301
|
+
) -> Types::certificate
|
|
302
|
+
end
|
|
303
|
+
|
|
304
|
+
# `Certificates`'s methods, returning an APIResponse with the HTTP status, headers and request id.
|
|
305
|
+
class Certificates::WithResponse < Internal::ResponseView
|
|
306
|
+
def initialize: (Certificates resource) -> void
|
|
307
|
+
|
|
308
|
+
def upload: (
|
|
309
|
+
String issuer_id,
|
|
310
|
+
Types::certificate_upload upload,
|
|
311
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
312
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
313
|
+
) -> APIResponse[Types::certificate]
|
|
314
|
+
|
|
315
|
+
def list: (
|
|
316
|
+
String issuer_id,
|
|
317
|
+
?Types::certificate_list_params? params,
|
|
318
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
319
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
320
|
+
) -> APIResponse[Page[Types::certificate]]
|
|
321
|
+
|
|
322
|
+
def get: (
|
|
323
|
+
String issuer_id,
|
|
324
|
+
String certificate_id,
|
|
325
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
326
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
327
|
+
) -> APIResponse[Types::certificate]
|
|
328
|
+
end
|
|
329
|
+
|
|
330
|
+
# The issuers (RUCs) of the account, with their establishments, emission points and .p12 certificates.
|
|
331
|
+
class Issuers < Internal::Resource
|
|
332
|
+
PATH: String
|
|
333
|
+
ITEM: String
|
|
334
|
+
|
|
335
|
+
attr_reader establishments: Establishments
|
|
336
|
+
attr_reader certificates: Certificates
|
|
337
|
+
def initialize: (Internal::Engine engine) -> void
|
|
338
|
+
|
|
339
|
+
def with_response: () -> Issuers::WithResponse
|
|
340
|
+
|
|
341
|
+
def create: (
|
|
342
|
+
Types::create_issuer body,
|
|
343
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
344
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
345
|
+
) -> Types::issuer
|
|
346
|
+
|
|
347
|
+
def list: (
|
|
348
|
+
?Types::issuer_list_params? params,
|
|
349
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
350
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
351
|
+
) -> Page[Types::issuer]
|
|
352
|
+
|
|
353
|
+
def get: (
|
|
354
|
+
String issuer_id,
|
|
355
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
356
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
357
|
+
) -> Types::issuer
|
|
358
|
+
|
|
359
|
+
def update: (
|
|
360
|
+
String issuer_id,
|
|
361
|
+
Types::update_issuer body,
|
|
362
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
363
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
364
|
+
) -> Types::issuer
|
|
365
|
+
|
|
366
|
+
def delete: (
|
|
367
|
+
String issuer_id,
|
|
368
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
369
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
370
|
+
) -> nil
|
|
371
|
+
end
|
|
372
|
+
|
|
373
|
+
# `Issuers`'s methods, returning an APIResponse with the HTTP status, headers and request id.
|
|
374
|
+
class Issuers::WithResponse < Internal::ResponseView
|
|
375
|
+
def initialize: (Issuers resource) -> void
|
|
376
|
+
|
|
377
|
+
def create: (
|
|
378
|
+
Types::create_issuer body,
|
|
379
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
380
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
381
|
+
) -> APIResponse[Types::issuer]
|
|
382
|
+
|
|
383
|
+
def list: (
|
|
384
|
+
?Types::issuer_list_params? params,
|
|
385
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
386
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
387
|
+
) -> APIResponse[Page[Types::issuer]]
|
|
388
|
+
|
|
389
|
+
def get: (
|
|
390
|
+
String issuer_id,
|
|
391
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
392
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
393
|
+
) -> APIResponse[Types::issuer]
|
|
394
|
+
|
|
395
|
+
def update: (
|
|
396
|
+
String issuer_id,
|
|
397
|
+
Types::update_issuer body,
|
|
398
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
399
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
400
|
+
) -> APIResponse[Types::issuer]
|
|
401
|
+
|
|
402
|
+
def delete: (
|
|
403
|
+
String issuer_id,
|
|
404
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
405
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
406
|
+
) -> APIResponse[nil]
|
|
407
|
+
end
|
|
408
|
+
|
|
409
|
+
# Creates an issuer from its .p12 certificate.
|
|
410
|
+
class IssuerOnboardings < Internal::Resource
|
|
411
|
+
def with_response: () -> IssuerOnboardings::WithResponse
|
|
412
|
+
|
|
413
|
+
def create: (
|
|
414
|
+
Types::certificate_upload upload,
|
|
415
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
416
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
417
|
+
) -> Types::issuer_onboarding
|
|
418
|
+
|
|
419
|
+
def get: (
|
|
420
|
+
String onboarding_id,
|
|
421
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
422
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
423
|
+
) -> Types::issuer_onboarding
|
|
424
|
+
|
|
425
|
+
def complete: (
|
|
426
|
+
String onboarding_id,
|
|
427
|
+
?Types::complete_issuer_onboarding? body,
|
|
428
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
429
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
430
|
+
) -> Types::completed_issuer_onboarding
|
|
431
|
+
end
|
|
432
|
+
|
|
433
|
+
# `IssuerOnboardings`'s methods, returning an APIResponse with the HTTP status, headers and request id.
|
|
434
|
+
class IssuerOnboardings::WithResponse < Internal::ResponseView
|
|
435
|
+
def initialize: (IssuerOnboardings resource) -> void
|
|
436
|
+
|
|
437
|
+
def create: (
|
|
438
|
+
Types::certificate_upload upload,
|
|
439
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
440
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
441
|
+
) -> APIResponse[Types::issuer_onboarding]
|
|
442
|
+
|
|
443
|
+
def get: (
|
|
444
|
+
String onboarding_id,
|
|
445
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
446
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
447
|
+
) -> APIResponse[Types::issuer_onboarding]
|
|
448
|
+
|
|
449
|
+
def complete: (
|
|
450
|
+
String onboarding_id,
|
|
451
|
+
?Types::complete_issuer_onboarding? body,
|
|
452
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
453
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
454
|
+
) -> APIResponse[Types::completed_issuer_onboarding]
|
|
455
|
+
end
|
|
456
|
+
|
|
457
|
+
# Deliveries of events to one endpoint.
|
|
458
|
+
class WebhookDeliveries < Internal::Resource
|
|
459
|
+
PATH: String
|
|
460
|
+
ITEM: String
|
|
461
|
+
|
|
462
|
+
def with_response: () -> WebhookDeliveries::WithResponse
|
|
463
|
+
|
|
464
|
+
def list: (
|
|
465
|
+
String endpoint_id,
|
|
466
|
+
?Types::webhook_delivery_list_params? params,
|
|
467
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
468
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
469
|
+
) -> Page[Types::webhook_delivery]
|
|
470
|
+
|
|
471
|
+
def get: (
|
|
472
|
+
String endpoint_id,
|
|
473
|
+
String delivery_id,
|
|
474
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
475
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
476
|
+
) -> Types::webhook_delivery_detail
|
|
477
|
+
|
|
478
|
+
def replay: (
|
|
479
|
+
String endpoint_id,
|
|
480
|
+
String delivery_id,
|
|
481
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
482
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
483
|
+
) -> Types::webhook_delivery_detail
|
|
484
|
+
end
|
|
485
|
+
|
|
486
|
+
# `WebhookDeliveries`'s methods, returning an APIResponse with the HTTP status, headers and request id.
|
|
487
|
+
class WebhookDeliveries::WithResponse < Internal::ResponseView
|
|
488
|
+
def initialize: (WebhookDeliveries resource) -> void
|
|
489
|
+
|
|
490
|
+
def list: (
|
|
491
|
+
String endpoint_id,
|
|
492
|
+
?Types::webhook_delivery_list_params? params,
|
|
493
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
494
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
495
|
+
) -> APIResponse[Page[Types::webhook_delivery]]
|
|
496
|
+
|
|
497
|
+
def get: (
|
|
498
|
+
String endpoint_id,
|
|
499
|
+
String delivery_id,
|
|
500
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
501
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
502
|
+
) -> APIResponse[Types::webhook_delivery_detail]
|
|
503
|
+
|
|
504
|
+
def replay: (
|
|
505
|
+
String endpoint_id,
|
|
506
|
+
String delivery_id,
|
|
507
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
508
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
509
|
+
) -> APIResponse[Types::webhook_delivery_detail]
|
|
510
|
+
end
|
|
511
|
+
|
|
512
|
+
# The URLs Flashpi sends events to.
|
|
513
|
+
class WebhookEndpoints < Internal::Resource
|
|
514
|
+
PATH: String
|
|
515
|
+
ITEM: String
|
|
516
|
+
|
|
517
|
+
attr_reader deliveries: WebhookDeliveries
|
|
518
|
+
def initialize: (Internal::Engine engine) -> void
|
|
519
|
+
|
|
520
|
+
def with_response: () -> WebhookEndpoints::WithResponse
|
|
521
|
+
|
|
522
|
+
def create: (
|
|
523
|
+
Types::create_webhook_endpoint body,
|
|
524
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
525
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
526
|
+
) -> Types::webhook_endpoint
|
|
527
|
+
|
|
528
|
+
def list: (
|
|
529
|
+
?Types::webhook_endpoint_list_params? params,
|
|
530
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
531
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
532
|
+
) -> Page[Types::webhook_endpoint]
|
|
533
|
+
|
|
534
|
+
def get: (
|
|
535
|
+
String endpoint_id,
|
|
536
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
537
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
538
|
+
) -> Types::webhook_endpoint
|
|
539
|
+
|
|
540
|
+
def update: (
|
|
541
|
+
String endpoint_id,
|
|
542
|
+
Types::update_webhook_endpoint body,
|
|
543
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
544
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
545
|
+
) -> Types::webhook_endpoint
|
|
546
|
+
|
|
547
|
+
def delete: (
|
|
548
|
+
String endpoint_id,
|
|
549
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
550
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
551
|
+
) -> nil
|
|
552
|
+
|
|
553
|
+
def get_secret: (
|
|
554
|
+
String endpoint_id,
|
|
555
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
556
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
557
|
+
) -> Types::webhook_endpoint_secret
|
|
558
|
+
|
|
559
|
+
def rotate_secret: (
|
|
560
|
+
String endpoint_id,
|
|
561
|
+
?Types::rotate_webhook_endpoint_secret? body,
|
|
562
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
563
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
564
|
+
) -> Types::webhook_endpoint
|
|
565
|
+
|
|
566
|
+
def verify: (
|
|
567
|
+
String endpoint_id,
|
|
568
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
569
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
570
|
+
) -> Types::webhook_endpoint
|
|
571
|
+
end
|
|
572
|
+
|
|
573
|
+
# `WebhookEndpoints`'s methods, returning an APIResponse with the HTTP status, headers and request id.
|
|
574
|
+
class WebhookEndpoints::WithResponse < Internal::ResponseView
|
|
575
|
+
def initialize: (WebhookEndpoints resource) -> void
|
|
576
|
+
|
|
577
|
+
def create: (
|
|
578
|
+
Types::create_webhook_endpoint body,
|
|
579
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
580
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
581
|
+
) -> APIResponse[Types::webhook_endpoint]
|
|
582
|
+
|
|
583
|
+
def list: (
|
|
584
|
+
?Types::webhook_endpoint_list_params? params,
|
|
585
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
586
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
587
|
+
) -> APIResponse[Page[Types::webhook_endpoint]]
|
|
588
|
+
|
|
589
|
+
def get: (
|
|
590
|
+
String endpoint_id,
|
|
591
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
592
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
593
|
+
) -> APIResponse[Types::webhook_endpoint]
|
|
594
|
+
|
|
595
|
+
def update: (
|
|
596
|
+
String endpoint_id,
|
|
597
|
+
Types::update_webhook_endpoint body,
|
|
598
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
599
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
600
|
+
) -> APIResponse[Types::webhook_endpoint]
|
|
601
|
+
|
|
602
|
+
def delete: (
|
|
603
|
+
String endpoint_id,
|
|
604
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
605
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
606
|
+
) -> APIResponse[nil]
|
|
607
|
+
|
|
608
|
+
def get_secret: (
|
|
609
|
+
String endpoint_id,
|
|
610
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
611
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
612
|
+
) -> APIResponse[Types::webhook_endpoint_secret]
|
|
613
|
+
|
|
614
|
+
def rotate_secret: (
|
|
615
|
+
String endpoint_id,
|
|
616
|
+
?Types::rotate_webhook_endpoint_secret? body,
|
|
617
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
618
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
619
|
+
) -> APIResponse[Types::webhook_endpoint]
|
|
620
|
+
|
|
621
|
+
def verify: (
|
|
622
|
+
String endpoint_id,
|
|
623
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
624
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
625
|
+
) -> APIResponse[Types::webhook_endpoint]
|
|
626
|
+
end
|
|
627
|
+
|
|
628
|
+
# Events: what happened to documents, certificates and email sending, newest first.
|
|
629
|
+
class Events < Internal::Resource
|
|
630
|
+
def with_response: () -> Events::WithResponse
|
|
631
|
+
|
|
632
|
+
def list: (
|
|
633
|
+
?Types::event_list_params? params,
|
|
634
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
635
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
636
|
+
) -> Page[Types::event]
|
|
637
|
+
|
|
638
|
+
def get: (
|
|
639
|
+
String event_id,
|
|
640
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
641
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
642
|
+
) -> Types::event
|
|
643
|
+
end
|
|
644
|
+
|
|
645
|
+
# `Events`'s methods, returning an APIResponse with the HTTP status, headers and request id.
|
|
646
|
+
class Events::WithResponse < Internal::ResponseView
|
|
647
|
+
def initialize: (Events resource) -> void
|
|
648
|
+
|
|
649
|
+
def list: (
|
|
650
|
+
?Types::event_list_params? params,
|
|
651
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
652
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
653
|
+
) -> APIResponse[Page[Types::event]]
|
|
654
|
+
|
|
655
|
+
def get: (
|
|
656
|
+
String event_id,
|
|
657
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
658
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
659
|
+
) -> APIResponse[Types::event]
|
|
660
|
+
end
|
|
661
|
+
|
|
662
|
+
# The API's own status.
|
|
663
|
+
class Status < Internal::Resource
|
|
664
|
+
def with_response: () -> Status::WithResponse
|
|
665
|
+
|
|
666
|
+
def get: (
|
|
667
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
668
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
669
|
+
) -> Types::status
|
|
670
|
+
end
|
|
671
|
+
|
|
672
|
+
# `Status`'s methods, returning an APIResponse with the HTTP status, headers and request id.
|
|
673
|
+
class Status::WithResponse < Internal::ResponseView
|
|
674
|
+
def initialize: (Status resource) -> void
|
|
675
|
+
|
|
676
|
+
def get: (
|
|
677
|
+
?idempotency_key: String?, ?timeout: Types::seconds?, ?max_retries: Integer?,
|
|
678
|
+
?language: Types::request_language?, ?correlation_id: String?, ?extra_headers: Types::headers?
|
|
679
|
+
) -> APIResponse[Types::status]
|
|
680
|
+
end
|
|
681
|
+
|
|
682
|
+
# Invoices (facturas).
|
|
683
|
+
class Invoices < DocumentIssuer[Types::create_invoice]
|
|
684
|
+
PATH: String
|
|
685
|
+
end
|
|
686
|
+
|
|
687
|
+
# Credit notes (notas de crédito).
|
|
688
|
+
class CreditNotes < DocumentIssuer[Types::create_credit_note]
|
|
689
|
+
PATH: String
|
|
690
|
+
end
|
|
691
|
+
|
|
692
|
+
# Debit notes (notas de débito).
|
|
693
|
+
class DebitNotes < DocumentIssuer[Types::create_debit_note]
|
|
694
|
+
PATH: String
|
|
695
|
+
end
|
|
696
|
+
|
|
697
|
+
# Purchase settlements (liquidaciones de compra).
|
|
698
|
+
class PurchaseSettlements < DocumentIssuer[Types::create_purchase_settlement]
|
|
699
|
+
PATH: String
|
|
700
|
+
end
|
|
701
|
+
|
|
702
|
+
# Waybills (guías de remisión).
|
|
703
|
+
class Waybills < DocumentIssuer[Types::create_waybill]
|
|
704
|
+
PATH: String
|
|
705
|
+
end
|
|
706
|
+
|
|
707
|
+
# Withholding receipts (comprobantes de retención).
|
|
708
|
+
class Withholdings < DocumentIssuer[Types::create_withholding]
|
|
709
|
+
PATH: String
|
|
710
|
+
end
|
|
711
|
+
end
|
|
712
|
+
end
|