diff --git a/campaigns.md b/campaigns.md index 04fa374..e9463d5 100644 --- a/campaigns.md +++ b/campaigns.md @@ -62,6 +62,7 @@ This means that you don't have to fetch the resources you want to use. You can s * `results` \(list\(models.Result\)\) The campaign results * `timeline` \(list\(models.TimelineEntry\)\) The timeline entries * `name` \(str\) The campaign name +* `description` \(str\) The campaign description * `status` \(str\) The current status of the campaign * `created_date` \(optional: datetime.datetime\) The campaign creation date * `send_by_date` \(optional: datetime.datetime\) The date to send all emails by @@ -83,10 +84,11 @@ page = Page(name='Existing Page') template = Template(name='Existing Template') smtp = SMTP(name='Existing Profile') url = 'http://phishing_server' +description = 'My first example campaign' campaign = Campaign( name='Example Campaign', groups=groups, page=page, - template=template, smtp=smtp) + template=template, smtp=smtp, url=url, description=description) ``` #### gophish.models.Stat @@ -215,7 +217,7 @@ smtp = SMTP(name='Existing Profile') url = 'http://phishing_server' campaign = Campaign( name='Example Campaign', groups=groups, page=page, - template=template, smtp=smtp) + template=template, smtp=smtp, url=url) campaign = api.campaigns.post(campaign) print campaign.id diff --git a/landing-pages.md b/landing-pages.md index 0f2e712..f746f1e 100644 --- a/landing-pages.md +++ b/landing-pages.md @@ -36,6 +36,7 @@ A page contains one or more `models.User` objects. The page name must be unique. * `id` \(int\) The page ID * `html` \(str\) The page HTML * `name` \(str\) The page name +* `description` \(str\) The page description * `modified_date` \(optional: datetime.datetime\) The scheduled time for page launch * `capture_credentials` \(bool default:False\) Whether or not the landing page should capture credentials * `capture_passwords` \(bool default:False\) Whether or not the landing page should capture passwords diff --git a/templates.md b/templates.md index c564d50..6cd55ee 100644 --- a/templates.md +++ b/templates.md @@ -53,6 +53,7 @@ A template contains a name and the email content. * `id` \(int\) The template ID * `name` \(str\) The template name +* `description` \(str\) The template description * `html` \(str\) The template HTML * `text` \(str\) The template HTML * `modified_date` \(optional: datetime.datetime\) The scheduled time for template launch