Skip to content

Commit

Permalink
- markdown tables - add types
Browse files Browse the repository at this point in the history
  • Loading branch information
Marcin Slezak committed Sep 28, 2023
1 parent 985ad0a commit 5d99700
Show file tree
Hide file tree
Showing 26 changed files with 860 additions and 854 deletions.
184 changes: 92 additions & 92 deletions docs/reference-docs/ASYNC-ACTIONS-API-Async-Action-Object.md

Large diffs are not rendered by default.

316 changes: 158 additions & 158 deletions docs/reference-docs/CAMPAIGNS-API-Campaign-Object.md

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/reference-docs/CATEGORIES-API-Category-Object.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ hidden: false
order: 1
---


## Category Object
| Attributes | Description |
|:-----|:--------|
| id | <p>Unique category ID assigned by Voucherify.</p> |
| name | <p>Category name.</p> |
| hierarchy | <p>Category hierarchy.</p> |
| created_at | <p>Timestamp representing the date and time when the category was created in ISO 8601 format.</p> **Example:** <p>2022-07-14T10:45:13.156Z</p> |
| updated_at | <p>Timestamp representing the date and time when the category was updated in ISO 8601 format.</p> **Example:** <p>2022-08-16T10:52:08.094Z</p> |
| object | <p>The type of object represented by the JSON. This object stores information about the category.</p> |
| id</br>`string` | <p>Unique category ID assigned by Voucherify.</p> |
| name</br>`string` | <p>Category name.</p> |
| hierarchy</br>`integer` | <p>Category hierarchy.</p> |
| created_at</br>`string` | <p>Timestamp representing the date and time when the category was created in ISO 8601 format.</p> **Example:** <p>2022-07-14T10:45:13.156Z</p> |
| updated_at</br>`string` | <p>Timestamp representing the date and time when the category was updated in ISO 8601 format.</p> **Example:** <p>2022-08-16T10:52:08.094Z</p> |
| object</br>`string` | <p>The type of object represented by the JSON. This object stores information about the category.</p> |

[block:html]
{
Expand Down
6 changes: 3 additions & 3 deletions docs/reference-docs/CONSENTS-API-Consents-Object.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ hidden: false
order: 1
---


## List Consents Response Body
| Attributes | Description |
|:-----|:--------|
| groups | <p>Contains marketing permission groups' definitions.</p> <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">object</td><td style="text-align:left"><p>Stores information about marketing permission groups.</p></td></tr><tr><td style="text-align:left">data_ref</td><td style="text-align:left"><p>Identifies the name of the attribute that contains the array of marketing permission groups.</p></td></tr><tr><td style="text-align:left">data</td><td style="text-align:left"><p>An array of marketing permission groups.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">id</td><td style="text-align:left"><p>Unique group ID.</p> <strong>Example:</strong> <p>cnstgr_3c7Z3rcOLv51bsXlRtTZPYj8</p></td></tr><tr><td style="text-align:left">name</td><td style="text-align:left"><p>Marketing permission group name.</p></td></tr><tr><td style="text-align:left">description</td><td style="text-align:left"><p>Marketing permission group category.</p></td></tr><tr><td style="text-align:left">consents</td><td style="text-align:left"><p>List of consents that are assigned to the group.</p></td></tr><tr><td style="text-align:left">created_at</td><td style="text-align:left"><p>Timestamp representing the date and time when the group was created in ISO 8601 format.</p> <strong>Example:</strong> <p>2022-04-13T09:12:47.743Z</p></td></tr><tr><td style="text-align:left">updated_at</td><td style="text-align:left"><p>Timestamp representing the date and time when the group was updated in ISO 8601 format.</p> <strong>Example:</strong> <p>2022-05-14T09:11:27.037Z</p></td></tr><tr><td style="text-align:left">object</td><td style="text-align:left"><p>Stores information about a marketing permission group.</p></td></tr></tbody></table></td></tr><tr><td style="text-align:left">total</td><td style="text-align:left"><p>Total number of groups.</p></td></tr></tbody></table> |
| consents | <p>Contains opt-in consents' definitions.</p> <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">object</td><td style="text-align:left"><p>Stores information about opt-in consents.</p></td></tr><tr><td style="text-align:left">data_ref</td><td style="text-align:left"><p>Identifies the name of the attribute that contains the array of opt-in consents.</p></td></tr><tr><td style="text-align:left">data</td><td style="text-align:left"><p>An array of consents.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">id</td><td style="text-align:left"><p>Unique consent ID.</p> <strong>Example:</strong> <p>cnst_6jQ5XcUOLnj5L7ImQAdBsJ1I</p></td></tr><tr><td style="text-align:left">name</td><td style="text-align:left"><p>Consent name.</p></td></tr><tr><td style="text-align:left">description</td><td style="text-align:left"><p>Consent description.</p></td></tr><tr><td style="text-align:left">category</td><td style="text-align:left"><p>Consent category.</p></td></tr><tr><td style="text-align:left">created_at</td><td style="text-align:left"><p>Timestamp representing the date and time when the consent was created in ISO 8601 format.</p> <strong>Example:</strong> <p>2022-04-13T09:11:27.037Z</p></td></tr><tr><td style="text-align:left">updated_at</td><td style="text-align:left"><p>Timestamp representing the date and time when the consent was updated in ISO 8601 format.</p> <strong>Example:</strong> <p>2022-05-14T09:11:27.037Z</p></td></tr><tr><td style="text-align:left">object</td><td style="text-align:left"><p>Stores information about an opt-in consent.</p></td></tr></tbody></table></td></tr><tr><td style="text-align:left">total</td><td style="text-align:left"><p>Total number of consents.</p></td></tr></tbody></table> |
| groups</br>`object` | <p>Contains marketing permission groups' definitions.</p> <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">object</br><code>string</code></td><td style="text-align:left"><p>Stores information about marketing permission groups.</p></td></tr><tr><td style="text-align:left">data_ref</br><code>string</code></td><td style="text-align:left"><p>Identifies the name of the attribute that contains the array of marketing permission groups.</p></td></tr><tr><td style="text-align:left">data</br><code>array</code></td><td style="text-align:left"><p>An array of marketing permission groups.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">id</br><code>string</code></td><td style="text-align:left"><p>Unique group ID.</p> <strong>Example:</strong> <p>cnstgr_3c7Z3rcOLv51bsXlRtTZPYj8</p></td></tr><tr><td style="text-align:left">name</br><code>string</code></td><td style="text-align:left"><p>Marketing permission group name.</p></td></tr><tr><td style="text-align:left">description</br><code>string</code></td><td style="text-align:left"><p>Marketing permission group category.</p></td></tr><tr><td style="text-align:left">consents</br><code>array</code></td><td style="text-align:left"><p>List of consents that are assigned to the group.</p></td></tr><tr><td style="text-align:left">created_at</br><code>string</code></td><td style="text-align:left"><p>Timestamp representing the date and time when the group was created in ISO 8601 format.</p> <strong>Example:</strong> <p>2022-04-13T09:12:47.743Z</p></td></tr><tr><td style="text-align:left">updated_at</br><code>string</code></td><td style="text-align:left"><p>Timestamp representing the date and time when the group was updated in ISO 8601 format.</p> <strong>Example:</strong> <p>2022-05-14T09:11:27.037Z</p></td></tr><tr><td style="text-align:left">object</br><code>string</code></td><td style="text-align:left"><p>Stores information about a marketing permission group.</p></td></tr></tbody></table></td></tr><tr><td style="text-align:left">total</br><code>integer</code></td><td style="text-align:left"><p>Total number of groups.</p></td></tr></tbody></table> |
| consents</br>`object` | <p>Contains opt-in consents' definitions.</p> <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">object</br><code>string</code></td><td style="text-align:left"><p>Stores information about opt-in consents.</p></td></tr><tr><td style="text-align:left">data_ref</br><code>string</code></td><td style="text-align:left"><p>Identifies the name of the attribute that contains the array of opt-in consents.</p></td></tr><tr><td style="text-align:left">data</br><code>array</code></td><td style="text-align:left"><p>An array of consents.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">id</br><code>string</code></td><td style="text-align:left"><p>Unique consent ID.</p> <strong>Example:</strong> <p>cnst_6jQ5XcUOLnj5L7ImQAdBsJ1I</p></td></tr><tr><td style="text-align:left">name</br><code>string</code></td><td style="text-align:left"><p>Consent name.</p></td></tr><tr><td style="text-align:left">description</br><code>string</code></td><td style="text-align:left"><p>Consent description.</p></td></tr><tr><td style="text-align:left">category</br><code>string</code></td><td style="text-align:left"><p>Consent category.</p></td></tr><tr><td style="text-align:left">created_at</br><code>string</code></td><td style="text-align:left"><p>Timestamp representing the date and time when the consent was created in ISO 8601 format.</p> <strong>Example:</strong> <p>2022-04-13T09:11:27.037Z</p></td></tr><tr><td style="text-align:left">updated_at</br><code>string</code></td><td style="text-align:left"><p>Timestamp representing the date and time when the consent was updated in ISO 8601 format.</p> <strong>Example:</strong> <p>2022-05-14T09:11:27.037Z</p></td></tr><tr><td style="text-align:left">object</br><code>string</code></td><td style="text-align:left"><p>Stores information about an opt-in consent.</p></td></tr></tbody></table></td></tr><tr><td style="text-align:left">total</br><code>integer</code></td><td style="text-align:left"><p>Total number of consents.</p></td></tr></tbody></table> |

[block:html]
{
Expand Down
12 changes: 6 additions & 6 deletions docs/reference-docs/CUSTOMERS-API-Customer-Activity-Object.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ hidden: false
order: 2
---


## Customer Activity Object
| Attributes | Description |
|:-----|:--------|
| id | <p>Unique event ID, assigned by Voucherify.</p> **Example:** <p>evcus_0c150c51730c6b60b1</p> |
| type | <p>Event type.</p> Available values: `customer.confirmed`, `customer.created`, `customer.updated`, `customer.deleted`, `customer.referred`, `customer.custom_event`, `customer.segment_entered`, `customer.segment.left`, `customer.sms.sent`, `customer.sms.failed`, `customer.email.sent`, `customer.email.failed`, `customer.activecampaign.sent`, `customer.braze.sent`, `customer.mailchimp.sent`, `customer.intercom.sent`, `customer.intercom.failed`, `customer.rewarded`, `customer.rewarded.loyalty_points`, `customer.voucher.gift.balance_added`, `customer.voucher.loyalty_card.points_added`, `customer.voucher.loyalty_card.points_transferred`, `customer.publication.succeeded`, `customer.publication.failed`, `customer.redemption.succeeded`, `customer.redemption.failed`, `customer.redemption.rollback.succeeded`, `customer.redemption.rollback.failed`, `customer.consents.given`, `customer.consents.revoked` |
| data | <p>Contains details about the event. The objects that are returned in the data attribute differ based on the context of the event type.</p> Array of [Customer Activity Data Object](#customer-activity-data-object) |
| created_at | <p>Timestamp representing the date and time when the customer activity occurred in ISO 8601 format.</p> **Example:** <p>2022-08-30T09:14:07.660Z</p> |
# Customer Activity Data Object
| id</br>`string` | <p>Unique event ID, assigned by Voucherify.</p> **Example:** <p>evcus_0c150c51730c6b60b1</p> |
| type</br>`string` | <p>Event type.</p> Available values: `customer.confirmed`, `customer.created`, `customer.updated`, `customer.deleted`, `customer.referred`, `customer.custom_event`, `customer.segment_entered`, `customer.segment.left`, `customer.sms.sent`, `customer.sms.failed`, `customer.email.sent`, `customer.email.failed`, `customer.activecampaign.sent`, `customer.braze.sent`, `customer.mailchimp.sent`, `customer.intercom.sent`, `customer.intercom.failed`, `customer.rewarded`, `customer.rewarded.loyalty_points`, `customer.voucher.gift.balance_added`, `customer.voucher.loyalty_card.points_added`, `customer.voucher.loyalty_card.points_transferred`, `customer.publication.succeeded`, `customer.publication.failed`, `customer.redemption.succeeded`, `customer.redemption.failed`, `customer.redemption.rollback.succeeded`, `customer.redemption.rollback.failed`, `customer.consents.given`, `customer.consents.revoked` |
| data</br>`array` | <p>Contains details about the event. The objects that are returned in the data attribute differ based on the context of the event type.</p> Array of [Customer Activity Data Object](#customer-activity-data-object) |
| created_at</br>`string` | <p>Timestamp representing the date and time when the customer activity occurred in ISO 8601 format.</p> **Example:** <p>2022-08-30T09:14:07.660Z</p> |
## Customer Activity Data Object

[block:html]
{
Expand Down
Loading

0 comments on commit 5d99700

Please sign in to comment.