Enumeration: PrecannedDateRange¶
Defined in: api_types.ts:1381
Special "live" date range values that can be used as the ParamDef.suggestedValue for a date array parameter.
Date array parameters are meant to represent date ranges. A date range can be a fixed range, e.g. April 1, 2020 - May 15, 2020, or it can be a "live" range, like "last 30 days".
At execution time, a date range will always be passed to a pack as an array of two specific dates, but for many use cases, it is necessary to provide a default value that is a "live" range rather than hardcoded one. For example, if your pack has a table that syncs recent emails, you might want to have a date range parameter that default to "last 7 days". Defaulting to a hardcoded date range would not be useful and requiring the user to always specify a date range may be inconvenient.
Enumeration Members¶
Everything¶
Everything:
"everything"
Defined in: api_types.ts:1426
Indicates a date range beginning in the very distant past (e.g. 1/1/1, aka 1 A.D.) and ending in the distant future (e.g. 12/31/3999). Exact dates are subject to change.
Last180Days¶
Last180Days:
"last_180_days"
Defined in: api_types.ts:1387
Last30AndNext30Days¶
Last30AndNext30Days:
"last_30_and_next_30_days"
Defined in: api_types.ts:1404
Last30Days¶
Last30Days:
"last_30_days"
Defined in: api_types.ts:1385
Last365Days¶
Last365Days:
"last_365_days"
Defined in: api_types.ts:1388
Last3Months¶
Last3Months:
"last_3_months"
Defined in: api_types.ts:1392
Deprecated¶
Last6Months¶
Last6Months:
"last_6_months"
Defined in: api_types.ts:1394
Deprecated¶
Last7AndNext7Days¶
Last7AndNext7Days:
"last_7_and_next_7_days"
Defined in: api_types.ts:1403
Last7Days¶
Last7Days:
"last_7_days"
Defined in: api_types.ts:1384
Last90AndNext90Days¶
Last90AndNext90Days:
"last_90_and_next_90_days"
Defined in: api_types.ts:1405
Last90Days¶
Last90Days:
"last_90_days"
Defined in: api_types.ts:1386
LastMonth¶
LastMonth:
"last_month"
Defined in: api_types.ts:1390
LastWeek¶
LastWeek:
"last_week"
Defined in: api_types.ts:1389
LastYear¶
LastYear:
"last_year"
Defined in: api_types.ts:1395
Next180Days¶
Next180Days:
"next_180_days"
Defined in: api_types.ts:1412
Next30Days¶
Next30Days:
"next_30_days"
Defined in: api_types.ts:1410
Next365Days¶
Next365Days:
"next_365_days"
Defined in: api_types.ts:1413
Next3Months¶
Next3Months:
"next_3_months"
Defined in: api_types.ts:1417
Deprecated¶
Next6Months¶
Next6Months:
"next_6_months"
Defined in: api_types.ts:1419
Deprecated¶
Next7Days¶
Next7Days:
"next_7_days"
Defined in: api_types.ts:1409
Next90Days¶
Next90Days:
"next_90_days"
Defined in: api_types.ts:1411
NextMonth¶
NextMonth:
"next_month"
Defined in: api_types.ts:1415
NextWeek¶
NextWeek:
"next_week"
Defined in: api_types.ts:1414
NextYear¶
NextYear:
"next_year"
Defined in: api_types.ts:1420
ThisMonth¶
ThisMonth:
"this_month"
Defined in: api_types.ts:1400
ThisWeek¶
ThisWeek:
"this_week"
Defined in: api_types.ts:1399
ThisYear¶
ThisYear:
"this_year"
Defined in: api_types.ts:1402
Today¶
Today:
"today"
Defined in: api_types.ts:1398
Tomorrow¶
Tomorrow:
"tomorrow"
Defined in: api_types.ts:1408
YearToDate¶
YearToDate:
"year_to_date"
Defined in: api_types.ts:1401
Yesterday¶
Yesterday:
"yesterday"
Defined in: api_types.ts:1383