pluggy-sdk 1.0.0.post42__py3-none-any.whl → 1.0.0.post43__py3-none-any.whl
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.
- pluggy_sdk/__init__.py +175 -23
- pluggy_sdk/api/__init__.py +0 -3
- pluggy_sdk/api/payment_request_api.py +0 -1074
- pluggy_sdk/api_client.py +1 -1
- pluggy_sdk/configuration.py +1 -1
- pluggy_sdk/models/__init__.py +0 -19
- pluggy_sdk/models/create_payment_intent.py +4 -6
- pluggy_sdk/models/create_payment_recipient.py +2 -4
- pluggy_sdk/models/create_payment_request.py +1 -3
- pluggy_sdk/models/payment_intent.py +1 -7
- pluggy_sdk/models/payment_recipient.py +2 -4
- pluggy_sdk/models/smart_transfer_payment.py +3 -3
- {pluggy_sdk-1.0.0.post42.dist-info → pluggy_sdk-1.0.0.post43.dist-info}/METADATA +3 -38
- {pluggy_sdk-1.0.0.post42.dist-info → pluggy_sdk-1.0.0.post43.dist-info}/RECORD +16 -16
- {pluggy_sdk-1.0.0.post42.dist-info → pluggy_sdk-1.0.0.post43.dist-info}/WHEEL +1 -1
- {pluggy_sdk-1.0.0.post42.dist-info → pluggy_sdk-1.0.0.post43.dist-info}/top_level.txt +0 -0
@@ -22,9 +22,7 @@ from typing_extensions import Annotated
|
|
22
22
|
from pluggy_sdk.models.create_boleto_payment_request import CreateBoletoPaymentRequest
|
23
23
|
from pluggy_sdk.models.create_payment_request import CreatePaymentRequest
|
24
24
|
from pluggy_sdk.models.create_pix_qr_payment_request import CreatePixQrPaymentRequest
|
25
|
-
from pluggy_sdk.models.payment_receipt import PaymentReceipt
|
26
25
|
from pluggy_sdk.models.payment_request import PaymentRequest
|
27
|
-
from pluggy_sdk.models.payment_request_receipt_list200_response import PaymentRequestReceiptList200Response
|
28
26
|
from pluggy_sdk.models.payment_requests_list200_response import PaymentRequestsList200Response
|
29
27
|
from pluggy_sdk.models.update_payment_request import UpdatePaymentRequest
|
30
28
|
|
@@ -1132,1078 +1130,6 @@ class PaymentRequestApi:
|
|
1132
1130
|
|
1133
1131
|
|
1134
1132
|
|
1135
|
-
@validate_call
|
1136
|
-
def payment_request_receipt_create(
|
1137
|
-
self,
|
1138
|
-
id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
|
1139
|
-
_request_timeout: Union[
|
1140
|
-
None,
|
1141
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1142
|
-
Tuple[
|
1143
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1144
|
-
Annotated[StrictFloat, Field(gt=0)]
|
1145
|
-
]
|
1146
|
-
] = None,
|
1147
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
1148
|
-
_content_type: Optional[StrictStr] = None,
|
1149
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
1150
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
1151
|
-
) -> PaymentReceipt:
|
1152
|
-
"""Create Payment Receipt
|
1153
|
-
|
1154
|
-
Creates the payment receipt resource
|
1155
|
-
|
1156
|
-
:param id: Payment request primary identifier (required)
|
1157
|
-
:type id: str
|
1158
|
-
:param _request_timeout: timeout setting for this request. If one
|
1159
|
-
number provided, it will be total request
|
1160
|
-
timeout. It can also be a pair (tuple) of
|
1161
|
-
(connection, read) timeouts.
|
1162
|
-
:type _request_timeout: int, tuple(int, int), optional
|
1163
|
-
:param _request_auth: set to override the auth_settings for an a single
|
1164
|
-
request; this effectively ignores the
|
1165
|
-
authentication in the spec for a single request.
|
1166
|
-
:type _request_auth: dict, optional
|
1167
|
-
:param _content_type: force content-type for the request.
|
1168
|
-
:type _content_type: str, Optional
|
1169
|
-
:param _headers: set to override the headers for a single
|
1170
|
-
request; this effectively ignores the headers
|
1171
|
-
in the spec for a single request.
|
1172
|
-
:type _headers: dict, optional
|
1173
|
-
:param _host_index: set to override the host_index for a single
|
1174
|
-
request; this effectively ignores the host_index
|
1175
|
-
in the spec for a single request.
|
1176
|
-
:type _host_index: int, optional
|
1177
|
-
:return: Returns the result object.
|
1178
|
-
""" # noqa: E501
|
1179
|
-
|
1180
|
-
_param = self._payment_request_receipt_create_serialize(
|
1181
|
-
id=id,
|
1182
|
-
_request_auth=_request_auth,
|
1183
|
-
_content_type=_content_type,
|
1184
|
-
_headers=_headers,
|
1185
|
-
_host_index=_host_index
|
1186
|
-
)
|
1187
|
-
|
1188
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
1189
|
-
'200': "PaymentReceipt",
|
1190
|
-
}
|
1191
|
-
response_data = self.api_client.call_api(
|
1192
|
-
*_param,
|
1193
|
-
_request_timeout=_request_timeout
|
1194
|
-
)
|
1195
|
-
response_data.read()
|
1196
|
-
return self.api_client.response_deserialize(
|
1197
|
-
response_data=response_data,
|
1198
|
-
response_types_map=_response_types_map,
|
1199
|
-
).data
|
1200
|
-
|
1201
|
-
|
1202
|
-
@validate_call
|
1203
|
-
def payment_request_receipt_create_with_http_info(
|
1204
|
-
self,
|
1205
|
-
id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
|
1206
|
-
_request_timeout: Union[
|
1207
|
-
None,
|
1208
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1209
|
-
Tuple[
|
1210
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1211
|
-
Annotated[StrictFloat, Field(gt=0)]
|
1212
|
-
]
|
1213
|
-
] = None,
|
1214
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
1215
|
-
_content_type: Optional[StrictStr] = None,
|
1216
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
1217
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
1218
|
-
) -> ApiResponse[PaymentReceipt]:
|
1219
|
-
"""Create Payment Receipt
|
1220
|
-
|
1221
|
-
Creates the payment receipt resource
|
1222
|
-
|
1223
|
-
:param id: Payment request primary identifier (required)
|
1224
|
-
:type id: str
|
1225
|
-
:param _request_timeout: timeout setting for this request. If one
|
1226
|
-
number provided, it will be total request
|
1227
|
-
timeout. It can also be a pair (tuple) of
|
1228
|
-
(connection, read) timeouts.
|
1229
|
-
:type _request_timeout: int, tuple(int, int), optional
|
1230
|
-
:param _request_auth: set to override the auth_settings for an a single
|
1231
|
-
request; this effectively ignores the
|
1232
|
-
authentication in the spec for a single request.
|
1233
|
-
:type _request_auth: dict, optional
|
1234
|
-
:param _content_type: force content-type for the request.
|
1235
|
-
:type _content_type: str, Optional
|
1236
|
-
:param _headers: set to override the headers for a single
|
1237
|
-
request; this effectively ignores the headers
|
1238
|
-
in the spec for a single request.
|
1239
|
-
:type _headers: dict, optional
|
1240
|
-
:param _host_index: set to override the host_index for a single
|
1241
|
-
request; this effectively ignores the host_index
|
1242
|
-
in the spec for a single request.
|
1243
|
-
:type _host_index: int, optional
|
1244
|
-
:return: Returns the result object.
|
1245
|
-
""" # noqa: E501
|
1246
|
-
|
1247
|
-
_param = self._payment_request_receipt_create_serialize(
|
1248
|
-
id=id,
|
1249
|
-
_request_auth=_request_auth,
|
1250
|
-
_content_type=_content_type,
|
1251
|
-
_headers=_headers,
|
1252
|
-
_host_index=_host_index
|
1253
|
-
)
|
1254
|
-
|
1255
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
1256
|
-
'200': "PaymentReceipt",
|
1257
|
-
}
|
1258
|
-
response_data = self.api_client.call_api(
|
1259
|
-
*_param,
|
1260
|
-
_request_timeout=_request_timeout
|
1261
|
-
)
|
1262
|
-
response_data.read()
|
1263
|
-
return self.api_client.response_deserialize(
|
1264
|
-
response_data=response_data,
|
1265
|
-
response_types_map=_response_types_map,
|
1266
|
-
)
|
1267
|
-
|
1268
|
-
|
1269
|
-
@validate_call
|
1270
|
-
def payment_request_receipt_create_without_preload_content(
|
1271
|
-
self,
|
1272
|
-
id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
|
1273
|
-
_request_timeout: Union[
|
1274
|
-
None,
|
1275
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1276
|
-
Tuple[
|
1277
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1278
|
-
Annotated[StrictFloat, Field(gt=0)]
|
1279
|
-
]
|
1280
|
-
] = None,
|
1281
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
1282
|
-
_content_type: Optional[StrictStr] = None,
|
1283
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
1284
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
1285
|
-
) -> RESTResponseType:
|
1286
|
-
"""Create Payment Receipt
|
1287
|
-
|
1288
|
-
Creates the payment receipt resource
|
1289
|
-
|
1290
|
-
:param id: Payment request primary identifier (required)
|
1291
|
-
:type id: str
|
1292
|
-
:param _request_timeout: timeout setting for this request. If one
|
1293
|
-
number provided, it will be total request
|
1294
|
-
timeout. It can also be a pair (tuple) of
|
1295
|
-
(connection, read) timeouts.
|
1296
|
-
:type _request_timeout: int, tuple(int, int), optional
|
1297
|
-
:param _request_auth: set to override the auth_settings for an a single
|
1298
|
-
request; this effectively ignores the
|
1299
|
-
authentication in the spec for a single request.
|
1300
|
-
:type _request_auth: dict, optional
|
1301
|
-
:param _content_type: force content-type for the request.
|
1302
|
-
:type _content_type: str, Optional
|
1303
|
-
:param _headers: set to override the headers for a single
|
1304
|
-
request; this effectively ignores the headers
|
1305
|
-
in the spec for a single request.
|
1306
|
-
:type _headers: dict, optional
|
1307
|
-
:param _host_index: set to override the host_index for a single
|
1308
|
-
request; this effectively ignores the host_index
|
1309
|
-
in the spec for a single request.
|
1310
|
-
:type _host_index: int, optional
|
1311
|
-
:return: Returns the result object.
|
1312
|
-
""" # noqa: E501
|
1313
|
-
|
1314
|
-
_param = self._payment_request_receipt_create_serialize(
|
1315
|
-
id=id,
|
1316
|
-
_request_auth=_request_auth,
|
1317
|
-
_content_type=_content_type,
|
1318
|
-
_headers=_headers,
|
1319
|
-
_host_index=_host_index
|
1320
|
-
)
|
1321
|
-
|
1322
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
1323
|
-
'200': "PaymentReceipt",
|
1324
|
-
}
|
1325
|
-
response_data = self.api_client.call_api(
|
1326
|
-
*_param,
|
1327
|
-
_request_timeout=_request_timeout
|
1328
|
-
)
|
1329
|
-
return response_data.response
|
1330
|
-
|
1331
|
-
|
1332
|
-
def _payment_request_receipt_create_serialize(
|
1333
|
-
self,
|
1334
|
-
id,
|
1335
|
-
_request_auth,
|
1336
|
-
_content_type,
|
1337
|
-
_headers,
|
1338
|
-
_host_index,
|
1339
|
-
) -> RequestSerialized:
|
1340
|
-
|
1341
|
-
_host = None
|
1342
|
-
|
1343
|
-
_collection_formats: Dict[str, str] = {
|
1344
|
-
}
|
1345
|
-
|
1346
|
-
_path_params: Dict[str, str] = {}
|
1347
|
-
_query_params: List[Tuple[str, str]] = []
|
1348
|
-
_header_params: Dict[str, Optional[str]] = _headers or {}
|
1349
|
-
_form_params: List[Tuple[str, str]] = []
|
1350
|
-
_files: Dict[
|
1351
|
-
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
1352
|
-
] = {}
|
1353
|
-
_body_params: Optional[bytes] = None
|
1354
|
-
|
1355
|
-
# process the path parameters
|
1356
|
-
if id is not None:
|
1357
|
-
_path_params['id'] = id
|
1358
|
-
# process the query parameters
|
1359
|
-
# process the header parameters
|
1360
|
-
# process the form parameters
|
1361
|
-
# process the body parameter
|
1362
|
-
|
1363
|
-
|
1364
|
-
# set the HTTP header `Accept`
|
1365
|
-
if 'Accept' not in _header_params:
|
1366
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
1367
|
-
[
|
1368
|
-
'application/json'
|
1369
|
-
]
|
1370
|
-
)
|
1371
|
-
|
1372
|
-
# set the HTTP header `Content-Type`
|
1373
|
-
if _content_type:
|
1374
|
-
_header_params['Content-Type'] = _content_type
|
1375
|
-
else:
|
1376
|
-
_default_content_type = (
|
1377
|
-
self.api_client.select_header_content_type(
|
1378
|
-
[
|
1379
|
-
'application/json'
|
1380
|
-
]
|
1381
|
-
)
|
1382
|
-
)
|
1383
|
-
if _default_content_type is not None:
|
1384
|
-
_header_params['Content-Type'] = _default_content_type
|
1385
|
-
|
1386
|
-
# authentication setting
|
1387
|
-
_auth_settings: List[str] = [
|
1388
|
-
]
|
1389
|
-
|
1390
|
-
return self.api_client.param_serialize(
|
1391
|
-
method='POST',
|
1392
|
-
resource_path='/payments/requests/{id}/receipts',
|
1393
|
-
path_params=_path_params,
|
1394
|
-
query_params=_query_params,
|
1395
|
-
header_params=_header_params,
|
1396
|
-
body=_body_params,
|
1397
|
-
post_params=_form_params,
|
1398
|
-
files=_files,
|
1399
|
-
auth_settings=_auth_settings,
|
1400
|
-
collection_formats=_collection_formats,
|
1401
|
-
_host=_host,
|
1402
|
-
_request_auth=_request_auth
|
1403
|
-
)
|
1404
|
-
|
1405
|
-
|
1406
|
-
|
1407
|
-
|
1408
|
-
@validate_call
|
1409
|
-
def payment_request_receipt_list(
|
1410
|
-
self,
|
1411
|
-
id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
|
1412
|
-
_request_timeout: Union[
|
1413
|
-
None,
|
1414
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1415
|
-
Tuple[
|
1416
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1417
|
-
Annotated[StrictFloat, Field(gt=0)]
|
1418
|
-
]
|
1419
|
-
] = None,
|
1420
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
1421
|
-
_content_type: Optional[StrictStr] = None,
|
1422
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
1423
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
1424
|
-
) -> PaymentRequestReceiptList200Response:
|
1425
|
-
"""List Payment Receipts
|
1426
|
-
|
1427
|
-
Recovers all created payment receipts for the payment request provided
|
1428
|
-
|
1429
|
-
:param id: Payment request primary identifier (required)
|
1430
|
-
:type id: str
|
1431
|
-
:param _request_timeout: timeout setting for this request. If one
|
1432
|
-
number provided, it will be total request
|
1433
|
-
timeout. It can also be a pair (tuple) of
|
1434
|
-
(connection, read) timeouts.
|
1435
|
-
:type _request_timeout: int, tuple(int, int), optional
|
1436
|
-
:param _request_auth: set to override the auth_settings for an a single
|
1437
|
-
request; this effectively ignores the
|
1438
|
-
authentication in the spec for a single request.
|
1439
|
-
:type _request_auth: dict, optional
|
1440
|
-
:param _content_type: force content-type for the request.
|
1441
|
-
:type _content_type: str, Optional
|
1442
|
-
:param _headers: set to override the headers for a single
|
1443
|
-
request; this effectively ignores the headers
|
1444
|
-
in the spec for a single request.
|
1445
|
-
:type _headers: dict, optional
|
1446
|
-
:param _host_index: set to override the host_index for a single
|
1447
|
-
request; this effectively ignores the host_index
|
1448
|
-
in the spec for a single request.
|
1449
|
-
:type _host_index: int, optional
|
1450
|
-
:return: Returns the result object.
|
1451
|
-
""" # noqa: E501
|
1452
|
-
|
1453
|
-
_param = self._payment_request_receipt_list_serialize(
|
1454
|
-
id=id,
|
1455
|
-
_request_auth=_request_auth,
|
1456
|
-
_content_type=_content_type,
|
1457
|
-
_headers=_headers,
|
1458
|
-
_host_index=_host_index
|
1459
|
-
)
|
1460
|
-
|
1461
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
1462
|
-
'200': "PaymentRequestReceiptList200Response",
|
1463
|
-
}
|
1464
|
-
response_data = self.api_client.call_api(
|
1465
|
-
*_param,
|
1466
|
-
_request_timeout=_request_timeout
|
1467
|
-
)
|
1468
|
-
response_data.read()
|
1469
|
-
return self.api_client.response_deserialize(
|
1470
|
-
response_data=response_data,
|
1471
|
-
response_types_map=_response_types_map,
|
1472
|
-
).data
|
1473
|
-
|
1474
|
-
|
1475
|
-
@validate_call
|
1476
|
-
def payment_request_receipt_list_with_http_info(
|
1477
|
-
self,
|
1478
|
-
id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
|
1479
|
-
_request_timeout: Union[
|
1480
|
-
None,
|
1481
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1482
|
-
Tuple[
|
1483
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1484
|
-
Annotated[StrictFloat, Field(gt=0)]
|
1485
|
-
]
|
1486
|
-
] = None,
|
1487
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
1488
|
-
_content_type: Optional[StrictStr] = None,
|
1489
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
1490
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
1491
|
-
) -> ApiResponse[PaymentRequestReceiptList200Response]:
|
1492
|
-
"""List Payment Receipts
|
1493
|
-
|
1494
|
-
Recovers all created payment receipts for the payment request provided
|
1495
|
-
|
1496
|
-
:param id: Payment request primary identifier (required)
|
1497
|
-
:type id: str
|
1498
|
-
:param _request_timeout: timeout setting for this request. If one
|
1499
|
-
number provided, it will be total request
|
1500
|
-
timeout. It can also be a pair (tuple) of
|
1501
|
-
(connection, read) timeouts.
|
1502
|
-
:type _request_timeout: int, tuple(int, int), optional
|
1503
|
-
:param _request_auth: set to override the auth_settings for an a single
|
1504
|
-
request; this effectively ignores the
|
1505
|
-
authentication in the spec for a single request.
|
1506
|
-
:type _request_auth: dict, optional
|
1507
|
-
:param _content_type: force content-type for the request.
|
1508
|
-
:type _content_type: str, Optional
|
1509
|
-
:param _headers: set to override the headers for a single
|
1510
|
-
request; this effectively ignores the headers
|
1511
|
-
in the spec for a single request.
|
1512
|
-
:type _headers: dict, optional
|
1513
|
-
:param _host_index: set to override the host_index for a single
|
1514
|
-
request; this effectively ignores the host_index
|
1515
|
-
in the spec for a single request.
|
1516
|
-
:type _host_index: int, optional
|
1517
|
-
:return: Returns the result object.
|
1518
|
-
""" # noqa: E501
|
1519
|
-
|
1520
|
-
_param = self._payment_request_receipt_list_serialize(
|
1521
|
-
id=id,
|
1522
|
-
_request_auth=_request_auth,
|
1523
|
-
_content_type=_content_type,
|
1524
|
-
_headers=_headers,
|
1525
|
-
_host_index=_host_index
|
1526
|
-
)
|
1527
|
-
|
1528
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
1529
|
-
'200': "PaymentRequestReceiptList200Response",
|
1530
|
-
}
|
1531
|
-
response_data = self.api_client.call_api(
|
1532
|
-
*_param,
|
1533
|
-
_request_timeout=_request_timeout
|
1534
|
-
)
|
1535
|
-
response_data.read()
|
1536
|
-
return self.api_client.response_deserialize(
|
1537
|
-
response_data=response_data,
|
1538
|
-
response_types_map=_response_types_map,
|
1539
|
-
)
|
1540
|
-
|
1541
|
-
|
1542
|
-
@validate_call
|
1543
|
-
def payment_request_receipt_list_without_preload_content(
|
1544
|
-
self,
|
1545
|
-
id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
|
1546
|
-
_request_timeout: Union[
|
1547
|
-
None,
|
1548
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1549
|
-
Tuple[
|
1550
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1551
|
-
Annotated[StrictFloat, Field(gt=0)]
|
1552
|
-
]
|
1553
|
-
] = None,
|
1554
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
1555
|
-
_content_type: Optional[StrictStr] = None,
|
1556
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
1557
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
1558
|
-
) -> RESTResponseType:
|
1559
|
-
"""List Payment Receipts
|
1560
|
-
|
1561
|
-
Recovers all created payment receipts for the payment request provided
|
1562
|
-
|
1563
|
-
:param id: Payment request primary identifier (required)
|
1564
|
-
:type id: str
|
1565
|
-
:param _request_timeout: timeout setting for this request. If one
|
1566
|
-
number provided, it will be total request
|
1567
|
-
timeout. It can also be a pair (tuple) of
|
1568
|
-
(connection, read) timeouts.
|
1569
|
-
:type _request_timeout: int, tuple(int, int), optional
|
1570
|
-
:param _request_auth: set to override the auth_settings for an a single
|
1571
|
-
request; this effectively ignores the
|
1572
|
-
authentication in the spec for a single request.
|
1573
|
-
:type _request_auth: dict, optional
|
1574
|
-
:param _content_type: force content-type for the request.
|
1575
|
-
:type _content_type: str, Optional
|
1576
|
-
:param _headers: set to override the headers for a single
|
1577
|
-
request; this effectively ignores the headers
|
1578
|
-
in the spec for a single request.
|
1579
|
-
:type _headers: dict, optional
|
1580
|
-
:param _host_index: set to override the host_index for a single
|
1581
|
-
request; this effectively ignores the host_index
|
1582
|
-
in the spec for a single request.
|
1583
|
-
:type _host_index: int, optional
|
1584
|
-
:return: Returns the result object.
|
1585
|
-
""" # noqa: E501
|
1586
|
-
|
1587
|
-
_param = self._payment_request_receipt_list_serialize(
|
1588
|
-
id=id,
|
1589
|
-
_request_auth=_request_auth,
|
1590
|
-
_content_type=_content_type,
|
1591
|
-
_headers=_headers,
|
1592
|
-
_host_index=_host_index
|
1593
|
-
)
|
1594
|
-
|
1595
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
1596
|
-
'200': "PaymentRequestReceiptList200Response",
|
1597
|
-
}
|
1598
|
-
response_data = self.api_client.call_api(
|
1599
|
-
*_param,
|
1600
|
-
_request_timeout=_request_timeout
|
1601
|
-
)
|
1602
|
-
return response_data.response
|
1603
|
-
|
1604
|
-
|
1605
|
-
def _payment_request_receipt_list_serialize(
|
1606
|
-
self,
|
1607
|
-
id,
|
1608
|
-
_request_auth,
|
1609
|
-
_content_type,
|
1610
|
-
_headers,
|
1611
|
-
_host_index,
|
1612
|
-
) -> RequestSerialized:
|
1613
|
-
|
1614
|
-
_host = None
|
1615
|
-
|
1616
|
-
_collection_formats: Dict[str, str] = {
|
1617
|
-
}
|
1618
|
-
|
1619
|
-
_path_params: Dict[str, str] = {}
|
1620
|
-
_query_params: List[Tuple[str, str]] = []
|
1621
|
-
_header_params: Dict[str, Optional[str]] = _headers or {}
|
1622
|
-
_form_params: List[Tuple[str, str]] = []
|
1623
|
-
_files: Dict[
|
1624
|
-
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
1625
|
-
] = {}
|
1626
|
-
_body_params: Optional[bytes] = None
|
1627
|
-
|
1628
|
-
# process the path parameters
|
1629
|
-
if id is not None:
|
1630
|
-
_path_params['id'] = id
|
1631
|
-
# process the query parameters
|
1632
|
-
# process the header parameters
|
1633
|
-
# process the form parameters
|
1634
|
-
# process the body parameter
|
1635
|
-
|
1636
|
-
|
1637
|
-
# set the HTTP header `Accept`
|
1638
|
-
if 'Accept' not in _header_params:
|
1639
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
1640
|
-
[
|
1641
|
-
'application/json'
|
1642
|
-
]
|
1643
|
-
)
|
1644
|
-
|
1645
|
-
|
1646
|
-
# authentication setting
|
1647
|
-
_auth_settings: List[str] = [
|
1648
|
-
]
|
1649
|
-
|
1650
|
-
return self.api_client.param_serialize(
|
1651
|
-
method='GET',
|
1652
|
-
resource_path='/payments/requests/{id}/receipts',
|
1653
|
-
path_params=_path_params,
|
1654
|
-
query_params=_query_params,
|
1655
|
-
header_params=_header_params,
|
1656
|
-
body=_body_params,
|
1657
|
-
post_params=_form_params,
|
1658
|
-
files=_files,
|
1659
|
-
auth_settings=_auth_settings,
|
1660
|
-
collection_formats=_collection_formats,
|
1661
|
-
_host=_host,
|
1662
|
-
_request_auth=_request_auth
|
1663
|
-
)
|
1664
|
-
|
1665
|
-
|
1666
|
-
|
1667
|
-
|
1668
|
-
@validate_call
|
1669
|
-
def payment_request_receipt_retrieve(
|
1670
|
-
self,
|
1671
|
-
payment_request_id: StrictStr,
|
1672
|
-
payment_receipt_id: StrictStr,
|
1673
|
-
_request_timeout: Union[
|
1674
|
-
None,
|
1675
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1676
|
-
Tuple[
|
1677
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1678
|
-
Annotated[StrictFloat, Field(gt=0)]
|
1679
|
-
]
|
1680
|
-
] = None,
|
1681
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
1682
|
-
_content_type: Optional[StrictStr] = None,
|
1683
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
1684
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
1685
|
-
) -> PaymentReceipt:
|
1686
|
-
"""Retrieve Payment Receipt
|
1687
|
-
|
1688
|
-
Recovers the payment receipt resource by its id
|
1689
|
-
|
1690
|
-
:param payment_request_id: (required)
|
1691
|
-
:type payment_request_id: str
|
1692
|
-
:param payment_receipt_id: (required)
|
1693
|
-
:type payment_receipt_id: str
|
1694
|
-
:param _request_timeout: timeout setting for this request. If one
|
1695
|
-
number provided, it will be total request
|
1696
|
-
timeout. It can also be a pair (tuple) of
|
1697
|
-
(connection, read) timeouts.
|
1698
|
-
:type _request_timeout: int, tuple(int, int), optional
|
1699
|
-
:param _request_auth: set to override the auth_settings for an a single
|
1700
|
-
request; this effectively ignores the
|
1701
|
-
authentication in the spec for a single request.
|
1702
|
-
:type _request_auth: dict, optional
|
1703
|
-
:param _content_type: force content-type for the request.
|
1704
|
-
:type _content_type: str, Optional
|
1705
|
-
:param _headers: set to override the headers for a single
|
1706
|
-
request; this effectively ignores the headers
|
1707
|
-
in the spec for a single request.
|
1708
|
-
:type _headers: dict, optional
|
1709
|
-
:param _host_index: set to override the host_index for a single
|
1710
|
-
request; this effectively ignores the host_index
|
1711
|
-
in the spec for a single request.
|
1712
|
-
:type _host_index: int, optional
|
1713
|
-
:return: Returns the result object.
|
1714
|
-
""" # noqa: E501
|
1715
|
-
|
1716
|
-
_param = self._payment_request_receipt_retrieve_serialize(
|
1717
|
-
payment_request_id=payment_request_id,
|
1718
|
-
payment_receipt_id=payment_receipt_id,
|
1719
|
-
_request_auth=_request_auth,
|
1720
|
-
_content_type=_content_type,
|
1721
|
-
_headers=_headers,
|
1722
|
-
_host_index=_host_index
|
1723
|
-
)
|
1724
|
-
|
1725
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
1726
|
-
'200': "PaymentReceipt",
|
1727
|
-
}
|
1728
|
-
response_data = self.api_client.call_api(
|
1729
|
-
*_param,
|
1730
|
-
_request_timeout=_request_timeout
|
1731
|
-
)
|
1732
|
-
response_data.read()
|
1733
|
-
return self.api_client.response_deserialize(
|
1734
|
-
response_data=response_data,
|
1735
|
-
response_types_map=_response_types_map,
|
1736
|
-
).data
|
1737
|
-
|
1738
|
-
|
1739
|
-
@validate_call
|
1740
|
-
def payment_request_receipt_retrieve_with_http_info(
|
1741
|
-
self,
|
1742
|
-
payment_request_id: StrictStr,
|
1743
|
-
payment_receipt_id: StrictStr,
|
1744
|
-
_request_timeout: Union[
|
1745
|
-
None,
|
1746
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1747
|
-
Tuple[
|
1748
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1749
|
-
Annotated[StrictFloat, Field(gt=0)]
|
1750
|
-
]
|
1751
|
-
] = None,
|
1752
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
1753
|
-
_content_type: Optional[StrictStr] = None,
|
1754
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
1755
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
1756
|
-
) -> ApiResponse[PaymentReceipt]:
|
1757
|
-
"""Retrieve Payment Receipt
|
1758
|
-
|
1759
|
-
Recovers the payment receipt resource by its id
|
1760
|
-
|
1761
|
-
:param payment_request_id: (required)
|
1762
|
-
:type payment_request_id: str
|
1763
|
-
:param payment_receipt_id: (required)
|
1764
|
-
:type payment_receipt_id: str
|
1765
|
-
:param _request_timeout: timeout setting for this request. If one
|
1766
|
-
number provided, it will be total request
|
1767
|
-
timeout. It can also be a pair (tuple) of
|
1768
|
-
(connection, read) timeouts.
|
1769
|
-
:type _request_timeout: int, tuple(int, int), optional
|
1770
|
-
:param _request_auth: set to override the auth_settings for an a single
|
1771
|
-
request; this effectively ignores the
|
1772
|
-
authentication in the spec for a single request.
|
1773
|
-
:type _request_auth: dict, optional
|
1774
|
-
:param _content_type: force content-type for the request.
|
1775
|
-
:type _content_type: str, Optional
|
1776
|
-
:param _headers: set to override the headers for a single
|
1777
|
-
request; this effectively ignores the headers
|
1778
|
-
in the spec for a single request.
|
1779
|
-
:type _headers: dict, optional
|
1780
|
-
:param _host_index: set to override the host_index for a single
|
1781
|
-
request; this effectively ignores the host_index
|
1782
|
-
in the spec for a single request.
|
1783
|
-
:type _host_index: int, optional
|
1784
|
-
:return: Returns the result object.
|
1785
|
-
""" # noqa: E501
|
1786
|
-
|
1787
|
-
_param = self._payment_request_receipt_retrieve_serialize(
|
1788
|
-
payment_request_id=payment_request_id,
|
1789
|
-
payment_receipt_id=payment_receipt_id,
|
1790
|
-
_request_auth=_request_auth,
|
1791
|
-
_content_type=_content_type,
|
1792
|
-
_headers=_headers,
|
1793
|
-
_host_index=_host_index
|
1794
|
-
)
|
1795
|
-
|
1796
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
1797
|
-
'200': "PaymentReceipt",
|
1798
|
-
}
|
1799
|
-
response_data = self.api_client.call_api(
|
1800
|
-
*_param,
|
1801
|
-
_request_timeout=_request_timeout
|
1802
|
-
)
|
1803
|
-
response_data.read()
|
1804
|
-
return self.api_client.response_deserialize(
|
1805
|
-
response_data=response_data,
|
1806
|
-
response_types_map=_response_types_map,
|
1807
|
-
)
|
1808
|
-
|
1809
|
-
|
1810
|
-
@validate_call
|
1811
|
-
def payment_request_receipt_retrieve_without_preload_content(
|
1812
|
-
self,
|
1813
|
-
payment_request_id: StrictStr,
|
1814
|
-
payment_receipt_id: StrictStr,
|
1815
|
-
_request_timeout: Union[
|
1816
|
-
None,
|
1817
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1818
|
-
Tuple[
|
1819
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1820
|
-
Annotated[StrictFloat, Field(gt=0)]
|
1821
|
-
]
|
1822
|
-
] = None,
|
1823
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
1824
|
-
_content_type: Optional[StrictStr] = None,
|
1825
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
1826
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
1827
|
-
) -> RESTResponseType:
|
1828
|
-
"""Retrieve Payment Receipt
|
1829
|
-
|
1830
|
-
Recovers the payment receipt resource by its id
|
1831
|
-
|
1832
|
-
:param payment_request_id: (required)
|
1833
|
-
:type payment_request_id: str
|
1834
|
-
:param payment_receipt_id: (required)
|
1835
|
-
:type payment_receipt_id: str
|
1836
|
-
:param _request_timeout: timeout setting for this request. If one
|
1837
|
-
number provided, it will be total request
|
1838
|
-
timeout. It can also be a pair (tuple) of
|
1839
|
-
(connection, read) timeouts.
|
1840
|
-
:type _request_timeout: int, tuple(int, int), optional
|
1841
|
-
:param _request_auth: set to override the auth_settings for an a single
|
1842
|
-
request; this effectively ignores the
|
1843
|
-
authentication in the spec for a single request.
|
1844
|
-
:type _request_auth: dict, optional
|
1845
|
-
:param _content_type: force content-type for the request.
|
1846
|
-
:type _content_type: str, Optional
|
1847
|
-
:param _headers: set to override the headers for a single
|
1848
|
-
request; this effectively ignores the headers
|
1849
|
-
in the spec for a single request.
|
1850
|
-
:type _headers: dict, optional
|
1851
|
-
:param _host_index: set to override the host_index for a single
|
1852
|
-
request; this effectively ignores the host_index
|
1853
|
-
in the spec for a single request.
|
1854
|
-
:type _host_index: int, optional
|
1855
|
-
:return: Returns the result object.
|
1856
|
-
""" # noqa: E501
|
1857
|
-
|
1858
|
-
_param = self._payment_request_receipt_retrieve_serialize(
|
1859
|
-
payment_request_id=payment_request_id,
|
1860
|
-
payment_receipt_id=payment_receipt_id,
|
1861
|
-
_request_auth=_request_auth,
|
1862
|
-
_content_type=_content_type,
|
1863
|
-
_headers=_headers,
|
1864
|
-
_host_index=_host_index
|
1865
|
-
)
|
1866
|
-
|
1867
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
1868
|
-
'200': "PaymentReceipt",
|
1869
|
-
}
|
1870
|
-
response_data = self.api_client.call_api(
|
1871
|
-
*_param,
|
1872
|
-
_request_timeout=_request_timeout
|
1873
|
-
)
|
1874
|
-
return response_data.response
|
1875
|
-
|
1876
|
-
|
1877
|
-
def _payment_request_receipt_retrieve_serialize(
|
1878
|
-
self,
|
1879
|
-
payment_request_id,
|
1880
|
-
payment_receipt_id,
|
1881
|
-
_request_auth,
|
1882
|
-
_content_type,
|
1883
|
-
_headers,
|
1884
|
-
_host_index,
|
1885
|
-
) -> RequestSerialized:
|
1886
|
-
|
1887
|
-
_host = None
|
1888
|
-
|
1889
|
-
_collection_formats: Dict[str, str] = {
|
1890
|
-
}
|
1891
|
-
|
1892
|
-
_path_params: Dict[str, str] = {}
|
1893
|
-
_query_params: List[Tuple[str, str]] = []
|
1894
|
-
_header_params: Dict[str, Optional[str]] = _headers or {}
|
1895
|
-
_form_params: List[Tuple[str, str]] = []
|
1896
|
-
_files: Dict[
|
1897
|
-
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
1898
|
-
] = {}
|
1899
|
-
_body_params: Optional[bytes] = None
|
1900
|
-
|
1901
|
-
# process the path parameters
|
1902
|
-
if payment_request_id is not None:
|
1903
|
-
_path_params['payment-request-id'] = payment_request_id
|
1904
|
-
if payment_receipt_id is not None:
|
1905
|
-
_path_params['payment-receipt-id'] = payment_receipt_id
|
1906
|
-
# process the query parameters
|
1907
|
-
# process the header parameters
|
1908
|
-
# process the form parameters
|
1909
|
-
# process the body parameter
|
1910
|
-
|
1911
|
-
|
1912
|
-
# set the HTTP header `Accept`
|
1913
|
-
if 'Accept' not in _header_params:
|
1914
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
1915
|
-
[
|
1916
|
-
'application/json'
|
1917
|
-
]
|
1918
|
-
)
|
1919
|
-
|
1920
|
-
|
1921
|
-
# authentication setting
|
1922
|
-
_auth_settings: List[str] = [
|
1923
|
-
]
|
1924
|
-
|
1925
|
-
return self.api_client.param_serialize(
|
1926
|
-
method='GET',
|
1927
|
-
resource_path='/payments/requests/{payment-request-id}/receipts/{payment-receipt-id}',
|
1928
|
-
path_params=_path_params,
|
1929
|
-
query_params=_query_params,
|
1930
|
-
header_params=_header_params,
|
1931
|
-
body=_body_params,
|
1932
|
-
post_params=_form_params,
|
1933
|
-
files=_files,
|
1934
|
-
auth_settings=_auth_settings,
|
1935
|
-
collection_formats=_collection_formats,
|
1936
|
-
_host=_host,
|
1937
|
-
_request_auth=_request_auth
|
1938
|
-
)
|
1939
|
-
|
1940
|
-
|
1941
|
-
|
1942
|
-
|
1943
|
-
@validate_call
|
1944
|
-
def payment_request_refund(
|
1945
|
-
self,
|
1946
|
-
id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
|
1947
|
-
_request_timeout: Union[
|
1948
|
-
None,
|
1949
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1950
|
-
Tuple[
|
1951
|
-
Annotated[StrictFloat, Field(gt=0)],
|
1952
|
-
Annotated[StrictFloat, Field(gt=0)]
|
1953
|
-
]
|
1954
|
-
] = None,
|
1955
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
1956
|
-
_content_type: Optional[StrictStr] = None,
|
1957
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
1958
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
1959
|
-
) -> None:
|
1960
|
-
"""Refund Payment Request
|
1961
|
-
|
1962
|
-
Refund a COMPLETED payment request payed using payment method PIX. Not available for Payment Initiation (PIS)
|
1963
|
-
|
1964
|
-
:param id: Payment request primary identifier (required)
|
1965
|
-
:type id: str
|
1966
|
-
:param _request_timeout: timeout setting for this request. If one
|
1967
|
-
number provided, it will be total request
|
1968
|
-
timeout. It can also be a pair (tuple) of
|
1969
|
-
(connection, read) timeouts.
|
1970
|
-
:type _request_timeout: int, tuple(int, int), optional
|
1971
|
-
:param _request_auth: set to override the auth_settings for an a single
|
1972
|
-
request; this effectively ignores the
|
1973
|
-
authentication in the spec for a single request.
|
1974
|
-
:type _request_auth: dict, optional
|
1975
|
-
:param _content_type: force content-type for the request.
|
1976
|
-
:type _content_type: str, Optional
|
1977
|
-
:param _headers: set to override the headers for a single
|
1978
|
-
request; this effectively ignores the headers
|
1979
|
-
in the spec for a single request.
|
1980
|
-
:type _headers: dict, optional
|
1981
|
-
:param _host_index: set to override the host_index for a single
|
1982
|
-
request; this effectively ignores the host_index
|
1983
|
-
in the spec for a single request.
|
1984
|
-
:type _host_index: int, optional
|
1985
|
-
:return: Returns the result object.
|
1986
|
-
""" # noqa: E501
|
1987
|
-
|
1988
|
-
_param = self._payment_request_refund_serialize(
|
1989
|
-
id=id,
|
1990
|
-
_request_auth=_request_auth,
|
1991
|
-
_content_type=_content_type,
|
1992
|
-
_headers=_headers,
|
1993
|
-
_host_index=_host_index
|
1994
|
-
)
|
1995
|
-
|
1996
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
1997
|
-
'200': None,
|
1998
|
-
'404': "GlobalErrorResponse",
|
1999
|
-
}
|
2000
|
-
response_data = self.api_client.call_api(
|
2001
|
-
*_param,
|
2002
|
-
_request_timeout=_request_timeout
|
2003
|
-
)
|
2004
|
-
response_data.read()
|
2005
|
-
return self.api_client.response_deserialize(
|
2006
|
-
response_data=response_data,
|
2007
|
-
response_types_map=_response_types_map,
|
2008
|
-
).data
|
2009
|
-
|
2010
|
-
|
2011
|
-
@validate_call
|
2012
|
-
def payment_request_refund_with_http_info(
|
2013
|
-
self,
|
2014
|
-
id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
|
2015
|
-
_request_timeout: Union[
|
2016
|
-
None,
|
2017
|
-
Annotated[StrictFloat, Field(gt=0)],
|
2018
|
-
Tuple[
|
2019
|
-
Annotated[StrictFloat, Field(gt=0)],
|
2020
|
-
Annotated[StrictFloat, Field(gt=0)]
|
2021
|
-
]
|
2022
|
-
] = None,
|
2023
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
2024
|
-
_content_type: Optional[StrictStr] = None,
|
2025
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
2026
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
2027
|
-
) -> ApiResponse[None]:
|
2028
|
-
"""Refund Payment Request
|
2029
|
-
|
2030
|
-
Refund a COMPLETED payment request payed using payment method PIX. Not available for Payment Initiation (PIS)
|
2031
|
-
|
2032
|
-
:param id: Payment request primary identifier (required)
|
2033
|
-
:type id: str
|
2034
|
-
:param _request_timeout: timeout setting for this request. If one
|
2035
|
-
number provided, it will be total request
|
2036
|
-
timeout. It can also be a pair (tuple) of
|
2037
|
-
(connection, read) timeouts.
|
2038
|
-
:type _request_timeout: int, tuple(int, int), optional
|
2039
|
-
:param _request_auth: set to override the auth_settings for an a single
|
2040
|
-
request; this effectively ignores the
|
2041
|
-
authentication in the spec for a single request.
|
2042
|
-
:type _request_auth: dict, optional
|
2043
|
-
:param _content_type: force content-type for the request.
|
2044
|
-
:type _content_type: str, Optional
|
2045
|
-
:param _headers: set to override the headers for a single
|
2046
|
-
request; this effectively ignores the headers
|
2047
|
-
in the spec for a single request.
|
2048
|
-
:type _headers: dict, optional
|
2049
|
-
:param _host_index: set to override the host_index for a single
|
2050
|
-
request; this effectively ignores the host_index
|
2051
|
-
in the spec for a single request.
|
2052
|
-
:type _host_index: int, optional
|
2053
|
-
:return: Returns the result object.
|
2054
|
-
""" # noqa: E501
|
2055
|
-
|
2056
|
-
_param = self._payment_request_refund_serialize(
|
2057
|
-
id=id,
|
2058
|
-
_request_auth=_request_auth,
|
2059
|
-
_content_type=_content_type,
|
2060
|
-
_headers=_headers,
|
2061
|
-
_host_index=_host_index
|
2062
|
-
)
|
2063
|
-
|
2064
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
2065
|
-
'200': None,
|
2066
|
-
'404': "GlobalErrorResponse",
|
2067
|
-
}
|
2068
|
-
response_data = self.api_client.call_api(
|
2069
|
-
*_param,
|
2070
|
-
_request_timeout=_request_timeout
|
2071
|
-
)
|
2072
|
-
response_data.read()
|
2073
|
-
return self.api_client.response_deserialize(
|
2074
|
-
response_data=response_data,
|
2075
|
-
response_types_map=_response_types_map,
|
2076
|
-
)
|
2077
|
-
|
2078
|
-
|
2079
|
-
@validate_call
|
2080
|
-
def payment_request_refund_without_preload_content(
|
2081
|
-
self,
|
2082
|
-
id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
|
2083
|
-
_request_timeout: Union[
|
2084
|
-
None,
|
2085
|
-
Annotated[StrictFloat, Field(gt=0)],
|
2086
|
-
Tuple[
|
2087
|
-
Annotated[StrictFloat, Field(gt=0)],
|
2088
|
-
Annotated[StrictFloat, Field(gt=0)]
|
2089
|
-
]
|
2090
|
-
] = None,
|
2091
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
2092
|
-
_content_type: Optional[StrictStr] = None,
|
2093
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
2094
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
2095
|
-
) -> RESTResponseType:
|
2096
|
-
"""Refund Payment Request
|
2097
|
-
|
2098
|
-
Refund a COMPLETED payment request payed using payment method PIX. Not available for Payment Initiation (PIS)
|
2099
|
-
|
2100
|
-
:param id: Payment request primary identifier (required)
|
2101
|
-
:type id: str
|
2102
|
-
:param _request_timeout: timeout setting for this request. If one
|
2103
|
-
number provided, it will be total request
|
2104
|
-
timeout. It can also be a pair (tuple) of
|
2105
|
-
(connection, read) timeouts.
|
2106
|
-
:type _request_timeout: int, tuple(int, int), optional
|
2107
|
-
:param _request_auth: set to override the auth_settings for an a single
|
2108
|
-
request; this effectively ignores the
|
2109
|
-
authentication in the spec for a single request.
|
2110
|
-
:type _request_auth: dict, optional
|
2111
|
-
:param _content_type: force content-type for the request.
|
2112
|
-
:type _content_type: str, Optional
|
2113
|
-
:param _headers: set to override the headers for a single
|
2114
|
-
request; this effectively ignores the headers
|
2115
|
-
in the spec for a single request.
|
2116
|
-
:type _headers: dict, optional
|
2117
|
-
:param _host_index: set to override the host_index for a single
|
2118
|
-
request; this effectively ignores the host_index
|
2119
|
-
in the spec for a single request.
|
2120
|
-
:type _host_index: int, optional
|
2121
|
-
:return: Returns the result object.
|
2122
|
-
""" # noqa: E501
|
2123
|
-
|
2124
|
-
_param = self._payment_request_refund_serialize(
|
2125
|
-
id=id,
|
2126
|
-
_request_auth=_request_auth,
|
2127
|
-
_content_type=_content_type,
|
2128
|
-
_headers=_headers,
|
2129
|
-
_host_index=_host_index
|
2130
|
-
)
|
2131
|
-
|
2132
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
2133
|
-
'200': None,
|
2134
|
-
'404': "GlobalErrorResponse",
|
2135
|
-
}
|
2136
|
-
response_data = self.api_client.call_api(
|
2137
|
-
*_param,
|
2138
|
-
_request_timeout=_request_timeout
|
2139
|
-
)
|
2140
|
-
return response_data.response
|
2141
|
-
|
2142
|
-
|
2143
|
-
def _payment_request_refund_serialize(
|
2144
|
-
self,
|
2145
|
-
id,
|
2146
|
-
_request_auth,
|
2147
|
-
_content_type,
|
2148
|
-
_headers,
|
2149
|
-
_host_index,
|
2150
|
-
) -> RequestSerialized:
|
2151
|
-
|
2152
|
-
_host = None
|
2153
|
-
|
2154
|
-
_collection_formats: Dict[str, str] = {
|
2155
|
-
}
|
2156
|
-
|
2157
|
-
_path_params: Dict[str, str] = {}
|
2158
|
-
_query_params: List[Tuple[str, str]] = []
|
2159
|
-
_header_params: Dict[str, Optional[str]] = _headers or {}
|
2160
|
-
_form_params: List[Tuple[str, str]] = []
|
2161
|
-
_files: Dict[
|
2162
|
-
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
2163
|
-
] = {}
|
2164
|
-
_body_params: Optional[bytes] = None
|
2165
|
-
|
2166
|
-
# process the path parameters
|
2167
|
-
if id is not None:
|
2168
|
-
_path_params['id'] = id
|
2169
|
-
# process the query parameters
|
2170
|
-
# process the header parameters
|
2171
|
-
# process the form parameters
|
2172
|
-
# process the body parameter
|
2173
|
-
|
2174
|
-
|
2175
|
-
# set the HTTP header `Accept`
|
2176
|
-
if 'Accept' not in _header_params:
|
2177
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
2178
|
-
[
|
2179
|
-
'application/json'
|
2180
|
-
]
|
2181
|
-
)
|
2182
|
-
|
2183
|
-
|
2184
|
-
# authentication setting
|
2185
|
-
_auth_settings: List[str] = [
|
2186
|
-
'default'
|
2187
|
-
]
|
2188
|
-
|
2189
|
-
return self.api_client.param_serialize(
|
2190
|
-
method='POST',
|
2191
|
-
resource_path='/payments/requests/{id}/refund',
|
2192
|
-
path_params=_path_params,
|
2193
|
-
query_params=_query_params,
|
2194
|
-
header_params=_header_params,
|
2195
|
-
body=_body_params,
|
2196
|
-
post_params=_form_params,
|
2197
|
-
files=_files,
|
2198
|
-
auth_settings=_auth_settings,
|
2199
|
-
collection_formats=_collection_formats,
|
2200
|
-
_host=_host,
|
2201
|
-
_request_auth=_request_auth
|
2202
|
-
)
|
2203
|
-
|
2204
|
-
|
2205
|
-
|
2206
|
-
|
2207
1133
|
@validate_call
|
2208
1134
|
def payment_request_retrieve(
|
2209
1135
|
self,
|