hostinger-api-sdk 1.30.7 → 1.31.0
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 +514 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +354 -1
- package/dist/api.js +343 -9
- 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 +354 -1
- package/dist/esm/api.js +331 -1
- 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/ReachAutomationsApi.md +187 -0
- package/docs/ReachListAutomationsV1200Response.md +22 -0
- package/docs/ReachV1AutomationsAutomationEventsResource.md +27 -0
- package/docs/ReachV1AutomationsAutomationResource.md +34 -0
- package/docs/ReachV1AutomationsStepsAutomationStepResource.md +30 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
## hostinger-api-sdk@1.
|
|
1
|
+
## hostinger-api-sdk@1.31.0
|
|
2
2
|
|
|
3
3
|
For more information, please visit [https://developers.hostinger.com](https://developers.hostinger.com).
|
|
4
4
|
|
|
5
5
|
### Usage
|
|
6
6
|
|
|
7
7
|
```
|
|
8
|
-
npm install hostinger-api-sdk@1.
|
|
8
|
+
npm install hostinger-api-sdk@1.31.0 --save
|
|
9
9
|
```
|
package/api.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.33.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -7771,6 +7771,25 @@ export interface MailV1WebhooksWebhookTestResultResource {
|
|
|
7771
7771
|
*/
|
|
7772
7772
|
'error': string | null;
|
|
7773
7773
|
}
|
|
7774
|
+
/**
|
|
7775
|
+
*
|
|
7776
|
+
* @export
|
|
7777
|
+
* @interface ReachListAutomationsV1200Response
|
|
7778
|
+
*/
|
|
7779
|
+
export interface ReachListAutomationsV1200Response {
|
|
7780
|
+
/**
|
|
7781
|
+
* Array of [`Reach.V1.Automations.AutomationResource`](#model/reachv1automationsautomationresource)
|
|
7782
|
+
* @type {Array<ReachV1AutomationsAutomationResource>}
|
|
7783
|
+
* @memberof ReachListAutomationsV1200Response
|
|
7784
|
+
*/
|
|
7785
|
+
'data': Array<ReachV1AutomationsAutomationResource>;
|
|
7786
|
+
/**
|
|
7787
|
+
*
|
|
7788
|
+
* @type {CommonSchemaPaginationMetaSchema}
|
|
7789
|
+
* @memberof ReachListAutomationsV1200Response
|
|
7790
|
+
*/
|
|
7791
|
+
'meta': CommonSchemaPaginationMetaSchema;
|
|
7792
|
+
}
|
|
7774
7793
|
/**
|
|
7775
7794
|
*
|
|
7776
7795
|
* @export
|
|
@@ -7847,6 +7866,182 @@ export interface ReachListProfileSegmentsV1200Response {
|
|
|
7847
7866
|
*/
|
|
7848
7867
|
'meta': CommonSchemaPaginationMetaSchema;
|
|
7849
7868
|
}
|
|
7869
|
+
/**
|
|
7870
|
+
* 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.
|
|
7871
|
+
* @export
|
|
7872
|
+
* @interface ReachV1AutomationsAutomationEventsResource
|
|
7873
|
+
*/
|
|
7874
|
+
export interface ReachV1AutomationsAutomationEventsResource {
|
|
7875
|
+
/**
|
|
7876
|
+
* Contacts that ever entered the automation, including those that already left it.
|
|
7877
|
+
* @type {number}
|
|
7878
|
+
* @memberof ReachV1AutomationsAutomationEventsResource
|
|
7879
|
+
*/
|
|
7880
|
+
'started': number;
|
|
7881
|
+
/**
|
|
7882
|
+
* Contacts currently moving through the automation, including those waiting on a delay step.
|
|
7883
|
+
* @type {number}
|
|
7884
|
+
* @memberof ReachV1AutomationsAutomationEventsResource
|
|
7885
|
+
*/
|
|
7886
|
+
'in_progress': number;
|
|
7887
|
+
/**
|
|
7888
|
+
* Contacts that reached the end of the workflow.
|
|
7889
|
+
* @type {number}
|
|
7890
|
+
* @memberof ReachV1AutomationsAutomationEventsResource
|
|
7891
|
+
*/
|
|
7892
|
+
'completed': number;
|
|
7893
|
+
/**
|
|
7894
|
+
* Contacts whose journey through the automation errored and stopped.
|
|
7895
|
+
* @type {number}
|
|
7896
|
+
* @memberof ReachV1AutomationsAutomationEventsResource
|
|
7897
|
+
*/
|
|
7898
|
+
'failed': number;
|
|
7899
|
+
}
|
|
7900
|
+
/**
|
|
7901
|
+
*
|
|
7902
|
+
* @export
|
|
7903
|
+
* @interface ReachV1AutomationsAutomationResource
|
|
7904
|
+
*/
|
|
7905
|
+
export interface ReachV1AutomationsAutomationResource {
|
|
7906
|
+
/**
|
|
7907
|
+
*
|
|
7908
|
+
* @type {string}
|
|
7909
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7910
|
+
*/
|
|
7911
|
+
'uuid': string;
|
|
7912
|
+
/**
|
|
7913
|
+
*
|
|
7914
|
+
* @type {string}
|
|
7915
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7916
|
+
*/
|
|
7917
|
+
'name': string;
|
|
7918
|
+
/**
|
|
7919
|
+
* There is no `completed` status. Use `events.completed` to see how many contacts finished.
|
|
7920
|
+
* @type {string}
|
|
7921
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7922
|
+
*/
|
|
7923
|
+
'status': ReachV1AutomationsAutomationResourceStatusEnum;
|
|
7924
|
+
/**
|
|
7925
|
+
* What kind of workflow this is. `custom` automations are the ones built from scratch.
|
|
7926
|
+
* @type {string}
|
|
7927
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7928
|
+
*/
|
|
7929
|
+
'type': ReachV1AutomationsAutomationResourceTypeEnum;
|
|
7930
|
+
/**
|
|
7931
|
+
* Trigger configuration of the automation. The shape depends on the type.
|
|
7932
|
+
* @type {object}
|
|
7933
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7934
|
+
*/
|
|
7935
|
+
'config': object | null;
|
|
7936
|
+
/**
|
|
7937
|
+
*
|
|
7938
|
+
* @type {ReachV1AutomationsAutomationEventsResource}
|
|
7939
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7940
|
+
*/
|
|
7941
|
+
'events': ReachV1AutomationsAutomationEventsResource;
|
|
7942
|
+
/**
|
|
7943
|
+
*
|
|
7944
|
+
* @type {string}
|
|
7945
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7946
|
+
*/
|
|
7947
|
+
'created_at': string | null;
|
|
7948
|
+
/**
|
|
7949
|
+
*
|
|
7950
|
+
* @type {string}
|
|
7951
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7952
|
+
*/
|
|
7953
|
+
'updated_at': string | null;
|
|
7954
|
+
}
|
|
7955
|
+
|
|
7956
|
+
export const ReachV1AutomationsAutomationResourceStatusEnum = {
|
|
7957
|
+
Active: 'active',
|
|
7958
|
+
Paused: 'paused',
|
|
7959
|
+
Draft: 'draft'
|
|
7960
|
+
} as const;
|
|
7961
|
+
|
|
7962
|
+
export type ReachV1AutomationsAutomationResourceStatusEnum = typeof ReachV1AutomationsAutomationResourceStatusEnum[keyof typeof ReachV1AutomationsAutomationResourceStatusEnum];
|
|
7963
|
+
export const ReachV1AutomationsAutomationResourceTypeEnum = {
|
|
7964
|
+
Welcome: 'welcome',
|
|
7965
|
+
WelcomeSeries: 'welcome_series',
|
|
7966
|
+
PromotionalSeries: 'promotional_series',
|
|
7967
|
+
TrustBuildingSeries: 'trust_building_series',
|
|
7968
|
+
EcommerceAbandonedCart: 'ecommerce_abandoned_cart',
|
|
7969
|
+
EcommerceRecommendAfterPurchase: 'ecommerce_recommend_after_purchase',
|
|
7970
|
+
EcommercePostPurchase: 'ecommerce_post_purchase',
|
|
7971
|
+
EcommerceDiscountAfterPurchase: 'ecommerce_discount_after_purchase',
|
|
7972
|
+
ReEngagementNonOpeners: 're_engagement_non_openers',
|
|
7973
|
+
ReEngagementNonClickers: 're_engagement_non_clickers',
|
|
7974
|
+
FormSubmitted: 'form_submitted',
|
|
7975
|
+
Custom: 'custom'
|
|
7976
|
+
} as const;
|
|
7977
|
+
|
|
7978
|
+
export type ReachV1AutomationsAutomationResourceTypeEnum = typeof ReachV1AutomationsAutomationResourceTypeEnum[keyof typeof ReachV1AutomationsAutomationResourceTypeEnum];
|
|
7979
|
+
|
|
7980
|
+
/**
|
|
7981
|
+
*
|
|
7982
|
+
* @export
|
|
7983
|
+
* @interface ReachV1AutomationsStepsAutomationStepResource
|
|
7984
|
+
*/
|
|
7985
|
+
export interface ReachV1AutomationsStepsAutomationStepResource {
|
|
7986
|
+
/**
|
|
7987
|
+
*
|
|
7988
|
+
* @type {string}
|
|
7989
|
+
* @memberof ReachV1AutomationsStepsAutomationStepResource
|
|
7990
|
+
*/
|
|
7991
|
+
'uuid': string;
|
|
7992
|
+
/**
|
|
7993
|
+
* The step this one branches from. Null for the entry point of the workflow.
|
|
7994
|
+
* @type {string}
|
|
7995
|
+
* @memberof ReachV1AutomationsStepsAutomationStepResource
|
|
7996
|
+
*/
|
|
7997
|
+
'parent_uuid': string | null;
|
|
7998
|
+
/**
|
|
7999
|
+
* Position of this step among the steps sharing its parent.
|
|
8000
|
+
* @type {number}
|
|
8001
|
+
* @memberof ReachV1AutomationsStepsAutomationStepResource
|
|
8002
|
+
*/
|
|
8003
|
+
'step_order': number;
|
|
8004
|
+
/**
|
|
8005
|
+
* Role of the step in the workflow. A `conditional` step branches into several children.
|
|
8006
|
+
* @type {string}
|
|
8007
|
+
* @memberof ReachV1AutomationsStepsAutomationStepResource
|
|
8008
|
+
*/
|
|
8009
|
+
'type': ReachV1AutomationsStepsAutomationStepResourceTypeEnum;
|
|
8010
|
+
/**
|
|
8011
|
+
* The concrete trigger, action, decision or delay this step performs.
|
|
8012
|
+
* @type {string}
|
|
8013
|
+
* @memberof ReachV1AutomationsStepsAutomationStepResource
|
|
8014
|
+
*/
|
|
8015
|
+
'value': ReachV1AutomationsStepsAutomationStepResourceValueEnum;
|
|
8016
|
+
/**
|
|
8017
|
+
* Step configuration. The shape depends on the value, and is empty for steps that take none.
|
|
8018
|
+
* @type {object}
|
|
8019
|
+
* @memberof ReachV1AutomationsStepsAutomationStepResource
|
|
8020
|
+
*/
|
|
8021
|
+
'config': object | null;
|
|
8022
|
+
}
|
|
8023
|
+
|
|
8024
|
+
export const ReachV1AutomationsStepsAutomationStepResourceTypeEnum = {
|
|
8025
|
+
Trigger: 'trigger',
|
|
8026
|
+
Action: 'action',
|
|
8027
|
+
Conditional: 'conditional'
|
|
8028
|
+
} as const;
|
|
8029
|
+
|
|
8030
|
+
export type ReachV1AutomationsStepsAutomationStepResourceTypeEnum = typeof ReachV1AutomationsStepsAutomationStepResourceTypeEnum[keyof typeof ReachV1AutomationsStepsAutomationStepResourceTypeEnum];
|
|
8031
|
+
export const ReachV1AutomationsStepsAutomationStepResourceValueEnum = {
|
|
8032
|
+
NewContact: 'new_contact',
|
|
8033
|
+
NewSegmentContact: 'new_segment_contact',
|
|
8034
|
+
FormSubmitted: 'form_submitted',
|
|
8035
|
+
Webhook: 'webhook',
|
|
8036
|
+
SendWelcomeEmail: 'send_welcome_email',
|
|
8037
|
+
SendEmail: 'send_email',
|
|
8038
|
+
SendCampaign: 'send_campaign',
|
|
8039
|
+
Decision: 'decision',
|
|
8040
|
+
Delay: 'delay'
|
|
8041
|
+
} as const;
|
|
8042
|
+
|
|
8043
|
+
export type ReachV1AutomationsStepsAutomationStepResourceValueEnum = typeof ReachV1AutomationsStepsAutomationStepResourceValueEnum[keyof typeof ReachV1AutomationsStepsAutomationStepResourceValueEnum];
|
|
8044
|
+
|
|
7850
8045
|
/**
|
|
7851
8046
|
* Create many contacts in one call
|
|
7852
8047
|
* @export
|
|
@@ -28502,6 +28697,324 @@ export const ListWebhooksV1StatusEnum = {
|
|
|
28502
28697
|
export type ListWebhooksV1StatusEnum = typeof ListWebhooksV1StatusEnum[keyof typeof ListWebhooksV1StatusEnum];
|
|
28503
28698
|
|
|
28504
28699
|
|
|
28700
|
+
/**
|
|
28701
|
+
* ReachAutomationsApi - axios parameter creator
|
|
28702
|
+
* @export
|
|
28703
|
+
*/
|
|
28704
|
+
export const ReachAutomationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
28705
|
+
return {
|
|
28706
|
+
/**
|
|
28707
|
+
* Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way. This describes the automation itself. To see the workflow it runs, use the steps endpoint.
|
|
28708
|
+
* @summary Get automation details
|
|
28709
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
28710
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
28711
|
+
* @param {*} [options] Override http request option.
|
|
28712
|
+
* @throws {RequiredError}
|
|
28713
|
+
*/
|
|
28714
|
+
getAutomationDetailsV1: async (profileUuid: string, automationUuid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
28715
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
28716
|
+
assertParamExists('getAutomationDetailsV1', 'profileUuid', profileUuid)
|
|
28717
|
+
// verify required parameter 'automationUuid' is not null or undefined
|
|
28718
|
+
assertParamExists('getAutomationDetailsV1', 'automationUuid', automationUuid)
|
|
28719
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}`
|
|
28720
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
28721
|
+
.replace(`{${"automationUuid"}}`, encodeURIComponent(String(automationUuid)));
|
|
28722
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
28723
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
28724
|
+
let baseOptions;
|
|
28725
|
+
if (configuration) {
|
|
28726
|
+
baseOptions = configuration.baseOptions;
|
|
28727
|
+
}
|
|
28728
|
+
|
|
28729
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
28730
|
+
const localVarHeaderParameter = {} as any;
|
|
28731
|
+
const localVarQueryParameter = {} as any;
|
|
28732
|
+
|
|
28733
|
+
// authentication apiToken required
|
|
28734
|
+
// http bearer authentication required
|
|
28735
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
28736
|
+
|
|
28737
|
+
|
|
28738
|
+
|
|
28739
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
28740
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
28741
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
28742
|
+
|
|
28743
|
+
return {
|
|
28744
|
+
url: toPathString(localVarUrlObj),
|
|
28745
|
+
options: localVarRequestOptions,
|
|
28746
|
+
};
|
|
28747
|
+
},
|
|
28748
|
+
/**
|
|
28749
|
+
* Get the workflow of an automation as a flat list of steps. The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list.
|
|
28750
|
+
* @summary List automation steps
|
|
28751
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
28752
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
28753
|
+
* @param {*} [options] Override http request option.
|
|
28754
|
+
* @throws {RequiredError}
|
|
28755
|
+
*/
|
|
28756
|
+
listAutomationStepsV1: async (profileUuid: string, automationUuid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
28757
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
28758
|
+
assertParamExists('listAutomationStepsV1', 'profileUuid', profileUuid)
|
|
28759
|
+
// verify required parameter 'automationUuid' is not null or undefined
|
|
28760
|
+
assertParamExists('listAutomationStepsV1', 'automationUuid', automationUuid)
|
|
28761
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}/steps`
|
|
28762
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
28763
|
+
.replace(`{${"automationUuid"}}`, encodeURIComponent(String(automationUuid)));
|
|
28764
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
28765
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
28766
|
+
let baseOptions;
|
|
28767
|
+
if (configuration) {
|
|
28768
|
+
baseOptions = configuration.baseOptions;
|
|
28769
|
+
}
|
|
28770
|
+
|
|
28771
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
28772
|
+
const localVarHeaderParameter = {} as any;
|
|
28773
|
+
const localVarQueryParameter = {} as any;
|
|
28774
|
+
|
|
28775
|
+
// authentication apiToken required
|
|
28776
|
+
// http bearer authentication required
|
|
28777
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
28778
|
+
|
|
28779
|
+
|
|
28780
|
+
|
|
28781
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
28782
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
28783
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
28784
|
+
|
|
28785
|
+
return {
|
|
28786
|
+
url: toPathString(localVarUrlObj),
|
|
28787
|
+
options: localVarRequestOptions,
|
|
28788
|
+
};
|
|
28789
|
+
},
|
|
28790
|
+
/**
|
|
28791
|
+
* Get a paginated list of the automations in a profile. Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
|
|
28792
|
+
* @summary List automations
|
|
28793
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
28794
|
+
* @param {ListAutomationsV1StatusEnum} [status] Filter automations by status. There is no `completed` status. An automation that has finished for every contact still reports `active`.
|
|
28795
|
+
* @param {ListAutomationsV1SortDirectionEnum} [sortDirection] Order automations by creation date. Newest first unless set to `asc`.
|
|
28796
|
+
* @param {number} [page] Page number
|
|
28797
|
+
* @param {number} [perPage] Number of items per page
|
|
28798
|
+
* @param {*} [options] Override http request option.
|
|
28799
|
+
* @throws {RequiredError}
|
|
28800
|
+
*/
|
|
28801
|
+
listAutomationsV1: async (profileUuid: string, status?: ListAutomationsV1StatusEnum, sortDirection?: ListAutomationsV1SortDirectionEnum, page?: number, perPage?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
28802
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
28803
|
+
assertParamExists('listAutomationsV1', 'profileUuid', profileUuid)
|
|
28804
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/automations`
|
|
28805
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
28806
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
28807
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
28808
|
+
let baseOptions;
|
|
28809
|
+
if (configuration) {
|
|
28810
|
+
baseOptions = configuration.baseOptions;
|
|
28811
|
+
}
|
|
28812
|
+
|
|
28813
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
28814
|
+
const localVarHeaderParameter = {} as any;
|
|
28815
|
+
const localVarQueryParameter = {} as any;
|
|
28816
|
+
|
|
28817
|
+
// authentication apiToken required
|
|
28818
|
+
// http bearer authentication required
|
|
28819
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
28820
|
+
|
|
28821
|
+
if (status !== undefined) {
|
|
28822
|
+
localVarQueryParameter['status'] = status;
|
|
28823
|
+
}
|
|
28824
|
+
|
|
28825
|
+
if (sortDirection !== undefined) {
|
|
28826
|
+
localVarQueryParameter['sort_direction'] = sortDirection;
|
|
28827
|
+
}
|
|
28828
|
+
|
|
28829
|
+
if (page !== undefined) {
|
|
28830
|
+
localVarQueryParameter['page'] = page;
|
|
28831
|
+
}
|
|
28832
|
+
|
|
28833
|
+
if (perPage !== undefined) {
|
|
28834
|
+
localVarQueryParameter['per_page'] = perPage;
|
|
28835
|
+
}
|
|
28836
|
+
|
|
28837
|
+
|
|
28838
|
+
|
|
28839
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
28840
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
28841
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
28842
|
+
|
|
28843
|
+
return {
|
|
28844
|
+
url: toPathString(localVarUrlObj),
|
|
28845
|
+
options: localVarRequestOptions,
|
|
28846
|
+
};
|
|
28847
|
+
},
|
|
28848
|
+
}
|
|
28849
|
+
};
|
|
28850
|
+
|
|
28851
|
+
/**
|
|
28852
|
+
* ReachAutomationsApi - functional programming interface
|
|
28853
|
+
* @export
|
|
28854
|
+
*/
|
|
28855
|
+
export const ReachAutomationsApiFp = function(configuration?: Configuration) {
|
|
28856
|
+
const localVarAxiosParamCreator = ReachAutomationsApiAxiosParamCreator(configuration)
|
|
28857
|
+
return {
|
|
28858
|
+
/**
|
|
28859
|
+
* Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way. This describes the automation itself. To see the workflow it runs, use the steps endpoint.
|
|
28860
|
+
* @summary Get automation details
|
|
28861
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
28862
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
28863
|
+
* @param {*} [options] Override http request option.
|
|
28864
|
+
* @throws {RequiredError}
|
|
28865
|
+
*/
|
|
28866
|
+
async getAutomationDetailsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1AutomationsAutomationResource>> {
|
|
28867
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAutomationDetailsV1(profileUuid, automationUuid, options);
|
|
28868
|
+
const localVarOperationServerBasePath = operationServerMap['ReachAutomationsApi.getAutomationDetailsV1']?.[0]?.url;
|
|
28869
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
28870
|
+
},
|
|
28871
|
+
/**
|
|
28872
|
+
* Get the workflow of an automation as a flat list of steps. The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list.
|
|
28873
|
+
* @summary List automation steps
|
|
28874
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
28875
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
28876
|
+
* @param {*} [options] Override http request option.
|
|
28877
|
+
* @throws {RequiredError}
|
|
28878
|
+
*/
|
|
28879
|
+
async listAutomationStepsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ReachV1AutomationsStepsAutomationStepResource>>> {
|
|
28880
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAutomationStepsV1(profileUuid, automationUuid, options);
|
|
28881
|
+
const localVarOperationServerBasePath = operationServerMap['ReachAutomationsApi.listAutomationStepsV1']?.[0]?.url;
|
|
28882
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
28883
|
+
},
|
|
28884
|
+
/**
|
|
28885
|
+
* Get a paginated list of the automations in a profile. Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
|
|
28886
|
+
* @summary List automations
|
|
28887
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
28888
|
+
* @param {ListAutomationsV1StatusEnum} [status] Filter automations by status. There is no `completed` status. An automation that has finished for every contact still reports `active`.
|
|
28889
|
+
* @param {ListAutomationsV1SortDirectionEnum} [sortDirection] Order automations by creation date. Newest first unless set to `asc`.
|
|
28890
|
+
* @param {number} [page] Page number
|
|
28891
|
+
* @param {number} [perPage] Number of items per page
|
|
28892
|
+
* @param {*} [options] Override http request option.
|
|
28893
|
+
* @throws {RequiredError}
|
|
28894
|
+
*/
|
|
28895
|
+
async listAutomationsV1(profileUuid: string, status?: ListAutomationsV1StatusEnum, sortDirection?: ListAutomationsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachListAutomationsV1200Response>> {
|
|
28896
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAutomationsV1(profileUuid, status, sortDirection, page, perPage, options);
|
|
28897
|
+
const localVarOperationServerBasePath = operationServerMap['ReachAutomationsApi.listAutomationsV1']?.[0]?.url;
|
|
28898
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
28899
|
+
},
|
|
28900
|
+
}
|
|
28901
|
+
};
|
|
28902
|
+
|
|
28903
|
+
/**
|
|
28904
|
+
* ReachAutomationsApi - factory interface
|
|
28905
|
+
* @export
|
|
28906
|
+
*/
|
|
28907
|
+
export const ReachAutomationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
28908
|
+
const localVarFp = ReachAutomationsApiFp(configuration)
|
|
28909
|
+
return {
|
|
28910
|
+
/**
|
|
28911
|
+
* Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way. This describes the automation itself. To see the workflow it runs, use the steps endpoint.
|
|
28912
|
+
* @summary Get automation details
|
|
28913
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
28914
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
28915
|
+
* @param {*} [options] Override http request option.
|
|
28916
|
+
* @throws {RequiredError}
|
|
28917
|
+
*/
|
|
28918
|
+
getAutomationDetailsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1AutomationsAutomationResource> {
|
|
28919
|
+
return localVarFp.getAutomationDetailsV1(profileUuid, automationUuid, options).then((request) => request(axios, basePath));
|
|
28920
|
+
},
|
|
28921
|
+
/**
|
|
28922
|
+
* Get the workflow of an automation as a flat list of steps. The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list.
|
|
28923
|
+
* @summary List automation steps
|
|
28924
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
28925
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
28926
|
+
* @param {*} [options] Override http request option.
|
|
28927
|
+
* @throws {RequiredError}
|
|
28928
|
+
*/
|
|
28929
|
+
listAutomationStepsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ReachV1AutomationsStepsAutomationStepResource>> {
|
|
28930
|
+
return localVarFp.listAutomationStepsV1(profileUuid, automationUuid, options).then((request) => request(axios, basePath));
|
|
28931
|
+
},
|
|
28932
|
+
/**
|
|
28933
|
+
* Get a paginated list of the automations in a profile. Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
|
|
28934
|
+
* @summary List automations
|
|
28935
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
28936
|
+
* @param {ListAutomationsV1StatusEnum} [status] Filter automations by status. There is no `completed` status. An automation that has finished for every contact still reports `active`.
|
|
28937
|
+
* @param {ListAutomationsV1SortDirectionEnum} [sortDirection] Order automations by creation date. Newest first unless set to `asc`.
|
|
28938
|
+
* @param {number} [page] Page number
|
|
28939
|
+
* @param {number} [perPage] Number of items per page
|
|
28940
|
+
* @param {*} [options] Override http request option.
|
|
28941
|
+
* @throws {RequiredError}
|
|
28942
|
+
*/
|
|
28943
|
+
listAutomationsV1(profileUuid: string, status?: ListAutomationsV1StatusEnum, sortDirection?: ListAutomationsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<ReachListAutomationsV1200Response> {
|
|
28944
|
+
return localVarFp.listAutomationsV1(profileUuid, status, sortDirection, page, perPage, options).then((request) => request(axios, basePath));
|
|
28945
|
+
},
|
|
28946
|
+
};
|
|
28947
|
+
};
|
|
28948
|
+
|
|
28949
|
+
/**
|
|
28950
|
+
* ReachAutomationsApi - object-oriented interface
|
|
28951
|
+
* @export
|
|
28952
|
+
* @class ReachAutomationsApi
|
|
28953
|
+
* @extends {BaseAPI}
|
|
28954
|
+
*/
|
|
28955
|
+
export class ReachAutomationsApi extends BaseAPI {
|
|
28956
|
+
/**
|
|
28957
|
+
* Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way. This describes the automation itself. To see the workflow it runs, use the steps endpoint.
|
|
28958
|
+
* @summary Get automation details
|
|
28959
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
28960
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
28961
|
+
* @param {*} [options] Override http request option.
|
|
28962
|
+
* @throws {RequiredError}
|
|
28963
|
+
* @memberof ReachAutomationsApi
|
|
28964
|
+
*/
|
|
28965
|
+
public getAutomationDetailsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig) {
|
|
28966
|
+
return ReachAutomationsApiFp(this.configuration).getAutomationDetailsV1(profileUuid, automationUuid, options).then((request) => request(this.axios, this.basePath));
|
|
28967
|
+
}
|
|
28968
|
+
|
|
28969
|
+
/**
|
|
28970
|
+
* Get the workflow of an automation as a flat list of steps. The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list.
|
|
28971
|
+
* @summary List automation steps
|
|
28972
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
28973
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
28974
|
+
* @param {*} [options] Override http request option.
|
|
28975
|
+
* @throws {RequiredError}
|
|
28976
|
+
* @memberof ReachAutomationsApi
|
|
28977
|
+
*/
|
|
28978
|
+
public listAutomationStepsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig) {
|
|
28979
|
+
return ReachAutomationsApiFp(this.configuration).listAutomationStepsV1(profileUuid, automationUuid, options).then((request) => request(this.axios, this.basePath));
|
|
28980
|
+
}
|
|
28981
|
+
|
|
28982
|
+
/**
|
|
28983
|
+
* Get a paginated list of the automations in a profile. Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
|
|
28984
|
+
* @summary List automations
|
|
28985
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
28986
|
+
* @param {ListAutomationsV1StatusEnum} [status] Filter automations by status. There is no `completed` status. An automation that has finished for every contact still reports `active`.
|
|
28987
|
+
* @param {ListAutomationsV1SortDirectionEnum} [sortDirection] Order automations by creation date. Newest first unless set to `asc`.
|
|
28988
|
+
* @param {number} [page] Page number
|
|
28989
|
+
* @param {number} [perPage] Number of items per page
|
|
28990
|
+
* @param {*} [options] Override http request option.
|
|
28991
|
+
* @throws {RequiredError}
|
|
28992
|
+
* @memberof ReachAutomationsApi
|
|
28993
|
+
*/
|
|
28994
|
+
public listAutomationsV1(profileUuid: string, status?: ListAutomationsV1StatusEnum, sortDirection?: ListAutomationsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig) {
|
|
28995
|
+
return ReachAutomationsApiFp(this.configuration).listAutomationsV1(profileUuid, status, sortDirection, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
28996
|
+
}
|
|
28997
|
+
}
|
|
28998
|
+
|
|
28999
|
+
/**
|
|
29000
|
+
* @export
|
|
29001
|
+
*/
|
|
29002
|
+
export const ListAutomationsV1StatusEnum = {
|
|
29003
|
+
Active: 'active',
|
|
29004
|
+
Paused: 'paused',
|
|
29005
|
+
Draft: 'draft'
|
|
29006
|
+
} as const;
|
|
29007
|
+
export type ListAutomationsV1StatusEnum = typeof ListAutomationsV1StatusEnum[keyof typeof ListAutomationsV1StatusEnum];
|
|
29008
|
+
/**
|
|
29009
|
+
* @export
|
|
29010
|
+
*/
|
|
29011
|
+
export const ListAutomationsV1SortDirectionEnum = {
|
|
29012
|
+
Asc: 'asc',
|
|
29013
|
+
Desc: 'desc'
|
|
29014
|
+
} as const;
|
|
29015
|
+
export type ListAutomationsV1SortDirectionEnum = typeof ListAutomationsV1SortDirectionEnum[keyof typeof ListAutomationsV1SortDirectionEnum];
|
|
29016
|
+
|
|
29017
|
+
|
|
28505
29018
|
/**
|
|
28506
29019
|
* ReachContactFieldsApi - axios parameter creator
|
|
28507
29020
|
* @export
|
package/base.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.33.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
package/common.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.33.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.33.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -48,7 +48,7 @@ export class Configuration {
|
|
|
48
48
|
this.baseOptions = {
|
|
49
49
|
...param.baseOptions,
|
|
50
50
|
headers: {
|
|
51
|
-
'User-Agent': "hostinger-typescript-sdk/1.
|
|
51
|
+
'User-Agent': "hostinger-typescript-sdk/1.31.0",
|
|
52
52
|
...param.baseOptions?.headers,
|
|
53
53
|
},
|
|
54
54
|
};
|