hostinger-api-sdk 1.31.0 → 1.32.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/dist/esm/api.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Hostinger API
3
3
  *
4
- * API Version: 1.33.0
4
+ * API Version: 1.34.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
@@ -7633,6 +7633,25 @@ export interface ReachListAutomationsV1200Response {
7633
7633
  */
7634
7634
  'meta': CommonSchemaPaginationMetaSchema;
7635
7635
  }
7636
+ /**
7637
+ *
7638
+ * @export
7639
+ * @interface ReachListCampaignsV1200Response
7640
+ */
7641
+ export interface ReachListCampaignsV1200Response {
7642
+ /**
7643
+ * Array of [`Reach.V1.Campaigns.CampaignResource`](#model/reachv1campaignscampaignresource)
7644
+ * @type {Array<ReachV1CampaignsCampaignResource>}
7645
+ * @memberof ReachListCampaignsV1200Response
7646
+ */
7647
+ 'data': Array<ReachV1CampaignsCampaignResource>;
7648
+ /**
7649
+ *
7650
+ * @type {CommonSchemaPaginationMetaSchema}
7651
+ * @memberof ReachListCampaignsV1200Response
7652
+ */
7653
+ 'meta': CommonSchemaPaginationMetaSchema;
7654
+ }
7636
7655
  /**
7637
7656
  *
7638
7657
  * @export
@@ -7877,6 +7896,381 @@ export declare const ReachV1AutomationsStepsAutomationStepResourceValueEnum: {
7877
7896
  readonly Delay: "delay";
7878
7897
  };
7879
7898
  export type ReachV1AutomationsStepsAutomationStepResourceValueEnum = typeof ReachV1AutomationsStepsAutomationStepResourceValueEnum[keyof typeof ReachV1AutomationsStepsAutomationStepResourceValueEnum];
7899
+ /**
7900
+ * Delivery progress. While the campaign is `sending`, `total_sent` climbs towards the estimate.
7901
+ * @export
7902
+ * @interface ReachV1CampaignsCampaignDeliveryResource
7903
+ */
7904
+ export interface ReachV1CampaignsCampaignDeliveryResource {
7905
+ /**
7906
+ * Emails sent so far.
7907
+ * @type {number}
7908
+ * @memberof ReachV1CampaignsCampaignDeliveryResource
7909
+ */
7910
+ 'total_sent': number;
7911
+ /**
7912
+ * Recipients this campaign was estimated to reach when sending started. Null for campaigns that have not started sending.
7913
+ * @type {number}
7914
+ * @memberof ReachV1CampaignsCampaignDeliveryResource
7915
+ */
7916
+ 'estimated_total_recipients': number | null;
7917
+ /**
7918
+ * Contacts currently targeted by this campaign.
7919
+ * @type {number}
7920
+ * @memberof ReachV1CampaignsCampaignDeliveryResource
7921
+ */
7922
+ 'subscribers_count': number;
7923
+ }
7924
+ /**
7925
+ *
7926
+ * @export
7927
+ * @interface ReachV1CampaignsCampaignDetailsResource
7928
+ */
7929
+ export interface ReachV1CampaignsCampaignDetailsResource {
7930
+ /**
7931
+ *
7932
+ * @type {string}
7933
+ * @memberof ReachV1CampaignsCampaignDetailsResource
7934
+ */
7935
+ 'uuid': string;
7936
+ /**
7937
+ *
7938
+ * @type {string}
7939
+ * @memberof ReachV1CampaignsCampaignDetailsResource
7940
+ */
7941
+ 'title': string;
7942
+ /**
7943
+ *
7944
+ * @type {string}
7945
+ * @memberof ReachV1CampaignsCampaignDetailsResource
7946
+ */
7947
+ 'subject': string;
7948
+ /**
7949
+ *
7950
+ * @type {string}
7951
+ * @memberof ReachV1CampaignsCampaignDetailsResource
7952
+ */
7953
+ 'sender_name': string;
7954
+ /**
7955
+ *
7956
+ * @type {string}
7957
+ * @memberof ReachV1CampaignsCampaignDetailsResource
7958
+ */
7959
+ 'sender_email': string;
7960
+ /**
7961
+ * The email template this campaign uses. The template title is not exposed.
7962
+ * @type {string}
7963
+ * @memberof ReachV1CampaignsCampaignDetailsResource
7964
+ */
7965
+ 'template_uuid': string | null;
7966
+ /**
7967
+ * A fully sent campaign is `publish`. There is no `sent`, `paused` or `archived` status.
7968
+ * @type {string}
7969
+ * @memberof ReachV1CampaignsCampaignDetailsResource
7970
+ */
7971
+ 'status': ReachV1CampaignsCampaignDetailsResourceStatusEnum;
7972
+ /**
7973
+ *
7974
+ * @type {string}
7975
+ * @memberof ReachV1CampaignsCampaignDetailsResource
7976
+ */
7977
+ 'type': ReachV1CampaignsCampaignDetailsResourceTypeEnum;
7978
+ /**
7979
+ * Set only while the status is `failed`.
7980
+ * @type {string}
7981
+ * @memberof ReachV1CampaignsCampaignDetailsResource
7982
+ */
7983
+ 'failure_reason': string | null;
7984
+ /**
7985
+ * Whether delivery time is picked per contact rather than sent to everyone at once.
7986
+ * @type {boolean}
7987
+ * @memberof ReachV1CampaignsCampaignDetailsResource
7988
+ */
7989
+ 'is_smart_send': boolean;
7990
+ /**
7991
+ * Whether the campaign targets every contact instead of the listed segments.
7992
+ * @type {boolean}
7993
+ * @memberof ReachV1CampaignsCampaignDetailsResource
7994
+ */
7995
+ 'is_all_contacts': boolean;
7996
+ /**
7997
+ *
7998
+ * @type {ReachV1CampaignsCampaignDeliveryResource}
7999
+ * @memberof ReachV1CampaignsCampaignDetailsResource
8000
+ */
8001
+ 'delivery': ReachV1CampaignsCampaignDeliveryResource;
8002
+ /**
8003
+ * Segments this campaign targets. Empty when it targets all contacts.
8004
+ * @type {Array<string>}
8005
+ * @memberof ReachV1CampaignsCampaignDetailsResource
8006
+ */
8007
+ 'segment_uuids': Array<string>;
8008
+ /**
8009
+ *
8010
+ * @type {string}
8011
+ * @memberof ReachV1CampaignsCampaignDetailsResource
8012
+ */
8013
+ 'created_at': string;
8014
+ /**
8015
+ *
8016
+ * @type {string}
8017
+ * @memberof ReachV1CampaignsCampaignDetailsResource
8018
+ */
8019
+ 'updated_at': string | null;
8020
+ /**
8021
+ *
8022
+ * @type {string}
8023
+ * @memberof ReachV1CampaignsCampaignDetailsResource
8024
+ */
8025
+ 'sent_at': string | null;
8026
+ /**
8027
+ *
8028
+ * @type {string}
8029
+ * @memberof ReachV1CampaignsCampaignDetailsResource
8030
+ */
8031
+ 'scheduled_at': string | null;
8032
+ }
8033
+ export declare const ReachV1CampaignsCampaignDetailsResourceStatusEnum: {
8034
+ readonly Draft: "draft";
8035
+ readonly Scheduled: "scheduled";
8036
+ readonly Sending: "sending";
8037
+ readonly Publish: "publish";
8038
+ readonly Failed: "failed";
8039
+ };
8040
+ export type ReachV1CampaignsCampaignDetailsResourceStatusEnum = typeof ReachV1CampaignsCampaignDetailsResourceStatusEnum[keyof typeof ReachV1CampaignsCampaignDetailsResourceStatusEnum];
8041
+ export declare const ReachV1CampaignsCampaignDetailsResourceTypeEnum: {
8042
+ readonly Campaign: "campaign";
8043
+ readonly Automation: "automation";
8044
+ readonly DoubleOptIn: "double_opt_in";
8045
+ };
8046
+ export type ReachV1CampaignsCampaignDetailsResourceTypeEnum = typeof ReachV1CampaignsCampaignDetailsResourceTypeEnum[keyof typeof ReachV1CampaignsCampaignDetailsResourceTypeEnum];
8047
+ /**
8048
+ *
8049
+ * @export
8050
+ * @interface ReachV1CampaignsCampaignResource
8051
+ */
8052
+ export interface ReachV1CampaignsCampaignResource {
8053
+ /**
8054
+ *
8055
+ * @type {string}
8056
+ * @memberof ReachV1CampaignsCampaignResource
8057
+ */
8058
+ 'uuid': string;
8059
+ /**
8060
+ *
8061
+ * @type {string}
8062
+ * @memberof ReachV1CampaignsCampaignResource
8063
+ */
8064
+ 'title': string;
8065
+ /**
8066
+ *
8067
+ * @type {string}
8068
+ * @memberof ReachV1CampaignsCampaignResource
8069
+ */
8070
+ 'subject': string;
8071
+ /**
8072
+ *
8073
+ * @type {string}
8074
+ * @memberof ReachV1CampaignsCampaignResource
8075
+ */
8076
+ 'sender_name': string;
8077
+ /**
8078
+ *
8079
+ * @type {string}
8080
+ * @memberof ReachV1CampaignsCampaignResource
8081
+ */
8082
+ 'sender_email': string;
8083
+ /**
8084
+ * The email template this campaign uses. The template title is not exposed.
8085
+ * @type {string}
8086
+ * @memberof ReachV1CampaignsCampaignResource
8087
+ */
8088
+ 'template_uuid': string | null;
8089
+ /**
8090
+ * A fully sent campaign is `publish`. There is no `sent`, `paused` or `archived` status.
8091
+ * @type {string}
8092
+ * @memberof ReachV1CampaignsCampaignResource
8093
+ */
8094
+ 'status': ReachV1CampaignsCampaignResourceStatusEnum;
8095
+ /**
8096
+ *
8097
+ * @type {string}
8098
+ * @memberof ReachV1CampaignsCampaignResource
8099
+ */
8100
+ 'type': ReachV1CampaignsCampaignResourceTypeEnum;
8101
+ /**
8102
+ *
8103
+ * @type {string}
8104
+ * @memberof ReachV1CampaignsCampaignResource
8105
+ */
8106
+ 'created_at': string;
8107
+ /**
8108
+ *
8109
+ * @type {string}
8110
+ * @memberof ReachV1CampaignsCampaignResource
8111
+ */
8112
+ 'updated_at': string | null;
8113
+ /**
8114
+ *
8115
+ * @type {string}
8116
+ * @memberof ReachV1CampaignsCampaignResource
8117
+ */
8118
+ 'sent_at': string | null;
8119
+ /**
8120
+ *
8121
+ * @type {string}
8122
+ * @memberof ReachV1CampaignsCampaignResource
8123
+ */
8124
+ 'scheduled_at': string | null;
8125
+ /**
8126
+ *
8127
+ * @type {ReachV1CampaignsCampaignSummaryStatisticsResource}
8128
+ * @memberof ReachV1CampaignsCampaignResource
8129
+ */
8130
+ 'statistics': ReachV1CampaignsCampaignSummaryStatisticsResource;
8131
+ }
8132
+ export declare const ReachV1CampaignsCampaignResourceStatusEnum: {
8133
+ readonly Draft: "draft";
8134
+ readonly Scheduled: "scheduled";
8135
+ readonly Sending: "sending";
8136
+ readonly Publish: "publish";
8137
+ readonly Failed: "failed";
8138
+ };
8139
+ export type ReachV1CampaignsCampaignResourceStatusEnum = typeof ReachV1CampaignsCampaignResourceStatusEnum[keyof typeof ReachV1CampaignsCampaignResourceStatusEnum];
8140
+ export declare const ReachV1CampaignsCampaignResourceTypeEnum: {
8141
+ readonly Campaign: "campaign";
8142
+ readonly Automation: "automation";
8143
+ readonly DoubleOptIn: "double_opt_in";
8144
+ };
8145
+ export type ReachV1CampaignsCampaignResourceTypeEnum = typeof ReachV1CampaignsCampaignResourceTypeEnum[keyof typeof ReachV1CampaignsCampaignResourceTypeEnum];
8146
+ /**
8147
+ * Campaign performance. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
8148
+ * @export
8149
+ * @interface ReachV1CampaignsCampaignStatisticsResource
8150
+ */
8151
+ export interface ReachV1CampaignsCampaignStatisticsResource {
8152
+ /**
8153
+ * Emails sent for this campaign, and the denominator of every rate below.
8154
+ * @type {number}
8155
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8156
+ */
8157
+ 'total_sent': number;
8158
+ /**
8159
+ * Recipients this campaign was estimated to reach when sending started. Null for campaigns that have not started sending.
8160
+ * @type {number}
8161
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8162
+ */
8163
+ 'estimated_total_recipients': number | null;
8164
+ /**
8165
+ *
8166
+ * @type {number}
8167
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8168
+ */
8169
+ 'processed_count': number;
8170
+ /**
8171
+ *
8172
+ * @type {number}
8173
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8174
+ */
8175
+ 'delivered_count': number;
8176
+ /**
8177
+ *
8178
+ * @type {number}
8179
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8180
+ */
8181
+ 'dropped_count': number;
8182
+ /**
8183
+ *
8184
+ * @type {number}
8185
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8186
+ */
8187
+ 'bounced_count': number;
8188
+ /**
8189
+ *
8190
+ * @type {number}
8191
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8192
+ */
8193
+ 'soft_bounced_count': number;
8194
+ /**
8195
+ * Contacts who opened this campaign.
8196
+ * @type {number}
8197
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8198
+ */
8199
+ 'opened_count': number;
8200
+ /**
8201
+ * Contacts who clicked a link. Only clicks from contacts who also registered an open count.
8202
+ * @type {number}
8203
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8204
+ */
8205
+ 'clicked_count': number;
8206
+ /**
8207
+ * Contacts who unsubscribed through this campaign.
8208
+ * @type {number}
8209
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8210
+ */
8211
+ 'unsubscribed_count': number;
8212
+ /**
8213
+ * Percentage of sent emails that were opened.
8214
+ * @type {number}
8215
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8216
+ */
8217
+ 'open_rate': number;
8218
+ /**
8219
+ * Percentage of sent emails that got a click.
8220
+ * @type {number}
8221
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8222
+ */
8223
+ 'click_rate': number;
8224
+ /**
8225
+ * Percentage of the contacts who opened that went on to click.
8226
+ * @type {number}
8227
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8228
+ */
8229
+ 'click_to_open_rate': number;
8230
+ /**
8231
+ * Percentage of sent emails that led to an unsubscribe.
8232
+ * @type {number}
8233
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8234
+ */
8235
+ 'unsubscribe_rate': number;
8236
+ /**
8237
+ *
8238
+ * @type {boolean}
8239
+ * @memberof ReachV1CampaignsCampaignStatisticsResource
8240
+ */
8241
+ 'has_bounced_contacts': boolean;
8242
+ }
8243
+ /**
8244
+ * Headline engagement rates. The statistics endpoint carries the full breakdown.
8245
+ * @export
8246
+ * @interface ReachV1CampaignsCampaignSummaryStatisticsResource
8247
+ */
8248
+ export interface ReachV1CampaignsCampaignSummaryStatisticsResource {
8249
+ /**
8250
+ * Emails sent for this campaign, and the denominator of the rates below.
8251
+ * @type {number}
8252
+ * @memberof ReachV1CampaignsCampaignSummaryStatisticsResource
8253
+ */
8254
+ 'total_sent': number;
8255
+ /**
8256
+ * Percentage of sent emails that were opened.
8257
+ * @type {number}
8258
+ * @memberof ReachV1CampaignsCampaignSummaryStatisticsResource
8259
+ */
8260
+ 'open_rate': number;
8261
+ /**
8262
+ * Percentage of sent emails that got a click.
8263
+ * @type {number}
8264
+ * @memberof ReachV1CampaignsCampaignSummaryStatisticsResource
8265
+ */
8266
+ 'click_rate': number;
8267
+ /**
8268
+ * Percentage of the contacts who opened that went on to click.
8269
+ * @type {number}
8270
+ * @memberof ReachV1CampaignsCampaignSummaryStatisticsResource
8271
+ */
8272
+ 'click_to_open_rate': number;
8273
+ }
7880
8274
  /**
7881
8275
  * Create many contacts in one call
7882
8276
  * @export
@@ -20119,6 +20513,187 @@ export declare const ListAutomationsV1SortDirectionEnum: {
20119
20513
  readonly Desc: "desc";
20120
20514
  };
20121
20515
  export type ListAutomationsV1SortDirectionEnum = typeof ListAutomationsV1SortDirectionEnum[keyof typeof ListAutomationsV1SortDirectionEnum];
20516
+ /**
20517
+ * ReachCampaignsApi - axios parameter creator
20518
+ * @export
20519
+ */
20520
+ export declare const ReachCampaignsApiAxiosParamCreator: (configuration?: Configuration) => {
20521
+ /**
20522
+ * 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.
20523
+ * @summary Get campaign details
20524
+ * @param {string} profileUuid Profile uuid parameter
20525
+ * @param {string} campaignUuid Campaign uuid parameter
20526
+ * @param {*} [options] Override http request option.
20527
+ * @throws {RequiredError}
20528
+ */
20529
+ getCampaignDetailsV1: (profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20530
+ /**
20531
+ * Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
20532
+ * @summary Get campaign performance
20533
+ * @param {string} profileUuid Profile uuid parameter
20534
+ * @param {string} campaignUuid Campaign uuid parameter
20535
+ * @param {*} [options] Override http request option.
20536
+ * @throws {RequiredError}
20537
+ */
20538
+ getCampaignPerformanceV1: (profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20539
+ /**
20540
+ * Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
20541
+ * @summary List campaigns
20542
+ * @param {string} profileUuid Profile uuid parameter
20543
+ * @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status &#x60;publish&#x60;. There is no &#x60;sent&#x60; status, and campaigns can be neither paused nor archived.
20544
+ * @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to &#x60;campaign&#x60;, which leaves out the emails sent by automations and the double opt-in confirmations.
20545
+ * @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to &#x60;asc&#x60;.
20546
+ * @param {number} [page] Page number
20547
+ * @param {number} [perPage] Number of items per page
20548
+ * @param {*} [options] Override http request option.
20549
+ * @throws {RequiredError}
20550
+ */
20551
+ listCampaignsV1: (profileUuid: string, status?: ListCampaignsV1StatusEnum, type?: ListCampaignsV1TypeEnum, sortDirection?: ListCampaignsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20552
+ };
20553
+ /**
20554
+ * ReachCampaignsApi - functional programming interface
20555
+ * @export
20556
+ */
20557
+ export declare const ReachCampaignsApiFp: (configuration?: Configuration) => {
20558
+ /**
20559
+ * 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.
20560
+ * @summary Get campaign details
20561
+ * @param {string} profileUuid Profile uuid parameter
20562
+ * @param {string} campaignUuid Campaign uuid parameter
20563
+ * @param {*} [options] Override http request option.
20564
+ * @throws {RequiredError}
20565
+ */
20566
+ getCampaignDetailsV1(profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1CampaignsCampaignDetailsResource>>;
20567
+ /**
20568
+ * Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
20569
+ * @summary Get campaign performance
20570
+ * @param {string} profileUuid Profile uuid parameter
20571
+ * @param {string} campaignUuid Campaign uuid parameter
20572
+ * @param {*} [options] Override http request option.
20573
+ * @throws {RequiredError}
20574
+ */
20575
+ getCampaignPerformanceV1(profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1CampaignsCampaignStatisticsResource>>;
20576
+ /**
20577
+ * Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
20578
+ * @summary List campaigns
20579
+ * @param {string} profileUuid Profile uuid parameter
20580
+ * @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status &#x60;publish&#x60;. There is no &#x60;sent&#x60; status, and campaigns can be neither paused nor archived.
20581
+ * @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to &#x60;campaign&#x60;, which leaves out the emails sent by automations and the double opt-in confirmations.
20582
+ * @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to &#x60;asc&#x60;.
20583
+ * @param {number} [page] Page number
20584
+ * @param {number} [perPage] Number of items per page
20585
+ * @param {*} [options] Override http request option.
20586
+ * @throws {RequiredError}
20587
+ */
20588
+ listCampaignsV1(profileUuid: string, status?: ListCampaignsV1StatusEnum, type?: ListCampaignsV1TypeEnum, sortDirection?: ListCampaignsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachListCampaignsV1200Response>>;
20589
+ };
20590
+ /**
20591
+ * ReachCampaignsApi - factory interface
20592
+ * @export
20593
+ */
20594
+ export declare const ReachCampaignsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
20595
+ /**
20596
+ * 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.
20597
+ * @summary Get campaign details
20598
+ * @param {string} profileUuid Profile uuid parameter
20599
+ * @param {string} campaignUuid Campaign uuid parameter
20600
+ * @param {*} [options] Override http request option.
20601
+ * @throws {RequiredError}
20602
+ */
20603
+ getCampaignDetailsV1(profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1CampaignsCampaignDetailsResource>;
20604
+ /**
20605
+ * Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
20606
+ * @summary Get campaign performance
20607
+ * @param {string} profileUuid Profile uuid parameter
20608
+ * @param {string} campaignUuid Campaign uuid parameter
20609
+ * @param {*} [options] Override http request option.
20610
+ * @throws {RequiredError}
20611
+ */
20612
+ getCampaignPerformanceV1(profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1CampaignsCampaignStatisticsResource>;
20613
+ /**
20614
+ * Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
20615
+ * @summary List campaigns
20616
+ * @param {string} profileUuid Profile uuid parameter
20617
+ * @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status &#x60;publish&#x60;. There is no &#x60;sent&#x60; status, and campaigns can be neither paused nor archived.
20618
+ * @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to &#x60;campaign&#x60;, which leaves out the emails sent by automations and the double opt-in confirmations.
20619
+ * @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to &#x60;asc&#x60;.
20620
+ * @param {number} [page] Page number
20621
+ * @param {number} [perPage] Number of items per page
20622
+ * @param {*} [options] Override http request option.
20623
+ * @throws {RequiredError}
20624
+ */
20625
+ listCampaignsV1(profileUuid: string, status?: ListCampaignsV1StatusEnum, type?: ListCampaignsV1TypeEnum, sortDirection?: ListCampaignsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<ReachListCampaignsV1200Response>;
20626
+ };
20627
+ /**
20628
+ * ReachCampaignsApi - object-oriented interface
20629
+ * @export
20630
+ * @class ReachCampaignsApi
20631
+ * @extends {BaseAPI}
20632
+ */
20633
+ export declare class ReachCampaignsApi extends BaseAPI {
20634
+ /**
20635
+ * 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.
20636
+ * @summary Get campaign details
20637
+ * @param {string} profileUuid Profile uuid parameter
20638
+ * @param {string} campaignUuid Campaign uuid parameter
20639
+ * @param {*} [options] Override http request option.
20640
+ * @throws {RequiredError}
20641
+ * @memberof ReachCampaignsApi
20642
+ */
20643
+ getCampaignDetailsV1(profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1CampaignsCampaignDetailsResource, any, {}, any>>;
20644
+ /**
20645
+ * Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
20646
+ * @summary Get campaign performance
20647
+ * @param {string} profileUuid Profile uuid parameter
20648
+ * @param {string} campaignUuid Campaign uuid parameter
20649
+ * @param {*} [options] Override http request option.
20650
+ * @throws {RequiredError}
20651
+ * @memberof ReachCampaignsApi
20652
+ */
20653
+ getCampaignPerformanceV1(profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1CampaignsCampaignStatisticsResource, any, {}, any>>;
20654
+ /**
20655
+ * Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
20656
+ * @summary List campaigns
20657
+ * @param {string} profileUuid Profile uuid parameter
20658
+ * @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status &#x60;publish&#x60;. There is no &#x60;sent&#x60; status, and campaigns can be neither paused nor archived.
20659
+ * @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to &#x60;campaign&#x60;, which leaves out the emails sent by automations and the double opt-in confirmations.
20660
+ * @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to &#x60;asc&#x60;.
20661
+ * @param {number} [page] Page number
20662
+ * @param {number} [perPage] Number of items per page
20663
+ * @param {*} [options] Override http request option.
20664
+ * @throws {RequiredError}
20665
+ * @memberof ReachCampaignsApi
20666
+ */
20667
+ listCampaignsV1(profileUuid: string, status?: ListCampaignsV1StatusEnum, type?: ListCampaignsV1TypeEnum, sortDirection?: ListCampaignsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachListCampaignsV1200Response, any, {}, any>>;
20668
+ }
20669
+ /**
20670
+ * @export
20671
+ */
20672
+ export declare const ListCampaignsV1StatusEnum: {
20673
+ readonly Draft: "draft";
20674
+ readonly Scheduled: "scheduled";
20675
+ readonly Sending: "sending";
20676
+ readonly Publish: "publish";
20677
+ readonly Failed: "failed";
20678
+ };
20679
+ export type ListCampaignsV1StatusEnum = typeof ListCampaignsV1StatusEnum[keyof typeof ListCampaignsV1StatusEnum];
20680
+ /**
20681
+ * @export
20682
+ */
20683
+ export declare const ListCampaignsV1TypeEnum: {
20684
+ readonly Campaign: "campaign";
20685
+ readonly Automation: "automation";
20686
+ readonly DoubleOptIn: "double_opt_in";
20687
+ };
20688
+ export type ListCampaignsV1TypeEnum = typeof ListCampaignsV1TypeEnum[keyof typeof ListCampaignsV1TypeEnum];
20689
+ /**
20690
+ * @export
20691
+ */
20692
+ export declare const ListCampaignsV1SortDirectionEnum: {
20693
+ readonly Asc: "asc";
20694
+ readonly Desc: "desc";
20695
+ };
20696
+ export type ListCampaignsV1SortDirectionEnum = typeof ListCampaignsV1SortDirectionEnum[keyof typeof ListCampaignsV1SortDirectionEnum];
20122
20697
  /**
20123
20698
  * ReachContactFieldsApi - axios parameter creator
20124
20699
  * @export