Skip to content

Commit aeee9f4

Browse files
hostingerbot[bot]hostingerbot[bot]
committed
chore: sdk update
1 parent d54c39a commit aeee9f4

939 files changed

Lines changed: 2992 additions & 927 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: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,9 @@ Class | Method | HTTP request | Description
262262
*MailWebhooksApi* | [**regenerate_webhook_secret_v1**](docs/MailWebhooksApi.md#regenerate_webhook_secret_v1) | **POST** /api/mail/v1/webhooks/{webhookId}/regenerate-secret | Regenerate webhook secret
263263
*MailWebhooksApi* | [**test_webhook_v1**](docs/MailWebhooksApi.md#test_webhook_v1) | **POST** /api/mail/v1/webhooks/{webhookId}/test | Test webhook
264264
*MailWebhooksApi* | [**update_webhook_v1**](docs/MailWebhooksApi.md#update_webhook_v1) | **PATCH** /api/mail/v1/webhooks/{webhookId} | Update webhook
265+
*ReachAutomationsApi* | [**get_automation_details_v1**](docs/ReachAutomationsApi.md#get_automation_details_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/automations/{automationUuid} | Get automation details
266+
*ReachAutomationsApi* | [**list_automation_steps_v1**](docs/ReachAutomationsApi.md#list_automation_steps_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}/steps | List automation steps
267+
*ReachAutomationsApi* | [**list_automations_v1**](docs/ReachAutomationsApi.md#list_automations_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/automations | List automations
265268
*ReachContactFieldsApi* | [**create_a_contact_field_v1**](docs/ReachContactFieldsApi.md#create_a_contact_field_v1) | **POST** /api/reach/v1/profiles/{profileUuid}/contacts/fields | Create a contact field
266269
*ReachContactFieldsApi* | [**delete_a_contact_field_v1**](docs/ReachContactFieldsApi.md#delete_a_contact_field_v1) | **DELETE** /api/reach/v1/profiles/{profileUuid}/contacts/fields/{fieldUuid} | Delete a contact field
267270
*ReachContactFieldsApi* | [**list_contact_fields_v1**](docs/ReachContactFieldsApi.md#list_contact_fields_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/contacts/fields | List contact fields
@@ -654,10 +657,14 @@ Class | Method | HTTP request | Description
654657
- [MailV1WebhooksWebhookResource](docs/MailV1WebhooksWebhookResource.md)
655658
- [MailV1WebhooksWebhookSecretResource](docs/MailV1WebhooksWebhookSecretResource.md)
656659
- [MailV1WebhooksWebhookTestResultResource](docs/MailV1WebhooksWebhookTestResultResource.md)
660+
- [ReachListAutomationsV1200Response](docs/ReachListAutomationsV1200Response.md)
657661
- [ReachListContactsV1200Response](docs/ReachListContactsV1200Response.md)
658662
- [ReachListProfileContactsV1200Response](docs/ReachListProfileContactsV1200Response.md)
659663
- [ReachListProfileSegmentContactsV1200Response](docs/ReachListProfileSegmentContactsV1200Response.md)
660664
- [ReachListProfileSegmentsV1200Response](docs/ReachListProfileSegmentsV1200Response.md)
665+
- [ReachV1AutomationsAutomationEventsResource](docs/ReachV1AutomationsAutomationEventsResource.md)
666+
- [ReachV1AutomationsAutomationResource](docs/ReachV1AutomationsAutomationResource.md)
667+
- [ReachV1AutomationsStepsAutomationStepResource](docs/ReachV1AutomationsStepsAutomationStepResource.md)
661668
- [ReachV1ContactsBulkStoreRequest](docs/ReachV1ContactsBulkStoreRequest.md)
662669
- [ReachV1ContactsBulkStoreRequestContactsInner](docs/ReachV1ContactsBulkStoreRequestContactsInner.md)
663670
- [ReachV1ContactsContactDetailsResource](docs/ReachV1ContactsContactDetailsResource.md)

‎docs/ReachAutomationsApi.md‎

Lines changed: 245 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,245 @@
1+
# hostinger_api.ReachAutomationsApi
2+
3+
All URIs are relative to *https://developers.hostinger.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**get_automation_details_v1**](ReachAutomationsApi.md#get_automation_details_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/automations/{automationUuid} | Get automation details
8+
[**list_automation_steps_v1**](ReachAutomationsApi.md#list_automation_steps_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}/steps | List automation steps
9+
[**list_automations_v1**](ReachAutomationsApi.md#list_automations_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/automations | List automations
10+
11+
12+
# **get_automation_details_v1**
13+
> ReachV1AutomationsAutomationResource get_automation_details_v1(profile_uuid, automation_uuid)
14+
15+
Get automation details
16+
17+
Get a single automation with the counts of contacts that entered it, are moving through it,
18+
finished it or failed on the way.
19+
20+
This describes the automation itself. To see the workflow it runs, use the steps endpoint.
21+
22+
### Example
23+
24+
* Bearer Authentication (apiToken):
25+
26+
```python
27+
import hostinger_api
28+
from hostinger_api.models.reach_v1_automations_automation_resource import ReachV1AutomationsAutomationResource
29+
from hostinger_api.rest import ApiException
30+
from pprint import pprint
31+
32+
33+
# Configure Bearer authorization: apiToken
34+
configuration = hostinger_api.Configuration(
35+
access_token = os.environ["BEARER_TOKEN"]
36+
)
37+
38+
# Enter a context with an instance of the API client
39+
with hostinger_api.ApiClient(configuration) as api_client:
40+
# Create an instance of the API class
41+
api_instance = hostinger_api.ReachAutomationsApi(api_client)
42+
profile_uuid = '550e8400-e09b-41d4-a716-400055000000' # str | Profile uuid parameter
43+
automation_uuid = '550e8400-e09b-41d4-a716-400055000000' # str | Automation uuid parameter
44+
45+
try:
46+
# Get automation details
47+
api_response = api_instance.get_automation_details_v1(profile_uuid, automation_uuid)
48+
print("The response of ReachAutomationsApi->get_automation_details_v1:\n")
49+
pprint(api_response)
50+
except Exception as e:
51+
print("Exception when calling ReachAutomationsApi->get_automation_details_v1: %s\n" % e)
52+
```
53+
54+
55+
56+
### Parameters
57+
58+
59+
Name | Type | Description | Notes
60+
------------- | ------------- | ------------- | -------------
61+
**profile_uuid** | **str**| Profile uuid parameter |
62+
**automation_uuid** | **str**| Automation uuid parameter |
63+
64+
### Return type
65+
66+
[**ReachV1AutomationsAutomationResource**](ReachV1AutomationsAutomationResource.md)
67+
68+
### Authorization
69+
70+
[apiToken](../README.md#apiToken)
71+
72+
### HTTP request headers
73+
74+
- **Content-Type**: Not defined
75+
- **Accept**: application/json
76+
77+
### HTTP response details
78+
79+
| Status code | Description | Response headers |
80+
|-------------|-------------|------------------|
81+
**200** | Success response | - |
82+
**401** | Unauthenticated response | - |
83+
**500** | Error response | - |
84+
85+
[[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)
86+
87+
# **list_automation_steps_v1**
88+
> List[ReachV1AutomationsStepsAutomationStepResource] list_automation_steps_v1(profile_uuid, automation_uuid)
89+
90+
List automation steps
91+
92+
Get the workflow of an automation as a flat list of steps.
93+
94+
The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the
95+
branches, and use `step_order` to order the steps that share a parent. An automation with no
96+
steps yet returns an empty list.
97+
98+
### Example
99+
100+
* Bearer Authentication (apiToken):
101+
102+
```python
103+
import hostinger_api
104+
from hostinger_api.models.reach_v1_automations_steps_automation_step_resource import ReachV1AutomationsStepsAutomationStepResource
105+
from hostinger_api.rest import ApiException
106+
from pprint import pprint
107+
108+
109+
# Configure Bearer authorization: apiToken
110+
configuration = hostinger_api.Configuration(
111+
access_token = os.environ["BEARER_TOKEN"]
112+
)
113+
114+
# Enter a context with an instance of the API client
115+
with hostinger_api.ApiClient(configuration) as api_client:
116+
# Create an instance of the API class
117+
api_instance = hostinger_api.ReachAutomationsApi(api_client)
118+
profile_uuid = '550e8400-e09b-41d4-a716-400055000000' # str | Profile uuid parameter
119+
automation_uuid = '550e8400-e09b-41d4-a716-400055000000' # str | Automation uuid parameter
120+
121+
try:
122+
# List automation steps
123+
api_response = api_instance.list_automation_steps_v1(profile_uuid, automation_uuid)
124+
print("The response of ReachAutomationsApi->list_automation_steps_v1:\n")
125+
pprint(api_response)
126+
except Exception as e:
127+
print("Exception when calling ReachAutomationsApi->list_automation_steps_v1: %s\n" % e)
128+
```
129+
130+
131+
132+
### Parameters
133+
134+
135+
Name | Type | Description | Notes
136+
------------- | ------------- | ------------- | -------------
137+
**profile_uuid** | **str**| Profile uuid parameter |
138+
**automation_uuid** | **str**| Automation uuid parameter |
139+
140+
### Return type
141+
142+
[**List[ReachV1AutomationsStepsAutomationStepResource]**](ReachV1AutomationsStepsAutomationStepResource.md)
143+
144+
### Authorization
145+
146+
[apiToken](../README.md#apiToken)
147+
148+
### HTTP request headers
149+
150+
- **Content-Type**: Not defined
151+
- **Accept**: application/json
152+
153+
### HTTP response details
154+
155+
| Status code | Description | Response headers |
156+
|-------------|-------------|------------------|
157+
**200** | Success response | - |
158+
**401** | Unauthenticated response | - |
159+
**500** | Error response | - |
160+
161+
[[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)
162+
163+
# **list_automations_v1**
164+
> ReachListAutomationsV1200Response list_automations_v1(profile_uuid, status=status, sort_direction=sort_direction, page=page, per_page=per_page)
165+
166+
List automations
167+
168+
Get a paginated list of the automations in a profile.
169+
170+
Every automation comes with the counts of contacts that entered it, are moving through it,
171+
finished it or failed on the way. Those counts describe the contact journey and are not
172+
email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics
173+
endpoint instead.
174+
175+
### Example
176+
177+
* Bearer Authentication (apiToken):
178+
179+
```python
180+
import hostinger_api
181+
from hostinger_api.models.reach_list_automations_v1200_response import ReachListAutomationsV1200Response
182+
from hostinger_api.rest import ApiException
183+
from pprint import pprint
184+
185+
186+
# Configure Bearer authorization: apiToken
187+
configuration = hostinger_api.Configuration(
188+
access_token = os.environ["BEARER_TOKEN"]
189+
)
190+
191+
# Enter a context with an instance of the API client
192+
with hostinger_api.ApiClient(configuration) as api_client:
193+
# Create an instance of the API class
194+
api_instance = hostinger_api.ReachAutomationsApi(api_client)
195+
profile_uuid = '550e8400-e09b-41d4-a716-400055000000' # str | Profile uuid parameter
196+
status = 'active' # str | Filter automations by status. There is no `completed` status. An automation that has finished for every contact still reports `active`. (optional)
197+
sort_direction = 'desc' # str | Order automations by creation date. Newest first unless set to `asc`. (optional)
198+
page = 1 # int | Page number (optional)
199+
per_page = 25 # int | Number of items per page (optional) (default to 25)
200+
201+
try:
202+
# List automations
203+
api_response = api_instance.list_automations_v1(profile_uuid, status=status, sort_direction=sort_direction, page=page, per_page=per_page)
204+
print("The response of ReachAutomationsApi->list_automations_v1:\n")
205+
pprint(api_response)
206+
except Exception as e:
207+
print("Exception when calling ReachAutomationsApi->list_automations_v1: %s\n" % e)
208+
```
209+
210+
211+
212+
### Parameters
213+
214+
215+
Name | Type | Description | Notes
216+
------------- | ------------- | ------------- | -------------
217+
**profile_uuid** | **str**| Profile uuid parameter |
218+
**status** | **str**| Filter automations by status. There is no `completed` status. An automation that has finished for every contact still reports `active`. | [optional]
219+
**sort_direction** | **str**| Order automations by creation date. Newest first unless set to `asc`. | [optional]
220+
**page** | **int**| Page number | [optional]
221+
**per_page** | **int**| Number of items per page | [optional] [default to 25]
222+
223+
### Return type
224+
225+
[**ReachListAutomationsV1200Response**](ReachListAutomationsV1200Response.md)
226+
227+
### Authorization
228+
229+
[apiToken](../README.md#apiToken)
230+
231+
### HTTP request headers
232+
233+
- **Content-Type**: Not defined
234+
- **Accept**: application/json
235+
236+
### HTTP response details
237+
238+
| Status code | Description | Response headers |
239+
|-------------|-------------|------------------|
240+
**200** | Success response | - |
241+
**401** | Unauthenticated response | - |
242+
**500** | Error response | - |
243+
244+
[[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)
245+

‎docs/ReachListAutomationsV1200Response.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# ReachListAutomationsV1200Response
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**data** | [**List[ReachV1AutomationsAutomationResource]**](ReachV1AutomationsAutomationResource.md) | Array of [`Reach.V1.Automations.AutomationResource`](#model/reachv1automationsautomationresource) | [optional]
9+
**meta** | [**CommonSchemaPaginationMetaSchema**](CommonSchemaPaginationMetaSchema.md) | | [optional]
10+
11+
## Example
12+
13+
```python
14+
from hostinger_api.models.reach_list_automations_v1200_response import ReachListAutomationsV1200Response
15+
16+
# TODO update the JSON string below
17+
json = "{}"
18+
# create an instance of ReachListAutomationsV1200Response from a JSON string
19+
reach_list_automations_v1200_response_instance = ReachListAutomationsV1200Response.from_json(json)
20+
# print the JSON string representation of the object
21+
print(ReachListAutomationsV1200Response.to_json())
22+
23+
# convert the object into a dict
24+
reach_list_automations_v1200_response_dict = reach_list_automations_v1200_response_instance.to_dict()
25+
# create an instance of ReachListAutomationsV1200Response from a dict
26+
reach_list_automations_v1200_response_from_dict = ReachListAutomationsV1200Response.from_dict(reach_list_automations_v1200_response_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/ReachV1AutomationsAutomationEventsResource.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# ReachV1AutomationsAutomationEventsResource
2+
3+
Counts of contacts moving through the automation. These are not email engagement metrics. Automations expose no sent, open or click counters - use the campaign statistics endpoint for those.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**started** | **int** | Contacts that ever entered the automation, including those that already left it. | [optional]
10+
**in_progress** | **int** | Contacts currently moving through the automation, including those waiting on a delay step. | [optional]
11+
**completed** | **int** | Contacts that reached the end of the workflow. | [optional]
12+
**failed** | **int** | Contacts whose journey through the automation errored and stopped. | [optional]
13+
14+
## Example
15+
16+
```python
17+
from hostinger_api.models.reach_v1_automations_automation_events_resource import ReachV1AutomationsAutomationEventsResource
18+
19+
# TODO update the JSON string below
20+
json = "{}"
21+
# create an instance of ReachV1AutomationsAutomationEventsResource from a JSON string
22+
reach_v1_automations_automation_events_resource_instance = ReachV1AutomationsAutomationEventsResource.from_json(json)
23+
# print the JSON string representation of the object
24+
print(ReachV1AutomationsAutomationEventsResource.to_json())
25+
26+
# convert the object into a dict
27+
reach_v1_automations_automation_events_resource_dict = reach_v1_automations_automation_events_resource_instance.to_dict()
28+
# create an instance of ReachV1AutomationsAutomationEventsResource from a dict
29+
reach_v1_automations_automation_events_resource_from_dict = ReachV1AutomationsAutomationEventsResource.from_dict(reach_v1_automations_automation_events_resource_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/ReachV1AutomationsAutomationResource.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# ReachV1AutomationsAutomationResource
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**uuid** | **str** | | [optional]
9+
**name** | **str** | | [optional]
10+
**status** | **str** | There is no `completed` status. Use `events.completed` to see how many contacts finished. | [optional]
11+
**type** | **str** | What kind of workflow this is. `custom` automations are the ones built from scratch. | [optional]
12+
**config** | **object** | Trigger configuration of the automation. The shape depends on the type. | [optional]
13+
**events** | [**ReachV1AutomationsAutomationEventsResource**](ReachV1AutomationsAutomationEventsResource.md) | | [optional]
14+
**created_at** | **datetime** | | [optional]
15+
**updated_at** | **datetime** | | [optional]
16+
17+
## Example
18+
19+
```python
20+
from hostinger_api.models.reach_v1_automations_automation_resource import ReachV1AutomationsAutomationResource
21+
22+
# TODO update the JSON string below
23+
json = "{}"
24+
# create an instance of ReachV1AutomationsAutomationResource from a JSON string
25+
reach_v1_automations_automation_resource_instance = ReachV1AutomationsAutomationResource.from_json(json)
26+
# print the JSON string representation of the object
27+
print(ReachV1AutomationsAutomationResource.to_json())
28+
29+
# convert the object into a dict
30+
reach_v1_automations_automation_resource_dict = reach_v1_automations_automation_resource_instance.to_dict()
31+
# create an instance of ReachV1AutomationsAutomationResource from a dict
32+
reach_v1_automations_automation_resource_from_dict = ReachV1AutomationsAutomationResource.from_dict(reach_v1_automations_automation_resource_dict)
33+
```
34+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
35+
36+

0 commit comments

Comments
 (0)