Skip to content

PRO-864 update the api docs #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 4, 2024
Merged

PRO-864 update the api docs #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 50 additions & 2 deletions data/3.1/events/attributes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,8 +530,20 @@
"translated": false,
"type": null
},
"end_at": {
"description": "The date and time the event is going to end based on the `end_date` and `end_time`, e.g. 2020-12-31T20:00:00.000+01:00.",
"expandable": false,
"expand_ids": false,
"expand_slugs": false,
"ignore": false,
"read_only": false,
"write_only": false,
"required": false,
"translated": false,
"type": "timestamp"
},
"end_date": {
"description": "The date the event is going to end",
"description": "The date the event is going to end, e.g. 2020-12-31",
"expandable": false,
"expand_ids": false,
"expand_slugs": false,
Expand All @@ -542,6 +554,18 @@
"translated": false,
"type": "date"
},
"end_time": {
"description": "The time the event is going to end using the event's `timezone`, e.g. 18:00",
"expandable": false,
"expand_ids": false,
"expand_slugs": false,
"ignore": false,
"read_only": false,
"write_only": false,
"required": false,
"translated": false,
"type": "time"
},
"facebook_share_message": {
"description": null,
"expandable": false,
Expand Down Expand Up @@ -1563,8 +1587,20 @@
"translated": false,
"type": "string"
},
"start_at": {
"description": "The time the event is going to start based on the `start_date` and `start_time`, e.g. 2020-12-31T13:00:00.000+01:00",
"expandable": false,
"expand_ids": false,
"expand_slugs": false,
"ignore": false,
"read_only": false,
"write_only": false,
"required": false,
"translated": false,
"type": "timestamp"
},
"start_date": {
"description": "The date the event is going to start",
"description": "The date the event is going to start, e.g. 2020-12-31",
"expandable": false,
"expand_ids": false,
"expand_slugs": false,
Expand All @@ -1575,6 +1611,18 @@
"translated": false,
"type": "date"
},
"start_time": {
"description": "The time the event is going to start using the event's time zone, e.g. 13:00",
"expandable": false,
"expand_ids": false,
"expand_slugs": false,
"ignore": false,
"read_only": false,
"write_only": false,
"required": false,
"translated": false,
"type": "time"
},
"stripe": {
"description": null,
"expandable": false,
Expand Down
34 changes: 32 additions & 2 deletions data/events.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,23 +91,53 @@
"required": false
},
"start_date": {
"description": "The date the event is going to start",
"description": "The date the event is going to start, e.g. 2020-12-31",
"type": "date",
"read_only": false,
"required": false
},
"start_time": {
"description": "The time the event is going to start using the event's time zone, e.g. 13:00",
"type": "string",
"read_only": false,
"required": false
},
"start_at": {
"description": "The time the event is going to start based on the `start_date` and `start_time`, e.g. 2020-12-31T13:00:00.000+01:00",
"type": "timestamp",
"read_only": false,
"required": false
},
"end_date": {
"description": "The date the event is going to end",
"description": "The date the event is going to end, e.g. 2020-12-31",
"type": "date",
"read_only": false,
"required": false
},
"end_time": {
"description": "The time the event is going to end using the event's `timezone`, e.g. 18:00",
"type": "string",
"read_only": false,
"required": false
},
"end_at": {
"description": "The time the event is going to end based on the `end_date` and `end_time`, e.g. 2020-12-31T18:00:00.000+01:00",
"type": "timestamp",
"read_only": false,
"required": false
},
"date_or_range": {
"description": null,
"type": "string",
"read_only": true,
"required": false
},
"timezone": {
"description": "The time zone for the event, e.g. Paris",
"type": "string",
"read_only": true,
"required": false
},
"security_token": {
"description": null,
"type": "string",
Expand Down
Loading