Merge pull request #48 from myemma/UMAMI-6034_remove_calendar_call

UMAMI-6034: Remove calendar call from API documentation
myemma · Aug 4, 2023 · 6e7f8d9 · 6e7f8d9
2 parents b21175c + d34acfd
commit 6e7f8d9
Showing 1 changed file with 0 additions and 104 deletions.
diff --git a/api/external/mailings.html b/api/external/mailings.html
@@ -282,110 +282,6 @@ <h1>Mailings<a class="headerlink" href="#mailings" title="Permalink to this head
 </p>
 </dd></dl>
 
-<dl class="get">
-<dt id="get--#account_id-calendar">
-<tt class="descname">GET </tt><tt class="descname">/#account_id/calendar</tt><a class="headerlink" href="#get--#account_id-calendar" title="Permalink to this definition">&para;</a></dt>
-<dd><p>Get information about sent and scheduled mailings for the calendar.</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>start_date</strong> (<em>string</em>) &#8211; Include sent or scheduled mailings starting on this date</li>
-<li><strong>end_date</strong> (<em>string</em>) &#8211; Include sent or scheduled mailings up to this end date</li>
-<li><strong>with_html_body</strong> (<em>boolean</em>) &#8211; Optional flag to include the html_body content.</li>
-<li><strong>with_plaintext</strong> (<em>boolean</em>) &#8211; Optional flag to include the plaintext content.</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><p class="first"><tt class="docutils literal"><span class="pre">Http400</span></tt> if the start and end dates are invalid or missing.</p>
-</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Returns :</th><td class="field-body"><p class="first last">An array of mailings.</p>
-</td>
-</tr>
-</tbody>
-</table>
-<p>
-<div class="sample-response hide-response">
-<span style="font-weight:bold;">Sample Response</span>
-<a href="#" class="resp-trigger">[<span class="tshow">show</span><span class="thide">hide</span>]</a>
-<pre class="response">
-<b>GET /100/calendar?start_date=2018-09-16&end_date=2018-09-17</b>
-
-[
-  {
-    "mailing_type": "m",
-    "send_started": "@D:2018-09-16T10:30:10",
-    "cancel_by_user_id": null,
-    "mailing_id": 210,
-    "recipient_count": 1,
-    "cancel_ts": null,
-    "mailing_status": "c",
-    "account_id": 100,
-    "month": 9,
-    "failure_ts": null,
-    "reply_to": null,
-    "year": 2018,
-    "deleted_at": null,
-    "started_or_finished": "@D:2018-09-16T10:30:10",
-    "subject": "Sample Mailing for [% member:first_name %] [% member:last_name %]",
-    "disabled": false,
-    "created_ts": "@D:2018-09-13T10:18:34",
-    "sender": "Kevin McConnell",
-    "plaintext_only": false,
-    "name": "Sample Mailing",
-    "hour": 10,
-    "parent_mailing_id": null,
-    "failure_message": null,
-    "day": 16,
-    "send_finished": "@D:2018-09-16T10:30:16",
-    "datacenter": null,
-    "send_at": "@D:2018-09-16T10:30:00",
-    "signup_form_id": null,
-    "purged_at: null,
-    archived_ts: null
-  },
-  {
-    "mailing_type": "m",
-    "send_started": null,
-    "cancel_by_user_id": null,
-    "mailing_id": 211,
-    "recipient_count": 0,
-    "cancel_ts": null,
-    "mailing_status": "p",
-    "account_id": 100,
-    "month": null,
-    "failure_ts": null,
-    "reply_to": null,
-    "year": null,
-    "deleted_at": null,
-    "started_or_finished": null,
-    "subject": "Scheduled Mailing",
-    "disabled": false,
-    "created_ts": "@D:2018-09-13T10:16:54",
-    "sender": "Donna Smith",
-    "plaintext_only": false,
-    "name": "Scheduled Mailing",
-    "hour": null,
-    "parent_mailing_id": null,
-    "failure_message": null,
-    "day": null,
-    "send_finished": null,
-    "datacenter": null,
-    "send_at": "@D:2018-09-22T10:30:00",
-    "signup_form_id": null,
-    "purged_at": null,
-    "archived_ts": null
-  }
-]
-
-</pre>
-</div>
-</p>
-</dd></dl>
-
-
 <dl class="get">
 <dt id="get--#account_id-mailings-#mailing_id">
 <tt class="descname">GET </tt><tt class="descname">/#account_id/mailings/#mailing_id</tt><a class="headerlink" href="#get--#account_id-mailings-#mailing_id" title="Permalink to this definition">&para;</a></dt>