Skip to content

Commit 2487552

Browse files
author
andreals
committed
Automated commit message
1 parent b3eaad0 commit 2487552

30 files changed

+4585
-4585
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ To run the file within your test project, right click on your Python file inside
7070

7171
## Initialize the API Client
7272

73-
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/client.md)
73+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/client.md)
7474

7575
The following parameters are configurable for the API Client:
7676

@@ -85,7 +85,7 @@ The following parameters are configurable for the API Client:
8585
| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
8686
| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
8787
| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |
88-
| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/$a/https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/basic-authentication.md) | The credential object for Basic Authentication |
88+
| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/$a/https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/basic-authentication.md) | The credential object for Basic Authentication |
8989

9090
The API client can be initialized as follows:
9191

@@ -104,39 +104,39 @@ client = PagarmeapisdkClient(
104104

105105
This API uses the following authentication schemes.
106106

107-
* [`httpBasic (Basic Authentication)`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/$a/https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/basic-authentication.md)
107+
* [`httpBasic (Basic Authentication)`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/$a/https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/basic-authentication.md)
108108

109109
## API Errors
110110

111111
Here is the list of errors that the API might throw.
112112

113113
| HTTP Status Code | Error Description | Exception Class |
114114
| --- | --- | --- |
115-
| 400 | Invalid request | [`ErrorException`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/models/error-exception.md) |
116-
| 401 | Invalid API key | [`ErrorException`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/models/error-exception.md) |
117-
| 404 | An informed resource was not found | [`ErrorException`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/models/error-exception.md) |
118-
| 412 | Business validation error | [`ErrorException`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/models/error-exception.md) |
119-
| 422 | Contract validation error | [`ErrorException`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/models/error-exception.md) |
120-
| 500 | Internal server error | [`ErrorException`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/models/error-exception.md) |
115+
| 400 | Invalid request | [`ErrorException`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/models/error-exception.md) |
116+
| 401 | Invalid API key | [`ErrorException`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/models/error-exception.md) |
117+
| 404 | An informed resource was not found | [`ErrorException`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/models/error-exception.md) |
118+
| 412 | Business validation error | [`ErrorException`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/models/error-exception.md) |
119+
| 422 | Contract validation error | [`ErrorException`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/models/error-exception.md) |
120+
| 500 | Internal server error | [`ErrorException`](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/models/error-exception.md) |
121121

122122
## List of APIs
123123

124-
* [Subscriptions](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/controllers/subscriptions.md)
125-
* [Orders](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/controllers/orders.md)
126-
* [Plans](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/controllers/plans.md)
127-
* [Invoices](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/controllers/invoices.md)
128-
* [Customers](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/controllers/customers.md)
129-
* [Charges](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/controllers/charges.md)
130-
* [Recipients](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/controllers/recipients.md)
131-
* [Tokens](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/controllers/tokens.md)
132-
* [Transactions](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/controllers/transactions.md)
133-
* [Transfers](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/controllers/transfers.md)
134-
* [Payables](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/controllers/payables.md)
135-
* [Balance Operations](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/controllers/balance-operations.md)
124+
* [Subscriptions](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/controllers/subscriptions.md)
125+
* [Orders](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/controllers/orders.md)
126+
* [Plans](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/controllers/plans.md)
127+
* [Invoices](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/controllers/invoices.md)
128+
* [Customers](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/controllers/customers.md)
129+
* [Charges](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/controllers/charges.md)
130+
* [Recipients](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/controllers/recipients.md)
131+
* [Tokens](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/controllers/tokens.md)
132+
* [Transactions](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/controllers/transactions.md)
133+
* [Transfers](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/controllers/transfers.md)
134+
* [Payables](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/controllers/payables.md)
135+
* [Balance Operations](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/controllers/balance-operations.md)
136136

137137
## Classes Documentation
138138

139-
* [Utility Classes](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/utility-classes.md)
140-
* [HttpResponse](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/http-response.md)
141-
* [HttpRequest](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.9/doc/http-request.md)
139+
* [Utility Classes](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/utility-classes.md)
140+
* [HttpResponse](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/http-response.md)
141+
* [HttpRequest](https://www.github.com/pagarme/pagarme-python-sdk/tree/6.8.10/doc/http-request.md)
142142

doc/controllers/balance-operations.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,64 +10,64 @@ balance_operations_controller = client.balance_operations
1010

1111
## Methods
1212

13-
* [Get Balance Operations](../../doc/controllers/balance-operations.md#get-balance-operations)
14-
* [Get Balance Operation by Id](../../doc/controllers/balance-operations.md#get-balance-operation-by-id)
13+
* [Get Balance Operation by Id](../../doc/controllers/balance-operations.md#get-balance-operation-by-id)
14+
* [Get Balance Operations](../../doc/controllers/balance-operations.md#get-balance-operations)
1515

1616

17-
# Get Balance Operations
17+
# Get Balance Operation by Id
1818

1919
```python
20-
def get_balance_operations(self,
21-
status=None,
22-
created_since=None,
23-
created_until=None,
24-
recipient_id=None)
20+
def get_balance_operation_by_id(self,
21+
id)
2522
```
2623

2724
## Parameters
2825

2926
| Parameter | Type | Tags | Description |
3027
| --- | --- | --- | --- |
31-
| `status` | `str` | Query, Optional | - |
32-
| `created_since` | `datetime` | Query, Optional | - |
33-
| `created_until` | `datetime` | Query, Optional | - |
34-
| `recipient_id` | `str` | Query, Optional | - |
28+
| `id` | `long\|int` | Template, Required | - |
3529

3630
## Response Type
3731

38-
[`ListBalanceOperationResponse`](../../doc/models/list-balance-operation-response.md)
32+
[`GetBalanceOperationResponse`](../../doc/models/get-balance-operation-response.md)
3933

4034
## Example Usage
4135

4236
```python
43-
result = balance_operations_controller.get_balance_operations()
37+
id = 112
38+
39+
result = balance_operations_controller.get_balance_operation_by_id(id)
4440
print(result)
4541
```
4642

4743

48-
# Get Balance Operation by Id
44+
# Get Balance Operations
4945

5046
```python
51-
def get_balance_operation_by_id(self,
52-
id)
47+
def get_balance_operations(self,
48+
status=None,
49+
created_since=None,
50+
created_until=None,
51+
recipient_id=None)
5352
```
5453

5554
## Parameters
5655

5756
| Parameter | Type | Tags | Description |
5857
| --- | --- | --- | --- |
59-
| `id` | `long\|int` | Template, Required | - |
58+
| `status` | `str` | Query, Optional | - |
59+
| `created_since` | `datetime` | Query, Optional | - |
60+
| `created_until` | `datetime` | Query, Optional | - |
61+
| `recipient_id` | `str` | Query, Optional | - |
6062

6163
## Response Type
6264

63-
[`GetBalanceOperationResponse`](../../doc/models/get-balance-operation-response.md)
65+
[`ListBalanceOperationResponse`](../../doc/models/list-balance-operation-response.md)
6466

6567
## Example Usage
6668

6769
```python
68-
id = 112
69-
70-
result = balance_operations_controller.get_balance_operation_by_id(id)
70+
result = balance_operations_controller.get_balance_operations()
7171
print(result)
7272
```
7373

0 commit comments

Comments
 (0)