ChmpCampaigns: Campaigns class

In sckott/chimpr: 'Mailchimp' API Client

Description

Campaigns class

Campaigns class

Details

xxx

Methods

Public methods

• ChmpCampaigns$new()

• ChmpCampaigns$print()

• ChmpCampaigns$all()

• ChmpCampaigns$info()

• ChmpCampaigns$content()

• ChmpCampaigns$feedback()

• ChmpCampaigns$send_checklist()

• ChmpCampaigns$clone()

---

Method new()

Usage

ChmpCampaigns$new(conn, id)

Arguments

conn

a connection object. see ChmpClient

id

a campgaign id. optional, but required for most methods

---

Method print()

Usage

ChmpCampaigns$print(x, ...)

---

Method all()

Usage

ChmpCampaigns$all(
  fields = NULL,
  exclude_fields = NULL,
  count = 10,
  offset = 0,
  type = NULL,
  status = NULL,
  before_send_time = NULL,
  since_send_time = NULL,
  before_create_time = NULL,
  since_create_time = NULL,
  list_id = NULL,
  folder_id = NULL,
  sort_field = NULL,
  sort_dir = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method info()

Usage

ChmpCampaigns$info(
  report = NULL,
  fields = NULL,
  exclude_fields = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method content()

Usage

ChmpCampaigns$content(
  fields = NULL,
  exclude_fields = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method feedback()

Usage

ChmpCampaigns$feedback(
  feedback_id = NULL,
  fields = NULL,
  exclude_fields = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method send_checklist()

Usage

ChmpCampaigns$send_checklist(
  fields = NULL,
  exclude_fields = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ChmpCampaigns$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Note

not all routes are implemented thus far

Examples

## Not run: 
(conn <- ChmpClient$new())
(x <- ChmpCampaigns$new(conn))
x$all()
x$all(count = 2)
x$all(count = 2, offset = 2)

(x <- ChmpCampaigns$new(conn, id = "<id>"))
x$info()
x$info(parse = FALSE)
x$info(fields = "report_summary")
x$content()
x$feedback()
x$send_checklist()

## End(Not run)

sckott/chimpr documentation built on Sept. 17, 2021, 11:04 a.m.