hostinger-api-sdk 1.40.3 → 1.41.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +7273 -3513
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +10977 -8171
- package/dist/api.js +1973 -100
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +10977 -8171
- package/dist/esm/api.js +1969 -109
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/EcommerceDiscountsApi.md +129 -0
- package/docs/EcommerceListDiscountsV1200Response.md +22 -0
- package/docs/EcommerceListProductVariantsV1200Response.md +22 -0
- package/docs/EcommerceListProductsV1200Response.md +22 -0
- package/docs/EcommerceListStoreOrdersV1200Response.md +22 -0
- package/docs/EcommerceOrdersApi.md +269 -0
- package/docs/EcommercePaymentsApi.md +114 -0
- package/docs/EcommerceProductVariantsApi.md +251 -0
- package/docs/EcommerceProductsApi.md +188 -0
- package/docs/EcommerceSalesChannelsApi.md +5 -5
- package/docs/EcommerceV1DiscountCreateDiscountRequest.md +38 -0
- package/docs/EcommerceV1DiscountDiscountResource.md +40 -0
- package/docs/EcommerceV1DiscountDiscountResponseResource.md +20 -0
- package/docs/EcommerceV1OrderCancelRequest.md +20 -0
- package/docs/EcommerceV1OrderFulfillRequest.md +26 -0
- package/docs/EcommerceV1OrderFulfillRequestItemsInner.md +22 -0
- package/docs/EcommerceV1OrderOrderDetailResource.md +60 -0
- package/docs/EcommerceV1OrderOrderDetailResourceBillingAddress.md +37 -0
- package/docs/EcommerceV1OrderOrderDetailResourceFulfillmentsInner.md +28 -0
- package/docs/EcommerceV1OrderOrderDetailResourceFulfillmentsInnerTrackingInner.md +22 -0
- package/docs/EcommerceV1OrderOrderDetailResourceItemsInner.md +36 -0
- package/docs/EcommerceV1OrderOrderDetailResourceShippingAddress.md +37 -0
- package/docs/EcommerceV1OrderOrderDetailResponseResource.md +20 -0
- package/docs/EcommerceV1OrderOrderResource.md +38 -0
- package/docs/EcommerceV1OrderOrderResponseResource.md +20 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderConnectLinkResource.md +20 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderConnectLinkResourceData.md +22 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderListResource.md +20 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderListResourceData.md +22 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderListResourceDataAvailableInner.md +28 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderListResourceDataConnectedInner.md +30 -0
- package/docs/EcommerceV1ProductProductDeletedResource.md +20 -0
- package/docs/EcommerceV1ProductProductDeletedResourceData.md +24 -0
- package/docs/EcommerceV1ProductProductResource.md +36 -0
- package/docs/EcommerceV1ProductProductResourceMediaInner.md +24 -0
- package/docs/EcommerceV1ProductProductResourcePriceRange.md +25 -0
- package/docs/EcommerceV1ProductProductResourceVariantsInner.md +32 -0
- package/docs/EcommerceV1ProductProductResourceVariantsInnerOptionsInner.md +22 -0
- package/docs/EcommerceV1ProductProductResourceVariantsInnerPricesInner.md +24 -0
- package/docs/EcommerceV1ProductProductResponseResource.md +20 -0
- package/docs/EcommerceV1ProductUpdateRequest.md +24 -0
- package/docs/EcommerceV1SalesChannelStoreRequest.md +3 -3
- package/docs/EcommerceV1VariantBatchUpdateVariantsRequest.md +20 -0
- package/docs/EcommerceV1VariantBatchUpdateVariantsRequestVariantsInner.md +28 -0
- package/docs/EcommerceV1VariantBatchUpdateVariantsRequestVariantsInnerPricesInner.md +24 -0
- package/docs/EcommerceV1VariantCreateVariantRequest.md +30 -0
- package/docs/EcommerceV1VariantCreateVariantRequestOptionsInner.md +22 -0
- package/docs/EcommerceV1VariantCreateVariantRequestPricesInner.md +24 -0
- package/docs/EcommerceV1VariantVariantDeletedResource.md +20 -0
- package/docs/EcommerceV1VariantVariantDeletedResourceData.md +22 -0
- package/docs/EcommerceV1VariantVariantListResponseResource.md +20 -0
- package/docs/EcommerceV1VariantVariantResource.md +32 -0
- package/docs/EcommerceV1VariantVariantResourceOptionsInner.md +22 -0
- package/docs/EcommerceV1VariantVariantResponseResource.md +20 -0
- package/docs/ReachProfilesApi.md +108 -0
- package/docs/ReachSegmentsApi.md +113 -0
- package/docs/ReachV1ContactsSegmentsProfileFilterContactsRequest.md +33 -0
- package/docs/ReachV1ContactsSegmentsProfileFilterContactsRequestConditionsInner.md +24 -0
- package/docs/ReachV1ContactsSegmentsSegmentFilterAttributeResource.md +27 -0
- package/docs/ReachV1ContactsSegmentsSegmentFilterAttributesResource.md +23 -0
- package/docs/ReachV1ContactsSegmentsSegmentFilterOperatorResource.md +29 -0
- package/docs/ReachV1ContactsStoreRequest.md +2 -0
- package/docs/ReachV1ProfilesDomainsSendingDomainResource.md +29 -0
- package/docs/ReachV1ProfilesDomainsSuspendedSenderEmailResource.md +25 -0
- package/docs/ReachV1ProfilesFeaturesPlanFeatureResource.md +25 -0
- package/index.ts +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# EcommerceV1ProductProductResourcePriceRange
|
|
2
|
+
|
|
3
|
+
Effective price bounds across the product\'s variants.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**min** | **number** | Lowest effective variant price in the smallest currency unit, or null if unpriced. | [optional] [default to undefined]
|
|
10
|
+
**max** | **number** | Highest effective variant price in the smallest currency unit, or null if unpriced. | [optional] [default to undefined]
|
|
11
|
+
**currency_code** | **string** | The store currency the range is expressed in. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { EcommerceV1ProductProductResourcePriceRange } from 'hostinger-api-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: EcommerceV1ProductProductResourcePriceRange = {
|
|
19
|
+
min,
|
|
20
|
+
max,
|
|
21
|
+
currency_code,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# EcommerceV1ProductProductResourceVariantsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | The variant ID. | [optional] [default to undefined]
|
|
9
|
+
**title** | **string** | The variant title. | [optional] [default to undefined]
|
|
10
|
+
**sku** | **string** | The variant SKU. | [optional] [default to undefined]
|
|
11
|
+
**_options** | [**Array<EcommerceV1ProductProductResourceVariantsInnerOptionsInner>**](EcommerceV1ProductProductResourceVariantsInnerOptionsInner.md) | The variant\'s option values. | [optional] [default to undefined]
|
|
12
|
+
**prices** | [**Array<EcommerceV1ProductProductResourceVariantsInnerPricesInner>**](EcommerceV1ProductProductResourceVariantsInnerPricesInner.md) | Prices per currency, in the smallest currency unit. | [optional] [default to undefined]
|
|
13
|
+
**inventory_quantity** | **number** | Units in stock. | [optional] [default to undefined]
|
|
14
|
+
**manage_inventory** | **boolean** | Whether stock is tracked for this variant. | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { EcommerceV1ProductProductResourceVariantsInner } from 'hostinger-api-sdk';
|
|
20
|
+
|
|
21
|
+
const instance: EcommerceV1ProductProductResourceVariantsInner = {
|
|
22
|
+
id,
|
|
23
|
+
title,
|
|
24
|
+
sku,
|
|
25
|
+
_options,
|
|
26
|
+
prices,
|
|
27
|
+
inventory_quantity,
|
|
28
|
+
manage_inventory,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
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)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# EcommerceV1ProductProductResourceVariantsInnerOptionsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | Option name, e.g. Size. | [optional] [default to undefined]
|
|
9
|
+
**value** | **string** | Option value, e.g. L. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { EcommerceV1ProductProductResourceVariantsInnerOptionsInner } from 'hostinger-api-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: EcommerceV1ProductProductResourceVariantsInnerOptionsInner = {
|
|
17
|
+
name,
|
|
18
|
+
value,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# EcommerceV1ProductProductResourceVariantsInnerPricesInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**amount** | **number** | Price in the smallest currency unit. | [optional] [default to undefined]
|
|
9
|
+
**sale_amount** | **number** | Sale price in the smallest currency unit, or null. | [optional] [default to undefined]
|
|
10
|
+
**currency_code** | **string** | The price currency code. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { EcommerceV1ProductProductResourceVariantsInnerPricesInner } from 'hostinger-api-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: EcommerceV1ProductProductResourceVariantsInnerPricesInner = {
|
|
18
|
+
amount,
|
|
19
|
+
sale_amount,
|
|
20
|
+
currency_code,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EcommerceV1ProductProductResponseResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**EcommerceV1ProductProductResource**](EcommerceV1ProductProductResource.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EcommerceV1ProductProductResponseResource } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EcommerceV1ProductProductResponseResource = {
|
|
16
|
+
data,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# EcommerceV1ProductUpdateRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | The product name. | [optional] [default to undefined]
|
|
9
|
+
**description** | **string** | The product description. | [optional] [default to undefined]
|
|
10
|
+
**status** | **string** | Set \"published\" to make the product buyable, \"draft\" to hide it, or \"archived\" to retire it. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { EcommerceV1ProductUpdateRequest } from 'hostinger-api-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: EcommerceV1ProductUpdateRequest = {
|
|
18
|
+
name,
|
|
19
|
+
description,
|
|
20
|
+
status,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**type** | **string** | Sales channel type.
|
|
9
|
-
**name** | **string** | Merchant-facing custom name
|
|
10
|
-
**url** | **string** | Optional public
|
|
8
|
+
**type** | **string** | Sales channel type. \"custom\" is a headless channel: it requires a name and takes an optional public url. \"quick-link\" is a one-page store whose handle is auto-generated; it supports neither name nor url. | [default to undefined]
|
|
9
|
+
**name** | **string** | Merchant-facing custom name. Required for custom channels; not supported for quick-link. | [optional] [default to undefined]
|
|
10
|
+
**url** | **string** | Optional public url for the channel. Custom channels only; not supported for quick-link. | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EcommerceV1VariantBatchUpdateVariantsRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**variants** | [**Array<EcommerceV1VariantBatchUpdateVariantsRequestVariantsInner>**](EcommerceV1VariantBatchUpdateVariantsRequestVariantsInner.md) | Variants to update in place by id, up to 100. Variants omitted from the list are left untouched. | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EcommerceV1VariantBatchUpdateVariantsRequest } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EcommerceV1VariantBatchUpdateVariantsRequest = {
|
|
16
|
+
variants,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# EcommerceV1VariantBatchUpdateVariantsRequestVariantsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**variant_id** | **string** | The id of the variant to update. | [default to undefined]
|
|
9
|
+
**title** | **string** | The variant title. | [optional] [default to undefined]
|
|
10
|
+
**inventory_quantity** | **number** | Units in stock. | [optional] [default to undefined]
|
|
11
|
+
**manage_inventory** | **boolean** | Whether stock is tracked for this variant. | [optional] [default to undefined]
|
|
12
|
+
**prices** | [**Array<EcommerceV1VariantBatchUpdateVariantsRequestVariantsInnerPricesInner>**](EcommerceV1VariantBatchUpdateVariantsRequestVariantsInnerPricesInner.md) | The full list of prices for the variant, replacing the existing ones. A free item is amount: 0. | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { EcommerceV1VariantBatchUpdateVariantsRequestVariantsInner } from 'hostinger-api-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: EcommerceV1VariantBatchUpdateVariantsRequestVariantsInner = {
|
|
20
|
+
variant_id,
|
|
21
|
+
title,
|
|
22
|
+
inventory_quantity,
|
|
23
|
+
manage_inventory,
|
|
24
|
+
prices,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
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)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# EcommerceV1VariantBatchUpdateVariantsRequestVariantsInnerPricesInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**amount** | **number** | Price in the smallest currency unit (e.g. cents). | [default to undefined]
|
|
9
|
+
**sale_amount** | **number** | Optional sale price in the smallest currency unit; must be lower than amount. | [optional] [default to undefined]
|
|
10
|
+
**currency** | **string** | ISO 4217 currency code. Defaults to the store\'s default currency. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { EcommerceV1VariantBatchUpdateVariantsRequestVariantsInnerPricesInner } from 'hostinger-api-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: EcommerceV1VariantBatchUpdateVariantsRequestVariantsInnerPricesInner = {
|
|
18
|
+
amount,
|
|
19
|
+
sale_amount,
|
|
20
|
+
currency,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# EcommerceV1VariantCreateVariantRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**title** | **string** | The variant title. Defaults to the option values joined with \' / \' (e.g. \'Red / L\'). | [optional] [default to undefined]
|
|
9
|
+
**sku** | **string** | The variant SKU. | [optional] [default to undefined]
|
|
10
|
+
**_options** | [**Array<EcommerceV1VariantCreateVariantRequestOptionsInner>**](EcommerceV1VariantCreateVariantRequestOptionsInner.md) | Option name/value pairs that distinguish this variant, e.g. [{name: Size, value: M}]. Options missing from the product are created; provide a value for every option the product already has. | [default to undefined]
|
|
11
|
+
**prices** | [**Array<EcommerceV1VariantCreateVariantRequestPricesInner>**](EcommerceV1VariantCreateVariantRequestPricesInner.md) | Prices per currency. Amounts are integers in the smallest currency unit. A free item is amount: 0. | [optional] [default to undefined]
|
|
12
|
+
**inventory_quantity** | **number** | Units in stock. Defaults to 0. | [optional] [default to undefined]
|
|
13
|
+
**manage_inventory** | **boolean** | Whether stock is tracked for this variant. Defaults to false. | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { EcommerceV1VariantCreateVariantRequest } from 'hostinger-api-sdk';
|
|
19
|
+
|
|
20
|
+
const instance: EcommerceV1VariantCreateVariantRequest = {
|
|
21
|
+
title,
|
|
22
|
+
sku,
|
|
23
|
+
_options,
|
|
24
|
+
prices,
|
|
25
|
+
inventory_quantity,
|
|
26
|
+
manage_inventory,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
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)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# EcommerceV1VariantCreateVariantRequestOptionsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | Option name, e.g. Size. | [default to undefined]
|
|
9
|
+
**value** | **string** | Option value for this variant, e.g. M. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { EcommerceV1VariantCreateVariantRequestOptionsInner } from 'hostinger-api-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: EcommerceV1VariantCreateVariantRequestOptionsInner = {
|
|
17
|
+
name,
|
|
18
|
+
value,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# EcommerceV1VariantCreateVariantRequestPricesInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**amount** | **number** | Price in the smallest currency unit (e.g. cents). | [default to undefined]
|
|
9
|
+
**sale_amount** | **number** | Optional sale price in the smallest currency unit; must be lower than amount. | [optional] [default to undefined]
|
|
10
|
+
**currency** | **string** | ISO 4217 currency code. Defaults to the store\'s default currency when omitted. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { EcommerceV1VariantCreateVariantRequestPricesInner } from 'hostinger-api-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: EcommerceV1VariantCreateVariantRequestPricesInner = {
|
|
18
|
+
amount,
|
|
19
|
+
sale_amount,
|
|
20
|
+
currency,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EcommerceV1VariantVariantDeletedResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**EcommerceV1VariantVariantDeletedResourceData**](EcommerceV1VariantVariantDeletedResourceData.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EcommerceV1VariantVariantDeletedResource } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EcommerceV1VariantVariantDeletedResource = {
|
|
16
|
+
data,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# EcommerceV1VariantVariantDeletedResourceData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | The ID of the variant. | [optional] [default to undefined]
|
|
9
|
+
**is_deleted** | **boolean** | True when the variant was deleted. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { EcommerceV1VariantVariantDeletedResourceData } from 'hostinger-api-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: EcommerceV1VariantVariantDeletedResourceData = {
|
|
17
|
+
id,
|
|
18
|
+
is_deleted,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EcommerceV1VariantVariantListResponseResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**Array<EcommerceV1VariantVariantResource>**](EcommerceV1VariantVariantResource.md) | The variants. | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EcommerceV1VariantVariantListResponseResource } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EcommerceV1VariantVariantListResponseResource = {
|
|
16
|
+
data,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# EcommerceV1VariantVariantResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | The variant ID, required by every other variant endpoint. | [optional] [default to undefined]
|
|
9
|
+
**title** | **string** | The variant title, or null. | [optional] [default to undefined]
|
|
10
|
+
**sku** | **string** | The variant SKU, or null. | [optional] [default to undefined]
|
|
11
|
+
**_options** | [**Array<EcommerceV1VariantVariantResourceOptionsInner>**](EcommerceV1VariantVariantResourceOptionsInner.md) | The variant\'s option values. | [optional] [default to undefined]
|
|
12
|
+
**prices** | [**Array<EcommerceV1ProductProductResourceVariantsInnerPricesInner>**](EcommerceV1ProductProductResourceVariantsInnerPricesInner.md) | Prices per currency, in the smallest currency unit. | [optional] [default to undefined]
|
|
13
|
+
**inventory_quantity** | **number** | Units in stock. | [optional] [default to undefined]
|
|
14
|
+
**manage_inventory** | **boolean** | Whether stock is tracked for this variant. | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { EcommerceV1VariantVariantResource } from 'hostinger-api-sdk';
|
|
20
|
+
|
|
21
|
+
const instance: EcommerceV1VariantVariantResource = {
|
|
22
|
+
id,
|
|
23
|
+
title,
|
|
24
|
+
sku,
|
|
25
|
+
_options,
|
|
26
|
+
prices,
|
|
27
|
+
inventory_quantity,
|
|
28
|
+
manage_inventory,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
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)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# EcommerceV1VariantVariantResourceOptionsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | Option name, e.g. Size. | [optional] [default to undefined]
|
|
9
|
+
**value** | **string** | Option value, e.g. M. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { EcommerceV1VariantVariantResourceOptionsInner } from 'hostinger-api-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: EcommerceV1VariantVariantResourceOptionsInner = {
|
|
17
|
+
name,
|
|
18
|
+
value,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EcommerceV1VariantVariantResponseResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**EcommerceV1VariantVariantResource**](EcommerceV1VariantVariantResource.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EcommerceV1VariantVariantResponseResource } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EcommerceV1VariantVariantResponseResource = {
|
|
16
|
+
data,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/ReachProfilesApi.md
CHANGED
|
@@ -4,10 +4,65 @@ All URIs are relative to *https://developers.hostinger.com*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getConnectedSendingDomainV1**](#getconnectedsendingdomainv1) | **GET** /api/reach/v1/profiles/{profileUuid}/domains | Get connected sending domain|
|
|
7
8
|
|[**getProfileDomainDNSStatusV1**](#getprofiledomaindnsstatusv1) | **GET** /api/reach/v1/profiles/{profileUuid}/domains/dns-status | Get profile domain DNS status|
|
|
8
9
|
|[**getRemainingPlanLimitsV1**](#getremainingplanlimitsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/limits | Get remaining plan limits|
|
|
10
|
+
|[**listPlanFeatureAccessV1**](#listplanfeatureaccessv1) | **GET** /api/reach/v1/profiles/{profileUuid}/features | List plan feature access|
|
|
9
11
|
|[**listProfilesV1**](#listprofilesv1) | **GET** /api/reach/v1/profiles | List Profiles|
|
|
10
12
|
|
|
13
|
+
# **getConnectedSendingDomainV1**
|
|
14
|
+
> ReachV1ProfilesDomainsSendingDomainResource getConnectedSendingDomainV1()
|
|
15
|
+
|
|
16
|
+
Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint.
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import {
|
|
22
|
+
ReachProfilesApi,
|
|
23
|
+
Configuration
|
|
24
|
+
} from 'hostinger-api-sdk';
|
|
25
|
+
|
|
26
|
+
const configuration = new Configuration();
|
|
27
|
+
const apiInstance = new ReachProfilesApi(configuration);
|
|
28
|
+
|
|
29
|
+
let profileUuid: string; //Profile uuid parameter (default to undefined)
|
|
30
|
+
|
|
31
|
+
const { status, data } = await apiInstance.getConnectedSendingDomainV1(
|
|
32
|
+
profileUuid
|
|
33
|
+
);
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
38
|
+
|Name | Type | Description | Notes|
|
|
39
|
+
|------------- | ------------- | ------------- | -------------|
|
|
40
|
+
| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
### Return type
|
|
44
|
+
|
|
45
|
+
**ReachV1ProfilesDomainsSendingDomainResource**
|
|
46
|
+
|
|
47
|
+
### Authorization
|
|
48
|
+
|
|
49
|
+
[apiToken](../README.md#apiToken)
|
|
50
|
+
|
|
51
|
+
### HTTP request headers
|
|
52
|
+
|
|
53
|
+
- **Content-Type**: Not defined
|
|
54
|
+
- **Accept**: application/json
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
### HTTP response details
|
|
58
|
+
| Status code | Description | Response headers |
|
|
59
|
+
|-------------|-------------|------------------|
|
|
60
|
+
|**200** | Success response | - |
|
|
61
|
+
|**401** | Unauthenticated response | - |
|
|
62
|
+
|**500** | Error response | - |
|
|
63
|
+
|
|
64
|
+
[[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)
|
|
65
|
+
|
|
11
66
|
# **getProfileDomainDNSStatusV1**
|
|
12
67
|
> ReachV1ProfilesDomainsDnsStatusResource getProfileDomainDNSStatusV1()
|
|
13
68
|
|
|
@@ -105,6 +160,59 @@ const { status, data } = await apiInstance.getRemainingPlanLimitsV1(
|
|
|
105
160
|
- **Accept**: application/json
|
|
106
161
|
|
|
107
162
|
|
|
163
|
+
### HTTP response details
|
|
164
|
+
| Status code | Description | Response headers |
|
|
165
|
+
|-------------|-------------|------------------|
|
|
166
|
+
|**200** | Success response | - |
|
|
167
|
+
|**401** | Unauthenticated response | - |
|
|
168
|
+
|**500** | Error response | - |
|
|
169
|
+
|
|
170
|
+
[[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)
|
|
171
|
+
|
|
172
|
+
# **listPlanFeatureAccessV1**
|
|
173
|
+
> Array<ReachV1ProfilesFeaturesPlanFeatureResource> listPlanFeatureAccessV1()
|
|
174
|
+
|
|
175
|
+
List which plan features the profile can use. This is the feature lock matrix, not a usage quota. `available` means the feature can be used right now and `locked` means it is not part of the base plan, so an upgrade is needed. For remaining emails, recipients and AI credits use the limits endpoint instead. Worth checking before building something that cannot be activated afterwards, such as an automation on a plan without automation activation.
|
|
176
|
+
|
|
177
|
+
### Example
|
|
178
|
+
|
|
179
|
+
```typescript
|
|
180
|
+
import {
|
|
181
|
+
ReachProfilesApi,
|
|
182
|
+
Configuration
|
|
183
|
+
} from 'hostinger-api-sdk';
|
|
184
|
+
|
|
185
|
+
const configuration = new Configuration();
|
|
186
|
+
const apiInstance = new ReachProfilesApi(configuration);
|
|
187
|
+
|
|
188
|
+
let profileUuid: string; //Profile uuid parameter (default to undefined)
|
|
189
|
+
|
|
190
|
+
const { status, data } = await apiInstance.listPlanFeatureAccessV1(
|
|
191
|
+
profileUuid
|
|
192
|
+
);
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### Parameters
|
|
196
|
+
|
|
197
|
+
|Name | Type | Description | Notes|
|
|
198
|
+
|------------- | ------------- | ------------- | -------------|
|
|
199
|
+
| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
### Return type
|
|
203
|
+
|
|
204
|
+
**Array<ReachV1ProfilesFeaturesPlanFeatureResource>**
|
|
205
|
+
|
|
206
|
+
### Authorization
|
|
207
|
+
|
|
208
|
+
[apiToken](../README.md#apiToken)
|
|
209
|
+
|
|
210
|
+
### HTTP request headers
|
|
211
|
+
|
|
212
|
+
- **Content-Type**: Not defined
|
|
213
|
+
- **Accept**: application/json
|
|
214
|
+
|
|
215
|
+
|
|
108
216
|
### HTTP response details
|
|
109
217
|
| Status code | Description | Response headers |
|
|
110
218
|
|-------------|-------------|------------------|
|