/**
* Constant Contact API v3
* Swagger build version 3.0.2475
*
* The version of the OpenAPI document: 1.0.116
* Contact: webservices@constantcontact.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { RequestArgs, BaseAPI } from '../base';
import { GetContactOpenClickRateReport200Response } from '../models';
import { GetContactTrackingCountReport200Response } from '../models';
import { GetContactTrackingReport200Response } from '../models';
/**
* ContactsReportingApi - axios parameter creator
* @export
*/
export declare const ContactsReportingApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Gets the average open and click rate for a given account and contact.
Looks at all tracking activities for bulk emails from a given contact over the given date range. Range cannot exceed 5 years.
Returns the rates and the number of campaign activities that were included in the calculation.
If no activities fall into the given date range, all rates will return 0 and the number of included activities will be 0.
* @summary GET Average Open and Click Rates
* @param {string} contactId The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
* @param {string} start The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
* @param {string} end The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getContactOpenClickRateReport: (contactId: string, start: string, end: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Get a list of the recent emails (aka, campaign activities) sent to a specific contact and a summary of the actions the contact took on that email for the most recent 200 campaigns.
* @summary GET Contact Action Summary
* @param {string} contactId The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
* @param {string} start The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
* @param {string} end The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getContactTrackingCountReport: (contactId: string, start: string, end: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Gets the tracking activity data for a single contact, sorted in descending activity date order.
You must chose either the `tracking_activities_list` query parameter and or the `tracking_activity_type` query parameter to specify one or more tracking activity types In the request. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
| Valid tracking activity types |
| em_sends | Send activities |
| em_opens | Email open tracking activities |
| em_clicks | Link click-through tracking activities |
| em_bounces | Bounce tracking activities |
| em_optouts | Opt-out tracking activities |
| em_forwards | Forward to a friend tracking activities |
| p_contact_open | Landing page opens |
| p_contact_click | Landing page clicks |
| p_contact_add | Landing page adds |
| p_contact_update | Landing page updates |
* @summary GET Contact Activity Details
* @param {string} contactId The contact\'s ID for which tracking activity data is requested.
* @param {Array} [trackingActivitiesList] Specify one or more tracking activity types to include as a comma-delimited string. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
* @param {Array} [trackingActivityType] Specify one or more tracking activity types to include as an array. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
* @param {boolean} [includeCampaignActivityNames] Default (`true`) returns campaign activity names in the results. Not including campaign activity names in the results (`false`), is more efficient.
* @param {string} [limit] The number of tracking activities to return in a single page. Valid values are 1 to 100. Default is 100.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getContactTrackingReport: (contactId: string, trackingActivitiesList?: Array, trackingActivityType?: Array, includeCampaignActivityNames?: boolean, limit?: string, options?: RawAxiosRequestConfig) => Promise;
};
/**
* ContactsReportingApi - functional programming interface
* @export
*/
export declare const ContactsReportingApiFp: (configuration?: Configuration) => {
/**
* Gets the average open and click rate for a given account and contact.
Looks at all tracking activities for bulk emails from a given contact over the given date range. Range cannot exceed 5 years.
Returns the rates and the number of campaign activities that were included in the calculation.
If no activities fall into the given date range, all rates will return 0 and the number of included activities will be 0.
* @summary GET Average Open and Click Rates
* @param {string} contactId The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
* @param {string} start The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
* @param {string} end The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getContactOpenClickRateReport(contactId: string, start: string, end: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get a list of the recent emails (aka, campaign activities) sent to a specific contact and a summary of the actions the contact took on that email for the most recent 200 campaigns.
* @summary GET Contact Action Summary
* @param {string} contactId The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
* @param {string} start The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
* @param {string} end The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getContactTrackingCountReport(contactId: string, start: string, end: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Gets the tracking activity data for a single contact, sorted in descending activity date order.
You must chose either the `tracking_activities_list` query parameter and or the `tracking_activity_type` query parameter to specify one or more tracking activity types In the request. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
| Valid tracking activity types |
| em_sends | Send activities |
| em_opens | Email open tracking activities |
| em_clicks | Link click-through tracking activities |
| em_bounces | Bounce tracking activities |
| em_optouts | Opt-out tracking activities |
| em_forwards | Forward to a friend tracking activities |
| p_contact_open | Landing page opens |
| p_contact_click | Landing page clicks |
| p_contact_add | Landing page adds |
| p_contact_update | Landing page updates |
* @summary GET Contact Activity Details
* @param {string} contactId The contact\'s ID for which tracking activity data is requested.
* @param {Array} [trackingActivitiesList] Specify one or more tracking activity types to include as a comma-delimited string. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
* @param {Array} [trackingActivityType] Specify one or more tracking activity types to include as an array. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
* @param {boolean} [includeCampaignActivityNames] Default (`true`) returns campaign activity names in the results. Not including campaign activity names in the results (`false`), is more efficient.
* @param {string} [limit] The number of tracking activities to return in a single page. Valid values are 1 to 100. Default is 100.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getContactTrackingReport(contactId: string, trackingActivitiesList?: Array, trackingActivityType?: Array, includeCampaignActivityNames?: boolean, limit?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* ContactsReportingApi - factory interface
* @export
*/
export declare const ContactsReportingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Gets the average open and click rate for a given account and contact.
Looks at all tracking activities for bulk emails from a given contact over the given date range. Range cannot exceed 5 years.
Returns the rates and the number of campaign activities that were included in the calculation.
If no activities fall into the given date range, all rates will return 0 and the number of included activities will be 0.
* @summary GET Average Open and Click Rates
* @param {string} contactId The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
* @param {string} start The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
* @param {string} end The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getContactOpenClickRateReport(contactId: string, start: string, end: string, options?: any): AxiosPromise;
/**
* Get a list of the recent emails (aka, campaign activities) sent to a specific contact and a summary of the actions the contact took on that email for the most recent 200 campaigns.
* @summary GET Contact Action Summary
* @param {string} contactId The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
* @param {string} start The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
* @param {string} end The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getContactTrackingCountReport(contactId: string, start: string, end: string, options?: any): AxiosPromise;
/**
* Gets the tracking activity data for a single contact, sorted in descending activity date order.
You must chose either the `tracking_activities_list` query parameter and or the `tracking_activity_type` query parameter to specify one or more tracking activity types In the request. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
| Valid tracking activity types |
| em_sends | Send activities |
| em_opens | Email open tracking activities |
| em_clicks | Link click-through tracking activities |
| em_bounces | Bounce tracking activities |
| em_optouts | Opt-out tracking activities |
| em_forwards | Forward to a friend tracking activities |
| p_contact_open | Landing page opens |
| p_contact_click | Landing page clicks |
| p_contact_add | Landing page adds |
| p_contact_update | Landing page updates |
* @summary GET Contact Activity Details
* @param {string} contactId The contact\'s ID for which tracking activity data is requested.
* @param {Array} [trackingActivitiesList] Specify one or more tracking activity types to include as a comma-delimited string. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
* @param {Array} [trackingActivityType] Specify one or more tracking activity types to include as an array. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
* @param {boolean} [includeCampaignActivityNames] Default (`true`) returns campaign activity names in the results. Not including campaign activity names in the results (`false`), is more efficient.
* @param {string} [limit] The number of tracking activities to return in a single page. Valid values are 1 to 100. Default is 100.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getContactTrackingReport(contactId: string, trackingActivitiesList?: Array, trackingActivityType?: Array, includeCampaignActivityNames?: boolean, limit?: string, options?: any): AxiosPromise;
};
/**
* ContactsReportingApi - object-oriented interface
* @export
* @class ContactsReportingApi
* @extends {BaseAPI}
*/
export declare class ContactsReportingApi extends BaseAPI {
/**
* Gets the average open and click rate for a given account and contact.
Looks at all tracking activities for bulk emails from a given contact over the given date range. Range cannot exceed 5 years.
Returns the rates and the number of campaign activities that were included in the calculation.
If no activities fall into the given date range, all rates will return 0 and the number of included activities will be 0.
* @summary GET Average Open and Click Rates
* @param {string} contactId The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
* @param {string} start The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
* @param {string} end The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ContactsReportingApi
*/
getContactOpenClickRateReport(contactId: string, start: string, end: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Get a list of the recent emails (aka, campaign activities) sent to a specific contact and a summary of the actions the contact took on that email for the most recent 200 campaigns.
* @summary GET Contact Action Summary
* @param {string} contactId The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
* @param {string} start The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
* @param {string} end The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ContactsReportingApi
*/
getContactTrackingCountReport(contactId: string, start: string, end: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Gets the tracking activity data for a single contact, sorted in descending activity date order.
You must chose either the `tracking_activities_list` query parameter and or the `tracking_activity_type` query parameter to specify one or more tracking activity types In the request. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
| Valid tracking activity types |
| em_sends | Send activities |
| em_opens | Email open tracking activities |
| em_clicks | Link click-through tracking activities |
| em_bounces | Bounce tracking activities |
| em_optouts | Opt-out tracking activities |
| em_forwards | Forward to a friend tracking activities |
| p_contact_open | Landing page opens |
| p_contact_click | Landing page clicks |
| p_contact_add | Landing page adds |
| p_contact_update | Landing page updates |
* @summary GET Contact Activity Details
* @param {string} contactId The contact\'s ID for which tracking activity data is requested.
* @param {Array} [trackingActivitiesList] Specify one or more tracking activity types to include as a comma-delimited string. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
* @param {Array} [trackingActivityType] Specify one or more tracking activity types to include as an array. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
* @param {boolean} [includeCampaignActivityNames] Default (`true`) returns campaign activity names in the results. Not including campaign activity names in the results (`false`), is more efficient.
* @param {string} [limit] The number of tracking activities to return in a single page. Valid values are 1 to 100. Default is 100.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ContactsReportingApi
*/
getContactTrackingReport(contactId: string, trackingActivitiesList?: Array, trackingActivityType?: Array, includeCampaignActivityNames?: boolean, limit?: string, options?: RawAxiosRequestConfig): Promise>;
}
/**
* @export
*/
export declare const GetContactTrackingReportTrackingActivitiesListEnum: {
readonly EmSends: "em_sends";
readonly EmOpens: "em_opens";
readonly EmClicks: "em_clicks";
readonly EmBounces: "em_bounces";
readonly EmOptouts: "em_optouts";
readonly EmForwards: "em_forwards";
readonly PContactOpen: "p_contact_open";
readonly PContactClick: "p_contact_click";
readonly PContactAdd: "p_contact_add";
readonly PContactUpdate: "p_contact_update";
};
export type GetContactTrackingReportTrackingActivitiesListEnum = typeof GetContactTrackingReportTrackingActivitiesListEnum[keyof typeof GetContactTrackingReportTrackingActivitiesListEnum];