@hostinger/sdk 1.46.3 → 1.47.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 +483 -59
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +341 -59
- package/dist/api.js +281 -12
- 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 +341 -59
- package/dist/esm/api.js +267 -2
- 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/AgencyHostingV1SetupsCreateSetupRequest.md +0 -4
- package/docs/ReachCampaignsApi.md +59 -0
- package/docs/ReachTemplatesApi.md +120 -0
- package/docs/ReachV1CampaignsCreatedCampaignResource.md +43 -0
- package/docs/ReachV1CampaignsStoreRequest.md +31 -0
- package/docs/ReachV1CampaignsStoreRequestMetadata.md +23 -0
- package/docs/ReachV1TemplatesStoreRequest.md +23 -0
- package/docs/ReachV1TemplatesTemplateResource.md +26 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/docs/AgencyHostingV1SetupsCreateSetupRequestClone.md +0 -21
- package/docs/AgencyHostingV1SetupsCreateSetupRequestDeriveDomain.md +0 -21
- package/docs/AgencyHostingV1SetupsCreateSetupRequestDeriveDomainFromVhost.md +0 -22
package/dist/esm/api.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.47.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -692,69 +692,11 @@ export interface AgencyHostingV1SetupsCreateSetupRequest {
|
|
|
692
692
|
* @memberof AgencyHostingV1SetupsCreateSetupRequest
|
|
693
693
|
*/
|
|
694
694
|
'wordpress': AgencyHostingV1SetupsCreateSetupRequestWordpress;
|
|
695
|
-
/**
|
|
696
|
-
*
|
|
697
|
-
* @type {AgencyHostingV1SetupsCreateSetupRequestClone}
|
|
698
|
-
* @memberof AgencyHostingV1SetupsCreateSetupRequest
|
|
699
|
-
*/
|
|
700
|
-
'clone': AgencyHostingV1SetupsCreateSetupRequestClone;
|
|
701
|
-
/**
|
|
702
|
-
*
|
|
703
|
-
* @type {AgencyHostingV1SetupsCreateSetupRequestDeriveDomain}
|
|
704
|
-
* @memberof AgencyHostingV1SetupsCreateSetupRequest
|
|
705
|
-
*/
|
|
706
|
-
'derive_domain': AgencyHostingV1SetupsCreateSetupRequestDeriveDomain;
|
|
707
695
|
}
|
|
708
696
|
export declare const AgencyHostingV1SetupsCreateSetupRequestTypeEnum: {
|
|
709
|
-
readonly Horizons: "horizons";
|
|
710
697
|
readonly NodeStatic: "node-static";
|
|
711
698
|
};
|
|
712
699
|
export type AgencyHostingV1SetupsCreateSetupRequestTypeEnum = typeof AgencyHostingV1SetupsCreateSetupRequestTypeEnum[keyof typeof AgencyHostingV1SetupsCreateSetupRequestTypeEnum];
|
|
713
|
-
/**
|
|
714
|
-
* Clone the new website from an existing website
|
|
715
|
-
* @export
|
|
716
|
-
* @interface AgencyHostingV1SetupsCreateSetupRequestClone
|
|
717
|
-
*/
|
|
718
|
-
export interface AgencyHostingV1SetupsCreateSetupRequestClone {
|
|
719
|
-
/**
|
|
720
|
-
*
|
|
721
|
-
* @type {string}
|
|
722
|
-
* @memberof AgencyHostingV1SetupsCreateSetupRequestClone
|
|
723
|
-
*/
|
|
724
|
-
'website_uid': string;
|
|
725
|
-
}
|
|
726
|
-
/**
|
|
727
|
-
* Derive the domain from an existing vhost
|
|
728
|
-
* @export
|
|
729
|
-
* @interface AgencyHostingV1SetupsCreateSetupRequestDeriveDomain
|
|
730
|
-
*/
|
|
731
|
-
export interface AgencyHostingV1SetupsCreateSetupRequestDeriveDomain {
|
|
732
|
-
/**
|
|
733
|
-
*
|
|
734
|
-
* @type {AgencyHostingV1SetupsCreateSetupRequestDeriveDomainFromVhost}
|
|
735
|
-
* @memberof AgencyHostingV1SetupsCreateSetupRequestDeriveDomain
|
|
736
|
-
*/
|
|
737
|
-
'from_vhost': AgencyHostingV1SetupsCreateSetupRequestDeriveDomainFromVhost;
|
|
738
|
-
}
|
|
739
|
-
/**
|
|
740
|
-
*
|
|
741
|
-
* @export
|
|
742
|
-
* @interface AgencyHostingV1SetupsCreateSetupRequestDeriveDomainFromVhost
|
|
743
|
-
*/
|
|
744
|
-
export interface AgencyHostingV1SetupsCreateSetupRequestDeriveDomainFromVhost {
|
|
745
|
-
/**
|
|
746
|
-
*
|
|
747
|
-
* @type {string}
|
|
748
|
-
* @memberof AgencyHostingV1SetupsCreateSetupRequestDeriveDomainFromVhost
|
|
749
|
-
*/
|
|
750
|
-
'username': string;
|
|
751
|
-
/**
|
|
752
|
-
*
|
|
753
|
-
* @type {string}
|
|
754
|
-
* @memberof AgencyHostingV1SetupsCreateSetupRequestDeriveDomainFromVhost
|
|
755
|
-
*/
|
|
756
|
-
'vhost': string;
|
|
757
|
-
}
|
|
758
700
|
/**
|
|
759
701
|
* Website settings
|
|
760
702
|
* @export
|
|
@@ -10895,6 +10837,163 @@ export interface ReachV1CampaignsCampaignSummaryStatisticsResource {
|
|
|
10895
10837
|
*/
|
|
10896
10838
|
'click_to_open_rate': number;
|
|
10897
10839
|
}
|
|
10840
|
+
/**
|
|
10841
|
+
* The campaign as it was stored, without targeting or delivery progress
|
|
10842
|
+
* @export
|
|
10843
|
+
* @interface ReachV1CampaignsCreatedCampaignResource
|
|
10844
|
+
*/
|
|
10845
|
+
export interface ReachV1CampaignsCreatedCampaignResource {
|
|
10846
|
+
/**
|
|
10847
|
+
*
|
|
10848
|
+
* @type {string}
|
|
10849
|
+
* @memberof ReachV1CampaignsCreatedCampaignResource
|
|
10850
|
+
*/
|
|
10851
|
+
'uuid': string;
|
|
10852
|
+
/**
|
|
10853
|
+
*
|
|
10854
|
+
* @type {string}
|
|
10855
|
+
* @memberof ReachV1CampaignsCreatedCampaignResource
|
|
10856
|
+
*/
|
|
10857
|
+
'title': string;
|
|
10858
|
+
/**
|
|
10859
|
+
*
|
|
10860
|
+
* @type {string}
|
|
10861
|
+
* @memberof ReachV1CampaignsCreatedCampaignResource
|
|
10862
|
+
*/
|
|
10863
|
+
'subject': string;
|
|
10864
|
+
/**
|
|
10865
|
+
*
|
|
10866
|
+
* @type {string}
|
|
10867
|
+
* @memberof ReachV1CampaignsCreatedCampaignResource
|
|
10868
|
+
*/
|
|
10869
|
+
'sender_name': string;
|
|
10870
|
+
/**
|
|
10871
|
+
*
|
|
10872
|
+
* @type {string}
|
|
10873
|
+
* @memberof ReachV1CampaignsCreatedCampaignResource
|
|
10874
|
+
*/
|
|
10875
|
+
'sender_email': string;
|
|
10876
|
+
/**
|
|
10877
|
+
*
|
|
10878
|
+
* @type {string}
|
|
10879
|
+
* @memberof ReachV1CampaignsCreatedCampaignResource
|
|
10880
|
+
*/
|
|
10881
|
+
'template_uuid': string | null;
|
|
10882
|
+
/**
|
|
10883
|
+
* Always `draft` for a campaign that was just created.
|
|
10884
|
+
* @type {string}
|
|
10885
|
+
* @memberof ReachV1CampaignsCreatedCampaignResource
|
|
10886
|
+
*/
|
|
10887
|
+
'status': ReachV1CampaignsCreatedCampaignResourceStatusEnum;
|
|
10888
|
+
/**
|
|
10889
|
+
*
|
|
10890
|
+
* @type {string}
|
|
10891
|
+
* @memberof ReachV1CampaignsCreatedCampaignResource
|
|
10892
|
+
*/
|
|
10893
|
+
'type': ReachV1CampaignsCreatedCampaignResourceTypeEnum;
|
|
10894
|
+
/**
|
|
10895
|
+
* Whether the campaign targets every contact instead of selected segments.
|
|
10896
|
+
* @type {boolean}
|
|
10897
|
+
* @memberof ReachV1CampaignsCreatedCampaignResource
|
|
10898
|
+
*/
|
|
10899
|
+
'is_all_contacts': boolean;
|
|
10900
|
+
/**
|
|
10901
|
+
* The stored extra fields, including the ones Reach sets itself.
|
|
10902
|
+
* @type {{ [key: string]: string; }}
|
|
10903
|
+
* @memberof ReachV1CampaignsCreatedCampaignResource
|
|
10904
|
+
*/
|
|
10905
|
+
'metadata': {
|
|
10906
|
+
[key: string]: string;
|
|
10907
|
+
};
|
|
10908
|
+
/**
|
|
10909
|
+
*
|
|
10910
|
+
* @type {string}
|
|
10911
|
+
* @memberof ReachV1CampaignsCreatedCampaignResource
|
|
10912
|
+
*/
|
|
10913
|
+
'created_at': string | null;
|
|
10914
|
+
/**
|
|
10915
|
+
*
|
|
10916
|
+
* @type {string}
|
|
10917
|
+
* @memberof ReachV1CampaignsCreatedCampaignResource
|
|
10918
|
+
*/
|
|
10919
|
+
'updated_at': string | null;
|
|
10920
|
+
}
|
|
10921
|
+
export declare const ReachV1CampaignsCreatedCampaignResourceStatusEnum: {
|
|
10922
|
+
readonly Draft: "draft";
|
|
10923
|
+
readonly Scheduled: "scheduled";
|
|
10924
|
+
readonly Sending: "sending";
|
|
10925
|
+
readonly Publish: "publish";
|
|
10926
|
+
readonly Failed: "failed";
|
|
10927
|
+
};
|
|
10928
|
+
export type ReachV1CampaignsCreatedCampaignResourceStatusEnum = typeof ReachV1CampaignsCreatedCampaignResourceStatusEnum[keyof typeof ReachV1CampaignsCreatedCampaignResourceStatusEnum];
|
|
10929
|
+
export declare const ReachV1CampaignsCreatedCampaignResourceTypeEnum: {
|
|
10930
|
+
readonly Campaign: "campaign";
|
|
10931
|
+
readonly Automation: "automation";
|
|
10932
|
+
readonly DoubleOptIn: "double_opt_in";
|
|
10933
|
+
};
|
|
10934
|
+
export type ReachV1CampaignsCreatedCampaignResourceTypeEnum = typeof ReachV1CampaignsCreatedCampaignResourceTypeEnum[keyof typeof ReachV1CampaignsCreatedCampaignResourceTypeEnum];
|
|
10935
|
+
/**
|
|
10936
|
+
* Create a campaign in draft status
|
|
10937
|
+
* @export
|
|
10938
|
+
* @interface ReachV1CampaignsStoreRequest
|
|
10939
|
+
*/
|
|
10940
|
+
export interface ReachV1CampaignsStoreRequest {
|
|
10941
|
+
/**
|
|
10942
|
+
* From name shown to the recipients.
|
|
10943
|
+
* @type {string}
|
|
10944
|
+
* @memberof ReachV1CampaignsStoreRequest
|
|
10945
|
+
*/
|
|
10946
|
+
'sender_name': string;
|
|
10947
|
+
/**
|
|
10948
|
+
* From address of the campaign. Its domain has to be verified on the profile before the campaign can be sent.
|
|
10949
|
+
* @type {string}
|
|
10950
|
+
* @memberof ReachV1CampaignsStoreRequest
|
|
10951
|
+
*/
|
|
10952
|
+
'sender_email': string;
|
|
10953
|
+
/**
|
|
10954
|
+
* Name the campaign is listed under. Not shown to the recipients.
|
|
10955
|
+
* @type {string}
|
|
10956
|
+
* @memberof ReachV1CampaignsStoreRequest
|
|
10957
|
+
*/
|
|
10958
|
+
'title': string;
|
|
10959
|
+
/**
|
|
10960
|
+
* Subject line of the email.
|
|
10961
|
+
* @type {string}
|
|
10962
|
+
* @memberof ReachV1CampaignsStoreRequest
|
|
10963
|
+
*/
|
|
10964
|
+
'subject': string;
|
|
10965
|
+
/**
|
|
10966
|
+
* Template to send, as returned by the template endpoints. Can be left out and attached later, but the campaign cannot be sent without one.
|
|
10967
|
+
* @type {string}
|
|
10968
|
+
* @memberof ReachV1CampaignsStoreRequest
|
|
10969
|
+
*/
|
|
10970
|
+
'template_uuid': string;
|
|
10971
|
+
/**
|
|
10972
|
+
*
|
|
10973
|
+
* @type {ReachV1CampaignsStoreRequestMetadata}
|
|
10974
|
+
* @memberof ReachV1CampaignsStoreRequest
|
|
10975
|
+
*/
|
|
10976
|
+
'metadata': ReachV1CampaignsStoreRequestMetadata | null;
|
|
10977
|
+
}
|
|
10978
|
+
/**
|
|
10979
|
+
* Extra campaign fields. Any key outside the listed ones is rejected.
|
|
10980
|
+
* @export
|
|
10981
|
+
* @interface ReachV1CampaignsStoreRequestMetadata
|
|
10982
|
+
*/
|
|
10983
|
+
export interface ReachV1CampaignsStoreRequestMetadata {
|
|
10984
|
+
/**
|
|
10985
|
+
* Preview text shown after the subject line in the inbox.
|
|
10986
|
+
* @type {string}
|
|
10987
|
+
* @memberof ReachV1CampaignsStoreRequestMetadata
|
|
10988
|
+
*/
|
|
10989
|
+
'preheader': string;
|
|
10990
|
+
/**
|
|
10991
|
+
* Where the campaign was created from.
|
|
10992
|
+
* @type {string}
|
|
10993
|
+
* @memberof ReachV1CampaignsStoreRequestMetadata
|
|
10994
|
+
*/
|
|
10995
|
+
'source': string;
|
|
10996
|
+
}
|
|
10898
10997
|
/**
|
|
10899
10998
|
* Create many contacts in one call
|
|
10900
10999
|
* @export
|
|
@@ -12961,6 +13060,56 @@ export interface ReachV1ProfilesProfileResourceProfilesInner {
|
|
|
12961
13060
|
*/
|
|
12962
13061
|
'updated_at': string;
|
|
12963
13062
|
}
|
|
13063
|
+
/**
|
|
13064
|
+
* Create a reusable email template
|
|
13065
|
+
* @export
|
|
13066
|
+
* @interface ReachV1TemplatesStoreRequest
|
|
13067
|
+
*/
|
|
13068
|
+
export interface ReachV1TemplatesStoreRequest {
|
|
13069
|
+
/**
|
|
13070
|
+
* The email body as HTML. It is sanitised before it is stored, so the saved template can differ from what was sent - inline any styles the email clients need and keep the markup self-contained.
|
|
13071
|
+
* @type {string}
|
|
13072
|
+
* @memberof ReachV1TemplatesStoreRequest
|
|
13073
|
+
*/
|
|
13074
|
+
'template_content': string;
|
|
13075
|
+
/**
|
|
13076
|
+
* Name the template is listed under. Not shown to the recipients.
|
|
13077
|
+
* @type {string}
|
|
13078
|
+
* @memberof ReachV1TemplatesStoreRequest
|
|
13079
|
+
*/
|
|
13080
|
+
'title': string | null;
|
|
13081
|
+
}
|
|
13082
|
+
/**
|
|
13083
|
+
*
|
|
13084
|
+
* @export
|
|
13085
|
+
* @interface ReachV1TemplatesTemplateResource
|
|
13086
|
+
*/
|
|
13087
|
+
export interface ReachV1TemplatesTemplateResource {
|
|
13088
|
+
/**
|
|
13089
|
+
* Pass this as the `template_uuid` of a campaign.
|
|
13090
|
+
* @type {string}
|
|
13091
|
+
* @memberof ReachV1TemplatesTemplateResource
|
|
13092
|
+
*/
|
|
13093
|
+
'uuid': string | null;
|
|
13094
|
+
/**
|
|
13095
|
+
* Null for templates that were never named.
|
|
13096
|
+
* @type {string}
|
|
13097
|
+
* @memberof ReachV1TemplatesTemplateResource
|
|
13098
|
+
*/
|
|
13099
|
+
'title': string | null;
|
|
13100
|
+
/**
|
|
13101
|
+
*
|
|
13102
|
+
* @type {string}
|
|
13103
|
+
* @memberof ReachV1TemplatesTemplateResource
|
|
13104
|
+
*/
|
|
13105
|
+
'created_at': string | null;
|
|
13106
|
+
/**
|
|
13107
|
+
*
|
|
13108
|
+
* @type {string}
|
|
13109
|
+
* @memberof ReachV1TemplatesTemplateResource
|
|
13110
|
+
*/
|
|
13111
|
+
'updated_at': string | null;
|
|
13112
|
+
}
|
|
12964
13113
|
/**
|
|
12965
13114
|
*
|
|
12966
13115
|
* @export
|
|
@@ -25502,6 +25651,15 @@ export type ListAutomationsV1SortDirectionEnum = typeof ListAutomationsV1SortDir
|
|
|
25502
25651
|
* @export
|
|
25503
25652
|
*/
|
|
25504
25653
|
export declare const ReachCampaignsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25654
|
+
/**
|
|
25655
|
+
* Create a campaign in a profile. The campaign is created as a draft, so nothing is sent and no contact is touched. It has no audience yet either - targeting and scheduling are not part of this request, the draft is finished and sent from the Reach interface.
|
|
25656
|
+
* @summary Create a draft campaign
|
|
25657
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25658
|
+
* @param {ReachV1CampaignsStoreRequest} reachV1CampaignsStoreRequest
|
|
25659
|
+
* @param {*} [options] Override http request option.
|
|
25660
|
+
* @throws {RequiredError}
|
|
25661
|
+
*/
|
|
25662
|
+
createADraftCampaignV1: (profileUuid: string, reachV1CampaignsStoreRequest: ReachV1CampaignsStoreRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25505
25663
|
/**
|
|
25506
25664
|
* Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
|
|
25507
25665
|
* @summary Get campaign details
|
|
@@ -25539,6 +25697,15 @@ export declare const ReachCampaignsApiAxiosParamCreator: (configuration?: Config
|
|
|
25539
25697
|
* @export
|
|
25540
25698
|
*/
|
|
25541
25699
|
export declare const ReachCampaignsApiFp: (configuration?: Configuration) => {
|
|
25700
|
+
/**
|
|
25701
|
+
* Create a campaign in a profile. The campaign is created as a draft, so nothing is sent and no contact is touched. It has no audience yet either - targeting and scheduling are not part of this request, the draft is finished and sent from the Reach interface.
|
|
25702
|
+
* @summary Create a draft campaign
|
|
25703
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25704
|
+
* @param {ReachV1CampaignsStoreRequest} reachV1CampaignsStoreRequest
|
|
25705
|
+
* @param {*} [options] Override http request option.
|
|
25706
|
+
* @throws {RequiredError}
|
|
25707
|
+
*/
|
|
25708
|
+
createADraftCampaignV1(profileUuid: string, reachV1CampaignsStoreRequest: ReachV1CampaignsStoreRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1CampaignsCreatedCampaignResource>>;
|
|
25542
25709
|
/**
|
|
25543
25710
|
* Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
|
|
25544
25711
|
* @summary Get campaign details
|
|
@@ -25576,6 +25743,15 @@ export declare const ReachCampaignsApiFp: (configuration?: Configuration) => {
|
|
|
25576
25743
|
* @export
|
|
25577
25744
|
*/
|
|
25578
25745
|
export declare const ReachCampaignsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
25746
|
+
/**
|
|
25747
|
+
* Create a campaign in a profile. The campaign is created as a draft, so nothing is sent and no contact is touched. It has no audience yet either - targeting and scheduling are not part of this request, the draft is finished and sent from the Reach interface.
|
|
25748
|
+
* @summary Create a draft campaign
|
|
25749
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25750
|
+
* @param {ReachV1CampaignsStoreRequest} reachV1CampaignsStoreRequest
|
|
25751
|
+
* @param {*} [options] Override http request option.
|
|
25752
|
+
* @throws {RequiredError}
|
|
25753
|
+
*/
|
|
25754
|
+
createADraftCampaignV1(profileUuid: string, reachV1CampaignsStoreRequest: ReachV1CampaignsStoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1CampaignsCreatedCampaignResource>;
|
|
25579
25755
|
/**
|
|
25580
25756
|
* Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
|
|
25581
25757
|
* @summary Get campaign details
|
|
@@ -25615,6 +25791,16 @@ export declare const ReachCampaignsApiFactory: (configuration?: Configuration, b
|
|
|
25615
25791
|
* @extends {BaseAPI}
|
|
25616
25792
|
*/
|
|
25617
25793
|
export declare class ReachCampaignsApi extends BaseAPI {
|
|
25794
|
+
/**
|
|
25795
|
+
* Create a campaign in a profile. The campaign is created as a draft, so nothing is sent and no contact is touched. It has no audience yet either - targeting and scheduling are not part of this request, the draft is finished and sent from the Reach interface.
|
|
25796
|
+
* @summary Create a draft campaign
|
|
25797
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25798
|
+
* @param {ReachV1CampaignsStoreRequest} reachV1CampaignsStoreRequest
|
|
25799
|
+
* @param {*} [options] Override http request option.
|
|
25800
|
+
* @throws {RequiredError}
|
|
25801
|
+
* @memberof ReachCampaignsApi
|
|
25802
|
+
*/
|
|
25803
|
+
createADraftCampaignV1(profileUuid: string, reachV1CampaignsStoreRequest: ReachV1CampaignsStoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1CampaignsCreatedCampaignResource, any, {}, any>>;
|
|
25618
25804
|
/**
|
|
25619
25805
|
* Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
|
|
25620
25806
|
* @summary Get campaign details
|
|
@@ -27493,6 +27679,102 @@ export declare class ReachTagsApi extends BaseAPI {
|
|
|
27493
27679
|
*/
|
|
27494
27680
|
renameATagV1(profileUuid: string, tagUuid: string, reachV1ContactsTagsUpdateRequest: ReachV1ContactsTagsUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1ContactsTagsTagResource, any, {}, any>>;
|
|
27495
27681
|
}
|
|
27682
|
+
/**
|
|
27683
|
+
* ReachTemplatesApi - axios parameter creator
|
|
27684
|
+
* @export
|
|
27685
|
+
*/
|
|
27686
|
+
export declare const ReachTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
27687
|
+
/**
|
|
27688
|
+
* Create an email template in a profile. The template holds the HTML body a campaign reuses, so it can be created before any campaign exists. Only the template metadata comes back - keep the returned `uuid` to reference it as the `template_uuid` of a campaign.
|
|
27689
|
+
* @summary Create an email template
|
|
27690
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
27691
|
+
* @param {ReachV1TemplatesStoreRequest} reachV1TemplatesStoreRequest
|
|
27692
|
+
* @param {*} [options] Override http request option.
|
|
27693
|
+
* @throws {RequiredError}
|
|
27694
|
+
*/
|
|
27695
|
+
createAnEmailTemplateV1: (profileUuid: string, reachV1TemplatesStoreRequest: ReachV1TemplatesStoreRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27696
|
+
/**
|
|
27697
|
+
* Get a list of the email templates in a profile, most recently updated first. Templates are the reusable email bodies a campaign is built from. The list is not paginated and only the metadata is returned - the template content itself is not exposed. Use the `uuid` of a template as the `template_uuid` when creating a campaign.
|
|
27698
|
+
* @summary List email templates
|
|
27699
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
27700
|
+
* @param {*} [options] Override http request option.
|
|
27701
|
+
* @throws {RequiredError}
|
|
27702
|
+
*/
|
|
27703
|
+
listEmailTemplatesV1: (profileUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27704
|
+
};
|
|
27705
|
+
/**
|
|
27706
|
+
* ReachTemplatesApi - functional programming interface
|
|
27707
|
+
* @export
|
|
27708
|
+
*/
|
|
27709
|
+
export declare const ReachTemplatesApiFp: (configuration?: Configuration) => {
|
|
27710
|
+
/**
|
|
27711
|
+
* Create an email template in a profile. The template holds the HTML body a campaign reuses, so it can be created before any campaign exists. Only the template metadata comes back - keep the returned `uuid` to reference it as the `template_uuid` of a campaign.
|
|
27712
|
+
* @summary Create an email template
|
|
27713
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
27714
|
+
* @param {ReachV1TemplatesStoreRequest} reachV1TemplatesStoreRequest
|
|
27715
|
+
* @param {*} [options] Override http request option.
|
|
27716
|
+
* @throws {RequiredError}
|
|
27717
|
+
*/
|
|
27718
|
+
createAnEmailTemplateV1(profileUuid: string, reachV1TemplatesStoreRequest: ReachV1TemplatesStoreRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1TemplatesTemplateResource>>;
|
|
27719
|
+
/**
|
|
27720
|
+
* Get a list of the email templates in a profile, most recently updated first. Templates are the reusable email bodies a campaign is built from. The list is not paginated and only the metadata is returned - the template content itself is not exposed. Use the `uuid` of a template as the `template_uuid` when creating a campaign.
|
|
27721
|
+
* @summary List email templates
|
|
27722
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
27723
|
+
* @param {*} [options] Override http request option.
|
|
27724
|
+
* @throws {RequiredError}
|
|
27725
|
+
*/
|
|
27726
|
+
listEmailTemplatesV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ReachV1TemplatesTemplateResource>>>;
|
|
27727
|
+
};
|
|
27728
|
+
/**
|
|
27729
|
+
* ReachTemplatesApi - factory interface
|
|
27730
|
+
* @export
|
|
27731
|
+
*/
|
|
27732
|
+
export declare const ReachTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
27733
|
+
/**
|
|
27734
|
+
* Create an email template in a profile. The template holds the HTML body a campaign reuses, so it can be created before any campaign exists. Only the template metadata comes back - keep the returned `uuid` to reference it as the `template_uuid` of a campaign.
|
|
27735
|
+
* @summary Create an email template
|
|
27736
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
27737
|
+
* @param {ReachV1TemplatesStoreRequest} reachV1TemplatesStoreRequest
|
|
27738
|
+
* @param {*} [options] Override http request option.
|
|
27739
|
+
* @throws {RequiredError}
|
|
27740
|
+
*/
|
|
27741
|
+
createAnEmailTemplateV1(profileUuid: string, reachV1TemplatesStoreRequest: ReachV1TemplatesStoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1TemplatesTemplateResource>;
|
|
27742
|
+
/**
|
|
27743
|
+
* Get a list of the email templates in a profile, most recently updated first. Templates are the reusable email bodies a campaign is built from. The list is not paginated and only the metadata is returned - the template content itself is not exposed. Use the `uuid` of a template as the `template_uuid` when creating a campaign.
|
|
27744
|
+
* @summary List email templates
|
|
27745
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
27746
|
+
* @param {*} [options] Override http request option.
|
|
27747
|
+
* @throws {RequiredError}
|
|
27748
|
+
*/
|
|
27749
|
+
listEmailTemplatesV1(profileUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ReachV1TemplatesTemplateResource>>;
|
|
27750
|
+
};
|
|
27751
|
+
/**
|
|
27752
|
+
* ReachTemplatesApi - object-oriented interface
|
|
27753
|
+
* @export
|
|
27754
|
+
* @class ReachTemplatesApi
|
|
27755
|
+
* @extends {BaseAPI}
|
|
27756
|
+
*/
|
|
27757
|
+
export declare class ReachTemplatesApi extends BaseAPI {
|
|
27758
|
+
/**
|
|
27759
|
+
* Create an email template in a profile. The template holds the HTML body a campaign reuses, so it can be created before any campaign exists. Only the template metadata comes back - keep the returned `uuid` to reference it as the `template_uuid` of a campaign.
|
|
27760
|
+
* @summary Create an email template
|
|
27761
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
27762
|
+
* @param {ReachV1TemplatesStoreRequest} reachV1TemplatesStoreRequest
|
|
27763
|
+
* @param {*} [options] Override http request option.
|
|
27764
|
+
* @throws {RequiredError}
|
|
27765
|
+
* @memberof ReachTemplatesApi
|
|
27766
|
+
*/
|
|
27767
|
+
createAnEmailTemplateV1(profileUuid: string, reachV1TemplatesStoreRequest: ReachV1TemplatesStoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1TemplatesTemplateResource, any, {}, any>>;
|
|
27768
|
+
/**
|
|
27769
|
+
* Get a list of the email templates in a profile, most recently updated first. Templates are the reusable email bodies a campaign is built from. The list is not paginated and only the metadata is returned - the template content itself is not exposed. Use the `uuid` of a template as the `template_uuid` when creating a campaign.
|
|
27770
|
+
* @summary List email templates
|
|
27771
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
27772
|
+
* @param {*} [options] Override http request option.
|
|
27773
|
+
* @throws {RequiredError}
|
|
27774
|
+
* @memberof ReachTemplatesApi
|
|
27775
|
+
*/
|
|
27776
|
+
listEmailTemplatesV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1TemplatesTemplateResource[], any, {}, any>>;
|
|
27777
|
+
}
|
|
27496
27778
|
/**
|
|
27497
27779
|
* VPSActionsApi - axios parameter creator
|
|
27498
27780
|
* @export
|