hostinger-api-sdk 1.31.0 → 1.33.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 +1440 -52
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +1045 -15
- package/dist/api.js +710 -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 +1045 -15
- package/dist/esm/api.js +693 -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/ReachCampaignsApi.md +190 -0
- package/docs/ReachFormsApi.md +182 -0
- package/docs/ReachListCampaignsV1200Response.md +22 -0
- package/docs/ReachListFormsV1200Response.md +22 -0
- package/docs/ReachProfilesApi.md +54 -0
- package/docs/ReachV1CampaignsCampaignDeliveryResource.md +25 -0
- package/docs/ReachV1CampaignsCampaignDetailsResource.md +52 -0
- package/docs/ReachV1CampaignsCampaignResource.md +44 -0
- package/docs/ReachV1CampaignsCampaignStatisticsResource.md +49 -0
- package/docs/ReachV1CampaignsCampaignSummaryStatisticsResource.md +27 -0
- package/docs/ReachV1FormsFormDetailsResource.md +34 -0
- package/docs/ReachV1FormsFormResource.md +32 -0
- package/docs/ReachV1FormsFormTagResource.md +25 -0
- package/docs/ReachV1FormsFormTemplateDetailsResource.md +25 -0
- package/docs/ReachV1FormsFormTemplateResource.md +23 -0
- package/docs/ReachV1ProfilesPlanLimitUsageResource.md +25 -0
- package/docs/ReachV1ProfilesPlanLimitsResource.md +29 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.35.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
|
|
@@ -7652,6 +7671,25 @@ export interface ReachListContactsV1200Response {
|
|
|
7652
7671
|
*/
|
|
7653
7672
|
'meta': CommonSchemaPaginationMetaSchema;
|
|
7654
7673
|
}
|
|
7674
|
+
/**
|
|
7675
|
+
*
|
|
7676
|
+
* @export
|
|
7677
|
+
* @interface ReachListFormsV1200Response
|
|
7678
|
+
*/
|
|
7679
|
+
export interface ReachListFormsV1200Response {
|
|
7680
|
+
/**
|
|
7681
|
+
* Array of [`Reach.V1.Forms.FormResource`](#model/reachv1formsformresource)
|
|
7682
|
+
* @type {Array<ReachV1FormsFormResource>}
|
|
7683
|
+
* @memberof ReachListFormsV1200Response
|
|
7684
|
+
*/
|
|
7685
|
+
'data': Array<ReachV1FormsFormResource>;
|
|
7686
|
+
/**
|
|
7687
|
+
*
|
|
7688
|
+
* @type {CommonSchemaPaginationMetaSchema}
|
|
7689
|
+
* @memberof ReachListFormsV1200Response
|
|
7690
|
+
*/
|
|
7691
|
+
'meta': CommonSchemaPaginationMetaSchema;
|
|
7692
|
+
}
|
|
7655
7693
|
/**
|
|
7656
7694
|
*
|
|
7657
7695
|
* @export
|
|
@@ -7877,6 +7915,381 @@ export declare const ReachV1AutomationsStepsAutomationStepResourceValueEnum: {
|
|
|
7877
7915
|
readonly Delay: "delay";
|
|
7878
7916
|
};
|
|
7879
7917
|
export type ReachV1AutomationsStepsAutomationStepResourceValueEnum = typeof ReachV1AutomationsStepsAutomationStepResourceValueEnum[keyof typeof ReachV1AutomationsStepsAutomationStepResourceValueEnum];
|
|
7918
|
+
/**
|
|
7919
|
+
* Delivery progress. While the campaign is `sending`, `total_sent` climbs towards the estimate.
|
|
7920
|
+
* @export
|
|
7921
|
+
* @interface ReachV1CampaignsCampaignDeliveryResource
|
|
7922
|
+
*/
|
|
7923
|
+
export interface ReachV1CampaignsCampaignDeliveryResource {
|
|
7924
|
+
/**
|
|
7925
|
+
* Emails sent so far.
|
|
7926
|
+
* @type {number}
|
|
7927
|
+
* @memberof ReachV1CampaignsCampaignDeliveryResource
|
|
7928
|
+
*/
|
|
7929
|
+
'total_sent': number;
|
|
7930
|
+
/**
|
|
7931
|
+
* Recipients this campaign was estimated to reach when sending started. Null for campaigns that have not started sending.
|
|
7932
|
+
* @type {number}
|
|
7933
|
+
* @memberof ReachV1CampaignsCampaignDeliveryResource
|
|
7934
|
+
*/
|
|
7935
|
+
'estimated_total_recipients': number | null;
|
|
7936
|
+
/**
|
|
7937
|
+
* Contacts currently targeted by this campaign.
|
|
7938
|
+
* @type {number}
|
|
7939
|
+
* @memberof ReachV1CampaignsCampaignDeliveryResource
|
|
7940
|
+
*/
|
|
7941
|
+
'subscribers_count': number;
|
|
7942
|
+
}
|
|
7943
|
+
/**
|
|
7944
|
+
*
|
|
7945
|
+
* @export
|
|
7946
|
+
* @interface ReachV1CampaignsCampaignDetailsResource
|
|
7947
|
+
*/
|
|
7948
|
+
export interface ReachV1CampaignsCampaignDetailsResource {
|
|
7949
|
+
/**
|
|
7950
|
+
*
|
|
7951
|
+
* @type {string}
|
|
7952
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
7953
|
+
*/
|
|
7954
|
+
'uuid': string;
|
|
7955
|
+
/**
|
|
7956
|
+
*
|
|
7957
|
+
* @type {string}
|
|
7958
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
7959
|
+
*/
|
|
7960
|
+
'title': string;
|
|
7961
|
+
/**
|
|
7962
|
+
*
|
|
7963
|
+
* @type {string}
|
|
7964
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
7965
|
+
*/
|
|
7966
|
+
'subject': string;
|
|
7967
|
+
/**
|
|
7968
|
+
*
|
|
7969
|
+
* @type {string}
|
|
7970
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
7971
|
+
*/
|
|
7972
|
+
'sender_name': string;
|
|
7973
|
+
/**
|
|
7974
|
+
*
|
|
7975
|
+
* @type {string}
|
|
7976
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
7977
|
+
*/
|
|
7978
|
+
'sender_email': string;
|
|
7979
|
+
/**
|
|
7980
|
+
* The email template this campaign uses. The template title is not exposed.
|
|
7981
|
+
* @type {string}
|
|
7982
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
7983
|
+
*/
|
|
7984
|
+
'template_uuid': string | null;
|
|
7985
|
+
/**
|
|
7986
|
+
* A fully sent campaign is `publish`. There is no `sent`, `paused` or `archived` status.
|
|
7987
|
+
* @type {string}
|
|
7988
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
7989
|
+
*/
|
|
7990
|
+
'status': ReachV1CampaignsCampaignDetailsResourceStatusEnum;
|
|
7991
|
+
/**
|
|
7992
|
+
*
|
|
7993
|
+
* @type {string}
|
|
7994
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
7995
|
+
*/
|
|
7996
|
+
'type': ReachV1CampaignsCampaignDetailsResourceTypeEnum;
|
|
7997
|
+
/**
|
|
7998
|
+
* Set only while the status is `failed`.
|
|
7999
|
+
* @type {string}
|
|
8000
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
8001
|
+
*/
|
|
8002
|
+
'failure_reason': string | null;
|
|
8003
|
+
/**
|
|
8004
|
+
* Whether delivery time is picked per contact rather than sent to everyone at once.
|
|
8005
|
+
* @type {boolean}
|
|
8006
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
8007
|
+
*/
|
|
8008
|
+
'is_smart_send': boolean;
|
|
8009
|
+
/**
|
|
8010
|
+
* Whether the campaign targets every contact instead of the listed segments.
|
|
8011
|
+
* @type {boolean}
|
|
8012
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
8013
|
+
*/
|
|
8014
|
+
'is_all_contacts': boolean;
|
|
8015
|
+
/**
|
|
8016
|
+
*
|
|
8017
|
+
* @type {ReachV1CampaignsCampaignDeliveryResource}
|
|
8018
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
8019
|
+
*/
|
|
8020
|
+
'delivery': ReachV1CampaignsCampaignDeliveryResource;
|
|
8021
|
+
/**
|
|
8022
|
+
* Segments this campaign targets. Empty when it targets all contacts.
|
|
8023
|
+
* @type {Array<string>}
|
|
8024
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
8025
|
+
*/
|
|
8026
|
+
'segment_uuids': Array<string>;
|
|
8027
|
+
/**
|
|
8028
|
+
*
|
|
8029
|
+
* @type {string}
|
|
8030
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
8031
|
+
*/
|
|
8032
|
+
'created_at': string;
|
|
8033
|
+
/**
|
|
8034
|
+
*
|
|
8035
|
+
* @type {string}
|
|
8036
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
8037
|
+
*/
|
|
8038
|
+
'updated_at': string | null;
|
|
8039
|
+
/**
|
|
8040
|
+
*
|
|
8041
|
+
* @type {string}
|
|
8042
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
8043
|
+
*/
|
|
8044
|
+
'sent_at': string | null;
|
|
8045
|
+
/**
|
|
8046
|
+
*
|
|
8047
|
+
* @type {string}
|
|
8048
|
+
* @memberof ReachV1CampaignsCampaignDetailsResource
|
|
8049
|
+
*/
|
|
8050
|
+
'scheduled_at': string | null;
|
|
8051
|
+
}
|
|
8052
|
+
export declare const ReachV1CampaignsCampaignDetailsResourceStatusEnum: {
|
|
8053
|
+
readonly Draft: "draft";
|
|
8054
|
+
readonly Scheduled: "scheduled";
|
|
8055
|
+
readonly Sending: "sending";
|
|
8056
|
+
readonly Publish: "publish";
|
|
8057
|
+
readonly Failed: "failed";
|
|
8058
|
+
};
|
|
8059
|
+
export type ReachV1CampaignsCampaignDetailsResourceStatusEnum = typeof ReachV1CampaignsCampaignDetailsResourceStatusEnum[keyof typeof ReachV1CampaignsCampaignDetailsResourceStatusEnum];
|
|
8060
|
+
export declare const ReachV1CampaignsCampaignDetailsResourceTypeEnum: {
|
|
8061
|
+
readonly Campaign: "campaign";
|
|
8062
|
+
readonly Automation: "automation";
|
|
8063
|
+
readonly DoubleOptIn: "double_opt_in";
|
|
8064
|
+
};
|
|
8065
|
+
export type ReachV1CampaignsCampaignDetailsResourceTypeEnum = typeof ReachV1CampaignsCampaignDetailsResourceTypeEnum[keyof typeof ReachV1CampaignsCampaignDetailsResourceTypeEnum];
|
|
8066
|
+
/**
|
|
8067
|
+
*
|
|
8068
|
+
* @export
|
|
8069
|
+
* @interface ReachV1CampaignsCampaignResource
|
|
8070
|
+
*/
|
|
8071
|
+
export interface ReachV1CampaignsCampaignResource {
|
|
8072
|
+
/**
|
|
8073
|
+
*
|
|
8074
|
+
* @type {string}
|
|
8075
|
+
* @memberof ReachV1CampaignsCampaignResource
|
|
8076
|
+
*/
|
|
8077
|
+
'uuid': string;
|
|
8078
|
+
/**
|
|
8079
|
+
*
|
|
8080
|
+
* @type {string}
|
|
8081
|
+
* @memberof ReachV1CampaignsCampaignResource
|
|
8082
|
+
*/
|
|
8083
|
+
'title': string;
|
|
8084
|
+
/**
|
|
8085
|
+
*
|
|
8086
|
+
* @type {string}
|
|
8087
|
+
* @memberof ReachV1CampaignsCampaignResource
|
|
8088
|
+
*/
|
|
8089
|
+
'subject': string;
|
|
8090
|
+
/**
|
|
8091
|
+
*
|
|
8092
|
+
* @type {string}
|
|
8093
|
+
* @memberof ReachV1CampaignsCampaignResource
|
|
8094
|
+
*/
|
|
8095
|
+
'sender_name': string;
|
|
8096
|
+
/**
|
|
8097
|
+
*
|
|
8098
|
+
* @type {string}
|
|
8099
|
+
* @memberof ReachV1CampaignsCampaignResource
|
|
8100
|
+
*/
|
|
8101
|
+
'sender_email': string;
|
|
8102
|
+
/**
|
|
8103
|
+
* The email template this campaign uses. The template title is not exposed.
|
|
8104
|
+
* @type {string}
|
|
8105
|
+
* @memberof ReachV1CampaignsCampaignResource
|
|
8106
|
+
*/
|
|
8107
|
+
'template_uuid': string | null;
|
|
8108
|
+
/**
|
|
8109
|
+
* A fully sent campaign is `publish`. There is no `sent`, `paused` or `archived` status.
|
|
8110
|
+
* @type {string}
|
|
8111
|
+
* @memberof ReachV1CampaignsCampaignResource
|
|
8112
|
+
*/
|
|
8113
|
+
'status': ReachV1CampaignsCampaignResourceStatusEnum;
|
|
8114
|
+
/**
|
|
8115
|
+
*
|
|
8116
|
+
* @type {string}
|
|
8117
|
+
* @memberof ReachV1CampaignsCampaignResource
|
|
8118
|
+
*/
|
|
8119
|
+
'type': ReachV1CampaignsCampaignResourceTypeEnum;
|
|
8120
|
+
/**
|
|
8121
|
+
*
|
|
8122
|
+
* @type {string}
|
|
8123
|
+
* @memberof ReachV1CampaignsCampaignResource
|
|
8124
|
+
*/
|
|
8125
|
+
'created_at': string;
|
|
8126
|
+
/**
|
|
8127
|
+
*
|
|
8128
|
+
* @type {string}
|
|
8129
|
+
* @memberof ReachV1CampaignsCampaignResource
|
|
8130
|
+
*/
|
|
8131
|
+
'updated_at': string | null;
|
|
8132
|
+
/**
|
|
8133
|
+
*
|
|
8134
|
+
* @type {string}
|
|
8135
|
+
* @memberof ReachV1CampaignsCampaignResource
|
|
8136
|
+
*/
|
|
8137
|
+
'sent_at': string | null;
|
|
8138
|
+
/**
|
|
8139
|
+
*
|
|
8140
|
+
* @type {string}
|
|
8141
|
+
* @memberof ReachV1CampaignsCampaignResource
|
|
8142
|
+
*/
|
|
8143
|
+
'scheduled_at': string | null;
|
|
8144
|
+
/**
|
|
8145
|
+
*
|
|
8146
|
+
* @type {ReachV1CampaignsCampaignSummaryStatisticsResource}
|
|
8147
|
+
* @memberof ReachV1CampaignsCampaignResource
|
|
8148
|
+
*/
|
|
8149
|
+
'statistics': ReachV1CampaignsCampaignSummaryStatisticsResource;
|
|
8150
|
+
}
|
|
8151
|
+
export declare const ReachV1CampaignsCampaignResourceStatusEnum: {
|
|
8152
|
+
readonly Draft: "draft";
|
|
8153
|
+
readonly Scheduled: "scheduled";
|
|
8154
|
+
readonly Sending: "sending";
|
|
8155
|
+
readonly Publish: "publish";
|
|
8156
|
+
readonly Failed: "failed";
|
|
8157
|
+
};
|
|
8158
|
+
export type ReachV1CampaignsCampaignResourceStatusEnum = typeof ReachV1CampaignsCampaignResourceStatusEnum[keyof typeof ReachV1CampaignsCampaignResourceStatusEnum];
|
|
8159
|
+
export declare const ReachV1CampaignsCampaignResourceTypeEnum: {
|
|
8160
|
+
readonly Campaign: "campaign";
|
|
8161
|
+
readonly Automation: "automation";
|
|
8162
|
+
readonly DoubleOptIn: "double_opt_in";
|
|
8163
|
+
};
|
|
8164
|
+
export type ReachV1CampaignsCampaignResourceTypeEnum = typeof ReachV1CampaignsCampaignResourceTypeEnum[keyof typeof ReachV1CampaignsCampaignResourceTypeEnum];
|
|
8165
|
+
/**
|
|
8166
|
+
* Campaign performance. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
|
|
8167
|
+
* @export
|
|
8168
|
+
* @interface ReachV1CampaignsCampaignStatisticsResource
|
|
8169
|
+
*/
|
|
8170
|
+
export interface ReachV1CampaignsCampaignStatisticsResource {
|
|
8171
|
+
/**
|
|
8172
|
+
* Emails sent for this campaign, and the denominator of every rate below.
|
|
8173
|
+
* @type {number}
|
|
8174
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8175
|
+
*/
|
|
8176
|
+
'total_sent': number;
|
|
8177
|
+
/**
|
|
8178
|
+
* Recipients this campaign was estimated to reach when sending started. Null for campaigns that have not started sending.
|
|
8179
|
+
* @type {number}
|
|
8180
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8181
|
+
*/
|
|
8182
|
+
'estimated_total_recipients': number | null;
|
|
8183
|
+
/**
|
|
8184
|
+
*
|
|
8185
|
+
* @type {number}
|
|
8186
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8187
|
+
*/
|
|
8188
|
+
'processed_count': number;
|
|
8189
|
+
/**
|
|
8190
|
+
*
|
|
8191
|
+
* @type {number}
|
|
8192
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8193
|
+
*/
|
|
8194
|
+
'delivered_count': number;
|
|
8195
|
+
/**
|
|
8196
|
+
*
|
|
8197
|
+
* @type {number}
|
|
8198
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8199
|
+
*/
|
|
8200
|
+
'dropped_count': number;
|
|
8201
|
+
/**
|
|
8202
|
+
*
|
|
8203
|
+
* @type {number}
|
|
8204
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8205
|
+
*/
|
|
8206
|
+
'bounced_count': number;
|
|
8207
|
+
/**
|
|
8208
|
+
*
|
|
8209
|
+
* @type {number}
|
|
8210
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8211
|
+
*/
|
|
8212
|
+
'soft_bounced_count': number;
|
|
8213
|
+
/**
|
|
8214
|
+
* Contacts who opened this campaign.
|
|
8215
|
+
* @type {number}
|
|
8216
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8217
|
+
*/
|
|
8218
|
+
'opened_count': number;
|
|
8219
|
+
/**
|
|
8220
|
+
* Contacts who clicked a link. Only clicks from contacts who also registered an open count.
|
|
8221
|
+
* @type {number}
|
|
8222
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8223
|
+
*/
|
|
8224
|
+
'clicked_count': number;
|
|
8225
|
+
/**
|
|
8226
|
+
* Contacts who unsubscribed through this campaign.
|
|
8227
|
+
* @type {number}
|
|
8228
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8229
|
+
*/
|
|
8230
|
+
'unsubscribed_count': number;
|
|
8231
|
+
/**
|
|
8232
|
+
* Percentage of sent emails that were opened.
|
|
8233
|
+
* @type {number}
|
|
8234
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8235
|
+
*/
|
|
8236
|
+
'open_rate': number;
|
|
8237
|
+
/**
|
|
8238
|
+
* Percentage of sent emails that got a click.
|
|
8239
|
+
* @type {number}
|
|
8240
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8241
|
+
*/
|
|
8242
|
+
'click_rate': number;
|
|
8243
|
+
/**
|
|
8244
|
+
* Percentage of the contacts who opened that went on to click.
|
|
8245
|
+
* @type {number}
|
|
8246
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8247
|
+
*/
|
|
8248
|
+
'click_to_open_rate': number;
|
|
8249
|
+
/**
|
|
8250
|
+
* Percentage of sent emails that led to an unsubscribe.
|
|
8251
|
+
* @type {number}
|
|
8252
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8253
|
+
*/
|
|
8254
|
+
'unsubscribe_rate': number;
|
|
8255
|
+
/**
|
|
8256
|
+
*
|
|
8257
|
+
* @type {boolean}
|
|
8258
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
8259
|
+
*/
|
|
8260
|
+
'has_bounced_contacts': boolean;
|
|
8261
|
+
}
|
|
8262
|
+
/**
|
|
8263
|
+
* Headline engagement rates. The statistics endpoint carries the full breakdown.
|
|
8264
|
+
* @export
|
|
8265
|
+
* @interface ReachV1CampaignsCampaignSummaryStatisticsResource
|
|
8266
|
+
*/
|
|
8267
|
+
export interface ReachV1CampaignsCampaignSummaryStatisticsResource {
|
|
8268
|
+
/**
|
|
8269
|
+
* Emails sent for this campaign, and the denominator of the rates below.
|
|
8270
|
+
* @type {number}
|
|
8271
|
+
* @memberof ReachV1CampaignsCampaignSummaryStatisticsResource
|
|
8272
|
+
*/
|
|
8273
|
+
'total_sent': number;
|
|
8274
|
+
/**
|
|
8275
|
+
* Percentage of sent emails that were opened.
|
|
8276
|
+
* @type {number}
|
|
8277
|
+
* @memberof ReachV1CampaignsCampaignSummaryStatisticsResource
|
|
8278
|
+
*/
|
|
8279
|
+
'open_rate': number;
|
|
8280
|
+
/**
|
|
8281
|
+
* Percentage of sent emails that got a click.
|
|
8282
|
+
* @type {number}
|
|
8283
|
+
* @memberof ReachV1CampaignsCampaignSummaryStatisticsResource
|
|
8284
|
+
*/
|
|
8285
|
+
'click_rate': number;
|
|
8286
|
+
/**
|
|
8287
|
+
* Percentage of the contacts who opened that went on to click.
|
|
8288
|
+
* @type {number}
|
|
8289
|
+
* @memberof ReachV1CampaignsCampaignSummaryStatisticsResource
|
|
8290
|
+
*/
|
|
8291
|
+
'click_to_open_rate': number;
|
|
8292
|
+
}
|
|
7880
8293
|
/**
|
|
7881
8294
|
* Create many contacts in one call
|
|
7882
8295
|
* @export
|
|
@@ -9073,29 +9486,229 @@ export declare const ReachV1ContactsUpdateRequestSubscriptionStatusEnum: {
|
|
|
9073
9486
|
};
|
|
9074
9487
|
export type ReachV1ContactsUpdateRequestSubscriptionStatusEnum = typeof ReachV1ContactsUpdateRequestSubscriptionStatusEnum[keyof typeof ReachV1ContactsUpdateRequestSubscriptionStatusEnum];
|
|
9075
9488
|
/**
|
|
9076
|
-
*
|
|
9489
|
+
*
|
|
9490
|
+
* @export
|
|
9491
|
+
* @interface ReachV1ContactsUpdateRequestFieldsInner
|
|
9492
|
+
*/
|
|
9493
|
+
export interface ReachV1ContactsUpdateRequestFieldsInner {
|
|
9494
|
+
/**
|
|
9495
|
+
*
|
|
9496
|
+
* @type {string}
|
|
9497
|
+
* @memberof ReachV1ContactsUpdateRequestFieldsInner
|
|
9498
|
+
*/
|
|
9499
|
+
'uuid': string;
|
|
9500
|
+
/**
|
|
9501
|
+
* For the scalar field types
|
|
9502
|
+
* @type {string}
|
|
9503
|
+
* @memberof ReachV1ContactsUpdateRequestFieldsInner
|
|
9504
|
+
*/
|
|
9505
|
+
'value': string | null;
|
|
9506
|
+
/**
|
|
9507
|
+
* For the choice field types
|
|
9508
|
+
* @type {Array<string>}
|
|
9509
|
+
* @memberof ReachV1ContactsUpdateRequestFieldsInner
|
|
9510
|
+
*/
|
|
9511
|
+
'selected_option_uuids': Array<string>;
|
|
9512
|
+
}
|
|
9513
|
+
/**
|
|
9514
|
+
*
|
|
9515
|
+
* @export
|
|
9516
|
+
* @interface ReachV1FormsFormDetailsResource
|
|
9517
|
+
*/
|
|
9518
|
+
export interface ReachV1FormsFormDetailsResource {
|
|
9519
|
+
/**
|
|
9520
|
+
*
|
|
9521
|
+
* @type {string}
|
|
9522
|
+
* @memberof ReachV1FormsFormDetailsResource
|
|
9523
|
+
*/
|
|
9524
|
+
'uuid': string;
|
|
9525
|
+
/**
|
|
9526
|
+
*
|
|
9527
|
+
* @type {string}
|
|
9528
|
+
* @memberof ReachV1FormsFormDetailsResource
|
|
9529
|
+
*/
|
|
9530
|
+
'name': string;
|
|
9531
|
+
/**
|
|
9532
|
+
* A `paused` form keeps its template online but stops accepting submissions.
|
|
9533
|
+
* @type {string}
|
|
9534
|
+
* @memberof ReachV1FormsFormDetailsResource
|
|
9535
|
+
*/
|
|
9536
|
+
'status': ReachV1FormsFormDetailsResourceStatusEnum;
|
|
9537
|
+
/**
|
|
9538
|
+
*
|
|
9539
|
+
* @type {string}
|
|
9540
|
+
* @memberof ReachV1FormsFormDetailsResource
|
|
9541
|
+
*/
|
|
9542
|
+
'type': ReachV1FormsFormDetailsResourceTypeEnum;
|
|
9543
|
+
/**
|
|
9544
|
+
*
|
|
9545
|
+
* @type {ReachV1FormsFormTemplateDetailsResource}
|
|
9546
|
+
* @memberof ReachV1FormsFormDetailsResource
|
|
9547
|
+
*/
|
|
9548
|
+
'template': ReachV1FormsFormTemplateDetailsResource;
|
|
9549
|
+
/**
|
|
9550
|
+
* Tags applied to every contact this form captures.
|
|
9551
|
+
* @type {Array<ReachV1FormsFormTagResource>}
|
|
9552
|
+
* @memberof ReachV1FormsFormDetailsResource
|
|
9553
|
+
*/
|
|
9554
|
+
'tags': Array<ReachV1FormsFormTagResource>;
|
|
9555
|
+
/**
|
|
9556
|
+
*
|
|
9557
|
+
* @type {string}
|
|
9558
|
+
* @memberof ReachV1FormsFormDetailsResource
|
|
9559
|
+
*/
|
|
9560
|
+
'created_at': string;
|
|
9561
|
+
/**
|
|
9562
|
+
*
|
|
9563
|
+
* @type {string}
|
|
9564
|
+
* @memberof ReachV1FormsFormDetailsResource
|
|
9565
|
+
*/
|
|
9566
|
+
'updated_at': string | null;
|
|
9567
|
+
}
|
|
9568
|
+
export declare const ReachV1FormsFormDetailsResourceStatusEnum: {
|
|
9569
|
+
readonly Active: "active";
|
|
9570
|
+
readonly Paused: "paused";
|
|
9571
|
+
readonly Draft: "draft";
|
|
9572
|
+
};
|
|
9573
|
+
export type ReachV1FormsFormDetailsResourceStatusEnum = typeof ReachV1FormsFormDetailsResourceStatusEnum[keyof typeof ReachV1FormsFormDetailsResourceStatusEnum];
|
|
9574
|
+
export declare const ReachV1FormsFormDetailsResourceTypeEnum: {
|
|
9575
|
+
readonly Form: "form";
|
|
9576
|
+
};
|
|
9577
|
+
export type ReachV1FormsFormDetailsResourceTypeEnum = typeof ReachV1FormsFormDetailsResourceTypeEnum[keyof typeof ReachV1FormsFormDetailsResourceTypeEnum];
|
|
9578
|
+
/**
|
|
9579
|
+
*
|
|
9580
|
+
* @export
|
|
9581
|
+
* @interface ReachV1FormsFormResource
|
|
9582
|
+
*/
|
|
9583
|
+
export interface ReachV1FormsFormResource {
|
|
9584
|
+
/**
|
|
9585
|
+
*
|
|
9586
|
+
* @type {string}
|
|
9587
|
+
* @memberof ReachV1FormsFormResource
|
|
9588
|
+
*/
|
|
9589
|
+
'uuid': string;
|
|
9590
|
+
/**
|
|
9591
|
+
*
|
|
9592
|
+
* @type {string}
|
|
9593
|
+
* @memberof ReachV1FormsFormResource
|
|
9594
|
+
*/
|
|
9595
|
+
'name': string;
|
|
9596
|
+
/**
|
|
9597
|
+
* A `paused` form keeps its template online but stops accepting submissions.
|
|
9598
|
+
* @type {string}
|
|
9599
|
+
* @memberof ReachV1FormsFormResource
|
|
9600
|
+
*/
|
|
9601
|
+
'status': ReachV1FormsFormResourceStatusEnum;
|
|
9602
|
+
/**
|
|
9603
|
+
*
|
|
9604
|
+
* @type {string}
|
|
9605
|
+
* @memberof ReachV1FormsFormResource
|
|
9606
|
+
*/
|
|
9607
|
+
'type': ReachV1FormsFormResourceTypeEnum;
|
|
9608
|
+
/**
|
|
9609
|
+
*
|
|
9610
|
+
* @type {ReachV1FormsFormTemplateResource}
|
|
9611
|
+
* @memberof ReachV1FormsFormResource
|
|
9612
|
+
*/
|
|
9613
|
+
'template': ReachV1FormsFormTemplateResource;
|
|
9614
|
+
/**
|
|
9615
|
+
*
|
|
9616
|
+
* @type {string}
|
|
9617
|
+
* @memberof ReachV1FormsFormResource
|
|
9618
|
+
*/
|
|
9619
|
+
'created_at': string;
|
|
9620
|
+
/**
|
|
9621
|
+
*
|
|
9622
|
+
* @type {string}
|
|
9623
|
+
* @memberof ReachV1FormsFormResource
|
|
9624
|
+
*/
|
|
9625
|
+
'updated_at': string | null;
|
|
9626
|
+
}
|
|
9627
|
+
export declare const ReachV1FormsFormResourceStatusEnum: {
|
|
9628
|
+
readonly Active: "active";
|
|
9629
|
+
readonly Paused: "paused";
|
|
9630
|
+
readonly Draft: "draft";
|
|
9631
|
+
};
|
|
9632
|
+
export type ReachV1FormsFormResourceStatusEnum = typeof ReachV1FormsFormResourceStatusEnum[keyof typeof ReachV1FormsFormResourceStatusEnum];
|
|
9633
|
+
export declare const ReachV1FormsFormResourceTypeEnum: {
|
|
9634
|
+
readonly Form: "form";
|
|
9635
|
+
};
|
|
9636
|
+
export type ReachV1FormsFormResourceTypeEnum = typeof ReachV1FormsFormResourceTypeEnum[keyof typeof ReachV1FormsFormResourceTypeEnum];
|
|
9637
|
+
/**
|
|
9638
|
+
* A tag applied to every contact this form captures.
|
|
9639
|
+
* @export
|
|
9640
|
+
* @interface ReachV1FormsFormTagResource
|
|
9641
|
+
*/
|
|
9642
|
+
export interface ReachV1FormsFormTagResource {
|
|
9643
|
+
/**
|
|
9644
|
+
*
|
|
9645
|
+
* @type {string}
|
|
9646
|
+
* @memberof ReachV1FormsFormTagResource
|
|
9647
|
+
*/
|
|
9648
|
+
'uuid': string;
|
|
9649
|
+
/**
|
|
9650
|
+
*
|
|
9651
|
+
* @type {string}
|
|
9652
|
+
* @memberof ReachV1FormsFormTagResource
|
|
9653
|
+
*/
|
|
9654
|
+
'value': string;
|
|
9655
|
+
/**
|
|
9656
|
+
* How the tag came about. `custom` covers the tags you create yourself, `import` the ones added by contact imports, and `form` and `system` the ones Reach creates on its own. Every form gets a `form:{name}` tag when it is created.
|
|
9657
|
+
* @type {string}
|
|
9658
|
+
* @memberof ReachV1FormsFormTagResource
|
|
9659
|
+
*/
|
|
9660
|
+
'type': ReachV1FormsFormTagResourceTypeEnum;
|
|
9661
|
+
}
|
|
9662
|
+
export declare const ReachV1FormsFormTagResourceTypeEnum: {
|
|
9663
|
+
readonly Form: "form";
|
|
9664
|
+
readonly Custom: "custom";
|
|
9665
|
+
readonly Import: "import";
|
|
9666
|
+
readonly System: "system";
|
|
9667
|
+
};
|
|
9668
|
+
export type ReachV1FormsFormTagResourceTypeEnum = typeof ReachV1FormsFormTagResourceTypeEnum[keyof typeof ReachV1FormsFormTagResourceTypeEnum];
|
|
9669
|
+
/**
|
|
9670
|
+
* The rendered form template. There is no ready-made embed snippet - either serve the HTML behind `url` or build your own embed around the form uuid. All fields stay null until the template has been generated.
|
|
9671
|
+
* @export
|
|
9672
|
+
* @interface ReachV1FormsFormTemplateDetailsResource
|
|
9673
|
+
*/
|
|
9674
|
+
export interface ReachV1FormsFormTemplateDetailsResource {
|
|
9675
|
+
/**
|
|
9676
|
+
*
|
|
9677
|
+
* @type {string}
|
|
9678
|
+
* @memberof ReachV1FormsFormTemplateDetailsResource
|
|
9679
|
+
*/
|
|
9680
|
+
'uuid': string | null;
|
|
9681
|
+
/**
|
|
9682
|
+
* Storage path of the template HTML, relative to the storage directory of this profile. `url` already includes that prefix, so prefer it unless you resolve storage paths yourself.
|
|
9683
|
+
* @type {string}
|
|
9684
|
+
* @memberof ReachV1FormsFormTemplateDetailsResource
|
|
9685
|
+
*/
|
|
9686
|
+
'path': string | null;
|
|
9687
|
+
/**
|
|
9688
|
+
* Publicly reachable URL of the template HTML.
|
|
9689
|
+
* @type {string}
|
|
9690
|
+
* @memberof ReachV1FormsFormTemplateDetailsResource
|
|
9691
|
+
*/
|
|
9692
|
+
'url': string | null;
|
|
9693
|
+
}
|
|
9694
|
+
/**
|
|
9695
|
+
* The rendered form template. Both fields stay null until the template has been generated.
|
|
9077
9696
|
* @export
|
|
9078
|
-
* @interface
|
|
9697
|
+
* @interface ReachV1FormsFormTemplateResource
|
|
9079
9698
|
*/
|
|
9080
|
-
export interface
|
|
9699
|
+
export interface ReachV1FormsFormTemplateResource {
|
|
9081
9700
|
/**
|
|
9082
9701
|
*
|
|
9083
9702
|
* @type {string}
|
|
9084
|
-
* @memberof
|
|
9703
|
+
* @memberof ReachV1FormsFormTemplateResource
|
|
9085
9704
|
*/
|
|
9086
|
-
'uuid': string;
|
|
9705
|
+
'uuid': string | null;
|
|
9087
9706
|
/**
|
|
9088
|
-
*
|
|
9707
|
+
* Storage path of the template HTML, relative to the storage directory of this profile. Get the form details to receive a directly usable URL instead.
|
|
9089
9708
|
* @type {string}
|
|
9090
|
-
* @memberof
|
|
9091
|
-
*/
|
|
9092
|
-
'value': string | null;
|
|
9093
|
-
/**
|
|
9094
|
-
* For the choice field types
|
|
9095
|
-
* @type {Array<string>}
|
|
9096
|
-
* @memberof ReachV1ContactsUpdateRequestFieldsInner
|
|
9709
|
+
* @memberof ReachV1FormsFormTemplateResource
|
|
9097
9710
|
*/
|
|
9098
|
-
'
|
|
9711
|
+
'path': string | null;
|
|
9099
9712
|
}
|
|
9100
9713
|
/**
|
|
9101
9714
|
*
|
|
@@ -9203,6 +9816,68 @@ export interface ReachV1ProfilesDomainsDnsStatusResource {
|
|
|
9203
9816
|
*/
|
|
9204
9817
|
'dmarc': ReachV1ProfilesDomainsDnsRecordStatus;
|
|
9205
9818
|
}
|
|
9819
|
+
/**
|
|
9820
|
+
* Allowance, consumption and headroom of a single plan limit for the current period.
|
|
9821
|
+
* @export
|
|
9822
|
+
* @interface ReachV1ProfilesPlanLimitUsageResource
|
|
9823
|
+
*/
|
|
9824
|
+
export interface ReachV1ProfilesPlanLimitUsageResource {
|
|
9825
|
+
/**
|
|
9826
|
+
* The allowance for the current period.
|
|
9827
|
+
* @type {number}
|
|
9828
|
+
* @memberof ReachV1ProfilesPlanLimitUsageResource
|
|
9829
|
+
*/
|
|
9830
|
+
'limit': number;
|
|
9831
|
+
/**
|
|
9832
|
+
* How much of the allowance has been consumed so far.
|
|
9833
|
+
* @type {number}
|
|
9834
|
+
* @memberof ReachV1ProfilesPlanLimitUsageResource
|
|
9835
|
+
*/
|
|
9836
|
+
'used': number;
|
|
9837
|
+
/**
|
|
9838
|
+
* Headroom left. Floors at 0, so it never reports a negative overage.
|
|
9839
|
+
* @type {number}
|
|
9840
|
+
* @memberof ReachV1ProfilesPlanLimitUsageResource
|
|
9841
|
+
*/
|
|
9842
|
+
'remaining': number;
|
|
9843
|
+
}
|
|
9844
|
+
/**
|
|
9845
|
+
* What the plan allows and what is left of it for the current period. `emails` counts every email sent. `recipients` counts the distinct contacts emailed - it is not the size of the contact list, a contact emailed three times counts once and a contact never emailed does not count at all. `ai_credits` counts the AI generations used, and its limit includes any extra credits bought on top of the plan.
|
|
9846
|
+
* @export
|
|
9847
|
+
* @interface ReachV1ProfilesPlanLimitsResource
|
|
9848
|
+
*/
|
|
9849
|
+
export interface ReachV1ProfilesPlanLimitsResource {
|
|
9850
|
+
/**
|
|
9851
|
+
*
|
|
9852
|
+
* @type {ReachV1ProfilesPlanLimitUsageResource}
|
|
9853
|
+
* @memberof ReachV1ProfilesPlanLimitsResource
|
|
9854
|
+
*/
|
|
9855
|
+
'emails': ReachV1ProfilesPlanLimitUsageResource;
|
|
9856
|
+
/**
|
|
9857
|
+
*
|
|
9858
|
+
* @type {ReachV1ProfilesPlanLimitUsageResource}
|
|
9859
|
+
* @memberof ReachV1ProfilesPlanLimitsResource
|
|
9860
|
+
*/
|
|
9861
|
+
'recipients': ReachV1ProfilesPlanLimitUsageResource;
|
|
9862
|
+
/**
|
|
9863
|
+
*
|
|
9864
|
+
* @type {ReachV1ProfilesPlanLimitUsageResource}
|
|
9865
|
+
* @memberof ReachV1ProfilesPlanLimitsResource
|
|
9866
|
+
*/
|
|
9867
|
+
'ai_credits': ReachV1ProfilesPlanLimitUsageResource;
|
|
9868
|
+
/**
|
|
9869
|
+
* Start of the current period. Periods are calendar months rather than billing anniversaries, so the counters reset at midnight UTC on the 1st no matter when the subscription started.
|
|
9870
|
+
* @type {string}
|
|
9871
|
+
* @memberof ReachV1ProfilesPlanLimitsResource
|
|
9872
|
+
*/
|
|
9873
|
+
'period_start': string;
|
|
9874
|
+
/**
|
|
9875
|
+
* End of the current period, that is the last moment of the calendar month.
|
|
9876
|
+
* @type {string}
|
|
9877
|
+
* @memberof ReachV1ProfilesPlanLimitsResource
|
|
9878
|
+
*/
|
|
9879
|
+
'period_end': string;
|
|
9880
|
+
}
|
|
9206
9881
|
/**
|
|
9207
9882
|
*
|
|
9208
9883
|
* @export
|
|
@@ -20119,6 +20794,187 @@ export declare const ListAutomationsV1SortDirectionEnum: {
|
|
|
20119
20794
|
readonly Desc: "desc";
|
|
20120
20795
|
};
|
|
20121
20796
|
export type ListAutomationsV1SortDirectionEnum = typeof ListAutomationsV1SortDirectionEnum[keyof typeof ListAutomationsV1SortDirectionEnum];
|
|
20797
|
+
/**
|
|
20798
|
+
* ReachCampaignsApi - axios parameter creator
|
|
20799
|
+
* @export
|
|
20800
|
+
*/
|
|
20801
|
+
export declare const ReachCampaignsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20802
|
+
/**
|
|
20803
|
+
* 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.
|
|
20804
|
+
* @summary Get campaign details
|
|
20805
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20806
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
20807
|
+
* @param {*} [options] Override http request option.
|
|
20808
|
+
* @throws {RequiredError}
|
|
20809
|
+
*/
|
|
20810
|
+
getCampaignDetailsV1: (profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
20811
|
+
/**
|
|
20812
|
+
* 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.
|
|
20813
|
+
* @summary Get campaign performance
|
|
20814
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20815
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
20816
|
+
* @param {*} [options] Override http request option.
|
|
20817
|
+
* @throws {RequiredError}
|
|
20818
|
+
*/
|
|
20819
|
+
getCampaignPerformanceV1: (profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
20820
|
+
/**
|
|
20821
|
+
* 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.
|
|
20822
|
+
* @summary List campaigns
|
|
20823
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20824
|
+
* @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
20825
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
|
|
20826
|
+
* @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
|
|
20827
|
+
* @param {number} [page] Page number
|
|
20828
|
+
* @param {number} [perPage] Number of items per page
|
|
20829
|
+
* @param {*} [options] Override http request option.
|
|
20830
|
+
* @throws {RequiredError}
|
|
20831
|
+
*/
|
|
20832
|
+
listCampaignsV1: (profileUuid: string, status?: ListCampaignsV1StatusEnum, type?: ListCampaignsV1TypeEnum, sortDirection?: ListCampaignsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
20833
|
+
};
|
|
20834
|
+
/**
|
|
20835
|
+
* ReachCampaignsApi - functional programming interface
|
|
20836
|
+
* @export
|
|
20837
|
+
*/
|
|
20838
|
+
export declare const ReachCampaignsApiFp: (configuration?: Configuration) => {
|
|
20839
|
+
/**
|
|
20840
|
+
* 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.
|
|
20841
|
+
* @summary Get campaign details
|
|
20842
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20843
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
20844
|
+
* @param {*} [options] Override http request option.
|
|
20845
|
+
* @throws {RequiredError}
|
|
20846
|
+
*/
|
|
20847
|
+
getCampaignDetailsV1(profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1CampaignsCampaignDetailsResource>>;
|
|
20848
|
+
/**
|
|
20849
|
+
* 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.
|
|
20850
|
+
* @summary Get campaign performance
|
|
20851
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20852
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
20853
|
+
* @param {*} [options] Override http request option.
|
|
20854
|
+
* @throws {RequiredError}
|
|
20855
|
+
*/
|
|
20856
|
+
getCampaignPerformanceV1(profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1CampaignsCampaignStatisticsResource>>;
|
|
20857
|
+
/**
|
|
20858
|
+
* 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.
|
|
20859
|
+
* @summary List campaigns
|
|
20860
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20861
|
+
* @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
20862
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
|
|
20863
|
+
* @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
|
|
20864
|
+
* @param {number} [page] Page number
|
|
20865
|
+
* @param {number} [perPage] Number of items per page
|
|
20866
|
+
* @param {*} [options] Override http request option.
|
|
20867
|
+
* @throws {RequiredError}
|
|
20868
|
+
*/
|
|
20869
|
+
listCampaignsV1(profileUuid: string, status?: ListCampaignsV1StatusEnum, type?: ListCampaignsV1TypeEnum, sortDirection?: ListCampaignsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachListCampaignsV1200Response>>;
|
|
20870
|
+
};
|
|
20871
|
+
/**
|
|
20872
|
+
* ReachCampaignsApi - factory interface
|
|
20873
|
+
* @export
|
|
20874
|
+
*/
|
|
20875
|
+
export declare const ReachCampaignsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
20876
|
+
/**
|
|
20877
|
+
* 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.
|
|
20878
|
+
* @summary Get campaign details
|
|
20879
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20880
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
20881
|
+
* @param {*} [options] Override http request option.
|
|
20882
|
+
* @throws {RequiredError}
|
|
20883
|
+
*/
|
|
20884
|
+
getCampaignDetailsV1(profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1CampaignsCampaignDetailsResource>;
|
|
20885
|
+
/**
|
|
20886
|
+
* 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.
|
|
20887
|
+
* @summary Get campaign performance
|
|
20888
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20889
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
20890
|
+
* @param {*} [options] Override http request option.
|
|
20891
|
+
* @throws {RequiredError}
|
|
20892
|
+
*/
|
|
20893
|
+
getCampaignPerformanceV1(profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1CampaignsCampaignStatisticsResource>;
|
|
20894
|
+
/**
|
|
20895
|
+
* 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.
|
|
20896
|
+
* @summary List campaigns
|
|
20897
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20898
|
+
* @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
20899
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
|
|
20900
|
+
* @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
|
|
20901
|
+
* @param {number} [page] Page number
|
|
20902
|
+
* @param {number} [perPage] Number of items per page
|
|
20903
|
+
* @param {*} [options] Override http request option.
|
|
20904
|
+
* @throws {RequiredError}
|
|
20905
|
+
*/
|
|
20906
|
+
listCampaignsV1(profileUuid: string, status?: ListCampaignsV1StatusEnum, type?: ListCampaignsV1TypeEnum, sortDirection?: ListCampaignsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<ReachListCampaignsV1200Response>;
|
|
20907
|
+
};
|
|
20908
|
+
/**
|
|
20909
|
+
* ReachCampaignsApi - object-oriented interface
|
|
20910
|
+
* @export
|
|
20911
|
+
* @class ReachCampaignsApi
|
|
20912
|
+
* @extends {BaseAPI}
|
|
20913
|
+
*/
|
|
20914
|
+
export declare class ReachCampaignsApi extends BaseAPI {
|
|
20915
|
+
/**
|
|
20916
|
+
* 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.
|
|
20917
|
+
* @summary Get campaign details
|
|
20918
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20919
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
20920
|
+
* @param {*} [options] Override http request option.
|
|
20921
|
+
* @throws {RequiredError}
|
|
20922
|
+
* @memberof ReachCampaignsApi
|
|
20923
|
+
*/
|
|
20924
|
+
getCampaignDetailsV1(profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1CampaignsCampaignDetailsResource, any, {}, any>>;
|
|
20925
|
+
/**
|
|
20926
|
+
* 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.
|
|
20927
|
+
* @summary Get campaign performance
|
|
20928
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20929
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
20930
|
+
* @param {*} [options] Override http request option.
|
|
20931
|
+
* @throws {RequiredError}
|
|
20932
|
+
* @memberof ReachCampaignsApi
|
|
20933
|
+
*/
|
|
20934
|
+
getCampaignPerformanceV1(profileUuid: string, campaignUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1CampaignsCampaignStatisticsResource, any, {}, any>>;
|
|
20935
|
+
/**
|
|
20936
|
+
* 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.
|
|
20937
|
+
* @summary List campaigns
|
|
20938
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20939
|
+
* @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
20940
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
|
|
20941
|
+
* @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
|
|
20942
|
+
* @param {number} [page] Page number
|
|
20943
|
+
* @param {number} [perPage] Number of items per page
|
|
20944
|
+
* @param {*} [options] Override http request option.
|
|
20945
|
+
* @throws {RequiredError}
|
|
20946
|
+
* @memberof ReachCampaignsApi
|
|
20947
|
+
*/
|
|
20948
|
+
listCampaignsV1(profileUuid: string, status?: ListCampaignsV1StatusEnum, type?: ListCampaignsV1TypeEnum, sortDirection?: ListCampaignsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachListCampaignsV1200Response, any, {}, any>>;
|
|
20949
|
+
}
|
|
20950
|
+
/**
|
|
20951
|
+
* @export
|
|
20952
|
+
*/
|
|
20953
|
+
export declare const ListCampaignsV1StatusEnum: {
|
|
20954
|
+
readonly Draft: "draft";
|
|
20955
|
+
readonly Scheduled: "scheduled";
|
|
20956
|
+
readonly Sending: "sending";
|
|
20957
|
+
readonly Publish: "publish";
|
|
20958
|
+
readonly Failed: "failed";
|
|
20959
|
+
};
|
|
20960
|
+
export type ListCampaignsV1StatusEnum = typeof ListCampaignsV1StatusEnum[keyof typeof ListCampaignsV1StatusEnum];
|
|
20961
|
+
/**
|
|
20962
|
+
* @export
|
|
20963
|
+
*/
|
|
20964
|
+
export declare const ListCampaignsV1TypeEnum: {
|
|
20965
|
+
readonly Campaign: "campaign";
|
|
20966
|
+
readonly Automation: "automation";
|
|
20967
|
+
readonly DoubleOptIn: "double_opt_in";
|
|
20968
|
+
};
|
|
20969
|
+
export type ListCampaignsV1TypeEnum = typeof ListCampaignsV1TypeEnum[keyof typeof ListCampaignsV1TypeEnum];
|
|
20970
|
+
/**
|
|
20971
|
+
* @export
|
|
20972
|
+
*/
|
|
20973
|
+
export declare const ListCampaignsV1SortDirectionEnum: {
|
|
20974
|
+
readonly Asc: "asc";
|
|
20975
|
+
readonly Desc: "desc";
|
|
20976
|
+
};
|
|
20977
|
+
export type ListCampaignsV1SortDirectionEnum = typeof ListCampaignsV1SortDirectionEnum[keyof typeof ListCampaignsV1SortDirectionEnum];
|
|
20122
20978
|
/**
|
|
20123
20979
|
* ReachContactFieldsApi - axios parameter creator
|
|
20124
20980
|
* @export
|
|
@@ -20733,6 +21589,147 @@ export declare const ListProfileContactsV1SubscriptionStatusEnum: {
|
|
|
20733
21589
|
readonly Pending: "pending";
|
|
20734
21590
|
};
|
|
20735
21591
|
export type ListProfileContactsV1SubscriptionStatusEnum = typeof ListProfileContactsV1SubscriptionStatusEnum[keyof typeof ListProfileContactsV1SubscriptionStatusEnum];
|
|
21592
|
+
/**
|
|
21593
|
+
* ReachFormsApi - axios parameter creator
|
|
21594
|
+
* @export
|
|
21595
|
+
*/
|
|
21596
|
+
export declare const ReachFormsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21597
|
+
/**
|
|
21598
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
21599
|
+
* @summary Delete form
|
|
21600
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21601
|
+
* @param {string} formUuid Form uuid parameter
|
|
21602
|
+
* @param {*} [options] Override http request option.
|
|
21603
|
+
* @throws {RequiredError}
|
|
21604
|
+
*/
|
|
21605
|
+
deleteFormV1: (profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21606
|
+
/**
|
|
21607
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
21608
|
+
* @summary Get form details
|
|
21609
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21610
|
+
* @param {string} formUuid Form uuid parameter
|
|
21611
|
+
* @param {*} [options] Override http request option.
|
|
21612
|
+
* @throws {RequiredError}
|
|
21613
|
+
*/
|
|
21614
|
+
getFormDetailsV1: (profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21615
|
+
/**
|
|
21616
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
21617
|
+
* @summary List forms
|
|
21618
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21619
|
+
* @param {number} [page] Page number
|
|
21620
|
+
* @param {number} [perPage] Number of items per page
|
|
21621
|
+
* @param {*} [options] Override http request option.
|
|
21622
|
+
* @throws {RequiredError}
|
|
21623
|
+
*/
|
|
21624
|
+
listFormsV1: (profileUuid: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21625
|
+
};
|
|
21626
|
+
/**
|
|
21627
|
+
* ReachFormsApi - functional programming interface
|
|
21628
|
+
* @export
|
|
21629
|
+
*/
|
|
21630
|
+
export declare const ReachFormsApiFp: (configuration?: Configuration) => {
|
|
21631
|
+
/**
|
|
21632
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
21633
|
+
* @summary Delete form
|
|
21634
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21635
|
+
* @param {string} formUuid Form uuid parameter
|
|
21636
|
+
* @param {*} [options] Override http request option.
|
|
21637
|
+
* @throws {RequiredError}
|
|
21638
|
+
*/
|
|
21639
|
+
deleteFormV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
21640
|
+
/**
|
|
21641
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
21642
|
+
* @summary Get form details
|
|
21643
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21644
|
+
* @param {string} formUuid Form uuid parameter
|
|
21645
|
+
* @param {*} [options] Override http request option.
|
|
21646
|
+
* @throws {RequiredError}
|
|
21647
|
+
*/
|
|
21648
|
+
getFormDetailsV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1FormsFormDetailsResource>>;
|
|
21649
|
+
/**
|
|
21650
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
21651
|
+
* @summary List forms
|
|
21652
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21653
|
+
* @param {number} [page] Page number
|
|
21654
|
+
* @param {number} [perPage] Number of items per page
|
|
21655
|
+
* @param {*} [options] Override http request option.
|
|
21656
|
+
* @throws {RequiredError}
|
|
21657
|
+
*/
|
|
21658
|
+
listFormsV1(profileUuid: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachListFormsV1200Response>>;
|
|
21659
|
+
};
|
|
21660
|
+
/**
|
|
21661
|
+
* ReachFormsApi - factory interface
|
|
21662
|
+
* @export
|
|
21663
|
+
*/
|
|
21664
|
+
export declare const ReachFormsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
21665
|
+
/**
|
|
21666
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
21667
|
+
* @summary Delete form
|
|
21668
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21669
|
+
* @param {string} formUuid Form uuid parameter
|
|
21670
|
+
* @param {*} [options] Override http request option.
|
|
21671
|
+
* @throws {RequiredError}
|
|
21672
|
+
*/
|
|
21673
|
+
deleteFormV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
21674
|
+
/**
|
|
21675
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
21676
|
+
* @summary Get form details
|
|
21677
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21678
|
+
* @param {string} formUuid Form uuid parameter
|
|
21679
|
+
* @param {*} [options] Override http request option.
|
|
21680
|
+
* @throws {RequiredError}
|
|
21681
|
+
*/
|
|
21682
|
+
getFormDetailsV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1FormsFormDetailsResource>;
|
|
21683
|
+
/**
|
|
21684
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
21685
|
+
* @summary List forms
|
|
21686
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21687
|
+
* @param {number} [page] Page number
|
|
21688
|
+
* @param {number} [perPage] Number of items per page
|
|
21689
|
+
* @param {*} [options] Override http request option.
|
|
21690
|
+
* @throws {RequiredError}
|
|
21691
|
+
*/
|
|
21692
|
+
listFormsV1(profileUuid: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<ReachListFormsV1200Response>;
|
|
21693
|
+
};
|
|
21694
|
+
/**
|
|
21695
|
+
* ReachFormsApi - object-oriented interface
|
|
21696
|
+
* @export
|
|
21697
|
+
* @class ReachFormsApi
|
|
21698
|
+
* @extends {BaseAPI}
|
|
21699
|
+
*/
|
|
21700
|
+
export declare class ReachFormsApi extends BaseAPI {
|
|
21701
|
+
/**
|
|
21702
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
21703
|
+
* @summary Delete form
|
|
21704
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21705
|
+
* @param {string} formUuid Form uuid parameter
|
|
21706
|
+
* @param {*} [options] Override http request option.
|
|
21707
|
+
* @throws {RequiredError}
|
|
21708
|
+
* @memberof ReachFormsApi
|
|
21709
|
+
*/
|
|
21710
|
+
deleteFormV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
21711
|
+
/**
|
|
21712
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
21713
|
+
* @summary Get form details
|
|
21714
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21715
|
+
* @param {string} formUuid Form uuid parameter
|
|
21716
|
+
* @param {*} [options] Override http request option.
|
|
21717
|
+
* @throws {RequiredError}
|
|
21718
|
+
* @memberof ReachFormsApi
|
|
21719
|
+
*/
|
|
21720
|
+
getFormDetailsV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1FormsFormDetailsResource, any, {}, any>>;
|
|
21721
|
+
/**
|
|
21722
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
21723
|
+
* @summary List forms
|
|
21724
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21725
|
+
* @param {number} [page] Page number
|
|
21726
|
+
* @param {number} [perPage] Number of items per page
|
|
21727
|
+
* @param {*} [options] Override http request option.
|
|
21728
|
+
* @throws {RequiredError}
|
|
21729
|
+
* @memberof ReachFormsApi
|
|
21730
|
+
*/
|
|
21731
|
+
listFormsV1(profileUuid: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachListFormsV1200Response, any, {}, any>>;
|
|
21732
|
+
}
|
|
20736
21733
|
/**
|
|
20737
21734
|
* ReachProfilesApi - axios parameter creator
|
|
20738
21735
|
* @export
|
|
@@ -20746,6 +21743,14 @@ export declare const ReachProfilesApiAxiosParamCreator: (configuration?: Configu
|
|
|
20746
21743
|
* @throws {RequiredError}
|
|
20747
21744
|
*/
|
|
20748
21745
|
getProfileDomainDNSStatusV1: (profileUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21746
|
+
/**
|
|
21747
|
+
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
21748
|
+
* @summary Get remaining plan limits
|
|
21749
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21750
|
+
* @param {*} [options] Override http request option.
|
|
21751
|
+
* @throws {RequiredError}
|
|
21752
|
+
*/
|
|
21753
|
+
getRemainingPlanLimitsV1: (profileUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
20749
21754
|
/**
|
|
20750
21755
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
20751
21756
|
* @summary List Profiles
|
|
@@ -20767,6 +21772,14 @@ export declare const ReachProfilesApiFp: (configuration?: Configuration) => {
|
|
|
20767
21772
|
* @throws {RequiredError}
|
|
20768
21773
|
*/
|
|
20769
21774
|
getProfileDomainDNSStatusV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1ProfilesDomainsDnsStatusResource>>;
|
|
21775
|
+
/**
|
|
21776
|
+
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
21777
|
+
* @summary Get remaining plan limits
|
|
21778
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21779
|
+
* @param {*} [options] Override http request option.
|
|
21780
|
+
* @throws {RequiredError}
|
|
21781
|
+
*/
|
|
21782
|
+
getRemainingPlanLimitsV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1ProfilesPlanLimitsResource>>;
|
|
20770
21783
|
/**
|
|
20771
21784
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
20772
21785
|
* @summary List Profiles
|
|
@@ -20788,6 +21801,14 @@ export declare const ReachProfilesApiFactory: (configuration?: Configuration, ba
|
|
|
20788
21801
|
* @throws {RequiredError}
|
|
20789
21802
|
*/
|
|
20790
21803
|
getProfileDomainDNSStatusV1(profileUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1ProfilesDomainsDnsStatusResource>;
|
|
21804
|
+
/**
|
|
21805
|
+
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
21806
|
+
* @summary Get remaining plan limits
|
|
21807
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21808
|
+
* @param {*} [options] Override http request option.
|
|
21809
|
+
* @throws {RequiredError}
|
|
21810
|
+
*/
|
|
21811
|
+
getRemainingPlanLimitsV1(profileUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1ProfilesPlanLimitsResource>;
|
|
20791
21812
|
/**
|
|
20792
21813
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
20793
21814
|
* @summary List Profiles
|
|
@@ -20812,6 +21833,15 @@ export declare class ReachProfilesApi extends BaseAPI {
|
|
|
20812
21833
|
* @memberof ReachProfilesApi
|
|
20813
21834
|
*/
|
|
20814
21835
|
getProfileDomainDNSStatusV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1ProfilesDomainsDnsStatusResource, any, {}, any>>;
|
|
21836
|
+
/**
|
|
21837
|
+
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
21838
|
+
* @summary Get remaining plan limits
|
|
21839
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21840
|
+
* @param {*} [options] Override http request option.
|
|
21841
|
+
* @throws {RequiredError}
|
|
21842
|
+
* @memberof ReachProfilesApi
|
|
21843
|
+
*/
|
|
21844
|
+
getRemainingPlanLimitsV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1ProfilesPlanLimitsResource, any, {}, any>>;
|
|
20815
21845
|
/**
|
|
20816
21846
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
20817
21847
|
* @summary List Profiles
|