Skip to content

Commit 2786507

Browse files
hostingerbot[bot]hostingerbot[bot]
committed
chore: sdk update
1 parent 825be09 commit 2786507

976 files changed

Lines changed: 4094 additions & 951 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: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,11 @@ Class | Method | HTTP request | Description
282282
*ReachContactsApi* | [**list_contacts_v1**](docs/ReachContactsApi.md#list_contacts_v1) | **GET** /api/reach/v1/contacts | List contacts
283283
*ReachContactsApi* | [**list_profile_contacts_v1**](docs/ReachContactsApi.md#list_profile_contacts_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/contacts | List profile contacts
284284
*ReachContactsApi* | [**update_a_contact_v1**](docs/ReachContactsApi.md#update_a_contact_v1) | **PATCH** /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid} | Update a contact
285+
*ReachFormsApi* | [**delete_form_v1**](docs/ReachFormsApi.md#delete_form_v1) | **DELETE** /api/reach/v1/profiles/{profileUuid}/forms/{formUuid} | Delete form
286+
*ReachFormsApi* | [**get_form_details_v1**](docs/ReachFormsApi.md#get_form_details_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/forms/{formUuid} | Get form details
287+
*ReachFormsApi* | [**list_forms_v1**](docs/ReachFormsApi.md#list_forms_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/forms | List forms
285288
*ReachProfilesApi* | [**get_profile_domain_dns_status_v1**](docs/ReachProfilesApi.md#get_profile_domain_dns_status_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/domains/dns-status | Get profile domain DNS status
289+
*ReachProfilesApi* | [**get_remaining_plan_limits_v1**](docs/ReachProfilesApi.md#get_remaining_plan_limits_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/limits | Get remaining plan limits
286290
*ReachProfilesApi* | [**list_profiles_v1**](docs/ReachProfilesApi.md#list_profiles_v1) | **GET** /api/reach/v1/profiles | List Profiles
287291
*ReachSegmentsApi* | [**count_profile_segment_contacts_v1**](docs/ReachSegmentsApi.md#count_profile_segment_contacts_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/count | Count profile segment contacts
288292
*ReachSegmentsApi* | [**create_a_new_contact_segment_v1**](docs/ReachSegmentsApi.md#create_a_new_contact_segment_v1) | **POST** /api/reach/v1/segmentation/segments | Create a new contact segment
@@ -663,6 +667,7 @@ Class | Method | HTTP request | Description
663667
- [ReachListAutomationsV1200Response](docs/ReachListAutomationsV1200Response.md)
664668
- [ReachListCampaignsV1200Response](docs/ReachListCampaignsV1200Response.md)
665669
- [ReachListContactsV1200Response](docs/ReachListContactsV1200Response.md)
670+
- [ReachListFormsV1200Response](docs/ReachListFormsV1200Response.md)
666671
- [ReachListProfileContactsV1200Response](docs/ReachListProfileContactsV1200Response.md)
667672
- [ReachListProfileSegmentContactsV1200Response](docs/ReachListProfileSegmentContactsV1200Response.md)
668673
- [ReachListProfileSegmentsV1200Response](docs/ReachListProfileSegmentsV1200Response.md)
@@ -705,10 +710,17 @@ Class | Method | HTTP request | Description
705710
- [ReachV1ContactsTagsUpdateRequest](docs/ReachV1ContactsTagsUpdateRequest.md)
706711
- [ReachV1ContactsUpdateRequest](docs/ReachV1ContactsUpdateRequest.md)
707712
- [ReachV1ContactsUpdateRequestFieldsInner](docs/ReachV1ContactsUpdateRequestFieldsInner.md)
713+
- [ReachV1FormsFormDetailsResource](docs/ReachV1FormsFormDetailsResource.md)
714+
- [ReachV1FormsFormResource](docs/ReachV1FormsFormResource.md)
715+
- [ReachV1FormsFormTagResource](docs/ReachV1FormsFormTagResource.md)
716+
- [ReachV1FormsFormTemplateDetailsResource](docs/ReachV1FormsFormTemplateDetailsResource.md)
717+
- [ReachV1FormsFormTemplateResource](docs/ReachV1FormsFormTemplateResource.md)
708718
- [ReachV1ProfilesDomainsDnsRecordStatus](docs/ReachV1ProfilesDomainsDnsRecordStatus.md)
709719
- [ReachV1ProfilesDomainsDnsRecordStatusActualInner](docs/ReachV1ProfilesDomainsDnsRecordStatusActualInner.md)
710720
- [ReachV1ProfilesDomainsDnsRecordStatusSuggestedInner](docs/ReachV1ProfilesDomainsDnsRecordStatusSuggestedInner.md)
711721
- [ReachV1ProfilesDomainsDnsStatusResource](docs/ReachV1ProfilesDomainsDnsStatusResource.md)
722+
- [ReachV1ProfilesPlanLimitUsageResource](docs/ReachV1ProfilesPlanLimitUsageResource.md)
723+
- [ReachV1ProfilesPlanLimitsResource](docs/ReachV1ProfilesPlanLimitsResource.md)
712724
- [ReachV1ProfilesProfileResource](docs/ReachV1ProfilesProfileResource.md)
713725
- [ReachV1ProfilesProfileResourceLimits](docs/ReachV1ProfilesProfileResourceLimits.md)
714726
- [ReachV1ProfilesProfileResourceProfilesInner](docs/ReachV1ProfilesProfileResourceProfilesInner.md)

‎docs/ReachFormsApi.md‎

Lines changed: 241 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,241 @@
1+
# hostinger_api.ReachFormsApi
2+
3+
All URIs are relative to *https://developers.hostinger.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**delete_form_v1**](ReachFormsApi.md#delete_form_v1) | **DELETE** /api/reach/v1/profiles/{profileUuid}/forms/{formUuid} | Delete form
8+
[**get_form_details_v1**](ReachFormsApi.md#get_form_details_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/forms/{formUuid} | Get form details
9+
[**list_forms_v1**](ReachFormsApi.md#list_forms_v1) | **GET** /api/reach/v1/profiles/{profileUuid}/forms | List forms
10+
11+
12+
# **delete_form_v1**
13+
> CommonSuccessEmptyResource delete_form_v1(profile_uuid, form_uuid)
14+
15+
Delete form
16+
17+
Permanently delete a form together with its template.
18+
19+
A form that has already captured submissions cannot be deleted, so that the contacts it collected
20+
are never silently discarded - pause the form instead to stop it collecting new ones. Views alone
21+
do not block deletion.
22+
23+
### Example
24+
25+
* Bearer Authentication (apiToken):
26+
27+
```python
28+
import hostinger_api
29+
from hostinger_api.models.common_success_empty_resource import CommonSuccessEmptyResource
30+
from hostinger_api.rest import ApiException
31+
from pprint import pprint
32+
33+
34+
# Configure Bearer authorization: apiToken
35+
configuration = hostinger_api.Configuration(
36+
access_token = os.environ["BEARER_TOKEN"]
37+
)
38+
39+
# Enter a context with an instance of the API client
40+
with hostinger_api.ApiClient(configuration) as api_client:
41+
# Create an instance of the API class
42+
api_instance = hostinger_api.ReachFormsApi(api_client)
43+
profile_uuid = '550e8400-e09b-41d4-a716-400055000000' # str | Profile uuid parameter
44+
form_uuid = '550e8400-e09b-41d4-a716-400055000000' # str | Form uuid parameter
45+
46+
try:
47+
# Delete form
48+
api_response = api_instance.delete_form_v1(profile_uuid, form_uuid)
49+
print("The response of ReachFormsApi->delete_form_v1:\n")
50+
pprint(api_response)
51+
except Exception as e:
52+
print("Exception when calling ReachFormsApi->delete_form_v1: %s\n" % e)
53+
```
54+
55+
56+
57+
### Parameters
58+
59+
60+
Name | Type | Description | Notes
61+
------------- | ------------- | ------------- | -------------
62+
**profile_uuid** | **str**| Profile uuid parameter |
63+
**form_uuid** | **str**| Form uuid parameter |
64+
65+
### Return type
66+
67+
[**CommonSuccessEmptyResource**](CommonSuccessEmptyResource.md)
68+
69+
### Authorization
70+
71+
[apiToken](../README.md#apiToken)
72+
73+
### HTTP request headers
74+
75+
- **Content-Type**: Not defined
76+
- **Accept**: application/json
77+
78+
### HTTP response details
79+
80+
| Status code | Description | Response headers |
81+
|-------------|-------------|------------------|
82+
**200** | Success empty response | - |
83+
**401** | Unauthenticated response | - |
84+
**409** | Error response | - |
85+
**500** | Error response | - |
86+
87+
[[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)
88+
89+
# **get_form_details_v1**
90+
> ReachV1FormsFormDetailsResource get_form_details_v1(profile_uuid, form_uuid)
91+
92+
Get form details
93+
94+
Get a single form with the URL of its hosted template and the tags it applies to the contacts
95+
it captures.
96+
97+
There is no ready-made embed snippet in the response - either serve the template HTML yourself
98+
or build your own embed around the form uuid.
99+
100+
### Example
101+
102+
* Bearer Authentication (apiToken):
103+
104+
```python
105+
import hostinger_api
106+
from hostinger_api.models.reach_v1_forms_form_details_resource import ReachV1FormsFormDetailsResource
107+
from hostinger_api.rest import ApiException
108+
from pprint import pprint
109+
110+
111+
# Configure Bearer authorization: apiToken
112+
configuration = hostinger_api.Configuration(
113+
access_token = os.environ["BEARER_TOKEN"]
114+
)
115+
116+
# Enter a context with an instance of the API client
117+
with hostinger_api.ApiClient(configuration) as api_client:
118+
# Create an instance of the API class
119+
api_instance = hostinger_api.ReachFormsApi(api_client)
120+
profile_uuid = '550e8400-e09b-41d4-a716-400055000000' # str | Profile uuid parameter
121+
form_uuid = '550e8400-e09b-41d4-a716-400055000000' # str | Form uuid parameter
122+
123+
try:
124+
# Get form details
125+
api_response = api_instance.get_form_details_v1(profile_uuid, form_uuid)
126+
print("The response of ReachFormsApi->get_form_details_v1:\n")
127+
pprint(api_response)
128+
except Exception as e:
129+
print("Exception when calling ReachFormsApi->get_form_details_v1: %s\n" % e)
130+
```
131+
132+
133+
134+
### Parameters
135+
136+
137+
Name | Type | Description | Notes
138+
------------- | ------------- | ------------- | -------------
139+
**profile_uuid** | **str**| Profile uuid parameter |
140+
**form_uuid** | **str**| Form uuid parameter |
141+
142+
### Return type
143+
144+
[**ReachV1FormsFormDetailsResource**](ReachV1FormsFormDetailsResource.md)
145+
146+
### Authorization
147+
148+
[apiToken](../README.md#apiToken)
149+
150+
### HTTP request headers
151+
152+
- **Content-Type**: Not defined
153+
- **Accept**: application/json
154+
155+
### HTTP response details
156+
157+
| Status code | Description | Response headers |
158+
|-------------|-------------|------------------|
159+
**200** | Success response | - |
160+
**401** | Unauthenticated response | - |
161+
**500** | Error response | - |
162+
163+
[[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)
164+
165+
# **list_forms_v1**
166+
> ReachListFormsV1200Response list_forms_v1(profile_uuid, page=page, per_page=per_page)
167+
168+
List forms
169+
170+
Get a paginated list of the signup forms in a profile.
171+
172+
Each form carries a reference to the template that renders it. Get the form details for a
173+
directly usable template URL and for the tags the form puts on the contacts it captures.
174+
175+
### Example
176+
177+
* Bearer Authentication (apiToken):
178+
179+
```python
180+
import hostinger_api
181+
from hostinger_api.models.reach_list_forms_v1200_response import ReachListFormsV1200Response
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.ReachFormsApi(api_client)
195+
profile_uuid = '550e8400-e09b-41d4-a716-400055000000' # str | Profile uuid parameter
196+
page = 1 # int | Page number (optional)
197+
per_page = 25 # int | Number of items per page (optional) (default to 25)
198+
199+
try:
200+
# List forms
201+
api_response = api_instance.list_forms_v1(profile_uuid, page=page, per_page=per_page)
202+
print("The response of ReachFormsApi->list_forms_v1:\n")
203+
pprint(api_response)
204+
except Exception as e:
205+
print("Exception when calling ReachFormsApi->list_forms_v1: %s\n" % e)
206+
```
207+
208+
209+
210+
### Parameters
211+
212+
213+
Name | Type | Description | Notes
214+
------------- | ------------- | ------------- | -------------
215+
**profile_uuid** | **str**| Profile uuid parameter |
216+
**page** | **int**| Page number | [optional]
217+
**per_page** | **int**| Number of items per page | [optional] [default to 25]
218+
219+
### Return type
220+
221+
[**ReachListFormsV1200Response**](ReachListFormsV1200Response.md)
222+
223+
### Authorization
224+
225+
[apiToken](../README.md#apiToken)
226+
227+
### HTTP request headers
228+
229+
- **Content-Type**: Not defined
230+
- **Accept**: application/json
231+
232+
### HTTP response details
233+
234+
| Status code | Description | Response headers |
235+
|-------------|-------------|------------------|
236+
**200** | Success response | - |
237+
**401** | Unauthenticated response | - |
238+
**500** | Error response | - |
239+
240+
[[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)
241+

‎docs/ReachListFormsV1200Response.md‎

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

0 commit comments

Comments
 (0)