Skip to content

Commit b945658

Browse files
committed
Updated python API Client
1 parent 2a9f2b5 commit b945658

80 files changed

Lines changed: 560 additions & 220 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.openapi-generator/FILES

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ docs/SendMailTo.md
3232
docs/SendingApi.md
3333
docs/ServicesApi.md
3434
docs/StatusApi.md
35+
docs/ViewMailLogStartDateParameter.md
3536
git_push.sh
3637
openapi_client/__init__.py
3738
openapi_client/api/__init__.py
@@ -68,6 +69,7 @@ openapi_client/models/send_mail.py
6869
openapi_client/models/send_mail_adv.py
6970
openapi_client/models/send_mail_raw.py
7071
openapi_client/models/send_mail_to.py
72+
openapi_client/models/view_mail_log_start_date_parameter.py
7173
openapi_client/py.typed
7274
openapi_client/rest.py
7375
pyproject.toml
@@ -104,4 +106,5 @@ test/test_send_mail_to.py
104106
test/test_sending_api.py
105107
test/test_services_api.py
106108
test/test_status_api.py
109+
test/test_view_mail_log_start_date_parameter.py
107110
tox.ini

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ After a successful send each endpoint returns a `GenericResponse` whose `text` f
1818

1919
# Filtering & Logs
2020

21-
`GET /mail/log` provides paginated access to every message accepted by the relay for your account. Combine any of the query parameters to narrow results — e.g. `from`, `to`, `subject`, `messageId`, `origin`, `mx`, `startDate`/`endDate`, and `delivered`.
21+
`GET /mail/log` provides paginated access to every message accepted by the relay for your account. Combine any of the query parameters to narrow results — e.g. `from`, `to`, `subject`, `messageId`, `origin`, `mx`, `startDate`/`endDate`, and `delivered`.
2222

2323
# Blocking
2424

@@ -114,7 +114,7 @@ configuration.api_key['apiKeyAuth'] = os.environ["API_KEY"]
114114
with openapi_client.ApiClient(configuration) as api_client:
115115
# Create an instance of the API class
116116
api_instance = openapi_client.BlockingApi(api_client)
117-
type = 'type_example' # str | The type of deny rule.
117+
type = 'type_example' # str | The matching strategy for this rule. `email` blocks an exact sender address, `domain` blocks all senders at a domain, `destination` blocks an exact recipient address, and `startswith` blocks any sender whose local-part begins with the given prefix.
118118
data = 'data_example' # str | The value to match against, interpreted according to `type`: a full email address for `email`/`destination`, a domain name for `domain`, or an alphanumeric prefix string for `startswith`.
119119
user = 'user_example' # str | Optional SMTP username of the mail order to associate this rule with (e.g. `mb20682`). If omitted the first active order is used. Valid usernames are the `username` values returned by `GET /mail`. (optional)
120120

@@ -174,6 +174,7 @@ Class | Method | HTTP request | Description
174174
- [SendMailAdv](docs/SendMailAdv.md)
175175
- [SendMailRaw](docs/SendMailRaw.md)
176176
- [SendMailTo](docs/SendMailTo.md)
177+
- [ViewMailLogStartDateParameter](docs/ViewMailLogStartDateParameter.md)
177178

178179

179180
<a id="documentation-for-authorization"></a>

docs/BlockingApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ configuration.api_key['apiKeyAuth'] = os.environ["API_KEY"]
6060
with openapi_client.ApiClient(configuration) as api_client:
6161
# Create an instance of the API class
6262
api_instance = openapi_client.BlockingApi(api_client)
63-
type = 'type_example' # str | The type of deny rule.
63+
type = 'type_example' # str | The matching strategy for this rule. `email` blocks an exact sender address, `domain` blocks all senders at a domain, `destination` blocks an exact recipient address, and `startswith` blocks any sender whose local-part begins with the given prefix.
6464
data = 'data_example' # str | The value to match against, interpreted according to `type`: a full email address for `email`/`destination`, a domain name for `domain`, or an alphanumeric prefix string for `startswith`.
6565
user = 'user_example' # str | Optional SMTP username of the mail order to associate this rule with (e.g. `mb20682`). If omitted the first active order is used. Valid usernames are the `username` values returned by `GET /mail`. (optional)
6666

@@ -80,7 +80,7 @@ with openapi_client.ApiClient(configuration) as api_client:
8080

8181
Name | Type | Description | Notes
8282
------------- | ------------- | ------------- | -------------
83-
**type** | **str**| The type of deny rule. |
83+
**type** | **str**| The matching strategy for this rule. &#x60;email&#x60; blocks an exact sender address, &#x60;domain&#x60; blocks all senders at a domain, &#x60;destination&#x60; blocks an exact recipient address, and &#x60;startswith&#x60; blocks any sender whose local-part begins with the given prefix. |
8484
**data** | **str**| The value to match against, interpreted according to &#x60;type&#x60;: a full email address for &#x60;email&#x60;/&#x60;destination&#x60;, a domain name for &#x60;domain&#x60;, or an alphanumeric prefix string for &#x60;startswith&#x60;. |
8585
**user** | **str**| Optional SMTP username of the mail order to associate this rule with (e.g. &#x60;mb20682&#x60;). If omitted the first active order is used. Valid usernames are the &#x60;username&#x60; values returned by &#x60;GET /mail&#x60;. | [optional]
8686

@@ -270,7 +270,7 @@ Name | Type | Description | Notes
270270

271271
### HTTP request headers
272272

273-
- **Content-Type**: application/json, multipart/form-data
273+
- **Content-Type**: application/json, application/x-www-form-urlencoded
274274
- **Accept**: application/json
275275

276276
### HTTP response details

docs/DenyRuleNew.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The fields required to create a new email deny rule via `POST /mail/rules`. The
77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**user** | **str** | Optional SMTP username of the mail order to associate this rule with (e.g. &#x60;mb20682&#x60;). If omitted the first active order is used. Valid usernames are the &#x60;username&#x60; values returned by &#x60;GET /mail&#x60;. | [optional]
10-
**type** | **str** | The type of deny rule. |
10+
**type** | **str** | The matching strategy for this rule. &#x60;email&#x60; blocks an exact sender address, &#x60;domain&#x60; blocks all senders at a domain, &#x60;destination&#x60; blocks an exact recipient address, and &#x60;startswith&#x60; blocks any sender whose local-part begins with the given prefix. |
1111
**data** | **str** | The value to match against, interpreted according to &#x60;type&#x60;: a full email address for &#x60;email&#x60;/&#x60;destination&#x60;, a domain name for &#x60;domain&#x60;, or an alphanumeric prefix string for &#x60;startswith&#x60;. |
1212

1313
## Example

docs/DenyRuleRecord.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ A complete deny rule record as returned by `GET /mail/rules`. Combines the rule
77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**user** | **str** | Optional SMTP username of the mail order to associate this rule with (e.g. &#x60;mb20682&#x60;). If omitted the first active order is used. Valid usernames are the &#x60;username&#x60; values returned by &#x60;GET /mail&#x60;. | [optional]
10-
**type** | **str** | The type of deny rule. |
10+
**type** | **str** | The matching strategy for this rule. &#x60;email&#x60; blocks an exact sender address, &#x60;domain&#x60; blocks all senders at a domain, &#x60;destination&#x60; blocks an exact recipient address, and &#x60;startswith&#x60; blocks any sender whose local-part begins with the given prefix. |
1111
**data** | **str** | The value to match against, interpreted according to &#x60;type&#x60;: a full email address for &#x60;email&#x60;/&#x60;destination&#x60;, a domain name for &#x60;domain&#x60;, or an alphanumeric prefix string for &#x60;startswith&#x60;. |
1212
**id** | **str** | The numeric ID of the deny rule, as a string. Pass this as &#x60;ruleId&#x60; to &#x60;DELETE /mail/rules/{ruleId}&#x60; to remove the rule. |
1313
**created** | **datetime** | The timestamp when the rule was created. |

docs/GenericResponse.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Standard success response returned by write operations (send, add rule, delete,
66

77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
9-
**status** | **str** | Always &#x60;\&quot;ok\&quot;&#x60; on success. | [optional]
10-
**text** | **str** | Operation-specific result string. For send operations this is the relay transaction ID (e.g. &#x60;185caa69ff7000f47c&#x60;) which can be used as the &#x60;mailid&#x60; parameter in &#x60;GET /mail/log&#x60;. For create operations this is the new record&#39;s numeric ID. For delete operations this is a human-readable confirmation. | [optional]
9+
**status** | **str** | Always &#x60;\&quot;ok\&quot;&#x60; on success. |
10+
**text** | **str** | Operation-specific result string. For send operations this is the relay transaction ID (e.g. &#x60;185caa69ff7000f47c&#x60;) which can be used as the &#x60;mailid&#x60; parameter in &#x60;GET /mail/log&#x60;. For create operations this is the new record&#39;s numeric ID. For delete operations this is a human-readable confirmation. |
1111

1212
## Example
1313

0 commit comments

Comments
 (0)