Skip to content

Commit 22132ba

Browse files
chore: sdk update
1 parent 928b29c commit 22132ba

486 files changed

Lines changed: 2809 additions & 465 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: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,12 @@ Class | Method | HTTP request | Description
117117
*DomainsWHOISApi* | [**get_whois_profile_list_v1**](docs/DomainsWHOISApi.md#get_whois_profile_list_v1) | **GET** /api/domains/v1/whois | Get WHOIS profile list
118118
*DomainsWHOISApi* | [**get_whois_profile_usage_v1**](docs/DomainsWHOISApi.md#get_whois_profile_usage_v1) | **GET** /api/domains/v1/whois/{whoisId}/usage | Get WHOIS profile usage
119119
*DomainsWHOISApi* | [**get_whois_profile_v1**](docs/DomainsWHOISApi.md#get_whois_profile_v1) | **GET** /api/domains/v1/whois/{whoisId} | Get WHOIS profile
120+
*EcommerceMiscellaneousApi* | [**get_custom_storefront_setup_instructions_v1**](docs/EcommerceMiscellaneousApi.md#get_custom_storefront_setup_instructions_v1) | **GET** /api/ecommerce/v1/miscellaneous/custom-storefront-instructions | Get custom storefront setup instructions
120121
*EcommercePaymentsApi* | [**enable_manual_payment_method_v1**](docs/EcommercePaymentsApi.md#enable_manual_payment_method_v1) | **POST** /api/ecommerce/v1/stores/{store_id}/payment-methods/manual | Enable manual payment method
121122
*EcommerceProductsApi* | [**create_digital_product_v1**](docs/EcommerceProductsApi.md#create_digital_product_v1) | **POST** /api/ecommerce/v1/stores/{store_id}/products/digital | Create digital product
122123
*EcommerceProductsApi* | [**create_physical_product_v1**](docs/EcommerceProductsApi.md#create_physical_product_v1) | **POST** /api/ecommerce/v1/stores/{store_id}/products/physical | Create physical product
124+
*EcommerceSalesChannelsApi* | [**create_a_custom_sales_channel_v1**](docs/EcommerceSalesChannelsApi.md#create_a_custom_sales_channel_v1) | **POST** /api/ecommerce/v1/stores/{store_id}/sales-channels | Create a custom sales channel
125+
*EcommerceSalesChannelsApi* | [**list_sales_channels_v1**](docs/EcommerceSalesChannelsApi.md#list_sales_channels_v1) | **GET** /api/ecommerce/v1/stores/{store_id}/sales-channels | List sales channels
123126
*EcommerceShippingApi* | [**set_store_shipping_v1**](docs/EcommerceShippingApi.md#set_store_shipping_v1) | **POST** /api/ecommerce/v1/stores/{store_id}/shipping | Set store shipping
124127
*EcommerceStoresApi* | [**create_store_v1**](docs/EcommerceStoresApi.md#create_store_v1) | **POST** /api/ecommerce/v1/stores | Create store
125128
*EcommerceStoresApi* | [**delete_store_v1**](docs/EcommerceStoresApi.md#delete_store_v1) | **DELETE** /api/ecommerce/v1/stores/{store_id} | Delete store
@@ -294,13 +297,19 @@ Class | Method | HTTP request | Description
294297
- [DomainsV1WHOISProfileResource](docs/DomainsV1WHOISProfileResource.md)
295298
- [DomainsV1WHOISStoreRequest](docs/DomainsV1WHOISStoreRequest.md)
296299
- [EcommerceGetStoresV1200Response](docs/EcommerceGetStoresV1200Response.md)
300+
- [EcommerceV1MiscellaneousCustomStorefrontInstructionsResource](docs/EcommerceV1MiscellaneousCustomStorefrontInstructionsResource.md)
297301
- [EcommerceV1PaymentEnableManualPaymentRequest](docs/EcommerceV1PaymentEnableManualPaymentRequest.md)
298302
- [EcommerceV1PaymentManualPaymentResource](docs/EcommerceV1PaymentManualPaymentResource.md)
299303
- [EcommerceV1PaymentManualPaymentResourcePaymentMethod](docs/EcommerceV1PaymentManualPaymentResourcePaymentMethod.md)
300304
- [EcommerceV1ProductCreateDigitalProductRequest](docs/EcommerceV1ProductCreateDigitalProductRequest.md)
301305
- [EcommerceV1ProductCreatePhysicalProductRequest](docs/EcommerceV1ProductCreatePhysicalProductRequest.md)
302306
- [EcommerceV1ProductProductCreationResource](docs/EcommerceV1ProductProductCreationResource.md)
303307
- [EcommerceV1ProductProductCreationResourceProduct](docs/EcommerceV1ProductProductCreationResourceProduct.md)
308+
- [EcommerceV1SalesChannelSalesChannelCreationResource](docs/EcommerceV1SalesChannelSalesChannelCreationResource.md)
309+
- [EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannel](docs/EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannel.md)
310+
- [EcommerceV1SalesChannelSalesChannelListResource](docs/EcommerceV1SalesChannelSalesChannelListResource.md)
311+
- [EcommerceV1SalesChannelSalesChannelListResourceSalesChannelsInner](docs/EcommerceV1SalesChannelSalesChannelListResourceSalesChannelsInner.md)
312+
- [EcommerceV1SalesChannelStoreRequest](docs/EcommerceV1SalesChannelStoreRequest.md)
304313
- [EcommerceV1ShippingSetShippingRequest](docs/EcommerceV1ShippingSetShippingRequest.md)
305314
- [EcommerceV1ShippingShippingResource](docs/EcommerceV1ShippingShippingResource.md)
306315
- [EcommerceV1ShippingShippingResourceShippingOption](docs/EcommerceV1ShippingShippingResourceShippingOption.md)

docs/EcommerceMiscellaneousApi.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# hostinger_api.EcommerceMiscellaneousApi
2+
3+
All URIs are relative to *https://developers.hostinger.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**get_custom_storefront_setup_instructions_v1**](EcommerceMiscellaneousApi.md#get_custom_storefront_setup_instructions_v1) | **GET** /api/ecommerce/v1/miscellaneous/custom-storefront-instructions | Get custom storefront setup instructions
8+
9+
10+
# **get_custom_storefront_setup_instructions_v1**
11+
> EcommerceV1MiscellaneousCustomStorefrontInstructionsResource get_custom_storefront_setup_instructions_v1()
12+
13+
Get custom storefront setup instructions
14+
15+
Retrieve step-by-step setup instructions, formatted as Markdown, for connecting a custom sales
16+
channel to your store and keeping your catalog, orders, shipping and payments in sync through
17+
the Ecommerce API.
18+
19+
### Example
20+
21+
* Bearer Authentication (apiToken):
22+
23+
```python
24+
import hostinger_api
25+
from hostinger_api.models.ecommerce_v1_miscellaneous_custom_storefront_instructions_resource import EcommerceV1MiscellaneousCustomStorefrontInstructionsResource
26+
from hostinger_api.rest import ApiException
27+
from pprint import pprint
28+
29+
30+
# Configure Bearer authorization: apiToken
31+
configuration = hostinger_api.Configuration(
32+
access_token = os.environ["BEARER_TOKEN"]
33+
)
34+
35+
# Enter a context with an instance of the API client
36+
with hostinger_api.ApiClient(configuration) as api_client:
37+
# Create an instance of the API class
38+
api_instance = hostinger_api.EcommerceMiscellaneousApi(api_client)
39+
40+
try:
41+
# Get custom storefront setup instructions
42+
api_response = api_instance.get_custom_storefront_setup_instructions_v1()
43+
print("The response of EcommerceMiscellaneousApi->get_custom_storefront_setup_instructions_v1:\n")
44+
pprint(api_response)
45+
except Exception as e:
46+
print("Exception when calling EcommerceMiscellaneousApi->get_custom_storefront_setup_instructions_v1: %s\n" % e)
47+
```
48+
49+
50+
51+
### Parameters
52+
53+
This endpoint does not need any parameter.
54+
55+
### Return type
56+
57+
[**EcommerceV1MiscellaneousCustomStorefrontInstructionsResource**](EcommerceV1MiscellaneousCustomStorefrontInstructionsResource.md)
58+
59+
### Authorization
60+
61+
[apiToken](../README.md#apiToken)
62+
63+
### HTTP request headers
64+
65+
- **Content-Type**: Not defined
66+
- **Accept**: application/json
67+
68+
### HTTP response details
69+
70+
| Status code | Description | Response headers |
71+
|-------------|-------------|------------------|
72+
**200** | Success response | - |
73+
**401** | Unauthenticated response | - |
74+
**500** | Error response | - |
75+
76+
[[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)
77+

docs/EcommerceSalesChannelsApi.md

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
# hostinger_api.EcommerceSalesChannelsApi
2+
3+
All URIs are relative to *https://developers.hostinger.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**create_a_custom_sales_channel_v1**](EcommerceSalesChannelsApi.md#create_a_custom_sales_channel_v1) | **POST** /api/ecommerce/v1/stores/{store_id}/sales-channels | Create a custom sales channel
8+
[**list_sales_channels_v1**](EcommerceSalesChannelsApi.md#list_sales_channels_v1) | **GET** /api/ecommerce/v1/stores/{store_id}/sales-channels | List sales channels
9+
10+
11+
# **create_a_custom_sales_channel_v1**
12+
> EcommerceV1SalesChannelSalesChannelCreationResource create_a_custom_sales_channel_v1(store_id, ecommerce_v1_sales_channel_store_request)
13+
14+
Create a custom sales channel
15+
16+
Create a custom sales channel for a store. Build your own frontend and keep your catalog,
17+
orders, shipping and payments in sync through the Ecommerce API.
18+
19+
### Example
20+
21+
* Bearer Authentication (apiToken):
22+
23+
```python
24+
import hostinger_api
25+
from hostinger_api.models.ecommerce_v1_sales_channel_sales_channel_creation_resource import EcommerceV1SalesChannelSalesChannelCreationResource
26+
from hostinger_api.models.ecommerce_v1_sales_channel_store_request import EcommerceV1SalesChannelStoreRequest
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.EcommerceSalesChannelsApi(api_client)
40+
store_id = 'store_01J8Z5F8W9K8M4A7B3C2D1E0FG' # str | The ID of the store to create the sales channel for.
41+
ecommerce_v1_sales_channel_store_request = hostinger_api.EcommerceV1SalesChannelStoreRequest() # EcommerceV1SalesChannelStoreRequest |
42+
43+
try:
44+
# Create a custom sales channel
45+
api_response = api_instance.create_a_custom_sales_channel_v1(store_id, ecommerce_v1_sales_channel_store_request)
46+
print("The response of EcommerceSalesChannelsApi->create_a_custom_sales_channel_v1:\n")
47+
pprint(api_response)
48+
except Exception as e:
49+
print("Exception when calling EcommerceSalesChannelsApi->create_a_custom_sales_channel_v1: %s\n" % e)
50+
```
51+
52+
53+
54+
### Parameters
55+
56+
57+
Name | Type | Description | Notes
58+
------------- | ------------- | ------------- | -------------
59+
**store_id** | **str**| The ID of the store to create the sales channel for. |
60+
**ecommerce_v1_sales_channel_store_request** | [**EcommerceV1SalesChannelStoreRequest**](EcommerceV1SalesChannelStoreRequest.md)| |
61+
62+
### Return type
63+
64+
[**EcommerceV1SalesChannelSalesChannelCreationResource**](EcommerceV1SalesChannelSalesChannelCreationResource.md)
65+
66+
### Authorization
67+
68+
[apiToken](../README.md#apiToken)
69+
70+
### HTTP request headers
71+
72+
- **Content-Type**: application/json
73+
- **Accept**: application/json
74+
75+
### HTTP response details
76+
77+
| Status code | Description | Response headers |
78+
|-------------|-------------|------------------|
79+
**201** | Created response | - |
80+
**422** | Validation error response | - |
81+
**401** | Unauthenticated response | - |
82+
**500** | Error response | - |
83+
84+
[[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)
85+
86+
# **list_sales_channels_v1**
87+
> EcommerceV1SalesChannelSalesChannelListResource list_sales_channels_v1(store_id)
88+
89+
List sales channels
90+
91+
List a store's active sales channels with their full metadata.
92+
93+
### Example
94+
95+
* Bearer Authentication (apiToken):
96+
97+
```python
98+
import hostinger_api
99+
from hostinger_api.models.ecommerce_v1_sales_channel_sales_channel_list_resource import EcommerceV1SalesChannelSalesChannelListResource
100+
from hostinger_api.rest import ApiException
101+
from pprint import pprint
102+
103+
104+
# Configure Bearer authorization: apiToken
105+
configuration = hostinger_api.Configuration(
106+
access_token = os.environ["BEARER_TOKEN"]
107+
)
108+
109+
# Enter a context with an instance of the API client
110+
with hostinger_api.ApiClient(configuration) as api_client:
111+
# Create an instance of the API class
112+
api_instance = hostinger_api.EcommerceSalesChannelsApi(api_client)
113+
store_id = 'store_01J8Z5F8W9K8M4A7B3C2D1E0FG' # str | The ID of the store to list sales channels for.
114+
115+
try:
116+
# List sales channels
117+
api_response = api_instance.list_sales_channels_v1(store_id)
118+
print("The response of EcommerceSalesChannelsApi->list_sales_channels_v1:\n")
119+
pprint(api_response)
120+
except Exception as e:
121+
print("Exception when calling EcommerceSalesChannelsApi->list_sales_channels_v1: %s\n" % e)
122+
```
123+
124+
125+
126+
### Parameters
127+
128+
129+
Name | Type | Description | Notes
130+
------------- | ------------- | ------------- | -------------
131+
**store_id** | **str**| The ID of the store to list sales channels for. |
132+
133+
### Return type
134+
135+
[**EcommerceV1SalesChannelSalesChannelListResource**](EcommerceV1SalesChannelSalesChannelListResource.md)
136+
137+
### Authorization
138+
139+
[apiToken](../README.md#apiToken)
140+
141+
### HTTP request headers
142+
143+
- **Content-Type**: Not defined
144+
- **Accept**: application/json
145+
146+
### HTTP response details
147+
148+
| Status code | Description | Response headers |
149+
|-------------|-------------|------------------|
150+
**200** | Success response | - |
151+
**401** | Unauthenticated response | - |
152+
**500** | Error response | - |
153+
154+
[[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)
155+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# EcommerceV1MiscellaneousCustomStorefrontInstructionsResource
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**instructions** | **str** | Markdown setup instructions for connecting a custom sales channel to your store. | [optional]
9+
10+
## Example
11+
12+
```python
13+
from hostinger_api.models.ecommerce_v1_miscellaneous_custom_storefront_instructions_resource import EcommerceV1MiscellaneousCustomStorefrontInstructionsResource
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of EcommerceV1MiscellaneousCustomStorefrontInstructionsResource from a JSON string
18+
ecommerce_v1_miscellaneous_custom_storefront_instructions_resource_instance = EcommerceV1MiscellaneousCustomStorefrontInstructionsResource.from_json(json)
19+
# print the JSON string representation of the object
20+
print(EcommerceV1MiscellaneousCustomStorefrontInstructionsResource.to_json())
21+
22+
# convert the object into a dict
23+
ecommerce_v1_miscellaneous_custom_storefront_instructions_resource_dict = ecommerce_v1_miscellaneous_custom_storefront_instructions_resource_instance.to_dict()
24+
# create an instance of EcommerceV1MiscellaneousCustomStorefrontInstructionsResource from a dict
25+
ecommerce_v1_miscellaneous_custom_storefront_instructions_resource_from_dict = EcommerceV1MiscellaneousCustomStorefrontInstructionsResource.from_dict(ecommerce_v1_miscellaneous_custom_storefront_instructions_resource_dict)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# EcommerceV1SalesChannelSalesChannelCreationResource
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**sales_channel** | [**EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannel**](EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannel.md) | | [optional]
9+
10+
## Example
11+
12+
```python
13+
from hostinger_api.models.ecommerce_v1_sales_channel_sales_channel_creation_resource import EcommerceV1SalesChannelSalesChannelCreationResource
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of EcommerceV1SalesChannelSalesChannelCreationResource from a JSON string
18+
ecommerce_v1_sales_channel_sales_channel_creation_resource_instance = EcommerceV1SalesChannelSalesChannelCreationResource.from_json(json)
19+
# print the JSON string representation of the object
20+
print(EcommerceV1SalesChannelSalesChannelCreationResource.to_json())
21+
22+
# convert the object into a dict
23+
ecommerce_v1_sales_channel_sales_channel_creation_resource_dict = ecommerce_v1_sales_channel_sales_channel_creation_resource_instance.to_dict()
24+
# create an instance of EcommerceV1SalesChannelSalesChannelCreationResource from a dict
25+
ecommerce_v1_sales_channel_sales_channel_creation_resource_from_dict = EcommerceV1SalesChannelSalesChannelCreationResource.from_dict(ecommerce_v1_sales_channel_sales_channel_creation_resource_dict)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannel
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**id** | **str** | Sales channel ID | [optional]
9+
**type** | **str** | Sales channel type | [optional]
10+
**is_primary** | **bool** | Whether this is the primary sales channel. | [optional]
11+
**is_active** | **bool** | Whether the sales channel is active. | [optional]
12+
**external_id** | **str** | External identifier for the sales channel. | [optional]
13+
**name** | **str** | Merchant-facing custom name. | [optional]
14+
**domain** | **str** | Public address where the custom sales channel lives. | [optional]
15+
16+
## Example
17+
18+
```python
19+
from hostinger_api.models.ecommerce_v1_sales_channel_sales_channel_creation_resource_sales_channel import EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannel
20+
21+
# TODO update the JSON string below
22+
json = "{}"
23+
# create an instance of EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannel from a JSON string
24+
ecommerce_v1_sales_channel_sales_channel_creation_resource_sales_channel_instance = EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannel.from_json(json)
25+
# print the JSON string representation of the object
26+
print(EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannel.to_json())
27+
28+
# convert the object into a dict
29+
ecommerce_v1_sales_channel_sales_channel_creation_resource_sales_channel_dict = ecommerce_v1_sales_channel_sales_channel_creation_resource_sales_channel_instance.to_dict()
30+
# create an instance of EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannel from a dict
31+
ecommerce_v1_sales_channel_sales_channel_creation_resource_sales_channel_from_dict = EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannel.from_dict(ecommerce_v1_sales_channel_sales_channel_creation_resource_sales_channel_dict)
32+
```
33+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
34+
35+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# EcommerceV1SalesChannelSalesChannelListResource
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**sales_channels** | [**List[EcommerceV1SalesChannelSalesChannelListResourceSalesChannelsInner]**](EcommerceV1SalesChannelSalesChannelListResourceSalesChannelsInner.md) | The store's active sales channels. | [optional]
9+
10+
## Example
11+
12+
```python
13+
from hostinger_api.models.ecommerce_v1_sales_channel_sales_channel_list_resource import EcommerceV1SalesChannelSalesChannelListResource
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of EcommerceV1SalesChannelSalesChannelListResource from a JSON string
18+
ecommerce_v1_sales_channel_sales_channel_list_resource_instance = EcommerceV1SalesChannelSalesChannelListResource.from_json(json)
19+
# print the JSON string representation of the object
20+
print(EcommerceV1SalesChannelSalesChannelListResource.to_json())
21+
22+
# convert the object into a dict
23+
ecommerce_v1_sales_channel_sales_channel_list_resource_dict = ecommerce_v1_sales_channel_sales_channel_list_resource_instance.to_dict()
24+
# create an instance of EcommerceV1SalesChannelSalesChannelListResource from a dict
25+
ecommerce_v1_sales_channel_sales_channel_list_resource_from_dict = EcommerceV1SalesChannelSalesChannelListResource.from_dict(ecommerce_v1_sales_channel_sales_channel_list_resource_dict)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+

0 commit comments

Comments
 (0)