Update supported objects for Airdrop #250
Conversation
🌟 EkLine ReviewerHello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page. For questions or feedback, please email support@ekline.io. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
EkLine
🚫 [EkLine]
'conversation' should use sentence-style capitalization. (EK00037)
Consider using 'customer' instead of 'rev'. (EK25033)
🚫 [EkLine]
'custom_link' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'custom_part' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'devu' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'directory' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'dm' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'enhancement' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'feature' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'group' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'incident' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'issue' should use sentence-style capitalization. (EK00037)
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
Consider using 'customer' instead of 'Rev'. (EK25033)
🚫 [EkLine]
'link' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'linkable' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'meeting' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'microservice' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'object_member' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'opportunity' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'product' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'revu' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'runnable' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'sysu' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'tag' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'task' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'ticket' should use sentence-style capitalization. (EK00037)
Consider using 'workspace' instead of 'rev org'. (EK25033)
|
Published docs preview URL: https://devrev-preview-f0ec6bb5-b98b-4de0-9956-af941ef464ee.docs.buildwithfern.com |
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
EkLine
🚫 [EkLine]
'incident' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'issue' should use sentence-style capitalization. (EK00037)
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
Consider using 'customer' instead of 'Rev'. (EK25033)
🚫 [EkLine]
'link' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'linkable' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'meeting' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'microservice' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'object_member' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'opportunity' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'product' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'revu' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'runnable' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'sysu' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'tag' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'task' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'ticket' should use sentence-style capitalization. (EK00037)
Consider using 'workspace' instead of 'rev org'. (EK25033)
|
Published docs preview URL: https://devrev-preview-c09e1c55-3942-430a-9d35-279c999f167a.docs.buildwithfern.com |
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
EkLine
🚫 [EkLine]
'conversation' should use sentence-style capitalization. (EK00037)
Consider using 'customer' instead of 'rev'. (EK25033)
🚫 [EkLine]
'custom_link' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'custom_part' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'devu' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'directory' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'dm' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'enhancement' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'feature' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'group' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'incident' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'issue' should use sentence-style capitalization. (EK00037)
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
Consider using 'customer' instead of 'Rev'. (EK25033)
🚫 [EkLine]
'link' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'linkable' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'meeting' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'microservice' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'object_member' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'opportunity' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'product' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'revu' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'runnable' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'sysu' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'tag' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'task' should use sentence-style capitalization. (EK00037)
🚫 [EkLine]
'ticket' should use sentence-style capitalization. (EK00037)
Consider using 'workspace' instead of 'rev org'. (EK25033)
| [ ▲ top](#summary) | ||
|
|
||
| --- | ||
|
|
||
| ## account |
There was a problem hiding this comment.
🚫 [EkLine]
'account' should use sentence-style capitalization. (EK00037)
| | `ACTIVE` | ACTIVE | - | | ||
| | `INACTIVE` | INACTIVE | - | | ||
| | `LOCKED` | LOCKED | - | | ||
|
|
||
| ### Structs | ||
|
|
||
| #### postal_address |
There was a problem hiding this comment.
🚫 [EkLine]
'postal_address' should use sentence-style capitalization. (EK00037)
| |-----|------|-------------| | ||
| | `dev_users` | Dev users | "Dynamic dev users group created by DevRev" | | ||
| | `none` | No group | "No group selected" | | ||
| | `rev_users` | Rev users | "Dynamic rev users group created by DevRev" | |
There was a problem hiding this comment.
Suggestions:
- Consider using 'customer' instead of 'Rev'. (EK25033)
- Consider using 'customer' instead of 'rev'. (EK25033)
| | `rev_users` | Rev users | "Dynamic rev users group created by DevRev" | | |
| | `rev_users` | Customer users | "Dynamic customer users group created by DevRev" | |
| | `customer_admins` | - | - | | ||
| | `customers` | - | - | | ||
| | `verified_customers` | - | - | | ||
|
|
||
| ### Structs | ||
|
|
||
| #### resource |
There was a problem hiding this comment.
🚫 [EkLine]
'resource' should use sentence-style capitalization. (EK00037)
| @@ -243,6 +378,19 @@ This document contains the list of all DevRev object types that are supported fo | |||
| | `name` | text | | The name of the channel. If provided, this will be unique across all channels in the Dev org. It's case insensitive and must contain the characters [A-Za-z0-9_-]. | | |||
There was a problem hiding this comment.
Suggestions:
- Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
- Consider using 'TBD' instead of 'Dev org'. (EK25033)
| | `name` | text | | The name of the channel. If provided, this will be unique across all channels in the Dev org. It's case insensitive and must contain the characters [A-Za-z0-9_-]. | | |
| | `name` | text | | The name of the channel. If provided, this is unique across all channels in the Dev org. It's case insensitive and must contain the characters [A-Za-z0-9_-]. | |
| | `qualification` | Qualification | - | | ||
| | `stalled` | Stalled | - | | ||
| | `validation` | Validation | - | | ||
|
|
||
| ### Structs | ||
|
|
||
| #### money |
There was a problem hiding this comment.
🚫 [EkLine]
'money' should use sentence-style capitalization. (EK00037)
| @@ -937,15 +1415,12 @@ This document contains the list of all DevRev object types that are supported fo | |||
| | `description` | rich_text | | Description of the Rev user. | | |||
There was a problem hiding this comment.
Consider using 'customer' instead of 'Rev user'. (EK25033)
| | `description` | rich_text | | Description of the Rev user. | | |
| | `description` | rich_text | | Description of the customer. | |
| @@ -937,15 +1415,12 @@ This document contains the list of all DevRev object types that are supported fo | |||
| | `description` | rich_text | | Description of the Rev user. | | |||
| | `display_handle` | text | | The user's display handle. This field is deprecated now. Use display_name field instead. | | |||
| | `display_name` | text | ✔︎ | The user's display name. The name is non-unique and mutable. | | |||
| | `display_picture` | reference -> [#record:artifact] | | Artifact ID of the user's display picture | | |||
| | `email` | text | | Email address of the user. | | |||
| | `external_uid` | text | | External ref is a mutable unique identifier for a user within the Rev organization from your primary customer record. If none is available, a good alternative is the email address/phone number which could uniquely identify the user. If none is specified, a system-generated identifier will be assigned to the user. | | |||
There was a problem hiding this comment.
Suggestions:
- Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
- Consider using 'customer' instead of 'Rev'. (EK25033)
| | `external_uid` | text | | External ref is a mutable unique identifier for a user within the Rev organization from your primary customer record. If none is available, a good alternative is the email address/phone number which could uniquely identify the user. If none is specified, a system-generated identifier will be assigned to the user. | | |
| | `external_uid` | text | | External ref is a mutable unique identifier for a user within the customer organization from your primary customer record. If none is available, a good alternative is the email address/phone number which could uniquely identify the user. If none is specified, a system-generated identifier is assigned to the user. | |
| @@ -937,15 +1415,12 @@ This document contains the list of all DevRev object types that are supported fo | |||
| | `description` | rich_text | | Description of the Rev user. | | |||
| | `display_handle` | text | | The user's display handle. This field is deprecated now. Use display_name field instead. | | |||
| | `display_name` | text | ✔︎ | The user's display name. The name is non-unique and mutable. | | |||
| | `display_picture` | reference -> [#record:artifact] | | Artifact ID of the user's display picture | | |||
| | `email` | text | | Email address of the user. | | |||
| | `external_uid` | text | | External ref is a mutable unique identifier for a user within the Rev organization from your primary customer record. If none is available, a good alternative is the email address/phone number which could uniquely identify the user. If none is specified, a system-generated identifier will be assigned to the user. | | |||
| | `full_name` | text | | Full name of the user. | | |||
| | `phone_numbers` | text (collection) | | Phone numbers of the user. | | |||
| | `rev_org` | reference -> [#record:account #record:revo] | | The ID of the parent Rev Organization. | | |||
There was a problem hiding this comment.
Consider using 'customer' instead of 'Rev'. (EK25033)
| | `rev_org` | reference -> [#record:account #record:revo] | | The ID of the parent Rev Organization. | | |
| | `rev_org` | reference -> [#record:account #record:revo] | | The ID of the parent customer Organization. | |
| @@ -1141,7 +1639,46 @@ This document contains the list of all DevRev object types that are supported fo | |||
| | `title` | text | ✔︎ | Title of the work object | | |||
| | `visibility` | enum | | The visibility of the object. If 'internal', the object is visible within the Dev organization. If 'external', it is visible to both the Dev organization and Rev users. If not set, the default visibility is 'external'. | | |||
There was a problem hiding this comment.
Consider using 'customer' instead of 'Rev'. (EK25033)
| | `visibility` | enum | | The visibility of the object. If 'internal', the object is visible within the Dev organization. If 'external', it is visible to both the Dev organization and Rev users. If not set, the default visibility is 'external'. | | |
| | `visibility` | enum | | The visibility of the object. If 'internal', the object is visible within the Dev organization. If 'external', it is visible to both the Dev organization and customer users. If not set, the default visibility is 'external'. | |
There was a problem hiding this comment.
🚫 [EkLine]
Avoid using the term 'Dev user'. (EK25015)
There was a problem hiding this comment.
🚫 [EkLine]
'airdrop_authorization_policy' should use sentence-style capitalization. (EK00037)
There was a problem hiding this comment.
🚫 [EkLine]
'airdrop_platform_group' should use sentence-style capitalization. (EK00037)
There was a problem hiding this comment.
🚫 [EkLine]
'article' should use sentence-style capitalization. (EK00037)
There was a problem hiding this comment.
Consider using 'customer' instead of 'Rev user'. (EK25033)
There was a problem hiding this comment.
🚫 [EkLine]
Use 'DevRev' instead of 'devrev'. (EK25050)
There was a problem hiding this comment.
🚫 [EkLine]
'capability' should use sentence-style capitalization. (EK00037)
There was a problem hiding this comment.
🚫 [EkLine]
'channel' should use sentence-style capitalization. (EK00037)
There was a problem hiding this comment.
🚫 [EkLine]
'comment' should use sentence-style capitalization. (EK00037)
There was a problem hiding this comment.
🚫 [EkLine]
'component' should use sentence-style capitalization. (EK00037)
|
Published docs preview URL: https://devrev-preview-adbe99f5-bca9-40ac-9409-09cc3e4f73cc.docs.buildwithfern.com |
| @@ -1,13 +1,14 @@ | |||
| # Supported DevRev object types for Airdrop | |||
|
|
|||
| Last updated: _2025-04_ | |||
| Last updated: _June 5, 2025_ | |||
There was a problem hiding this comment.
Does this need to be exposed to the user?
|
Published docs preview URL: https://devrev-preview-3b8a2515-99a2-4814-8800-b257e4c13183.docs.buildwithfern.com |
* Update supported objects for Airdrop * Update supported-object-types.mdx * Update supported-object-types.mdx * Update supported-object-types.mdx
Work: https://app.devrev.ai/devrev/works/ISS-180330
Update the supported objects for Airdrop