Skip to content

Commit 4bb450e

Browse files
hostingerbot[bot]hostingerbot[bot]
committed
chore: sdk update
1 parent 713982b commit 4bb450e

762 files changed

Lines changed: 2767 additions & 743 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.

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,9 @@ Class | Method | HTTP request | Description
210210
*MailMailboxesApi* | [**create_mailbox_v1**](docs/MailMailboxesApi.md#create_mailbox_v1) | **POST** /api/mail/v1/orders/{orderId}/mailboxes | Create mailbox
211211
*MailMailboxesApi* | [**delete_mailbox_v1**](docs/MailMailboxesApi.md#delete_mailbox_v1) | **DELETE** /api/mail/v1/mailboxes/{mailboxId} | Delete mailbox
212212
*MailMailboxesApi* | [**list_mailboxes_v1**](docs/MailMailboxesApi.md#list_mailboxes_v1) | **GET** /api/mail/v1/orders/{orderId}/mailboxes | List mailboxes
213+
*MailOrdersApi* | [**get_order_plan_v1**](docs/MailOrdersApi.md#get_order_plan_v1) | **GET** /api/mail/v1/orders/{orderId}/plan | Get order plan
213214
*MailOrdersApi* | [**list_orders_v1**](docs/MailOrdersApi.md#list_orders_v1) | **GET** /api/mail/v1/orders | List orders
215+
*MailWebhooksApi* | [**create_webhook_v1**](docs/MailWebhooksApi.md#create_webhook_v1) | **POST** /api/mail/v1/mailboxes/{mailboxId}/webhooks | Create webhook
214216
*ReachContactsApi* | [**create_a_new_contact_v1**](docs/ReachContactsApi.md#create_a_new_contact_v1) | **POST** /api/reach/v1/contacts | Create a new contact
215217
*ReachContactsApi* | [**create_new_contacts_v1**](docs/ReachContactsApi.md#create_new_contacts_v1) | **POST** /api/reach/v1/profiles/{profileUuid}/contacts | Create new contacts
216218
*ReachContactsApi* | [**delete_a_contact_v1**](docs/ReachContactsApi.md#delete_a_contact_v1) | **DELETE** /api/reach/v1/contacts/{uuid} | Delete a contact
@@ -522,8 +524,14 @@ Class | Method | HTTP request | Description
522524
- [MailV1OrdersOrderDomainResource](docs/MailV1OrdersOrderDomainResource.md)
523525
- [MailV1OrdersOrderPlanResource](docs/MailV1OrdersOrderPlanResource.md)
524526
- [MailV1OrdersOrderResource](docs/MailV1OrdersOrderResource.md)
527+
- [MailV1OrdersPlanDomainResource](docs/MailV1OrdersPlanDomainResource.md)
528+
- [MailV1OrdersPlanMailboxResource](docs/MailV1OrdersPlanMailboxResource.md)
529+
- [MailV1OrdersPlanResource](docs/MailV1OrdersPlanResource.md)
525530
- [MailV1SchemaChangeMailboxPasswordRequestSchema](docs/MailV1SchemaChangeMailboxPasswordRequestSchema.md)
526531
- [MailV1SchemaCreateMailboxRequestSchema](docs/MailV1SchemaCreateMailboxRequestSchema.md)
532+
- [MailV1SchemaCreateWebhookRequestSchema](docs/MailV1SchemaCreateWebhookRequestSchema.md)
533+
- [MailV1WebhooksWebhookMailboxResource](docs/MailV1WebhooksWebhookMailboxResource.md)
534+
- [MailV1WebhooksWebhookResource](docs/MailV1WebhooksWebhookResource.md)
527535
- [ReachListContactsV1200Response](docs/ReachListContactsV1200Response.md)
528536
- [ReachListProfileSegmentContactsV1200Response](docs/ReachListProfileSegmentContactsV1200Response.md)
529537
- [ReachV1ContactsContactResource](docs/ReachV1ContactsContactResource.md)

‎docs/MailOrdersApi.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,83 @@ All URIs are relative to *https://developers.hostinger.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**get_order_plan_v1**](MailOrdersApi.md#get_order_plan_v1) | **GET** /api/mail/v1/orders/{orderId}/plan | Get order plan
78
[**list_orders_v1**](MailOrdersApi.md#list_orders_v1) | **GET** /api/mail/v1/orders | List orders
89

910

11+
# **get_order_plan_v1**
12+
> MailV1OrdersPlanResource get_order_plan_v1(order_id)
13+
14+
Get order plan
15+
16+
Retrieve the plan the given mail order was purchased with, including
17+
domain-level and mailbox-level quotas, limits, and protocol
18+
availability.
19+
20+
### Example
21+
22+
* Bearer Authentication (apiToken):
23+
24+
```python
25+
import hostinger_api
26+
from hostinger_api.models.mail_v1_orders_plan_resource import MailV1OrdersPlanResource
27+
from hostinger_api.rest import ApiException
28+
from pprint import pprint
29+
30+
31+
# Configure Bearer authorization: apiToken
32+
configuration = hostinger_api.Configuration(
33+
access_token = os.environ["BEARER_TOKEN"]
34+
)
35+
36+
# Enter a context with an instance of the API client
37+
with hostinger_api.ApiClient(configuration) as api_client:
38+
# Create an instance of the API class
39+
api_instance = hostinger_api.MailOrdersApi(api_client)
40+
order_id = 'OR1a2b3c4d5e6f7g' # str | Order resource ID
41+
42+
try:
43+
# Get order plan
44+
api_response = api_instance.get_order_plan_v1(order_id)
45+
print("The response of MailOrdersApi->get_order_plan_v1:\n")
46+
pprint(api_response)
47+
except Exception as e:
48+
print("Exception when calling MailOrdersApi->get_order_plan_v1: %s\n" % e)
49+
```
50+
51+
52+
53+
### Parameters
54+
55+
56+
Name | Type | Description | Notes
57+
------------- | ------------- | ------------- | -------------
58+
**order_id** | **str**| Order resource ID |
59+
60+
### Return type
61+
62+
[**MailV1OrdersPlanResource**](MailV1OrdersPlanResource.md)
63+
64+
### Authorization
65+
66+
[apiToken](../README.md#apiToken)
67+
68+
### HTTP request headers
69+
70+
- **Content-Type**: Not defined
71+
- **Accept**: application/json
72+
73+
### HTTP response details
74+
75+
| Status code | Description | Response headers |
76+
|-------------|-------------|------------------|
77+
**200** | Success response | - |
78+
**401** | Unauthenticated response | - |
79+
**404** | Error response | - |
80+
**500** | Error response | - |
81+
82+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
83+
1084
# **list_orders_v1**
1185
> MailListOrdersV1200Response list_orders_v1(domain=domain, status=status, is_trial=is_trial, sort=sort, page=page, per_page=per_page)
1286

‎docs/MailV1OrdersPlanDomainResource.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# MailV1OrdersPlanDomainResource
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**mailbox_quota** | **int** | Maximum number of mailboxes per domain | [optional]
9+
**forwarder_quota** | **int** | Maximum number of forwarders per domain | [optional]
10+
**alias_quota** | **int** | Maximum number of aliases per domain | [optional]
11+
**is_catchall_enabled** | **bool** | Whether catch-all mailboxes are available | [optional]
12+
**is_imap_enabled** | **bool** | Whether IMAP access is available | [optional]
13+
**is_pop3_enabled** | **bool** | Whether POP3 access is available | [optional]
14+
15+
## Example
16+
17+
```python
18+
from hostinger_api.models.mail_v1_orders_plan_domain_resource import MailV1OrdersPlanDomainResource
19+
20+
# TODO update the JSON string below
21+
json = "{}"
22+
# create an instance of MailV1OrdersPlanDomainResource from a JSON string
23+
mail_v1_orders_plan_domain_resource_instance = MailV1OrdersPlanDomainResource.from_json(json)
24+
# print the JSON string representation of the object
25+
print(MailV1OrdersPlanDomainResource.to_json())
26+
27+
# convert the object into a dict
28+
mail_v1_orders_plan_domain_resource_dict = mail_v1_orders_plan_domain_resource_instance.to_dict()
29+
# create an instance of MailV1OrdersPlanDomainResource from a dict
30+
mail_v1_orders_plan_domain_resource_from_dict = MailV1OrdersPlanDomainResource.from_dict(mail_v1_orders_plan_domain_resource_dict)
31+
```
32+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
33+
34+

‎docs/MailV1OrdersPlanMailboxResource.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# MailV1OrdersPlanMailboxResource
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**storage_quota** | **int** | Storage quota per mailbox in megabytes | [optional]
9+
**messages_quota** | **int** | Maximum number of stored messages per mailbox | [optional]
10+
**forwarder_quota** | **int** | Maximum number of forwarders per mailbox | [optional]
11+
**alias_quota** | **int** | Maximum number of aliases per mailbox | [optional]
12+
**max_outbound_message_size** | **int** | Maximum outbound message size in bytes | [optional]
13+
**max_outbound_attachment_size** | **int** | Maximum outbound attachment size in bytes | [optional]
14+
**max_outbound_recipient_limit** | **int** | Maximum number of recipients per outbound message | [optional]
15+
**rate_limit_inbound** | **str** | Inbound message rate limit as `messages/seconds` | [optional]
16+
**rate_limit_outbound** | **str** | Outbound message rate limit as `messages/seconds` | [optional]
17+
18+
## Example
19+
20+
```python
21+
from hostinger_api.models.mail_v1_orders_plan_mailbox_resource import MailV1OrdersPlanMailboxResource
22+
23+
# TODO update the JSON string below
24+
json = "{}"
25+
# create an instance of MailV1OrdersPlanMailboxResource from a JSON string
26+
mail_v1_orders_plan_mailbox_resource_instance = MailV1OrdersPlanMailboxResource.from_json(json)
27+
# print the JSON string representation of the object
28+
print(MailV1OrdersPlanMailboxResource.to_json())
29+
30+
# convert the object into a dict
31+
mail_v1_orders_plan_mailbox_resource_dict = mail_v1_orders_plan_mailbox_resource_instance.to_dict()
32+
# create an instance of MailV1OrdersPlanMailboxResource from a dict
33+
mail_v1_orders_plan_mailbox_resource_from_dict = MailV1OrdersPlanMailboxResource.from_dict(mail_v1_orders_plan_mailbox_resource_dict)
34+
```
35+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
36+
37+

‎docs/MailV1OrdersPlanResource.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# MailV1OrdersPlanResource
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**name** | **str** | Machine name of the plan | [optional]
9+
**title** | **str** | Human-readable plan title | [optional]
10+
**domain** | [**MailV1OrdersPlanDomainResource**](MailV1OrdersPlanDomainResource.md) | | [optional]
11+
**mailbox** | [**MailV1OrdersPlanMailboxResource**](MailV1OrdersPlanMailboxResource.md) | | [optional]
12+
13+
## Example
14+
15+
```python
16+
from hostinger_api.models.mail_v1_orders_plan_resource import MailV1OrdersPlanResource
17+
18+
# TODO update the JSON string below
19+
json = "{}"
20+
# create an instance of MailV1OrdersPlanResource from a JSON string
21+
mail_v1_orders_plan_resource_instance = MailV1OrdersPlanResource.from_json(json)
22+
# print the JSON string representation of the object
23+
print(MailV1OrdersPlanResource.to_json())
24+
25+
# convert the object into a dict
26+
mail_v1_orders_plan_resource_dict = mail_v1_orders_plan_resource_instance.to_dict()
27+
# create an instance of MailV1OrdersPlanResource from a dict
28+
mail_v1_orders_plan_resource_from_dict = MailV1OrdersPlanResource.from_dict(mail_v1_orders_plan_resource_dict)
29+
```
30+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31+
32+

‎docs/MailV1SchemaCreateWebhookRequestSchema.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# MailV1SchemaCreateWebhookRequestSchema
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**name** | **str** | Human-readable name for this webhook |
9+
**description** | **str** | Optional description of the webhook's purpose | [optional]
10+
**events** | **List[str]** | Events that trigger this webhook |
11+
**status** | **str** | Initial status of the webhook | [optional] [default to 'active']
12+
**url** | **str** | Publicly reachable URL that receives the webhook POST requests |
13+
14+
## Example
15+
16+
```python
17+
from hostinger_api.models.mail_v1_schema_create_webhook_request_schema import MailV1SchemaCreateWebhookRequestSchema
18+
19+
# TODO update the JSON string below
20+
json = "{}"
21+
# create an instance of MailV1SchemaCreateWebhookRequestSchema from a JSON string
22+
mail_v1_schema_create_webhook_request_schema_instance = MailV1SchemaCreateWebhookRequestSchema.from_json(json)
23+
# print the JSON string representation of the object
24+
print(MailV1SchemaCreateWebhookRequestSchema.to_json())
25+
26+
# convert the object into a dict
27+
mail_v1_schema_create_webhook_request_schema_dict = mail_v1_schema_create_webhook_request_schema_instance.to_dict()
28+
# create an instance of MailV1SchemaCreateWebhookRequestSchema from a dict
29+
mail_v1_schema_create_webhook_request_schema_from_dict = MailV1SchemaCreateWebhookRequestSchema.from_dict(mail_v1_schema_create_webhook_request_schema_dict)
30+
```
31+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
32+
33+

‎docs/MailV1WebhooksWebhookMailboxResource.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# MailV1WebhooksWebhookMailboxResource
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**id** | **str** | | [optional]
9+
**address** | **str** | | [optional]
10+
11+
## Example
12+
13+
```python
14+
from hostinger_api.models.mail_v1_webhooks_webhook_mailbox_resource import MailV1WebhooksWebhookMailboxResource
15+
16+
# TODO update the JSON string below
17+
json = "{}"
18+
# create an instance of MailV1WebhooksWebhookMailboxResource from a JSON string
19+
mail_v1_webhooks_webhook_mailbox_resource_instance = MailV1WebhooksWebhookMailboxResource.from_json(json)
20+
# print the JSON string representation of the object
21+
print(MailV1WebhooksWebhookMailboxResource.to_json())
22+
23+
# convert the object into a dict
24+
mail_v1_webhooks_webhook_mailbox_resource_dict = mail_v1_webhooks_webhook_mailbox_resource_instance.to_dict()
25+
# create an instance of MailV1WebhooksWebhookMailboxResource from a dict
26+
mail_v1_webhooks_webhook_mailbox_resource_from_dict = MailV1WebhooksWebhookMailboxResource.from_dict(mail_v1_webhooks_webhook_mailbox_resource_dict)
27+
```
28+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29+
30+

‎docs/MailV1WebhooksWebhookResource.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# MailV1WebhooksWebhookResource
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**id** | **str** | Unique webhook identifier | [optional]
9+
**mailbox** | [**MailV1WebhooksWebhookMailboxResource**](MailV1WebhooksWebhookMailboxResource.md) | | [optional]
10+
**name** | **str** | Human-readable name for this webhook | [optional]
11+
**description** | **str** | Optional description of the webhook's purpose | [optional]
12+
**events** | **List[str]** | Events that trigger this webhook | [optional]
13+
**status** | **str** | Current status of the webhook | [optional]
14+
**url** | **str** | URL that receives webhook POST requests | [optional]
15+
**secret** | **str** | One-time webhook secret, returned only on creation. Sent as `Authorization: Bearer <secret>` with every delivery. | [optional]
16+
**created_at** | **datetime** | | [optional]
17+
**updated_at** | **datetime** | | [optional]
18+
19+
## Example
20+
21+
```python
22+
from hostinger_api.models.mail_v1_webhooks_webhook_resource import MailV1WebhooksWebhookResource
23+
24+
# TODO update the JSON string below
25+
json = "{}"
26+
# create an instance of MailV1WebhooksWebhookResource from a JSON string
27+
mail_v1_webhooks_webhook_resource_instance = MailV1WebhooksWebhookResource.from_json(json)
28+
# print the JSON string representation of the object
29+
print(MailV1WebhooksWebhookResource.to_json())
30+
31+
# convert the object into a dict
32+
mail_v1_webhooks_webhook_resource_dict = mail_v1_webhooks_webhook_resource_instance.to_dict()
33+
# create an instance of MailV1WebhooksWebhookResource from a dict
34+
mail_v1_webhooks_webhook_resource_from_dict = MailV1WebhooksWebhookResource.from_dict(mail_v1_webhooks_webhook_resource_dict)
35+
```
36+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
37+
38+

0 commit comments

Comments
 (0)