hostinger-api-sdk 1.30.8 → 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/README.md +2 -2
- package/api.ts +2234 -982
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +977 -49
- package/dist/api.js +683 -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 +977 -49
- package/dist/esm/api.js +667 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ReachAutomationsApi.md +187 -0
- package/docs/ReachCampaignsApi.md +190 -0
- package/docs/ReachListAutomationsV1200Response.md +22 -0
- package/docs/ReachListCampaignsV1200Response.md +22 -0
- package/docs/ReachV1AutomationsAutomationEventsResource.md +27 -0
- package/docs/ReachV1AutomationsAutomationResource.md +34 -0
- package/docs/ReachV1AutomationsStepsAutomationStepResource.md +30 -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/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.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
|
|
@@ -7614,6 +7614,44 @@ export interface MailV1WebhooksWebhookTestResultResource {
|
|
|
7614
7614
|
*/
|
|
7615
7615
|
'error': string | null;
|
|
7616
7616
|
}
|
|
7617
|
+
/**
|
|
7618
|
+
*
|
|
7619
|
+
* @export
|
|
7620
|
+
* @interface ReachListAutomationsV1200Response
|
|
7621
|
+
*/
|
|
7622
|
+
export interface ReachListAutomationsV1200Response {
|
|
7623
|
+
/**
|
|
7624
|
+
* Array of [`Reach.V1.Automations.AutomationResource`](#model/reachv1automationsautomationresource)
|
|
7625
|
+
* @type {Array<ReachV1AutomationsAutomationResource>}
|
|
7626
|
+
* @memberof ReachListAutomationsV1200Response
|
|
7627
|
+
*/
|
|
7628
|
+
'data': Array<ReachV1AutomationsAutomationResource>;
|
|
7629
|
+
/**
|
|
7630
|
+
*
|
|
7631
|
+
* @type {CommonSchemaPaginationMetaSchema}
|
|
7632
|
+
* @memberof ReachListAutomationsV1200Response
|
|
7633
|
+
*/
|
|
7634
|
+
'meta': CommonSchemaPaginationMetaSchema;
|
|
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
|
+
}
|
|
7617
7655
|
/**
|
|
7618
7656
|
*
|
|
7619
7657
|
* @export
|
|
@@ -7621,74 +7659,617 @@ export interface MailV1WebhooksWebhookTestResultResource {
|
|
|
7621
7659
|
*/
|
|
7622
7660
|
export interface ReachListContactsV1200Response {
|
|
7623
7661
|
/**
|
|
7624
|
-
* Array of [`Reach.V1.Contacts.ContactResource`](#model/reachv1contactscontactresource)
|
|
7625
|
-
* @type {Array<ReachV1ContactsContactResource>}
|
|
7626
|
-
* @memberof ReachListContactsV1200Response
|
|
7662
|
+
* Array of [`Reach.V1.Contacts.ContactResource`](#model/reachv1contactscontactresource)
|
|
7663
|
+
* @type {Array<ReachV1ContactsContactResource>}
|
|
7664
|
+
* @memberof ReachListContactsV1200Response
|
|
7665
|
+
*/
|
|
7666
|
+
'data': Array<ReachV1ContactsContactResource>;
|
|
7667
|
+
/**
|
|
7668
|
+
*
|
|
7669
|
+
* @type {CommonSchemaPaginationMetaSchema}
|
|
7670
|
+
* @memberof ReachListContactsV1200Response
|
|
7671
|
+
*/
|
|
7672
|
+
'meta': CommonSchemaPaginationMetaSchema;
|
|
7673
|
+
}
|
|
7674
|
+
/**
|
|
7675
|
+
*
|
|
7676
|
+
* @export
|
|
7677
|
+
* @interface ReachListProfileContactsV1200Response
|
|
7678
|
+
*/
|
|
7679
|
+
export interface ReachListProfileContactsV1200Response {
|
|
7680
|
+
/**
|
|
7681
|
+
* Array of [`Reach.V1.Contacts.ProfileContactResource`](#model/reachv1contactsprofilecontactresource)
|
|
7682
|
+
* @type {Array<ReachV1ContactsProfileContactResource>}
|
|
7683
|
+
* @memberof ReachListProfileContactsV1200Response
|
|
7684
|
+
*/
|
|
7685
|
+
'data': Array<ReachV1ContactsProfileContactResource>;
|
|
7686
|
+
/**
|
|
7687
|
+
*
|
|
7688
|
+
* @type {CommonSchemaPaginationMetaSchema}
|
|
7689
|
+
* @memberof ReachListProfileContactsV1200Response
|
|
7690
|
+
*/
|
|
7691
|
+
'meta': CommonSchemaPaginationMetaSchema;
|
|
7692
|
+
}
|
|
7693
|
+
/**
|
|
7694
|
+
*
|
|
7695
|
+
* @export
|
|
7696
|
+
* @interface ReachListProfileSegmentContactsV1200Response
|
|
7697
|
+
*/
|
|
7698
|
+
export interface ReachListProfileSegmentContactsV1200Response {
|
|
7699
|
+
/**
|
|
7700
|
+
* Array of [`Reach.V1.Contacts.Segments.SegmentationContactResource`](#model/reachv1contactssegmentssegmentationcontactresource)
|
|
7701
|
+
* @type {Array<ReachV1ContactsSegmentsSegmentationContactResource>}
|
|
7702
|
+
* @memberof ReachListProfileSegmentContactsV1200Response
|
|
7703
|
+
*/
|
|
7704
|
+
'data': Array<ReachV1ContactsSegmentsSegmentationContactResource>;
|
|
7705
|
+
/**
|
|
7706
|
+
*
|
|
7707
|
+
* @type {CommonSchemaPaginationMetaSchema}
|
|
7708
|
+
* @memberof ReachListProfileSegmentContactsV1200Response
|
|
7709
|
+
*/
|
|
7710
|
+
'meta': CommonSchemaPaginationMetaSchema;
|
|
7711
|
+
}
|
|
7712
|
+
/**
|
|
7713
|
+
*
|
|
7714
|
+
* @export
|
|
7715
|
+
* @interface ReachListProfileSegmentsV1200Response
|
|
7716
|
+
*/
|
|
7717
|
+
export interface ReachListProfileSegmentsV1200Response {
|
|
7718
|
+
/**
|
|
7719
|
+
* Array of [`Reach.V1.Contacts.Segments.SegmentListItemResource`](#model/reachv1contactssegmentssegmentlistitemresource)
|
|
7720
|
+
* @type {Array<ReachV1ContactsSegmentsSegmentListItemResource>}
|
|
7721
|
+
* @memberof ReachListProfileSegmentsV1200Response
|
|
7722
|
+
*/
|
|
7723
|
+
'data': Array<ReachV1ContactsSegmentsSegmentListItemResource>;
|
|
7724
|
+
/**
|
|
7725
|
+
*
|
|
7726
|
+
* @type {CommonSchemaPaginationMetaSchema}
|
|
7727
|
+
* @memberof ReachListProfileSegmentsV1200Response
|
|
7728
|
+
*/
|
|
7729
|
+
'meta': CommonSchemaPaginationMetaSchema;
|
|
7730
|
+
}
|
|
7731
|
+
/**
|
|
7732
|
+
* Counts of contacts moving through the automation. These are not email engagement metrics. Automations expose no sent, open or click counters - use the campaign statistics endpoint for those.
|
|
7733
|
+
* @export
|
|
7734
|
+
* @interface ReachV1AutomationsAutomationEventsResource
|
|
7735
|
+
*/
|
|
7736
|
+
export interface ReachV1AutomationsAutomationEventsResource {
|
|
7737
|
+
/**
|
|
7738
|
+
* Contacts that ever entered the automation, including those that already left it.
|
|
7739
|
+
* @type {number}
|
|
7740
|
+
* @memberof ReachV1AutomationsAutomationEventsResource
|
|
7741
|
+
*/
|
|
7742
|
+
'started': number;
|
|
7743
|
+
/**
|
|
7744
|
+
* Contacts currently moving through the automation, including those waiting on a delay step.
|
|
7745
|
+
* @type {number}
|
|
7746
|
+
* @memberof ReachV1AutomationsAutomationEventsResource
|
|
7747
|
+
*/
|
|
7748
|
+
'in_progress': number;
|
|
7749
|
+
/**
|
|
7750
|
+
* Contacts that reached the end of the workflow.
|
|
7751
|
+
* @type {number}
|
|
7752
|
+
* @memberof ReachV1AutomationsAutomationEventsResource
|
|
7753
|
+
*/
|
|
7754
|
+
'completed': number;
|
|
7755
|
+
/**
|
|
7756
|
+
* Contacts whose journey through the automation errored and stopped.
|
|
7757
|
+
* @type {number}
|
|
7758
|
+
* @memberof ReachV1AutomationsAutomationEventsResource
|
|
7759
|
+
*/
|
|
7760
|
+
'failed': number;
|
|
7761
|
+
}
|
|
7762
|
+
/**
|
|
7763
|
+
*
|
|
7764
|
+
* @export
|
|
7765
|
+
* @interface ReachV1AutomationsAutomationResource
|
|
7766
|
+
*/
|
|
7767
|
+
export interface ReachV1AutomationsAutomationResource {
|
|
7768
|
+
/**
|
|
7769
|
+
*
|
|
7770
|
+
* @type {string}
|
|
7771
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7772
|
+
*/
|
|
7773
|
+
'uuid': string;
|
|
7774
|
+
/**
|
|
7775
|
+
*
|
|
7776
|
+
* @type {string}
|
|
7777
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7778
|
+
*/
|
|
7779
|
+
'name': string;
|
|
7780
|
+
/**
|
|
7781
|
+
* There is no `completed` status. Use `events.completed` to see how many contacts finished.
|
|
7782
|
+
* @type {string}
|
|
7783
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7784
|
+
*/
|
|
7785
|
+
'status': ReachV1AutomationsAutomationResourceStatusEnum;
|
|
7786
|
+
/**
|
|
7787
|
+
* What kind of workflow this is. `custom` automations are the ones built from scratch.
|
|
7788
|
+
* @type {string}
|
|
7789
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7790
|
+
*/
|
|
7791
|
+
'type': ReachV1AutomationsAutomationResourceTypeEnum;
|
|
7792
|
+
/**
|
|
7793
|
+
* Trigger configuration of the automation. The shape depends on the type.
|
|
7794
|
+
* @type {object}
|
|
7795
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7796
|
+
*/
|
|
7797
|
+
'config': object | null;
|
|
7798
|
+
/**
|
|
7799
|
+
*
|
|
7800
|
+
* @type {ReachV1AutomationsAutomationEventsResource}
|
|
7801
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7802
|
+
*/
|
|
7803
|
+
'events': ReachV1AutomationsAutomationEventsResource;
|
|
7804
|
+
/**
|
|
7805
|
+
*
|
|
7806
|
+
* @type {string}
|
|
7807
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7808
|
+
*/
|
|
7809
|
+
'created_at': string | null;
|
|
7810
|
+
/**
|
|
7811
|
+
*
|
|
7812
|
+
* @type {string}
|
|
7813
|
+
* @memberof ReachV1AutomationsAutomationResource
|
|
7814
|
+
*/
|
|
7815
|
+
'updated_at': string | null;
|
|
7816
|
+
}
|
|
7817
|
+
export declare const ReachV1AutomationsAutomationResourceStatusEnum: {
|
|
7818
|
+
readonly Active: "active";
|
|
7819
|
+
readonly Paused: "paused";
|
|
7820
|
+
readonly Draft: "draft";
|
|
7821
|
+
};
|
|
7822
|
+
export type ReachV1AutomationsAutomationResourceStatusEnum = typeof ReachV1AutomationsAutomationResourceStatusEnum[keyof typeof ReachV1AutomationsAutomationResourceStatusEnum];
|
|
7823
|
+
export declare const ReachV1AutomationsAutomationResourceTypeEnum: {
|
|
7824
|
+
readonly Welcome: "welcome";
|
|
7825
|
+
readonly WelcomeSeries: "welcome_series";
|
|
7826
|
+
readonly PromotionalSeries: "promotional_series";
|
|
7827
|
+
readonly TrustBuildingSeries: "trust_building_series";
|
|
7828
|
+
readonly EcommerceAbandonedCart: "ecommerce_abandoned_cart";
|
|
7829
|
+
readonly EcommerceRecommendAfterPurchase: "ecommerce_recommend_after_purchase";
|
|
7830
|
+
readonly EcommercePostPurchase: "ecommerce_post_purchase";
|
|
7831
|
+
readonly EcommerceDiscountAfterPurchase: "ecommerce_discount_after_purchase";
|
|
7832
|
+
readonly ReEngagementNonOpeners: "re_engagement_non_openers";
|
|
7833
|
+
readonly ReEngagementNonClickers: "re_engagement_non_clickers";
|
|
7834
|
+
readonly FormSubmitted: "form_submitted";
|
|
7835
|
+
readonly Custom: "custom";
|
|
7836
|
+
};
|
|
7837
|
+
export type ReachV1AutomationsAutomationResourceTypeEnum = typeof ReachV1AutomationsAutomationResourceTypeEnum[keyof typeof ReachV1AutomationsAutomationResourceTypeEnum];
|
|
7838
|
+
/**
|
|
7839
|
+
*
|
|
7840
|
+
* @export
|
|
7841
|
+
* @interface ReachV1AutomationsStepsAutomationStepResource
|
|
7842
|
+
*/
|
|
7843
|
+
export interface ReachV1AutomationsStepsAutomationStepResource {
|
|
7844
|
+
/**
|
|
7845
|
+
*
|
|
7846
|
+
* @type {string}
|
|
7847
|
+
* @memberof ReachV1AutomationsStepsAutomationStepResource
|
|
7848
|
+
*/
|
|
7849
|
+
'uuid': string;
|
|
7850
|
+
/**
|
|
7851
|
+
* The step this one branches from. Null for the entry point of the workflow.
|
|
7852
|
+
* @type {string}
|
|
7853
|
+
* @memberof ReachV1AutomationsStepsAutomationStepResource
|
|
7854
|
+
*/
|
|
7855
|
+
'parent_uuid': string | null;
|
|
7856
|
+
/**
|
|
7857
|
+
* Position of this step among the steps sharing its parent.
|
|
7858
|
+
* @type {number}
|
|
7859
|
+
* @memberof ReachV1AutomationsStepsAutomationStepResource
|
|
7860
|
+
*/
|
|
7861
|
+
'step_order': number;
|
|
7862
|
+
/**
|
|
7863
|
+
* Role of the step in the workflow. A `conditional` step branches into several children.
|
|
7864
|
+
* @type {string}
|
|
7865
|
+
* @memberof ReachV1AutomationsStepsAutomationStepResource
|
|
7866
|
+
*/
|
|
7867
|
+
'type': ReachV1AutomationsStepsAutomationStepResourceTypeEnum;
|
|
7868
|
+
/**
|
|
7869
|
+
* The concrete trigger, action, decision or delay this step performs.
|
|
7870
|
+
* @type {string}
|
|
7871
|
+
* @memberof ReachV1AutomationsStepsAutomationStepResource
|
|
7872
|
+
*/
|
|
7873
|
+
'value': ReachV1AutomationsStepsAutomationStepResourceValueEnum;
|
|
7874
|
+
/**
|
|
7875
|
+
* Step configuration. The shape depends on the value, and is empty for steps that take none.
|
|
7876
|
+
* @type {object}
|
|
7877
|
+
* @memberof ReachV1AutomationsStepsAutomationStepResource
|
|
7878
|
+
*/
|
|
7879
|
+
'config': object | null;
|
|
7880
|
+
}
|
|
7881
|
+
export declare const ReachV1AutomationsStepsAutomationStepResourceTypeEnum: {
|
|
7882
|
+
readonly Trigger: "trigger";
|
|
7883
|
+
readonly Action: "action";
|
|
7884
|
+
readonly Conditional: "conditional";
|
|
7885
|
+
};
|
|
7886
|
+
export type ReachV1AutomationsStepsAutomationStepResourceTypeEnum = typeof ReachV1AutomationsStepsAutomationStepResourceTypeEnum[keyof typeof ReachV1AutomationsStepsAutomationStepResourceTypeEnum];
|
|
7887
|
+
export declare const ReachV1AutomationsStepsAutomationStepResourceValueEnum: {
|
|
7888
|
+
readonly NewContact: "new_contact";
|
|
7889
|
+
readonly NewSegmentContact: "new_segment_contact";
|
|
7890
|
+
readonly FormSubmitted: "form_submitted";
|
|
7891
|
+
readonly Webhook: "webhook";
|
|
7892
|
+
readonly SendWelcomeEmail: "send_welcome_email";
|
|
7893
|
+
readonly SendEmail: "send_email";
|
|
7894
|
+
readonly SendCampaign: "send_campaign";
|
|
7895
|
+
readonly Decision: "decision";
|
|
7896
|
+
readonly Delay: "delay";
|
|
7897
|
+
};
|
|
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
|
|
7627
8210
|
*/
|
|
7628
|
-
'
|
|
8211
|
+
'unsubscribed_count': number;
|
|
7629
8212
|
/**
|
|
7630
|
-
*
|
|
7631
|
-
* @type {
|
|
7632
|
-
* @memberof
|
|
8213
|
+
* Percentage of sent emails that were opened.
|
|
8214
|
+
* @type {number}
|
|
8215
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
7633
8216
|
*/
|
|
7634
|
-
'
|
|
7635
|
-
}
|
|
7636
|
-
/**
|
|
7637
|
-
*
|
|
7638
|
-
* @export
|
|
7639
|
-
* @interface ReachListProfileContactsV1200Response
|
|
7640
|
-
*/
|
|
7641
|
-
export interface ReachListProfileContactsV1200Response {
|
|
8217
|
+
'open_rate': number;
|
|
7642
8218
|
/**
|
|
7643
|
-
*
|
|
7644
|
-
* @type {
|
|
7645
|
-
* @memberof
|
|
8219
|
+
* Percentage of sent emails that got a click.
|
|
8220
|
+
* @type {number}
|
|
8221
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
7646
8222
|
*/
|
|
7647
|
-
'
|
|
8223
|
+
'click_rate': number;
|
|
7648
8224
|
/**
|
|
7649
|
-
*
|
|
7650
|
-
* @type {
|
|
7651
|
-
* @memberof
|
|
8225
|
+
* Percentage of the contacts who opened that went on to click.
|
|
8226
|
+
* @type {number}
|
|
8227
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
7652
8228
|
*/
|
|
7653
|
-
'
|
|
7654
|
-
}
|
|
7655
|
-
/**
|
|
7656
|
-
*
|
|
7657
|
-
* @export
|
|
7658
|
-
* @interface ReachListProfileSegmentContactsV1200Response
|
|
7659
|
-
*/
|
|
7660
|
-
export interface ReachListProfileSegmentContactsV1200Response {
|
|
8229
|
+
'click_to_open_rate': number;
|
|
7661
8230
|
/**
|
|
7662
|
-
*
|
|
7663
|
-
* @type {
|
|
7664
|
-
* @memberof
|
|
8231
|
+
* Percentage of sent emails that led to an unsubscribe.
|
|
8232
|
+
* @type {number}
|
|
8233
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
7665
8234
|
*/
|
|
7666
|
-
'
|
|
8235
|
+
'unsubscribe_rate': number;
|
|
7667
8236
|
/**
|
|
7668
8237
|
*
|
|
7669
|
-
* @type {
|
|
7670
|
-
* @memberof
|
|
8238
|
+
* @type {boolean}
|
|
8239
|
+
* @memberof ReachV1CampaignsCampaignStatisticsResource
|
|
7671
8240
|
*/
|
|
7672
|
-
'
|
|
8241
|
+
'has_bounced_contacts': boolean;
|
|
7673
8242
|
}
|
|
7674
8243
|
/**
|
|
7675
|
-
*
|
|
8244
|
+
* Headline engagement rates. The statistics endpoint carries the full breakdown.
|
|
7676
8245
|
* @export
|
|
7677
|
-
* @interface
|
|
8246
|
+
* @interface ReachV1CampaignsCampaignSummaryStatisticsResource
|
|
7678
8247
|
*/
|
|
7679
|
-
export interface
|
|
8248
|
+
export interface ReachV1CampaignsCampaignSummaryStatisticsResource {
|
|
7680
8249
|
/**
|
|
7681
|
-
*
|
|
7682
|
-
* @type {
|
|
7683
|
-
* @memberof
|
|
8250
|
+
* Emails sent for this campaign, and the denominator of the rates below.
|
|
8251
|
+
* @type {number}
|
|
8252
|
+
* @memberof ReachV1CampaignsCampaignSummaryStatisticsResource
|
|
7684
8253
|
*/
|
|
7685
|
-
'
|
|
8254
|
+
'total_sent': number;
|
|
7686
8255
|
/**
|
|
7687
|
-
*
|
|
7688
|
-
* @type {
|
|
7689
|
-
* @memberof
|
|
8256
|
+
* Percentage of sent emails that were opened.
|
|
8257
|
+
* @type {number}
|
|
8258
|
+
* @memberof ReachV1CampaignsCampaignSummaryStatisticsResource
|
|
7690
8259
|
*/
|
|
7691
|
-
'
|
|
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;
|
|
7692
8273
|
}
|
|
7693
8274
|
/**
|
|
7694
8275
|
* Create many contacts in one call
|
|
@@ -19766,6 +20347,353 @@ export declare const ListWebhooksV1StatusEnum: {
|
|
|
19766
20347
|
readonly Paused: "paused";
|
|
19767
20348
|
};
|
|
19768
20349
|
export type ListWebhooksV1StatusEnum = typeof ListWebhooksV1StatusEnum[keyof typeof ListWebhooksV1StatusEnum];
|
|
20350
|
+
/**
|
|
20351
|
+
* ReachAutomationsApi - axios parameter creator
|
|
20352
|
+
* @export
|
|
20353
|
+
*/
|
|
20354
|
+
export declare const ReachAutomationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20355
|
+
/**
|
|
20356
|
+
* Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way. This describes the automation itself. To see the workflow it runs, use the steps endpoint.
|
|
20357
|
+
* @summary Get automation details
|
|
20358
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20359
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
20360
|
+
* @param {*} [options] Override http request option.
|
|
20361
|
+
* @throws {RequiredError}
|
|
20362
|
+
*/
|
|
20363
|
+
getAutomationDetailsV1: (profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
20364
|
+
/**
|
|
20365
|
+
* Get the workflow of an automation as a flat list of steps. The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list.
|
|
20366
|
+
* @summary List automation steps
|
|
20367
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20368
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
20369
|
+
* @param {*} [options] Override http request option.
|
|
20370
|
+
* @throws {RequiredError}
|
|
20371
|
+
*/
|
|
20372
|
+
listAutomationStepsV1: (profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
20373
|
+
/**
|
|
20374
|
+
* Get a paginated list of the automations in a profile. Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
|
|
20375
|
+
* @summary List automations
|
|
20376
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20377
|
+
* @param {ListAutomationsV1StatusEnum} [status] Filter automations by status. There is no `completed` status. An automation that has finished for every contact still reports `active`.
|
|
20378
|
+
* @param {ListAutomationsV1SortDirectionEnum} [sortDirection] Order automations by creation date. Newest first unless set to `asc`.
|
|
20379
|
+
* @param {number} [page] Page number
|
|
20380
|
+
* @param {number} [perPage] Number of items per page
|
|
20381
|
+
* @param {*} [options] Override http request option.
|
|
20382
|
+
* @throws {RequiredError}
|
|
20383
|
+
*/
|
|
20384
|
+
listAutomationsV1: (profileUuid: string, status?: ListAutomationsV1StatusEnum, sortDirection?: ListAutomationsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
20385
|
+
};
|
|
20386
|
+
/**
|
|
20387
|
+
* ReachAutomationsApi - functional programming interface
|
|
20388
|
+
* @export
|
|
20389
|
+
*/
|
|
20390
|
+
export declare const ReachAutomationsApiFp: (configuration?: Configuration) => {
|
|
20391
|
+
/**
|
|
20392
|
+
* Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way. This describes the automation itself. To see the workflow it runs, use the steps endpoint.
|
|
20393
|
+
* @summary Get automation details
|
|
20394
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20395
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
20396
|
+
* @param {*} [options] Override http request option.
|
|
20397
|
+
* @throws {RequiredError}
|
|
20398
|
+
*/
|
|
20399
|
+
getAutomationDetailsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1AutomationsAutomationResource>>;
|
|
20400
|
+
/**
|
|
20401
|
+
* Get the workflow of an automation as a flat list of steps. The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list.
|
|
20402
|
+
* @summary List automation steps
|
|
20403
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20404
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
20405
|
+
* @param {*} [options] Override http request option.
|
|
20406
|
+
* @throws {RequiredError}
|
|
20407
|
+
*/
|
|
20408
|
+
listAutomationStepsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ReachV1AutomationsStepsAutomationStepResource>>>;
|
|
20409
|
+
/**
|
|
20410
|
+
* Get a paginated list of the automations in a profile. Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
|
|
20411
|
+
* @summary List automations
|
|
20412
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20413
|
+
* @param {ListAutomationsV1StatusEnum} [status] Filter automations by status. There is no `completed` status. An automation that has finished for every contact still reports `active`.
|
|
20414
|
+
* @param {ListAutomationsV1SortDirectionEnum} [sortDirection] Order automations by creation date. Newest first unless set to `asc`.
|
|
20415
|
+
* @param {number} [page] Page number
|
|
20416
|
+
* @param {number} [perPage] Number of items per page
|
|
20417
|
+
* @param {*} [options] Override http request option.
|
|
20418
|
+
* @throws {RequiredError}
|
|
20419
|
+
*/
|
|
20420
|
+
listAutomationsV1(profileUuid: string, status?: ListAutomationsV1StatusEnum, sortDirection?: ListAutomationsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachListAutomationsV1200Response>>;
|
|
20421
|
+
};
|
|
20422
|
+
/**
|
|
20423
|
+
* ReachAutomationsApi - factory interface
|
|
20424
|
+
* @export
|
|
20425
|
+
*/
|
|
20426
|
+
export declare const ReachAutomationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
20427
|
+
/**
|
|
20428
|
+
* Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way. This describes the automation itself. To see the workflow it runs, use the steps endpoint.
|
|
20429
|
+
* @summary Get automation details
|
|
20430
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20431
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
20432
|
+
* @param {*} [options] Override http request option.
|
|
20433
|
+
* @throws {RequiredError}
|
|
20434
|
+
*/
|
|
20435
|
+
getAutomationDetailsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1AutomationsAutomationResource>;
|
|
20436
|
+
/**
|
|
20437
|
+
* Get the workflow of an automation as a flat list of steps. The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list.
|
|
20438
|
+
* @summary List automation steps
|
|
20439
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20440
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
20441
|
+
* @param {*} [options] Override http request option.
|
|
20442
|
+
* @throws {RequiredError}
|
|
20443
|
+
*/
|
|
20444
|
+
listAutomationStepsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ReachV1AutomationsStepsAutomationStepResource>>;
|
|
20445
|
+
/**
|
|
20446
|
+
* Get a paginated list of the automations in a profile. Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
|
|
20447
|
+
* @summary List automations
|
|
20448
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20449
|
+
* @param {ListAutomationsV1StatusEnum} [status] Filter automations by status. There is no `completed` status. An automation that has finished for every contact still reports `active`.
|
|
20450
|
+
* @param {ListAutomationsV1SortDirectionEnum} [sortDirection] Order automations by creation date. Newest first unless set to `asc`.
|
|
20451
|
+
* @param {number} [page] Page number
|
|
20452
|
+
* @param {number} [perPage] Number of items per page
|
|
20453
|
+
* @param {*} [options] Override http request option.
|
|
20454
|
+
* @throws {RequiredError}
|
|
20455
|
+
*/
|
|
20456
|
+
listAutomationsV1(profileUuid: string, status?: ListAutomationsV1StatusEnum, sortDirection?: ListAutomationsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<ReachListAutomationsV1200Response>;
|
|
20457
|
+
};
|
|
20458
|
+
/**
|
|
20459
|
+
* ReachAutomationsApi - object-oriented interface
|
|
20460
|
+
* @export
|
|
20461
|
+
* @class ReachAutomationsApi
|
|
20462
|
+
* @extends {BaseAPI}
|
|
20463
|
+
*/
|
|
20464
|
+
export declare class ReachAutomationsApi extends BaseAPI {
|
|
20465
|
+
/**
|
|
20466
|
+
* Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way. This describes the automation itself. To see the workflow it runs, use the steps endpoint.
|
|
20467
|
+
* @summary Get automation details
|
|
20468
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20469
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
20470
|
+
* @param {*} [options] Override http request option.
|
|
20471
|
+
* @throws {RequiredError}
|
|
20472
|
+
* @memberof ReachAutomationsApi
|
|
20473
|
+
*/
|
|
20474
|
+
getAutomationDetailsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1AutomationsAutomationResource, any, {}, any>>;
|
|
20475
|
+
/**
|
|
20476
|
+
* Get the workflow of an automation as a flat list of steps. The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list.
|
|
20477
|
+
* @summary List automation steps
|
|
20478
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20479
|
+
* @param {string} automationUuid Automation uuid parameter
|
|
20480
|
+
* @param {*} [options] Override http request option.
|
|
20481
|
+
* @throws {RequiredError}
|
|
20482
|
+
* @memberof ReachAutomationsApi
|
|
20483
|
+
*/
|
|
20484
|
+
listAutomationStepsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1AutomationsStepsAutomationStepResource[], any, {}, any>>;
|
|
20485
|
+
/**
|
|
20486
|
+
* Get a paginated list of the automations in a profile. Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
|
|
20487
|
+
* @summary List automations
|
|
20488
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
20489
|
+
* @param {ListAutomationsV1StatusEnum} [status] Filter automations by status. There is no `completed` status. An automation that has finished for every contact still reports `active`.
|
|
20490
|
+
* @param {ListAutomationsV1SortDirectionEnum} [sortDirection] Order automations by creation date. Newest first unless set to `asc`.
|
|
20491
|
+
* @param {number} [page] Page number
|
|
20492
|
+
* @param {number} [perPage] Number of items per page
|
|
20493
|
+
* @param {*} [options] Override http request option.
|
|
20494
|
+
* @throws {RequiredError}
|
|
20495
|
+
* @memberof ReachAutomationsApi
|
|
20496
|
+
*/
|
|
20497
|
+
listAutomationsV1(profileUuid: string, status?: ListAutomationsV1StatusEnum, sortDirection?: ListAutomationsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachListAutomationsV1200Response, any, {}, any>>;
|
|
20498
|
+
}
|
|
20499
|
+
/**
|
|
20500
|
+
* @export
|
|
20501
|
+
*/
|
|
20502
|
+
export declare const ListAutomationsV1StatusEnum: {
|
|
20503
|
+
readonly Active: "active";
|
|
20504
|
+
readonly Paused: "paused";
|
|
20505
|
+
readonly Draft: "draft";
|
|
20506
|
+
};
|
|
20507
|
+
export type ListAutomationsV1StatusEnum = typeof ListAutomationsV1StatusEnum[keyof typeof ListAutomationsV1StatusEnum];
|
|
20508
|
+
/**
|
|
20509
|
+
* @export
|
|
20510
|
+
*/
|
|
20511
|
+
export declare const ListAutomationsV1SortDirectionEnum: {
|
|
20512
|
+
readonly Asc: "asc";
|
|
20513
|
+
readonly Desc: "desc";
|
|
20514
|
+
};
|
|
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 `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
20544
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, 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 `asc`.
|
|
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 `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
20581
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, 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 `asc`.
|
|
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 `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
20618
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, 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 `asc`.
|
|
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 `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
20659
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, 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 `asc`.
|
|
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];
|
|
19769
20697
|
/**
|
|
19770
20698
|
* ReachContactFieldsApi - axios parameter creator
|
|
19771
20699
|
* @export
|