pluggy-sdk 1.0.0.post15__py3-none-any.whl → 1.0.0.post16__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.
@@ -22,11 +22,8 @@ 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
- from pluggy_sdk.models.payment_schedules_list200_response import PaymentSchedulesList200Response
30
27
  from pluggy_sdk.models.update_payment_request import UpdatePaymentRequest
31
28
 
32
29
  from pluggy_sdk.api_client import ApiClient, RequestSerialized
@@ -1125,808 +1122,6 @@ class PaymentRequestApi:
1125
1122
 
1126
1123
 
1127
1124
 
1128
- @validate_call
1129
- def payment_request_receipt_create(
1130
- self,
1131
- id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
1132
- _request_timeout: Union[
1133
- None,
1134
- Annotated[StrictFloat, Field(gt=0)],
1135
- Tuple[
1136
- Annotated[StrictFloat, Field(gt=0)],
1137
- Annotated[StrictFloat, Field(gt=0)]
1138
- ]
1139
- ] = None,
1140
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1141
- _content_type: Optional[StrictStr] = None,
1142
- _headers: Optional[Dict[StrictStr, Any]] = None,
1143
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1144
- ) -> PaymentReceipt:
1145
- """Create Payment Receipt
1146
-
1147
- Creates the payment receipt resource
1148
-
1149
- :param id: Payment request primary identifier (required)
1150
- :type id: str
1151
- :param _request_timeout: timeout setting for this request. If one
1152
- number provided, it will be total request
1153
- timeout. It can also be a pair (tuple) of
1154
- (connection, read) timeouts.
1155
- :type _request_timeout: int, tuple(int, int), optional
1156
- :param _request_auth: set to override the auth_settings for an a single
1157
- request; this effectively ignores the
1158
- authentication in the spec for a single request.
1159
- :type _request_auth: dict, optional
1160
- :param _content_type: force content-type for the request.
1161
- :type _content_type: str, Optional
1162
- :param _headers: set to override the headers for a single
1163
- request; this effectively ignores the headers
1164
- in the spec for a single request.
1165
- :type _headers: dict, optional
1166
- :param _host_index: set to override the host_index for a single
1167
- request; this effectively ignores the host_index
1168
- in the spec for a single request.
1169
- :type _host_index: int, optional
1170
- :return: Returns the result object.
1171
- """ # noqa: E501
1172
-
1173
- _param = self._payment_request_receipt_create_serialize(
1174
- id=id,
1175
- _request_auth=_request_auth,
1176
- _content_type=_content_type,
1177
- _headers=_headers,
1178
- _host_index=_host_index
1179
- )
1180
-
1181
- _response_types_map: Dict[str, Optional[str]] = {
1182
- '200': "PaymentReceipt",
1183
- }
1184
- response_data = self.api_client.call_api(
1185
- *_param,
1186
- _request_timeout=_request_timeout
1187
- )
1188
- response_data.read()
1189
- return self.api_client.response_deserialize(
1190
- response_data=response_data,
1191
- response_types_map=_response_types_map,
1192
- ).data
1193
-
1194
-
1195
- @validate_call
1196
- def payment_request_receipt_create_with_http_info(
1197
- self,
1198
- id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
1199
- _request_timeout: Union[
1200
- None,
1201
- Annotated[StrictFloat, Field(gt=0)],
1202
- Tuple[
1203
- Annotated[StrictFloat, Field(gt=0)],
1204
- Annotated[StrictFloat, Field(gt=0)]
1205
- ]
1206
- ] = None,
1207
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1208
- _content_type: Optional[StrictStr] = None,
1209
- _headers: Optional[Dict[StrictStr, Any]] = None,
1210
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1211
- ) -> ApiResponse[PaymentReceipt]:
1212
- """Create Payment Receipt
1213
-
1214
- Creates the payment receipt resource
1215
-
1216
- :param id: Payment request primary identifier (required)
1217
- :type id: str
1218
- :param _request_timeout: timeout setting for this request. If one
1219
- number provided, it will be total request
1220
- timeout. It can also be a pair (tuple) of
1221
- (connection, read) timeouts.
1222
- :type _request_timeout: int, tuple(int, int), optional
1223
- :param _request_auth: set to override the auth_settings for an a single
1224
- request; this effectively ignores the
1225
- authentication in the spec for a single request.
1226
- :type _request_auth: dict, optional
1227
- :param _content_type: force content-type for the request.
1228
- :type _content_type: str, Optional
1229
- :param _headers: set to override the headers for a single
1230
- request; this effectively ignores the headers
1231
- in the spec for a single request.
1232
- :type _headers: dict, optional
1233
- :param _host_index: set to override the host_index for a single
1234
- request; this effectively ignores the host_index
1235
- in the spec for a single request.
1236
- :type _host_index: int, optional
1237
- :return: Returns the result object.
1238
- """ # noqa: E501
1239
-
1240
- _param = self._payment_request_receipt_create_serialize(
1241
- id=id,
1242
- _request_auth=_request_auth,
1243
- _content_type=_content_type,
1244
- _headers=_headers,
1245
- _host_index=_host_index
1246
- )
1247
-
1248
- _response_types_map: Dict[str, Optional[str]] = {
1249
- '200': "PaymentReceipt",
1250
- }
1251
- response_data = self.api_client.call_api(
1252
- *_param,
1253
- _request_timeout=_request_timeout
1254
- )
1255
- response_data.read()
1256
- return self.api_client.response_deserialize(
1257
- response_data=response_data,
1258
- response_types_map=_response_types_map,
1259
- )
1260
-
1261
-
1262
- @validate_call
1263
- def payment_request_receipt_create_without_preload_content(
1264
- self,
1265
- id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
1266
- _request_timeout: Union[
1267
- None,
1268
- Annotated[StrictFloat, Field(gt=0)],
1269
- Tuple[
1270
- Annotated[StrictFloat, Field(gt=0)],
1271
- Annotated[StrictFloat, Field(gt=0)]
1272
- ]
1273
- ] = None,
1274
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1275
- _content_type: Optional[StrictStr] = None,
1276
- _headers: Optional[Dict[StrictStr, Any]] = None,
1277
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1278
- ) -> RESTResponseType:
1279
- """Create Payment Receipt
1280
-
1281
- Creates the payment receipt resource
1282
-
1283
- :param id: Payment request primary identifier (required)
1284
- :type id: str
1285
- :param _request_timeout: timeout setting for this request. If one
1286
- number provided, it will be total request
1287
- timeout. It can also be a pair (tuple) of
1288
- (connection, read) timeouts.
1289
- :type _request_timeout: int, tuple(int, int), optional
1290
- :param _request_auth: set to override the auth_settings for an a single
1291
- request; this effectively ignores the
1292
- authentication in the spec for a single request.
1293
- :type _request_auth: dict, optional
1294
- :param _content_type: force content-type for the request.
1295
- :type _content_type: str, Optional
1296
- :param _headers: set to override the headers for a single
1297
- request; this effectively ignores the headers
1298
- in the spec for a single request.
1299
- :type _headers: dict, optional
1300
- :param _host_index: set to override the host_index for a single
1301
- request; this effectively ignores the host_index
1302
- in the spec for a single request.
1303
- :type _host_index: int, optional
1304
- :return: Returns the result object.
1305
- """ # noqa: E501
1306
-
1307
- _param = self._payment_request_receipt_create_serialize(
1308
- id=id,
1309
- _request_auth=_request_auth,
1310
- _content_type=_content_type,
1311
- _headers=_headers,
1312
- _host_index=_host_index
1313
- )
1314
-
1315
- _response_types_map: Dict[str, Optional[str]] = {
1316
- '200': "PaymentReceipt",
1317
- }
1318
- response_data = self.api_client.call_api(
1319
- *_param,
1320
- _request_timeout=_request_timeout
1321
- )
1322
- return response_data.response
1323
-
1324
-
1325
- def _payment_request_receipt_create_serialize(
1326
- self,
1327
- id,
1328
- _request_auth,
1329
- _content_type,
1330
- _headers,
1331
- _host_index,
1332
- ) -> RequestSerialized:
1333
-
1334
- _host = None
1335
-
1336
- _collection_formats: Dict[str, str] = {
1337
- }
1338
-
1339
- _path_params: Dict[str, str] = {}
1340
- _query_params: List[Tuple[str, str]] = []
1341
- _header_params: Dict[str, Optional[str]] = _headers or {}
1342
- _form_params: List[Tuple[str, str]] = []
1343
- _files: Dict[str, Union[str, bytes]] = {}
1344
- _body_params: Optional[bytes] = None
1345
-
1346
- # process the path parameters
1347
- if id is not None:
1348
- _path_params['id'] = id
1349
- # process the query parameters
1350
- # process the header parameters
1351
- # process the form parameters
1352
- # process the body parameter
1353
-
1354
-
1355
- # set the HTTP header `Accept`
1356
- if 'Accept' not in _header_params:
1357
- _header_params['Accept'] = self.api_client.select_header_accept(
1358
- [
1359
- 'application/json'
1360
- ]
1361
- )
1362
-
1363
- # set the HTTP header `Content-Type`
1364
- if _content_type:
1365
- _header_params['Content-Type'] = _content_type
1366
- else:
1367
- _default_content_type = (
1368
- self.api_client.select_header_content_type(
1369
- [
1370
- 'application/json'
1371
- ]
1372
- )
1373
- )
1374
- if _default_content_type is not None:
1375
- _header_params['Content-Type'] = _default_content_type
1376
-
1377
- # authentication setting
1378
- _auth_settings: List[str] = [
1379
- ]
1380
-
1381
- return self.api_client.param_serialize(
1382
- method='POST',
1383
- resource_path='/payments/requests/{id}/receipts',
1384
- path_params=_path_params,
1385
- query_params=_query_params,
1386
- header_params=_header_params,
1387
- body=_body_params,
1388
- post_params=_form_params,
1389
- files=_files,
1390
- auth_settings=_auth_settings,
1391
- collection_formats=_collection_formats,
1392
- _host=_host,
1393
- _request_auth=_request_auth
1394
- )
1395
-
1396
-
1397
-
1398
-
1399
- @validate_call
1400
- def payment_request_receipt_list(
1401
- self,
1402
- id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
1403
- _request_timeout: Union[
1404
- None,
1405
- Annotated[StrictFloat, Field(gt=0)],
1406
- Tuple[
1407
- Annotated[StrictFloat, Field(gt=0)],
1408
- Annotated[StrictFloat, Field(gt=0)]
1409
- ]
1410
- ] = None,
1411
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1412
- _content_type: Optional[StrictStr] = None,
1413
- _headers: Optional[Dict[StrictStr, Any]] = None,
1414
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1415
- ) -> PaymentRequestReceiptList200Response:
1416
- """List Payment Receipts
1417
-
1418
- Recovers all created payment receipts for the payment request provided
1419
-
1420
- :param id: Payment request primary identifier (required)
1421
- :type id: str
1422
- :param _request_timeout: timeout setting for this request. If one
1423
- number provided, it will be total request
1424
- timeout. It can also be a pair (tuple) of
1425
- (connection, read) timeouts.
1426
- :type _request_timeout: int, tuple(int, int), optional
1427
- :param _request_auth: set to override the auth_settings for an a single
1428
- request; this effectively ignores the
1429
- authentication in the spec for a single request.
1430
- :type _request_auth: dict, optional
1431
- :param _content_type: force content-type for the request.
1432
- :type _content_type: str, Optional
1433
- :param _headers: set to override the headers for a single
1434
- request; this effectively ignores the headers
1435
- in the spec for a single request.
1436
- :type _headers: dict, optional
1437
- :param _host_index: set to override the host_index for a single
1438
- request; this effectively ignores the host_index
1439
- in the spec for a single request.
1440
- :type _host_index: int, optional
1441
- :return: Returns the result object.
1442
- """ # noqa: E501
1443
-
1444
- _param = self._payment_request_receipt_list_serialize(
1445
- id=id,
1446
- _request_auth=_request_auth,
1447
- _content_type=_content_type,
1448
- _headers=_headers,
1449
- _host_index=_host_index
1450
- )
1451
-
1452
- _response_types_map: Dict[str, Optional[str]] = {
1453
- '200': "PaymentRequestReceiptList200Response",
1454
- }
1455
- response_data = self.api_client.call_api(
1456
- *_param,
1457
- _request_timeout=_request_timeout
1458
- )
1459
- response_data.read()
1460
- return self.api_client.response_deserialize(
1461
- response_data=response_data,
1462
- response_types_map=_response_types_map,
1463
- ).data
1464
-
1465
-
1466
- @validate_call
1467
- def payment_request_receipt_list_with_http_info(
1468
- self,
1469
- id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
1470
- _request_timeout: Union[
1471
- None,
1472
- Annotated[StrictFloat, Field(gt=0)],
1473
- Tuple[
1474
- Annotated[StrictFloat, Field(gt=0)],
1475
- Annotated[StrictFloat, Field(gt=0)]
1476
- ]
1477
- ] = None,
1478
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1479
- _content_type: Optional[StrictStr] = None,
1480
- _headers: Optional[Dict[StrictStr, Any]] = None,
1481
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1482
- ) -> ApiResponse[PaymentRequestReceiptList200Response]:
1483
- """List Payment Receipts
1484
-
1485
- Recovers all created payment receipts for the payment request provided
1486
-
1487
- :param id: Payment request primary identifier (required)
1488
- :type id: str
1489
- :param _request_timeout: timeout setting for this request. If one
1490
- number provided, it will be total request
1491
- timeout. It can also be a pair (tuple) of
1492
- (connection, read) timeouts.
1493
- :type _request_timeout: int, tuple(int, int), optional
1494
- :param _request_auth: set to override the auth_settings for an a single
1495
- request; this effectively ignores the
1496
- authentication in the spec for a single request.
1497
- :type _request_auth: dict, optional
1498
- :param _content_type: force content-type for the request.
1499
- :type _content_type: str, Optional
1500
- :param _headers: set to override the headers for a single
1501
- request; this effectively ignores the headers
1502
- in the spec for a single request.
1503
- :type _headers: dict, optional
1504
- :param _host_index: set to override the host_index for a single
1505
- request; this effectively ignores the host_index
1506
- in the spec for a single request.
1507
- :type _host_index: int, optional
1508
- :return: Returns the result object.
1509
- """ # noqa: E501
1510
-
1511
- _param = self._payment_request_receipt_list_serialize(
1512
- id=id,
1513
- _request_auth=_request_auth,
1514
- _content_type=_content_type,
1515
- _headers=_headers,
1516
- _host_index=_host_index
1517
- )
1518
-
1519
- _response_types_map: Dict[str, Optional[str]] = {
1520
- '200': "PaymentRequestReceiptList200Response",
1521
- }
1522
- response_data = self.api_client.call_api(
1523
- *_param,
1524
- _request_timeout=_request_timeout
1525
- )
1526
- response_data.read()
1527
- return self.api_client.response_deserialize(
1528
- response_data=response_data,
1529
- response_types_map=_response_types_map,
1530
- )
1531
-
1532
-
1533
- @validate_call
1534
- def payment_request_receipt_list_without_preload_content(
1535
- self,
1536
- id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
1537
- _request_timeout: Union[
1538
- None,
1539
- Annotated[StrictFloat, Field(gt=0)],
1540
- Tuple[
1541
- Annotated[StrictFloat, Field(gt=0)],
1542
- Annotated[StrictFloat, Field(gt=0)]
1543
- ]
1544
- ] = None,
1545
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1546
- _content_type: Optional[StrictStr] = None,
1547
- _headers: Optional[Dict[StrictStr, Any]] = None,
1548
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1549
- ) -> RESTResponseType:
1550
- """List Payment Receipts
1551
-
1552
- Recovers all created payment receipts for the payment request provided
1553
-
1554
- :param id: Payment request primary identifier (required)
1555
- :type id: str
1556
- :param _request_timeout: timeout setting for this request. If one
1557
- number provided, it will be total request
1558
- timeout. It can also be a pair (tuple) of
1559
- (connection, read) timeouts.
1560
- :type _request_timeout: int, tuple(int, int), optional
1561
- :param _request_auth: set to override the auth_settings for an a single
1562
- request; this effectively ignores the
1563
- authentication in the spec for a single request.
1564
- :type _request_auth: dict, optional
1565
- :param _content_type: force content-type for the request.
1566
- :type _content_type: str, Optional
1567
- :param _headers: set to override the headers for a single
1568
- request; this effectively ignores the headers
1569
- in the spec for a single request.
1570
- :type _headers: dict, optional
1571
- :param _host_index: set to override the host_index for a single
1572
- request; this effectively ignores the host_index
1573
- in the spec for a single request.
1574
- :type _host_index: int, optional
1575
- :return: Returns the result object.
1576
- """ # noqa: E501
1577
-
1578
- _param = self._payment_request_receipt_list_serialize(
1579
- id=id,
1580
- _request_auth=_request_auth,
1581
- _content_type=_content_type,
1582
- _headers=_headers,
1583
- _host_index=_host_index
1584
- )
1585
-
1586
- _response_types_map: Dict[str, Optional[str]] = {
1587
- '200': "PaymentRequestReceiptList200Response",
1588
- }
1589
- response_data = self.api_client.call_api(
1590
- *_param,
1591
- _request_timeout=_request_timeout
1592
- )
1593
- return response_data.response
1594
-
1595
-
1596
- def _payment_request_receipt_list_serialize(
1597
- self,
1598
- id,
1599
- _request_auth,
1600
- _content_type,
1601
- _headers,
1602
- _host_index,
1603
- ) -> RequestSerialized:
1604
-
1605
- _host = None
1606
-
1607
- _collection_formats: Dict[str, str] = {
1608
- }
1609
-
1610
- _path_params: Dict[str, str] = {}
1611
- _query_params: List[Tuple[str, str]] = []
1612
- _header_params: Dict[str, Optional[str]] = _headers or {}
1613
- _form_params: List[Tuple[str, str]] = []
1614
- _files: Dict[str, Union[str, bytes]] = {}
1615
- _body_params: Optional[bytes] = None
1616
-
1617
- # process the path parameters
1618
- if id is not None:
1619
- _path_params['id'] = id
1620
- # process the query parameters
1621
- # process the header parameters
1622
- # process the form parameters
1623
- # process the body parameter
1624
-
1625
-
1626
- # set the HTTP header `Accept`
1627
- if 'Accept' not in _header_params:
1628
- _header_params['Accept'] = self.api_client.select_header_accept(
1629
- [
1630
- 'application/json'
1631
- ]
1632
- )
1633
-
1634
-
1635
- # authentication setting
1636
- _auth_settings: List[str] = [
1637
- ]
1638
-
1639
- return self.api_client.param_serialize(
1640
- method='GET',
1641
- resource_path='/payments/requests/{id}/receipts',
1642
- path_params=_path_params,
1643
- query_params=_query_params,
1644
- header_params=_header_params,
1645
- body=_body_params,
1646
- post_params=_form_params,
1647
- files=_files,
1648
- auth_settings=_auth_settings,
1649
- collection_formats=_collection_formats,
1650
- _host=_host,
1651
- _request_auth=_request_auth
1652
- )
1653
-
1654
-
1655
-
1656
-
1657
- @validate_call
1658
- def payment_request_receipt_retrieve(
1659
- self,
1660
- payment_request_id: StrictStr,
1661
- payment_receipt_id: StrictStr,
1662
- _request_timeout: Union[
1663
- None,
1664
- Annotated[StrictFloat, Field(gt=0)],
1665
- Tuple[
1666
- Annotated[StrictFloat, Field(gt=0)],
1667
- Annotated[StrictFloat, Field(gt=0)]
1668
- ]
1669
- ] = None,
1670
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1671
- _content_type: Optional[StrictStr] = None,
1672
- _headers: Optional[Dict[StrictStr, Any]] = None,
1673
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1674
- ) -> PaymentReceipt:
1675
- """Retrieve Payment Receipt
1676
-
1677
- Recovers the payment receipt resource by its id
1678
-
1679
- :param payment_request_id: (required)
1680
- :type payment_request_id: str
1681
- :param payment_receipt_id: (required)
1682
- :type payment_receipt_id: str
1683
- :param _request_timeout: timeout setting for this request. If one
1684
- number provided, it will be total request
1685
- timeout. It can also be a pair (tuple) of
1686
- (connection, read) timeouts.
1687
- :type _request_timeout: int, tuple(int, int), optional
1688
- :param _request_auth: set to override the auth_settings for an a single
1689
- request; this effectively ignores the
1690
- authentication in the spec for a single request.
1691
- :type _request_auth: dict, optional
1692
- :param _content_type: force content-type for the request.
1693
- :type _content_type: str, Optional
1694
- :param _headers: set to override the headers for a single
1695
- request; this effectively ignores the headers
1696
- in the spec for a single request.
1697
- :type _headers: dict, optional
1698
- :param _host_index: set to override the host_index for a single
1699
- request; this effectively ignores the host_index
1700
- in the spec for a single request.
1701
- :type _host_index: int, optional
1702
- :return: Returns the result object.
1703
- """ # noqa: E501
1704
-
1705
- _param = self._payment_request_receipt_retrieve_serialize(
1706
- payment_request_id=payment_request_id,
1707
- payment_receipt_id=payment_receipt_id,
1708
- _request_auth=_request_auth,
1709
- _content_type=_content_type,
1710
- _headers=_headers,
1711
- _host_index=_host_index
1712
- )
1713
-
1714
- _response_types_map: Dict[str, Optional[str]] = {
1715
- '200': "PaymentReceipt",
1716
- }
1717
- response_data = self.api_client.call_api(
1718
- *_param,
1719
- _request_timeout=_request_timeout
1720
- )
1721
- response_data.read()
1722
- return self.api_client.response_deserialize(
1723
- response_data=response_data,
1724
- response_types_map=_response_types_map,
1725
- ).data
1726
-
1727
-
1728
- @validate_call
1729
- def payment_request_receipt_retrieve_with_http_info(
1730
- self,
1731
- payment_request_id: StrictStr,
1732
- payment_receipt_id: StrictStr,
1733
- _request_timeout: Union[
1734
- None,
1735
- Annotated[StrictFloat, Field(gt=0)],
1736
- Tuple[
1737
- Annotated[StrictFloat, Field(gt=0)],
1738
- Annotated[StrictFloat, Field(gt=0)]
1739
- ]
1740
- ] = None,
1741
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1742
- _content_type: Optional[StrictStr] = None,
1743
- _headers: Optional[Dict[StrictStr, Any]] = None,
1744
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1745
- ) -> ApiResponse[PaymentReceipt]:
1746
- """Retrieve Payment Receipt
1747
-
1748
- Recovers the payment receipt resource by its id
1749
-
1750
- :param payment_request_id: (required)
1751
- :type payment_request_id: str
1752
- :param payment_receipt_id: (required)
1753
- :type payment_receipt_id: str
1754
- :param _request_timeout: timeout setting for this request. If one
1755
- number provided, it will be total request
1756
- timeout. It can also be a pair (tuple) of
1757
- (connection, read) timeouts.
1758
- :type _request_timeout: int, tuple(int, int), optional
1759
- :param _request_auth: set to override the auth_settings for an a single
1760
- request; this effectively ignores the
1761
- authentication in the spec for a single request.
1762
- :type _request_auth: dict, optional
1763
- :param _content_type: force content-type for the request.
1764
- :type _content_type: str, Optional
1765
- :param _headers: set to override the headers for a single
1766
- request; this effectively ignores the headers
1767
- in the spec for a single request.
1768
- :type _headers: dict, optional
1769
- :param _host_index: set to override the host_index for a single
1770
- request; this effectively ignores the host_index
1771
- in the spec for a single request.
1772
- :type _host_index: int, optional
1773
- :return: Returns the result object.
1774
- """ # noqa: E501
1775
-
1776
- _param = self._payment_request_receipt_retrieve_serialize(
1777
- payment_request_id=payment_request_id,
1778
- payment_receipt_id=payment_receipt_id,
1779
- _request_auth=_request_auth,
1780
- _content_type=_content_type,
1781
- _headers=_headers,
1782
- _host_index=_host_index
1783
- )
1784
-
1785
- _response_types_map: Dict[str, Optional[str]] = {
1786
- '200': "PaymentReceipt",
1787
- }
1788
- response_data = self.api_client.call_api(
1789
- *_param,
1790
- _request_timeout=_request_timeout
1791
- )
1792
- response_data.read()
1793
- return self.api_client.response_deserialize(
1794
- response_data=response_data,
1795
- response_types_map=_response_types_map,
1796
- )
1797
-
1798
-
1799
- @validate_call
1800
- def payment_request_receipt_retrieve_without_preload_content(
1801
- self,
1802
- payment_request_id: StrictStr,
1803
- payment_receipt_id: StrictStr,
1804
- _request_timeout: Union[
1805
- None,
1806
- Annotated[StrictFloat, Field(gt=0)],
1807
- Tuple[
1808
- Annotated[StrictFloat, Field(gt=0)],
1809
- Annotated[StrictFloat, Field(gt=0)]
1810
- ]
1811
- ] = None,
1812
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1813
- _content_type: Optional[StrictStr] = None,
1814
- _headers: Optional[Dict[StrictStr, Any]] = None,
1815
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1816
- ) -> RESTResponseType:
1817
- """Retrieve Payment Receipt
1818
-
1819
- Recovers the payment receipt resource by its id
1820
-
1821
- :param payment_request_id: (required)
1822
- :type payment_request_id: str
1823
- :param payment_receipt_id: (required)
1824
- :type payment_receipt_id: str
1825
- :param _request_timeout: timeout setting for this request. If one
1826
- number provided, it will be total request
1827
- timeout. It can also be a pair (tuple) of
1828
- (connection, read) timeouts.
1829
- :type _request_timeout: int, tuple(int, int), optional
1830
- :param _request_auth: set to override the auth_settings for an a single
1831
- request; this effectively ignores the
1832
- authentication in the spec for a single request.
1833
- :type _request_auth: dict, optional
1834
- :param _content_type: force content-type for the request.
1835
- :type _content_type: str, Optional
1836
- :param _headers: set to override the headers for a single
1837
- request; this effectively ignores the headers
1838
- in the spec for a single request.
1839
- :type _headers: dict, optional
1840
- :param _host_index: set to override the host_index for a single
1841
- request; this effectively ignores the host_index
1842
- in the spec for a single request.
1843
- :type _host_index: int, optional
1844
- :return: Returns the result object.
1845
- """ # noqa: E501
1846
-
1847
- _param = self._payment_request_receipt_retrieve_serialize(
1848
- payment_request_id=payment_request_id,
1849
- payment_receipt_id=payment_receipt_id,
1850
- _request_auth=_request_auth,
1851
- _content_type=_content_type,
1852
- _headers=_headers,
1853
- _host_index=_host_index
1854
- )
1855
-
1856
- _response_types_map: Dict[str, Optional[str]] = {
1857
- '200': "PaymentReceipt",
1858
- }
1859
- response_data = self.api_client.call_api(
1860
- *_param,
1861
- _request_timeout=_request_timeout
1862
- )
1863
- return response_data.response
1864
-
1865
-
1866
- def _payment_request_receipt_retrieve_serialize(
1867
- self,
1868
- payment_request_id,
1869
- payment_receipt_id,
1870
- _request_auth,
1871
- _content_type,
1872
- _headers,
1873
- _host_index,
1874
- ) -> RequestSerialized:
1875
-
1876
- _host = None
1877
-
1878
- _collection_formats: Dict[str, str] = {
1879
- }
1880
-
1881
- _path_params: Dict[str, str] = {}
1882
- _query_params: List[Tuple[str, str]] = []
1883
- _header_params: Dict[str, Optional[str]] = _headers or {}
1884
- _form_params: List[Tuple[str, str]] = []
1885
- _files: Dict[str, Union[str, bytes]] = {}
1886
- _body_params: Optional[bytes] = None
1887
-
1888
- # process the path parameters
1889
- if payment_request_id is not None:
1890
- _path_params['payment-request-id'] = payment_request_id
1891
- if payment_receipt_id is not None:
1892
- _path_params['payment-receipt-id'] = payment_receipt_id
1893
- # process the query parameters
1894
- # process the header parameters
1895
- # process the form parameters
1896
- # process the body parameter
1897
-
1898
-
1899
- # set the HTTP header `Accept`
1900
- if 'Accept' not in _header_params:
1901
- _header_params['Accept'] = self.api_client.select_header_accept(
1902
- [
1903
- 'application/json'
1904
- ]
1905
- )
1906
-
1907
-
1908
- # authentication setting
1909
- _auth_settings: List[str] = [
1910
- ]
1911
-
1912
- return self.api_client.param_serialize(
1913
- method='GET',
1914
- resource_path='/payments/requests/{payment-request-id}/receipts/{payment-receipt-id}',
1915
- path_params=_path_params,
1916
- query_params=_query_params,
1917
- header_params=_header_params,
1918
- body=_body_params,
1919
- post_params=_form_params,
1920
- files=_files,
1921
- auth_settings=_auth_settings,
1922
- collection_formats=_collection_formats,
1923
- _host=_host,
1924
- _request_auth=_request_auth
1925
- )
1926
-
1927
-
1928
-
1929
-
1930
1125
  @validate_call
1931
1126
  def payment_request_retrieve(
1932
1127
  self,
@@ -2718,262 +1913,3 @@ class PaymentRequestApi:
2718
1913
  )
2719
1914
 
2720
1915
 
2721
-
2722
-
2723
- @validate_call
2724
- def payment_schedules_list(
2725
- self,
2726
- id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
2727
- _request_timeout: Union[
2728
- None,
2729
- Annotated[StrictFloat, Field(gt=0)],
2730
- Tuple[
2731
- Annotated[StrictFloat, Field(gt=0)],
2732
- Annotated[StrictFloat, Field(gt=0)]
2733
- ]
2734
- ] = None,
2735
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2736
- _content_type: Optional[StrictStr] = None,
2737
- _headers: Optional[Dict[StrictStr, Any]] = None,
2738
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2739
- ) -> PaymentSchedulesList200Response:
2740
- """Schedule List
2741
-
2742
- Recovers all scheduled payments from a payment request
2743
-
2744
- :param id: Payment request primary identifier (required)
2745
- :type id: str
2746
- :param _request_timeout: timeout setting for this request. If one
2747
- number provided, it will be total request
2748
- timeout. It can also be a pair (tuple) of
2749
- (connection, read) timeouts.
2750
- :type _request_timeout: int, tuple(int, int), optional
2751
- :param _request_auth: set to override the auth_settings for an a single
2752
- request; this effectively ignores the
2753
- authentication in the spec for a single request.
2754
- :type _request_auth: dict, optional
2755
- :param _content_type: force content-type for the request.
2756
- :type _content_type: str, Optional
2757
- :param _headers: set to override the headers for a single
2758
- request; this effectively ignores the headers
2759
- in the spec for a single request.
2760
- :type _headers: dict, optional
2761
- :param _host_index: set to override the host_index for a single
2762
- request; this effectively ignores the host_index
2763
- in the spec for a single request.
2764
- :type _host_index: int, optional
2765
- :return: Returns the result object.
2766
- """ # noqa: E501
2767
-
2768
- _param = self._payment_schedules_list_serialize(
2769
- id=id,
2770
- _request_auth=_request_auth,
2771
- _content_type=_content_type,
2772
- _headers=_headers,
2773
- _host_index=_host_index
2774
- )
2775
-
2776
- _response_types_map: Dict[str, Optional[str]] = {
2777
- '200': "PaymentSchedulesList200Response",
2778
- }
2779
- response_data = self.api_client.call_api(
2780
- *_param,
2781
- _request_timeout=_request_timeout
2782
- )
2783
- response_data.read()
2784
- return self.api_client.response_deserialize(
2785
- response_data=response_data,
2786
- response_types_map=_response_types_map,
2787
- ).data
2788
-
2789
-
2790
- @validate_call
2791
- def payment_schedules_list_with_http_info(
2792
- self,
2793
- id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
2794
- _request_timeout: Union[
2795
- None,
2796
- Annotated[StrictFloat, Field(gt=0)],
2797
- Tuple[
2798
- Annotated[StrictFloat, Field(gt=0)],
2799
- Annotated[StrictFloat, Field(gt=0)]
2800
- ]
2801
- ] = None,
2802
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2803
- _content_type: Optional[StrictStr] = None,
2804
- _headers: Optional[Dict[StrictStr, Any]] = None,
2805
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2806
- ) -> ApiResponse[PaymentSchedulesList200Response]:
2807
- """Schedule List
2808
-
2809
- Recovers all scheduled payments from a payment request
2810
-
2811
- :param id: Payment request primary identifier (required)
2812
- :type id: str
2813
- :param _request_timeout: timeout setting for this request. If one
2814
- number provided, it will be total request
2815
- timeout. It can also be a pair (tuple) of
2816
- (connection, read) timeouts.
2817
- :type _request_timeout: int, tuple(int, int), optional
2818
- :param _request_auth: set to override the auth_settings for an a single
2819
- request; this effectively ignores the
2820
- authentication in the spec for a single request.
2821
- :type _request_auth: dict, optional
2822
- :param _content_type: force content-type for the request.
2823
- :type _content_type: str, Optional
2824
- :param _headers: set to override the headers for a single
2825
- request; this effectively ignores the headers
2826
- in the spec for a single request.
2827
- :type _headers: dict, optional
2828
- :param _host_index: set to override the host_index for a single
2829
- request; this effectively ignores the host_index
2830
- in the spec for a single request.
2831
- :type _host_index: int, optional
2832
- :return: Returns the result object.
2833
- """ # noqa: E501
2834
-
2835
- _param = self._payment_schedules_list_serialize(
2836
- id=id,
2837
- _request_auth=_request_auth,
2838
- _content_type=_content_type,
2839
- _headers=_headers,
2840
- _host_index=_host_index
2841
- )
2842
-
2843
- _response_types_map: Dict[str, Optional[str]] = {
2844
- '200': "PaymentSchedulesList200Response",
2845
- }
2846
- response_data = self.api_client.call_api(
2847
- *_param,
2848
- _request_timeout=_request_timeout
2849
- )
2850
- response_data.read()
2851
- return self.api_client.response_deserialize(
2852
- response_data=response_data,
2853
- response_types_map=_response_types_map,
2854
- )
2855
-
2856
-
2857
- @validate_call
2858
- def payment_schedules_list_without_preload_content(
2859
- self,
2860
- id: Annotated[StrictStr, Field(description="Payment request primary identifier")],
2861
- _request_timeout: Union[
2862
- None,
2863
- Annotated[StrictFloat, Field(gt=0)],
2864
- Tuple[
2865
- Annotated[StrictFloat, Field(gt=0)],
2866
- Annotated[StrictFloat, Field(gt=0)]
2867
- ]
2868
- ] = None,
2869
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2870
- _content_type: Optional[StrictStr] = None,
2871
- _headers: Optional[Dict[StrictStr, Any]] = None,
2872
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2873
- ) -> RESTResponseType:
2874
- """Schedule List
2875
-
2876
- Recovers all scheduled payments from a payment request
2877
-
2878
- :param id: Payment request primary identifier (required)
2879
- :type id: str
2880
- :param _request_timeout: timeout setting for this request. If one
2881
- number provided, it will be total request
2882
- timeout. It can also be a pair (tuple) of
2883
- (connection, read) timeouts.
2884
- :type _request_timeout: int, tuple(int, int), optional
2885
- :param _request_auth: set to override the auth_settings for an a single
2886
- request; this effectively ignores the
2887
- authentication in the spec for a single request.
2888
- :type _request_auth: dict, optional
2889
- :param _content_type: force content-type for the request.
2890
- :type _content_type: str, Optional
2891
- :param _headers: set to override the headers for a single
2892
- request; this effectively ignores the headers
2893
- in the spec for a single request.
2894
- :type _headers: dict, optional
2895
- :param _host_index: set to override the host_index for a single
2896
- request; this effectively ignores the host_index
2897
- in the spec for a single request.
2898
- :type _host_index: int, optional
2899
- :return: Returns the result object.
2900
- """ # noqa: E501
2901
-
2902
- _param = self._payment_schedules_list_serialize(
2903
- id=id,
2904
- _request_auth=_request_auth,
2905
- _content_type=_content_type,
2906
- _headers=_headers,
2907
- _host_index=_host_index
2908
- )
2909
-
2910
- _response_types_map: Dict[str, Optional[str]] = {
2911
- '200': "PaymentSchedulesList200Response",
2912
- }
2913
- response_data = self.api_client.call_api(
2914
- *_param,
2915
- _request_timeout=_request_timeout
2916
- )
2917
- return response_data.response
2918
-
2919
-
2920
- def _payment_schedules_list_serialize(
2921
- self,
2922
- id,
2923
- _request_auth,
2924
- _content_type,
2925
- _headers,
2926
- _host_index,
2927
- ) -> RequestSerialized:
2928
-
2929
- _host = None
2930
-
2931
- _collection_formats: Dict[str, str] = {
2932
- }
2933
-
2934
- _path_params: Dict[str, str] = {}
2935
- _query_params: List[Tuple[str, str]] = []
2936
- _header_params: Dict[str, Optional[str]] = _headers or {}
2937
- _form_params: List[Tuple[str, str]] = []
2938
- _files: Dict[str, Union[str, bytes]] = {}
2939
- _body_params: Optional[bytes] = None
2940
-
2941
- # process the path parameters
2942
- if id is not None:
2943
- _path_params['id'] = id
2944
- # process the query parameters
2945
- # process the header parameters
2946
- # process the form parameters
2947
- # process the body parameter
2948
-
2949
-
2950
- # set the HTTP header `Accept`
2951
- if 'Accept' not in _header_params:
2952
- _header_params['Accept'] = self.api_client.select_header_accept(
2953
- [
2954
- 'application/json'
2955
- ]
2956
- )
2957
-
2958
-
2959
- # authentication setting
2960
- _auth_settings: List[str] = [
2961
- 'default'
2962
- ]
2963
-
2964
- return self.api_client.param_serialize(
2965
- method='GET',
2966
- resource_path='/payments/requests/{id}/schedules',
2967
- path_params=_path_params,
2968
- query_params=_query_params,
2969
- header_params=_header_params,
2970
- body=_body_params,
2971
- post_params=_form_params,
2972
- files=_files,
2973
- auth_settings=_auth_settings,
2974
- collection_formats=_collection_formats,
2975
- _host=_host,
2976
- _request_auth=_request_auth
2977
- )
2978
-
2979
-